refactor(plugins): Extract registration of extensions to its own file.

- add tests.
- move the IDeckPlugin interface
- remove IPluginManifest interface

app/scripts/modules/core/src/plugins/deck.plugin.spec.ts

@@ -0,0 +1,20 @@
+import { registerPluginExtensions } from './deck.plugin';
+import { Registry } from '../registry';
+
+describe('deck plugin registerPluginExtensions', () => {
+  it('should register stages', async () => {
+    const registerSpy = spyOn(Registry.pipeline, 'registerStage');
+    const stage = { key: 'test' };
+    registerPluginExtensions({ stages: [stage] });
+    expect(registerSpy).toHaveBeenCalledTimes(1);
+    expect(registerSpy).toHaveBeenCalledWith(stage);
+  });
+
+  it('should register preconfigured job stages', async () => {
+    const registerSpy = spyOn(Registry.pipeline, 'registerPreconfiguredJobStage');
+    const stage = { key: 'test' };
+    registerPluginExtensions({ preconfiguredJobStages: [stage] });
+    expect(registerSpy).toHaveBeenCalledTimes(1);
+    expect(registerSpy).toHaveBeenCalledWith(stage);
+  });
+});

app/scripts/modules/core/src/plugins/deck.plugin.ts

@@ -0,0 +1,22 @@
+import { IStageTypeConfig } from 'core/domain';
+import { Registry } from 'core/registry';
+import { SearchResultType } from 'core/search';
+
+export interface IDeckPlugin {
+  stages?: IStageTypeConfig[];
+  preconfiguredJobStages?: IStageTypeConfig[];
+  helpContents?: { [helpKey: string]: string };
+  searchResultTypes?: SearchResultType[];
+
+  initialize?(): void;
+}
+
+/** Given a plugin, registers the plugin's extensions */
+export function registerPluginExtensions(plugin: IDeckPlugin) {
+  // Register the plugin's extensions with deck.
+  plugin.stages?.forEach(stage => Registry.pipeline.registerStage(stage));
+  plugin.preconfiguredJobStages?.forEach(stage => Registry.pipeline.registerPreconfiguredJobStage(stage));
+
+  // Run code that currently does not have an extension point
+  plugin.initialize?.();
+}

app/scripts/modules/core/src/plugins/index.ts

@@ -1,2 +1,3 @@
+export * from './deck.plugin';
 export * from './plugin.module';
 export * from './plugin.registry';

app/scripts/modules/core/src/plugins/plugin.registry.spec.ts

@@ -1,11 +1,12 @@
 import { IStageTypeConfig } from 'core/domain';
+import { IDeckPlugin } from './deck.plugin';
 import { API } from '../api';
-import { IDeckPlugin, IPluginManifest, IPluginMetaData, PluginRegistry } from './plugin.registry';
+import { IPluginMetaData, PluginRegistry } from './plugin.registry';
 import { Registry } from 'core/registry';
 import { mock } from 'angular';
 
 type TestPluginRegistry = PluginRegistry & {
-  load(pluginManifestData: IPluginManifest): Promise<any>;
+  load(pluginMetaData: IPluginMetaData): Promise<any>;
   loadModuleFromUrl(url: string): Promise<any>;
 };
 

app/scripts/modules/core/src/plugins/plugin.registry.ts

@@ -1,18 +1,8 @@
-import { API } from 'core/api';
-import { Registry } from 'core/registry';
-import { IStageTypeConfig } from 'core/domain';
 import { $http } from 'ngimport';
+import { API } from 'core/api';
+import { registerPluginExtensions, IDeckPlugin } from './deck.plugin';
 
-export interface IDeckPlugin {
-  stages?: IStageTypeConfig[];
-  preconfiguredJobStages?: IStageTypeConfig[];
-  initialize?(): void;
-}
-
-export interface IPluginManifest {
-  plugins: IPluginMetaData[];
-}
-
+/** The shape of plugin metadata objects in plugin-manifest.json */
 export interface IPluginMetaData {
   id?: string;
   /** @deprecated use `id` instead */
@@ -126,8 +116,8 @@ export class PluginRegistry {
   /**
    * Loads plugin manifests from Gate and from `/plugin-manifest.json` in the deck resources
    *
-   * plugin-manifest.json should contain an array of IPluginManifest(s) exported as `plugin`, i.e.,
-   * export const plugins = [{ 'name': 'myPlugin', 'version': '1.2.3', 'devUrl': '/plugins/index.js' }]
+   * plugin-manifest.json should contain an array of IPluginMetaData objects, i.e.,
+   * [{ 'name': 'myPlugin', 'version': '1.2.3', 'url': '/plugins/index.js' }]
    */
   public async loadPluginManifest(
     source: ISource,
@@ -166,14 +156,7 @@ export class PluginRegistry {
         );
       }
 
-      const plugin: IDeckPlugin = module.plugin;
-
-      // Register extensions with deck.
-      plugin.stages?.forEach(stage => Registry.pipeline.registerStage(stage));
-      plugin.preconfiguredJobStages?.forEach(stage => Registry.pipeline.registerPreconfiguredJobStage(stage));
-
-      // Run code that currently does not have an extension point
-      plugin.initialize?.();
+      registerPluginExtensions(module.plugin as IDeckPlugin);
 
       return module;
     } catch (error) {