CONSOLE-3769: Address review comments

Author: logonoff

frontend/packages/console-dynamic-plugin-sdk/CHANGELOG-core.md

@@ -12,15 +12,12 @@ table in [Console dynamic plugins README](./README.md).
 
 ## 4.21.0-prerelease.x - TBD
 
-- **Deprecated** `setPluginStore` function in `k8s-utils.ts`. The function is now a noop and the export
+- **Deprecated**: `setPluginStore` function in `k8s-utils.ts`. The function is now a noop and the export
   will be removed in a future release. ([CONSOLE-4840], [#15671])
-- **Type-only breaking change**: Fix `popupComponent` prop type in extension `console.dashboards/overview/health/resource` ([CONSOLE-4796], [#15526])
-- Increased alignment with `@openshift/dynamic-plugin-sdk` types ([CONSOLE-3769], [#15509], [#15738])
-  - `AlwaysOnExtension` and `ModelDefinition` types are removed from `api/common-types` because they referred
-    to a legacy system which console dynamic plugins never supported. There is no direct replacement for these
-    types, and plugins should remove all uses of them. ([#15671])
-  - The following types are now re-exported from `@openshift/dynamic-plugin-sdk` instead of being defined
-    locally: `ExtensionFlags`, `ExtensionTypeGuard`, `ResolvedCodeRefProperties`, `RemoteEntryModule`, and `Update`. ([#15509], [#15738])
+- **Type breaking**: Fix `popupComponent` prop type in extension `console.dashboards/overview/health/resource` ([CONSOLE-4796], [#15526])
+- **Type breaking**: `AlwaysOnExtension` and `ModelDefinition` types are removed from `api/common-types`. ([CONSOLE-3769], [#15509])
+- The following types are now re-exported from `@openshift/dynamic-plugin-sdk` instead of being defined
+  locally: `ExtensionFlags`, `ExtensionTypeGuard`, `ResolvedCodeRefProperties`, `RemoteEntryModule`, and `Update`. ([CONSOLE-4840], [#15509], [#15671])
 - Add optional `fetch` property to extension `console.dashboards/overview/health/url` ([CONSOLE-4796], [#15526])
 - Add optional `infrastructure` parameter to `PrometheusHealthHandler` type ([CONSOLE-4796], [#15526])
 - Allow `K8sResourceKind` in `TopologyDataObject`, `TopologyResourcesObject`, and `OverviewItem` types ([CONSOLE-4840], [#15699])
@@ -221,4 +218,3 @@ table in [Console dynamic plugins README](./README.md).
 [#15671]: https://github.com/openshift/console/pull/15671
 [#15699]: https://github.com/openshift/console/pull/15699
 [#15735]: https://github.com/openshift/console/pull/15735
-[#15738]: https://github.com/openshift/console/pull/15738

frontend/packages/console-dynamic-plugin-sdk/README.md

@@ -89,8 +89,6 @@ For older 1.x plugin SDK packages, refer to the following version compatibility
 
 | Console Version | SDK Package                                     | Last Package Version |
 | --------------- | ----------------------------------------------- | -------------------- |
-| 4.18.x          | `@openshift-console/dynamic-plugin-sdk`         | 1.8.0                |
-|                 | `@openshift-console/dynamic-plugin-sdk-webpack` | 1.3.0                |
 | 4.17.x          | `@openshift-console/dynamic-plugin-sdk`         | 1.6.0                |
 |                 | `@openshift-console/dynamic-plugin-sdk-webpack` | 1.2.0                |
 | 4.16.x          | `@openshift-console/dynamic-plugin-sdk`         | 1.4.0                |
@@ -115,15 +113,15 @@ Console.
 
 | Console Version | PatternFly Versions | Notes                                 |
 | --------------- | ------------------- | ------------------------------------- |
-| 4.19.x          | 6.x + 5.x           | New dynamic plugins should use PF 6.x |
+| 4.19.x - 4.21.x | 6.x + 5.x           | New dynamic plugins should use PF 6.x |
 | 4.15.x - 4.18.x | 5.x + 4.x           | New dynamic plugins should use PF 5.x |
 | 4.12.x - 4.14.x | 4.x                 |                                       |
 
 Refer to [PatternFly Upgrade Notes][console-pf-upgrade-notes] containing links to PatternFly documentation.
 
 ## Shared modules
 
-Console is [configured](./src/shared-modules.ts) to share specific modules with its dynamic plugins.
+Console is [configured](./src/shared-modules/shared-modules-meta.ts) to share specific modules with its dynamic plugins.
 
 The following shared modules are provided by Console, without plugins providing their own fallback:
 
@@ -211,6 +209,7 @@ This section documents notable changes in Console provided shared modules and ot
 > [!WARNING]
 > Usage of non-PatternFly CSS provided by Console in plugins is not supported. This section only serves
 > as a courtesy for plugins which use these unsupported CSS classes.
+
 - Removed support for the Bootstrap Grid system (`.row`, `.col-*`, etc.). Use
   [PatternFly Grid](https://www.patternfly.org/layouts/grid) instead.
 - Removed `co-external-link` styling. Use PatternFly Buttons with `variant="link"` instead.

frontend/packages/console-dynamic-plugin-sdk/src/api/useResolvedExtensions.ts

@@ -2,10 +2,10 @@ import { useState, useEffect } from 'react';
 import { useExtensions } from '@console/plugin-sdk/src/api/useExtensions';
 import { resolveExtension } from '../coderefs/coderef-resolver';
 import { UseResolvedExtensions } from '../extensions/console-types';
-import { Extension, ExtensionTypeGuard, ResolvedExtension } from '../types';
+import type { ExtensionDeclaration, ExtensionTypeGuard, ResolvedExtension } from '../types';
 import { settleAllPromises } from '../utils/promise';
 
-export const useResolvedExtensions: UseResolvedExtensions = <E extends Extension>(
+export const useResolvedExtensions: UseResolvedExtensions = <E extends ExtensionDeclaration>(
   ...typeGuards: ExtensionTypeGuard<E>[]
 ): [ResolvedExtension<E>[], boolean, any[]] => {
   const extensions = useExtensions<E>(...typeGuards);

frontend/packages/console-dynamic-plugin-sdk/src/coderefs/__tests__/coderef-resolver.spec.ts

@@ -206,9 +206,12 @@ describe('loadReferencedObject', () => {
   });
 });
 
+type FooExtension = ExtensionDeclaration<'Foo', { test: boolean; qux: CodeRef<string> }>;
+type BarExtension = ExtensionDeclaration<'Bar', { test: number[]; baz: { test: CodeRef<string> } }>;
+
 describe('resolveEncodedCodeRefs', () => {
   it('replaces encoded code references with CodeRef functions', async () => {
-    const extensions: ExtensionDeclaration[] = [
+    const extensions = [
       {
         type: 'Foo',
         properties: {
@@ -233,7 +236,7 @@ describe('resolveEncodedCodeRefs', () => {
       entryModule,
       '[email protected]',
       errorCallback,
-    );
+    ) as [FooExtension, BarExtension];
 
     expect(resolvedExtensions.length).toBe(extensions.length);
 

frontend/packages/console-dynamic-plugin-sdk/src/coderefs/coderef-resolver.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
 
+import { AnyObject } from '@openshift/dynamic-plugin-sdk';
 import * as _ from 'lodash';
-import {
-  Extension,
+import type {
+  ExtensionDeclaration,
   RemoteEntryModule,
   EncodedCodeRef,
   CodeRef,
@@ -94,11 +95,11 @@ export const loadReferencedObject = async <TExport = any>(
  * _Does not execute `CodeRef` functions to load the referenced objects._
  */
 export const resolveEncodedCodeRefs = (
-  extensions: Extension[],
+  extensions: ExtensionDeclaration[],
   entryModule: RemoteEntryModule,
   pluginID: string,
   errorCallback: VoidFunction,
-): Extension[] =>
+): ExtensionDeclaration[] =>
   _.cloneDeep(extensions).map((e) => {
     deepForOwn<EncodedCodeRef>(e.properties, isEncodedCodeRef, (ref, key, obj) => {
       const loader = applyCodeRefSymbol(async () =>
@@ -114,8 +115,8 @@ export const resolveEncodedCodeRefs = (
  * Returns an extension with its `CodeRef` properties replaced with referenced objects.
  */
 export const resolveExtension = async <
-  E extends Extension<P>,
-  P = ExtensionProperties<E>,
+  E extends ExtensionDeclaration<string, P>,
+  P extends AnyObject = ExtensionProperties<E>,
   R = UpdateExtensionProperties<E, ResolvedCodeRefProperties<P>, P>
 >(
   extension: E,

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

@@ -5,7 +5,7 @@ import { ButtonProps } from '@patternfly/react-core';
 import { ICell, OnSelect, SortByDirection, TableGridBreakpoint } from '@patternfly/react-table';
 import { LocationDescriptor } from 'history';
 import type * as monaco from 'monaco-editor/esm/vs/editor/editor.api';
-import {
+import type {
   ExtensionK8sGroupKindModel,
   K8sModel,
   K8sVerb,
@@ -16,7 +16,7 @@ import {
   ResolvedExtension,
   Selector,
 } from '../api/common-types';
-import { Extension, ExtensionTypeGuard } from '../types';
+import type { ExtensionDeclaration, ExtensionTypeGuard } from '../types';
 import { CustomDataSource } from './dashboard-data-source';
 
 export type OwnerReference = {
@@ -250,7 +250,7 @@ export type UseK8sWatchResources = <R extends ResourcesObject>(
   initResources: WatchK8sResources<R>,
 ) => WatchK8sResults<R>;
 
-export type UseResolvedExtensions = <E extends Extension>(
+export type UseResolvedExtensions = <E extends ExtensionDeclaration>(
   ...typeGuards: ExtensionTypeGuard<E>[]
 ) => [ResolvedExtension<E>[], boolean, any[]];
 

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

@@ -1,15 +1,17 @@
 import type {
   CodeRef as SDKCodeRef,
+  Extension as ExtensionDeclaration,
   ExtensionFlags,
-  ExtensionPredicate,
   LoadedExtension as SDKLoadedExtension,
   ReplaceProperties as Update,
   MapCodeRefsToValues,
+  AnyObject,
 } from '@openshift/dynamic-plugin-sdk';
 
 export type {
   ExtensionFlags,
   Extension as ExtensionDeclaration,
+  ExtensionPredicate as ExtensionTypeGuard,
   MapCodeRefsToValues as ResolvedCodeRefProperties,
   PluginEntryModule as RemoteEntryModule,
   ReplaceProperties as Update,
@@ -32,15 +34,12 @@ export type Extension<P extends {} = any> = {
   flags?: ExtensionFlags;
 };
 
-/**
- * TS type guard to narrow type of the given extension to `E`.
- */
-export type ExtensionTypeGuard<E extends Extension> = ExtensionPredicate<E>;
-
 /**
  * Runtime extension interface, exposing additional metadata.
  */
-export type LoadedExtension<E extends Extension = Extension> = SDKLoadedExtension<E> & {
+export type LoadedExtension<
+  E extends ExtensionDeclaration = ExtensionDeclaration
+> = SDKLoadedExtension<E> & {
   pluginID: string;
 };
 
@@ -65,15 +64,15 @@ export type ExtractCodeRefType<R> = R extends CodeRef<infer T> ? T : never;
 /**
  * Infer the properties of extension `E`.
  */
-export type ExtensionProperties<E> = E extends Extension<infer P> ? P : never;
+export type ExtensionProperties<E> = E extends ExtensionDeclaration<string, infer P> ? P : never;
 
 /**
  * Update existing properties of extension `E` with ones declared in object `U`.
  */
 export type UpdateExtensionProperties<
-  E extends Extension<P>,
+  E extends ExtensionDeclaration,
   U extends {},
-  P = ExtensionProperties<E>
+  P extends AnyObject = ExtensionProperties<E>
 > = Update<
   E,
   {
@@ -86,6 +85,7 @@ export type UpdateExtensionProperties<
  *
  * This also coerces `E` type to `LoadedExtension` interface for runtime consumption.
  */
-export type ResolvedExtension<E extends Extension<P>, P = ExtensionProperties<E>> = LoadedExtension<
-  UpdateExtensionProperties<E, MapCodeRefsToValues<P>, P>
->;
+export type ResolvedExtension<
+  E extends ExtensionDeclaration,
+  P extends AnyObject = ExtensionProperties<E>
+> = LoadedExtension<UpdateExtensionProperties<E, MapCodeRefsToValues<P>, P>>;

frontend/packages/console-dynamic-plugin-sdk/src/validation/ExtensionValidator.ts

@@ -4,7 +4,7 @@ import * as _ from 'lodash';
 import * as webpack from 'webpack';
 import { ConsolePluginBuildMetadata } from '../build-types';
 import { isEncodedCodeRef, parseEncodedCodeRefValue } from '../coderefs/coderef-resolver';
-import { Extension, EncodedCodeRef } from '../types';
+import { ExtensionDeclaration, EncodedCodeRef } from '../types';
 import { deepForOwn } from '../utils/object';
 import { BaseValidator } from './BaseValidator';
 
@@ -59,7 +59,7 @@ export const guessModuleFilePath = (
   return basePath;
 };
 
-export const collectCodeRefData = (extensions: Extension[]) =>
+export const collectCodeRefData = (extensions: ExtensionDeclaration[]) =>
   extensions.reduce((acc, e, index) => {
     const data: ExtensionCodeRefData = { index, propToCodeRefValue: {} };
 
@@ -106,7 +106,7 @@ export const findWebpackModules = (
 export class ExtensionValidator extends BaseValidator {
   validate(
     compilation: webpack.Compilation,
-    extensions: Extension[],
+    extensions: ExtensionDeclaration[],
     exposedModules: ConsolePluginBuildMetadata['exposedModules'],
     pluginBasePath?: string,
   ) {

frontend/packages/console-plugin-sdk/src/api/pluginSubscriptionService.ts

@@ -1,7 +1,7 @@
 import * as _ from 'lodash';
 import { Store } from 'redux';
 import type {
-  Extension,
+  ExtensionDeclaration,
   ExtensionTypeGuard,
   LoadedExtension,
 } from '@console/dynamic-plugin-sdk/src/types';
@@ -46,7 +46,7 @@ export const initSubscriptionService = (pluginStore: PluginStore, reduxStore: St
 
   const invokeExtensionListener = (
     sub: ExtensionSubscription,
-    currentExtensions: Extension[],
+    currentExtensions: ExtensionDeclaration[],
     currentFlags: FeatureFlags,
   ) => {
     // Narrow extensions according to type guards
@@ -72,7 +72,7 @@ export const initSubscriptionService = (pluginStore: PluginStore, reduxStore: St
     listener(pluginStore.getPluginInfo());
   };
 
-  let lastExtensions: Extension[] = null;
+  let lastExtensions: ExtensionDeclaration[] = null;
   let lastFlags: FeatureFlags = null;
 
   const invokeAllExtensionListeners = () => {
@@ -151,7 +151,7 @@ export const getPluginStore = (): PluginStore => {
  *
  * @returns Function that unsubscribes the listener.
  */
-export const subscribeToExtensions = <E extends Extension>(
+export const subscribeToExtensions = <E extends ExtensionDeclaration>(
   listener: ExtensionListener<LoadedExtension<E>>,
   ...typeGuards: ExtensionTypeGuard<E>[]
 ) => {
@@ -182,7 +182,7 @@ export const subscribeToDynamicPlugins = (listener: DynamicPluginListener) => {
 /**
  * `ExtensionListener` adapter that computes the difference between the calls.
  */
-export const extensionDiffListener = <E extends Extension>(
+export const extensionDiffListener = <E extends ExtensionDeclaration>(
   listener: (added: E[], removed: E[]) => void,
 ): ExtensionListener<E> => {
   let prevExtensions: E[] = [];
@@ -197,9 +197,9 @@ export const extensionDiffListener = <E extends Extension>(
   };
 };
 
-type ExtensionListener<E extends Extension> = (extensions: E[]) => void;
+type ExtensionListener<E extends ExtensionDeclaration> = (extensions: E[]) => void;
 
-type ExtensionSubscription<E extends Extension = Extension> = {
+type ExtensionSubscription<E extends ExtensionDeclaration = ExtensionDeclaration> = {
   listener: ExtensionListener<E>;
   typeGuards: ExtensionTypeGuard<E>[];
   listenerLastArgs?: E[];

frontend/packages/console-plugin-sdk/src/api/useExtensions.ts

@@ -1,7 +1,7 @@
 import { useRef, useCallback, useEffect } from 'react';
 import * as _ from 'lodash';
 import type {
-  Extension,
+  ExtensionDeclaration,
   ExtensionTypeGuard,
   LoadedExtension,
 } from '@console/dynamic-plugin-sdk/src/types';
@@ -41,7 +41,7 @@ import { subscribeToExtensions } from './pluginSubscriptionService';
  * @returns List of extension instances which are currently in use, narrowed by the
  * given type guard(s).
  */
-export const useExtensions = <E extends Extension>(
+export const useExtensions = <E extends ExtensionDeclaration>(
   ...typeGuards: ExtensionTypeGuard<E>[]
 ): LoadedExtension<E>[] => {
   if (typeGuards.length === 0) {