CONSOLE-4840: Remove all plugin entry points

as well as the concept of "static extensions"

Co-Authored-By: Vojtech Szocs <[email protected]>

Author: logonoff

frontend/packages/console-app/package.json

@@ -27,7 +27,6 @@
     "@console/webterminal-plugin": "0.0.0-fixed"
   },
   "consolePlugin": {
-    "entry": "src/plugin.ts",
     "exposedModules": {
       "tourContext": "src/components/tour/tour-context.ts",
       "quickStartContext": "src/components/quick-starts/utils/quick-start-context.tsx",

frontend/packages/console-app/src/plugin.ts

@@ -16,15 +16,15 @@ export type {
 } from '@openshift/dynamic-plugin-sdk';
 
 /**
- * A type for **existing static extensions** in console.
+ * A legacy type for static extensions that should not be used anymore.
  *
  * Each extension instance has a `type` and the corresponding parameters
  * represented by the `properties` object.
  *
  * Each extension may specify `flags` referencing Console feature flags which
  * are required and/or disallowed in order to put this extension into effect.
  *
- * @deprecated - Use `ExtensionDeclaration` instead for dynamic extensions.
+ * @deprecated - Use `ExtensionDeclaration` instead.
  */
 export type Extension<P extends {} = any> = {
   type: string;

frontend/packages/console-dynamic-plugin-sdk/src/types.ts

@@ -35,14 +35,14 @@ describe('getActivePluginsModule', () => {
       ...getTemplatePackage({
         name: 'foo',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const barPluginPackage: PluginPackage = {
       ...getTemplatePackage({
         name: 'bar-plugin',
       }),
-      consolePlugin: { entry: 'index.ts' },
+      consolePlugin: {},
     };
 
     const fooDynamicExtensions: Extension[] = [{ type: 'Dynamic/Foo', properties: { test: true } }];
@@ -80,18 +80,12 @@ describe('getActivePluginsModule', () => {
 
         activePlugins.push({
           name: 'foo',
-          extensions: [
-            ...require('foo/src/plugin.ts').default,
-            ...${JSON.stringify(fooDynamicExtensions)},
-          ],
+          extensions: ${JSON.stringify(fooDynamicExtensions)},
         });
 
         activePlugins.push({
           name: 'bar-plugin',
-          extensions: [
-            ...require('bar-plugin/index.ts').default,
-            ...${JSON.stringify(barDynamicExtensions)},
-          ],
+          extensions: ${JSON.stringify(barDynamicExtensions)},
         });
 
         export default activePlugins;
@@ -118,21 +112,16 @@ describe('loadActivePluginsForTestPurposes', () => {
       ...getTemplatePackage({
         name: 'foo',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const barPluginPackage: PluginPackage = {
       ...getTemplatePackage({
         name: 'bar-plugin',
       }),
-      consolePlugin: { entry: 'index.ts' },
+      consolePlugin: {},
     };
 
-    const fooStaticExtensions: Extension[] = [{ type: 'Static/Foo', properties: { test: true } }];
-    const barStaticExtensions: Extension[] = [
-      { type: 'Static/Bar', properties: { baz: 1, qux: () => true } },
-    ];
-
     const fooDynamicExtensions: Extension[] = [{ type: 'Dynamic/Foo', properties: { test: true } }];
     const barDynamicExtensions: Extension[] = [
       { type: 'Dynamic/Bar', properties: { baz: 1, qux: { $codeRef: 'a.b' } } },
@@ -151,9 +140,6 @@ describe('loadActivePluginsForTestPurposes', () => {
       }
     });
 
-    jest.doMock('foo/src/plugin.ts', () => ({ default: fooStaticExtensions }), { virtual: true });
-    jest.doMock('bar-plugin/index.ts', () => ({ default: barStaticExtensions }), { virtual: true });
-
     expect(
       loadActivePluginsForTestPurposes(
         [fooPluginPackage, barPluginPackage],
@@ -163,11 +149,11 @@ describe('loadActivePluginsForTestPurposes', () => {
     ).toEqual([
       {
         name: 'foo',
-        extensions: [...fooStaticExtensions, ...fooDynamicExtensions],
+        extensions: fooDynamicExtensions,
       },
       {
         name: 'bar-plugin',
-        extensions: [...barStaticExtensions, ...barDynamicExtensions],
+        extensions: barDynamicExtensions,
       },
     ]);
 
@@ -186,7 +172,7 @@ describe('getExecutableCodeRefSource', () => {
     exposedModules: { [moduleName: string]: string } = {},
   ): PluginPackage => ({
     ...getTemplatePackage({ name }),
-    consolePlugin: { entry: 'src/plugin.ts', exposedModules },
+    consolePlugin: { exposedModules },
   });
 
   it('transforms encoded code reference into CodeRef function source', () => {
@@ -270,7 +256,7 @@ describe('getDynamicExtensions', () => {
       ...getTemplatePackage({
         name: 'test-plugin',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const extensionsJSON: Extension[] = [
@@ -357,7 +343,7 @@ describe('getDynamicExtensions', () => {
       ...getTemplatePackage({
         name: 'test-plugin',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const extensionsFilePath = `${pluginPackage._path}/${extensionsFile}`;
@@ -383,7 +369,7 @@ describe('getDynamicExtensions', () => {
       ...getTemplatePackage({
         name: 'test-plugin',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const extensionsJSON: Extension[] = [];
@@ -419,7 +405,7 @@ describe('getDynamicExtensions', () => {
       ...getTemplatePackage({
         name: 'test-plugin',
       }),
-      consolePlugin: { entry: 'src/plugin.ts' },
+      consolePlugin: {},
     };
 
     const extensionsJSON: Extension[] = [

frontend/packages/console-plugin-sdk/src/codegen/__tests__/active-plugins.spec.ts

@@ -20,33 +20,6 @@ describe('isPluginPackage', () => {
       }),
     ).toBe(false);
   });
-
-  it('returns false if package.consolePlugin.entry is missing', () => {
-    expect(
-      isPluginPackage({
-        ...getTemplatePackage(),
-        consolePlugin: {},
-      }),
-    ).toBe(false);
-  });
-
-  it('returns false if package.consolePlugin.entry is an empty string', () => {
-    expect(
-      isPluginPackage({
-        ...getTemplatePackage(),
-        consolePlugin: { entry: '' },
-      }),
-    ).toBe(false);
-  });
-
-  it('returns true if package.consolePlugin.entry is a non-empty string', () => {
-    expect(
-      isPluginPackage({
-        ...getTemplatePackage(),
-        consolePlugin: { entry: 'plugin.ts' },
-      }),
-    ).toBe(true);
-  });
 });
 
 describe('readPackages', () => {
@@ -75,7 +48,7 @@ describe('readPackages', () => {
         name: '@console/foo-plugin',
         _path: pluginPackagePath,
       }),
-      consolePlugin: { entry: 'plugin.ts' },
+      consolePlugin: {},
     };
 
     const utilsPackagePath = '/test/packages/bar-utils';
@@ -132,14 +105,14 @@ describe('filterActivePluginPackages', () => {
           name: 'bar',
           version: '1.2.3',
         }),
-        consolePlugin: { entry: 'plugin.ts' },
+        consolePlugin: {},
       },
       {
         ...getTemplatePackage({
           name: 'qux',
           version: '2.3.4',
         }),
-        consolePlugin: { entry: 'plugin.ts' },
+        consolePlugin: {},
       },
     ];
 
@@ -152,7 +125,7 @@ describe('filterActivePluginPackages', () => {
         name: 'app',
       }),
       dependencies: {},
-      consolePlugin: { entry: 'plugin.ts' },
+      consolePlugin: {},
     };
 
     expect(filterActivePluginPackages(appPackage, [appPackage])).toEqual([appPackage]);
@@ -167,7 +140,7 @@ describe('filterActivePluginPackages', () => {
         bar: '1.2.3',
         qux: '2.3.4',
       },
-      consolePlugin: { entry: 'plugin.ts' },
+      consolePlugin: {},
     };
 
     const pluginPackages: PluginPackage[] = [
@@ -176,14 +149,14 @@ describe('filterActivePluginPackages', () => {
           name: 'bar',
           version: '1.2.3',
         }),
-        consolePlugin: { entry: 'plugin.ts' },
+        consolePlugin: {},
       },
       {
         ...getTemplatePackage({
           name: 'qux',
           version: '2.3.4',
         }),
-        consolePlugin: { entry: 'plugin.ts' },
+        consolePlugin: {},
       },
     ];
 

frontend/packages/console-plugin-sdk/src/codegen/__tests__/plugin-resolver.spec.ts

@@ -57,10 +57,7 @@ export const getActivePluginsModule = (
       ${output}
       activePlugins.push({
         name: '${pkg.name}',
-        extensions: [
-          ...require('${pkg.name}/${pkg.consolePlugin.entry}').default,
-          ...${extensionHook(pkg)},
-        ],
+        extensions: ${extensionHook(pkg)},
       });
     `;
   }
@@ -87,11 +84,7 @@ export const loadActivePluginsForTestPurposes = (
   for (const pkg of pluginPackages) {
     activePlugins.push({
       name: pkg.name,
-      extensions: [
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        ...require(`${pkg.name}/${pkg.consolePlugin.entry}`).default,
-        ...extensionHook(pkg),
-      ],
+      extensions: extensionHook(pkg),
     });
   }
 

frontend/packages/console-plugin-sdk/src/codegen/active-plugins.ts

@@ -20,12 +20,8 @@ const consolePluginOverrideEnvVar = 'CONSOLE_PLUGINS';
  * Return `true` if the given package represents a Console plugin.
  */
 export const isPluginPackage = (pkg: Package): pkg is PluginPackage => {
-  if (!(pkg as PluginPackage).consolePlugin) {
-    return false;
-  }
-
-  const { entry } = (pkg as PluginPackage).consolePlugin;
-  return typeof entry === 'string' && !!entry;
+  const { consolePlugin } = pkg as PluginPackage;
+  return !_.isNil(consolePlugin) && _.isObject(consolePlugin);
 };
 
 /**
@@ -114,7 +110,6 @@ export type Package = readPkg.NormalizedPackageJson & {
 
 export type PluginPackage = Package & {
   consolePlugin: {
-    entry: string;
     exposedModules?: { [moduleName: string]: string };
   };
 };

frontend/packages/console-plugin-sdk/src/codegen/plugin-resolver.ts

@@ -8,47 +8,6 @@ import {
 
 export type { ExtensionFlags, Extension, ExtensionTypeGuard, LoadedExtension };
 
-/**
- * From plugin author perspective, a plugin is simply a list of extensions.
- *
- * Plugin metadata is stored in the `package.json` file of the corresponding
- * monorepo package. The `consolePlugin.entry` path should point to a module
- * that exports the plugin object.
- *
- * ```json
- *  {
- *    "name": "@console/my-cool-plugin",
- *    "version": "0.0.0-fixed",
- *    // scripts, dependencies, etc.
- *    "consolePlugin": {
- *      "entry": "src/plugin.ts"
- *    }
- *  }
- * ```
- *
- * For better type checking and code completion, use a type parameter that
- * represents the union of all the extension types consumed by the plugin:
- *
- * ```ts
- *  // packages/my-cool-plugin/src/plugin.ts
- *  import { Plugin } from '@console/plugin-sdk';
- *
- *  const plugin: Plugin<FooExtension | BarExtension> = [
- *    {
- *      type: 'Foo',
- *      properties: {} // Foo extension specific properties
- *    },
- *    {
- *      type: 'Bar',
- *      properties: {} // Bar extension specific properties
- *    }
- *  ];
- *
- *  export default plugin;
- * ```
- */
-export type Plugin<E extends Extension> = E[];
-
 /**
  * Common interface for loading async React components.
  */

frontend/packages/console-plugin-sdk/src/typings/base.ts

@@ -5,7 +5,6 @@
   "private": true,
   "scripts": {},
   "consolePlugin": {
-    "entry": "src/plugin.ts",
     "displayName": "Telemetry Plugin",
     "description": "An OpenShift Console plugin for capturing events in segment.",
     "exposedModules": {