feat(plugins): Make plugin.initialize() async

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

@@ -4,6 +4,23 @@ import { HelpContentsRegistry } from '../help';
 import { Registry } from '../registry';
 
 describe('deck plugin registerPluginExtensions', () => {
+  it('returns a promise', async () => {
+    const promiseLike = registerPluginExtensions({});
+    expect(promiseLike).toBeDefined();
+    expect(promiseLike.then).toBeDefined();
+    expect(typeof promiseLike.then).toBe('function');
+  });
+
+  it('returns a promise that resolves to the return value of initialize', async () => {
+    const result = await registerPluginExtensions({ initialize: () => 'anything' });
+    expect(result).toBe('anything');
+  });
+
+  it('returns a promise that unwraps a promise returned by initialize', async () => {
+    const result = await registerPluginExtensions({ initialize: () => Promise.resolve('anything') });
+    expect(result).toBe('anything');
+  });
+
   it('should register stages', async () => {
     const registerSpy = spyOn(Registry.pipeline, 'registerStage');
     const stage = { key: 'test' };

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

@@ -14,13 +14,13 @@ export interface IDeckPlugin {
 }
 
 /** Given a plugin, registers the plugin's extensions */
-export function registerPluginExtensions(plugin: IDeckPlugin) {
+export function registerPluginExtensions(plugin: IDeckPlugin): PromiseLike<any> {
   // Register the plugin's extensions with deck.
   plugin.stages?.forEach(stage => Registry.pipeline.registerStage(stage));
   plugin.preconfiguredJobStages?.forEach(stage => Registry.pipeline.registerPreconfiguredJobStage(stage));
   toPairs(plugin.help ?? {}).forEach(([key, value]) => HelpContentsRegistry.register(key, value));
   plugin.search?.forEach(search => searchResultTypeRegistry.register(search));
 
-  // Run code that currently does not have an extension point
-  plugin.initialize?.();
+  // Run arbitrary initialization code
+  return Promise.resolve(plugin.initialize?.());
 }

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

@@ -156,9 +156,7 @@ export class PluginRegistry {
         );
       }
 
-      registerPluginExtensions(module.plugin as IDeckPlugin);
-
-      return module;
+      return registerPluginExtensions(module.plugin as IDeckPlugin).then(() => module);
     } catch (error) {
       console.error(`Failed to load plugin code from ${pluginUrl}`);
       throw error;