feat: manage samples via plugin (microsoft#2805)

* redo on a clean master * fix dotnet tests path * correct the typo * update all other places * fix the last path * fix paths * remove commented code * fix typo * fix comments * fix comments * update type * align with local publisher * revert the dependency to plugin-loader Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>
lei9444 · May 6, 2020 · e408267 · e408267
1 parent c42b6e1
commit e408267
Show file tree

Hide file tree

Showing 234 changed files with 617 additions and 380 deletions.
diff --git a/Composer/package.json b/Composer/package.json
@@ -33,7 +33,10 @@
     "build:server": "yarn workspace @bfc/server build",
     "build:client": "yarn workspace @bfc/client build",
     "build:tools": "yarn workspace @bfc/tools build:all",
-    "build:plugins": "concurrently \"cd plugins/localPublish && yarn install && yarn build\" \"cd plugins/azurePublish && yarn install && yarn build\" ",
+    "build:plugins": "yarn build:plugins:localpublish && yarn build:plugins:samples && yarn build:plugins:azurePublish",
+    "build:plugins:localpublish": "cd plugins/localPublish && yarn install && yarn build",
+    "build:plugins:samples": "cd plugins/samples && yarn install && yarn build",
+    "build:plugins:azurePublish": "cd plugins/azurePublish && yarn install && yarn build",
     "start": "cross-env NODE_ENV=production PORT=3000 yarn start:server",
     "startall": "node scripts/update.js && yarn start",
     "start:dev": "concurrently  \"npm:start:client\" \"npm:start:server:dev\"",

diff --git a/Composer/packages/extensions/plugin-loader/src/composerPluginRegistration.ts b/Composer/packages/extensions/plugin-loader/src/composerPluginRegistration.ts
@@ -7,7 +7,7 @@ import { JSONSchema7 } from 'json-schema';
 
 import { PluginLoader } from './pluginLoader';
 import log from './logger';
-import { PublishPlugin, RuntimeTemplate } from './types';
+import { PublishPlugin, RuntimeTemplate, BotTemplate } from './types';
 
 export class ComposerPluginRegistration {
   public loader: PluginLoader;
@@ -89,6 +89,20 @@ export class ComposerPluginRegistration {
     this.loader.extensions.runtimeTemplates.push(plugin);
   }
 
+  /**************************************************************************************
+   * Add Bot Template (aka, SampleBot)
+   *************************************************************************************/
+  public addBotTemplate(template: BotTemplate) {
+    this.loader.extensions.botTemplates.push(template);
+  }
+
+  /**************************************************************************************
+   * Add Base Template (aka, BoilerPlate)
+   *************************************************************************************/
+  public addBaseTemplate(template: BotTemplate) {
+    this.loader.extensions.baseTemplates.push(template);
+  }
+
   /**************************************************************************************
    * Express/web related features
    *************************************************************************************/

diff --git a/Composer/packages/extensions/plugin-loader/src/pluginLoader.ts b/Composer/packages/extensions/plugin-loader/src/pluginLoader.ts
@@ -32,6 +32,8 @@ export class PluginLoader {
         allowedUrls: [this.loginUri],
       },
       runtimeTemplates: [],
+      botTemplates: [],
+      baseTemplates: [],
     };
     this._passport = passport;
   }

diff --git a/Composer/packages/extensions/plugin-loader/src/types.ts b/Composer/packages/extensions/plugin-loader/src/types.ts
@@ -23,6 +23,18 @@ export interface PublishResponse {
   result: PublishResult;
 }
 
+export interface BotTemplate {
+  id: string;
+  name: string;
+  description: string;
+  /* absolute path */
+  path: string;
+  /* tags for further grouping and search secenario */
+  tags?: string[];
+  /* list of supported runtime versions */
+  support?: string[];
+}
+
 // TODO: Add types for project, metadata
 export interface PublishPlugin<Config = any> {
   publish: (config: Config, project: any, metadata: any, user?: UserIdentity) => Promise<PublishResponse>;
@@ -73,4 +85,6 @@ export interface ExtensionCollection {
     [key: string]: any;
   };
   runtimeTemplates: RuntimeTemplate[];
+  botTemplates: BotTemplate[];
+  baseTemplates: BotTemplate[];
 }
diff --git a/Composer/packages/lib/shared/src/types/server.ts b/Composer/packages/lib/shared/src/types/server.ts
@@ -5,8 +5,10 @@ export interface ProjectTemplate {
   id: string;
   name: string;
   description: string;
-  /** Absolute path of the template */
-  path?: string;
-  /** Optional order property */
-  order?: number;
+  /* absolute path */
+  path: string;
+  /* tags for further grouping and search secenario */
+  tags?: string[];
+  /* list of supported runtime versions */
+  support?: string[];
 }
