OCPBUGS-35928: Improve control over PatternFly shared modules used in Console plugins

[vojtechszocs]

1. Customize node_modules directories to search when parsing dynamic modules

New ConsoleRemotePlugin option sharedDynamicModuleSettings.modulePaths can be used to customize node_modules directories to search when parsing dynamic modules. If not specified, the list will contain a single entry (as per existing logic):

path.resolve(process.cwd(), 'node_modules')

Taking ODF Console Plugin as an example, their webpack config changes the current work directory to accomodate for different plugin builds:

const processPath = path.resolve(__dirname, `plugins/${PLUGIN}`);
process.chdir(processPath);

However, this breaks the default assumption of vendor packages installed at {process.cwd}/node_modules and ultimately results in tons of dynamic module related warnings like:

<w> No dynamic module found for Button in @patternfly/react-core

To address this issue, plugins can now use the above mentioned option like so:

new ConsoleRemotePlugin({
  sharedDynamicModuleSettings: { modulePaths: [path.resolve(__dirname, 'node_modules')] }
})

2. Discard Console provided PatternFly 4.x shared module metadata when using PF 5+

Older plugins using PatternFly 4.x rely on Console providing the following shared modules at runtime:

• @patternfly/react-core
• @patternfly/react-table
• @patternfly/quickstarts

Newer plugins using PatternFly 5.x do NOT utilize above shared modules. Instead, they share individual PatternFly code bits (components, icons, functions, etc.) via dynamic modules (introduced in #13521).

To improve build performance and allow for smaller production builds, we now discard the Console provided PatternFly 4.x shared module metadata when we detect that the plugin uses PF 5+ (detection is based on @patternfly/react-core dependency).

[TheRealJon]

Just one minor nit. Take it or leave it :)

[TheRealJon]

What if we used an immutable accumulator like this:

Suggested change

	if (basePath) {
	acc[pkgName] = getDynamicModuleMap(basePath, indexModule, resolutionField);
	}
	return acc;
	return !basePath ? acc : {
	...acc,
	[pkgName]: getDynamicModuleMap(basePath, indexModule, resolutionField)
	};

[vojtechszocs]

@TheRealJon Good idea, I'd personally prefer non-negated variation like

return basePath
  ? { ...acc, [pkgName]: getDynamicModuleMap(basePath, indexModule, resolutionField) }
  : acc;

[openshift-ci-robot]

@vojtechszocs: This pull request references Jira Issue OCPBUGS-35928, which is invalid:

• expected the bug to target the "4.17.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

1. Customize node_modules directories to search when parsing dynamic modules

New ConsoleRemotePlugin option sharedDynamicModuleSettings.modulePaths can be used to customize node_modules directories to search when parsing dynamic modules. If not specified, the list will contain a single entry (as per existing logic):

path.resolve(process.cwd(), 'node_modules')

Taking ODF Console Plugin as an example, their webpack config changes the current work directory to accomodate for different plugin builds:

const processPath = path.resolve(__dirname, `plugins/${PLUGIN}`);
process.chdir(processPath);

However, this breaks the default assumption of vendor packages installed at {process.cwd}/node_modules and ultimately results in tons of dynamic module related warnings like:

<w> No dynamic module found for Button in @patternfly/react-core

To address this issue, plugins can now use the above mentioned option like so:

new ConsoleRemotePlugin({
 sharedDynamicModuleSettings: { modulePaths: [path.resolve(__dirname, 'node_modules')] }
})

2. Discard Console provided PatternFly 4.x shared module metadata when using PF 5+

Older plugins using PatternFly 4.x rely on Console providing the following shared modules at runtime:

• @patternfly/react-core
• @patternfly/react-table
• @patternfly/quickstarts

Newer plugins using PatternFly 5.x do NOT utilize above shared modules. Instead, they share individual PatternFly code bits (components, icons, functions, etc.) via dynamic modules (introduced in #13521).

To improve build performance and allow for smaller production builds, we now discard the Console provided PatternFly 4.x shared module metadata when we detect that the plugin uses PF 5+ (detection is based on @patternfly/react-core dependency).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[vojtechszocs]

/jira refresh

[openshift-ci-robot]

@vojtechszocs: This pull request references Jira Issue OCPBUGS-35928, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.17.0) matches configured target version for branch (4.17.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[vojtechszocs]

/retest

[TheRealJon]

/lgtm

[vojtechszocs]

/test e2e-gcp-console

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: TheRealJon, vojtechszocs

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• frontend/packages/console-dynamic-plugin-sdk/OWNERS [TheRealJon,vojtechszocs]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci]

@vojtechszocs: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@vojtechszocs: Jira Issue OCPBUGS-35928: All pull requests linked via external trackers have merged:

• openshift/console#13992

Jira Issue OCPBUGS-35928 has been moved to the MODIFIED state.

In response to this:

1. Customize node_modules directories to search when parsing dynamic modules

New ConsoleRemotePlugin option sharedDynamicModuleSettings.modulePaths can be used to customize node_modules directories to search when parsing dynamic modules. If not specified, the list will contain a single entry (as per existing logic):

path.resolve(process.cwd(), 'node_modules')

Taking ODF Console Plugin as an example, their webpack config changes the current work directory to accomodate for different plugin builds:

const processPath = path.resolve(__dirname, `plugins/${PLUGIN}`);
process.chdir(processPath);

However, this breaks the default assumption of vendor packages installed at {process.cwd}/node_modules and ultimately results in tons of dynamic module related warnings like:

<w> No dynamic module found for Button in @patternfly/react-core

To address this issue, plugins can now use the above mentioned option like so:

new ConsoleRemotePlugin({
 sharedDynamicModuleSettings: { modulePaths: [path.resolve(__dirname, 'node_modules')] }
})

2. Discard Console provided PatternFly 4.x shared module metadata when using PF 5+

Older plugins using PatternFly 4.x rely on Console providing the following shared modules at runtime:

• @patternfly/react-core
• @patternfly/react-table
• @patternfly/quickstarts

Newer plugins using PatternFly 5.x do NOT utilize above shared modules. Instead, they share individual PatternFly code bits (components, icons, functions, etc.) via dynamic modules (introduced in #13521).

To improve build performance and allow for smaller production builds, we now discard the Console provided PatternFly 4.x shared module metadata when we detect that the plugin uses PF 5+ (detection is based on @patternfly/react-core dependency).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-bot]

[ART PR BUILD NOTIFIER]

This PR has been included in build openshift-enterprise-console-container-v4.17.0-202406260443.p0.g0a468b4.assembly.stream.el9 for distgit openshift-enterprise-console.
All builds following this will include this PR.