diff --git a/Composer/packages/server/__tests__/controllers/project.test.ts b/Composer/packages/server/__tests__/controllers/project.test.ts
@@ -3,11 +3,28 @@
 
 import { Request, Response } from 'express';
 import rimraf from 'rimraf';
+import { pluginLoader } from '@bfc/plugin-loader';
 
 import { BotProjectService } from '../../src/services/project';
 import { ProjectController } from '../../src/controllers/project';
 import { Path } from '../../src/utility/path';
 
+jest.mock('@bfc/plugin-loader', () => {
+  return {
+    pluginLoader: {
+      extensions: {
+        botTemplates: [],
+        baseTemplates: [],
+      },
+    },
+    PluginLoader: {
+      getUserFromRequest: jest.fn(),
+    },
+  };
+});
+
+const mockSampleBotPath = Path.join(__dirname, '../mocks/asset/projects/SampleBot');
+
 let mockRes: Response;
 
 const newBot = Path.resolve(__dirname, '../mocks/samplebots/newBot');
@@ -34,6 +51,12 @@ beforeEach(() => {
 });
 
 beforeAll(async () => {
+  pluginLoader.extensions.botTemplates.push({
+    id: 'SampleBot',
+    name: 'Sample Bot',
+    description: 'Sample Bot',
+    path: mockSampleBotPath,
+  });
   const currentProjectId = await BotProjectService.openProject(location1);
   const currentProject = await BotProjectService.getProjectById(currentProjectId);
   await BotProjectService.saveProjectAs(currentProject, location2);
@@ -134,7 +157,7 @@ describe('create a Empty Bot project', () => {
     const mockReq = {
       params: {},
       query: {},
-      body: { storageId: 'default', location: newBotDir, description: '', name: name, templateId: '' },
+      body: { storageId: 'default', location: newBotDir, description: '', name: name, templateId: 'SampleBot' },
     } as Request;
     await ProjectController.createProject(mockReq, mockRes);
     expect(mockRes.status).toHaveBeenCalledWith(200);

diff --git a/Composer/packages/server/__tests__/models/asset/assetManager.test.ts b/Composer/packages/server/__tests__/models/asset/assetManager.test.ts
@@ -2,33 +2,53 @@
 // Licensed under the MIT License.
 
 import rimraf from 'rimraf';
+import { pluginLoader } from '@bfc/plugin-loader';
 
 import { Path } from '../../../src/utility/path';
 import { AssetManager } from '../../../src/models/asset/assetManager';
 jest.mock('azure-storage', () => {
   return {};
 });
-const mockAssetLibraryPath = Path.join(__dirname, '../../mocks/asset');
-const mockRuntimeLibraryPath = Path.join(__dirname, '../../mocks/runtimes');
 
+jest.mock('@bfc/plugin-loader', () => {
+  //const p = require('path');
+  return {
+    pluginLoader: {
+      extensions: {
+        botTemplates: [],
+      },
+    },
+  };
+});
+
+const mockSampleBotPath = Path.join(__dirname, '../../mocks/asset/projects/SampleBot');
 const mockCopyToPath = Path.join(__dirname, '../../mocks/new');
 const locationRef = {
   storageId: 'default',
   path: mockCopyToPath,
 };
+
+beforeAll(() => {
+  pluginLoader.extensions.botTemplates.push({
+    id: 'SampleBot',
+    name: 'Sample Bot',
+    description: 'Sample Bot',
+    path: mockSampleBotPath,
+  });
+});
+
 describe('assetManager', () => {
   it('getProjectTemplate', async () => {
-    const assetManager = new AssetManager(mockAssetLibraryPath, mockRuntimeLibraryPath);
+    const assetManager = new AssetManager();
     const result = await assetManager.getProjectTemplates();
     expect(result.length).toBeGreaterThan(0);
     expect(result[0].name).toBe('Sample Bot');
     expect(result[0].id).toBe('SampleBot');
   });
 
   it('copyProjectTemplateTo', async () => {
-    const assetManager = new AssetManager(mockAssetLibraryPath, mockRuntimeLibraryPath);
+    const assetManager = new AssetManager();
     await assetManager.getProjectTemplates();
-    await assetManager.getProjectRuntime();
 
     await expect(assetManager.copyProjectTemplateTo('SampleBot', locationRef)).resolves.toBe(locationRef);
     // remove the saveas files