Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK #10433

vojtechszocs · 2021-11-10T18:13:23Z

This PR addresses all TODO items and refactors plugin SDK webpack code to comply with webpack 5 APIs.

Improvements

ConsoleAssetPlugin is now responsible for generating and/or post-processing all Console plugin assets.
ExtensionValidator is now executed via emit hook. Plugins that wish to avoid emitting assets entirely due to webpack error(s) should do so via optimization.emitOnErrors option.
ExtensionValidator can be disabled by passing CONSOLE_PLUGIN_SKIP_EXT_VALIDATOR=true env. variable to your webpack command, for example:

CONSOLE_PLUGIN_SKIP_EXT_VALIDATOR=true yarn ts-node node_modules/.bin/webpack

Plugins should not specify output.publicPath option. ConsoleRemotePlugin will always set its value to /api/plugins/<ConsolePluginName>/. A warning will be issued in case it's specified explicitly, for example:

<w> [ConsoleRemotePlugin] output.publicPath is defined, but will be overridden to /api/plugins/console-demo-plugin/

exposed module chunks have better file names, e.g. exposed-navPage-chunk.js

Shared module configuration

all shared modules are treated as singletons, i.e. allow only a single version of the shared module
- ➡️ Console is responsible for providing all shared modules to all of its plugins
plugins won't bring their own fallback version of shared modules
- ➡️ results in faster plugin builds and smaller plugin asset footprint
no version checking when initializing shared modules for the given plugin
- ➡️ using * semver range to ensure plugins always use the Console-provided shared module version

openshift-ci · 2021-11-10T18:33:06Z

@vojtechszocs: This pull request references Bugzilla bug 2020428, which is invalid:

expected the bug to target the "4.10.0" release, but it targets "---" instead

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

In response to this:

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK

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/test-infra repository.

spadgett

We might need to revisit some of the assumptions we're making about shared modules down the road, but I think this is good for now.

spadgett · 2021-11-10T18:16:30Z

frontend/packages/console-dynamic-plugin-sdk/src/__tests__/shared-modules-init.spec.ts

+    expectSameValues(Object.keys(entryModule.init.mock.calls[0][0]), sharedPluginModules);
+  });
+
+  it('supports plugins built with an older version of plugin SDK', () => {


spadgett · 2021-11-10T18:32:46Z

frontend/packages/console-dynamic-plugin-sdk/src/webpack/ConsoleRemotePlugin.ts

-        shared: sharedPluginModules,
-      }).apply(compiler);
+    const logger = compiler.getInfrastructureLogger(ConsoleRemotePlugin.name);
+    const publicPath = `/api/plugins/${this.pkg.consolePlugin.name}/`;


Console has an option for a base context root, although we don't use it for OpenShift. Would this break that?

This option means that all plugin assets will be loaded from <ConsoleOrigin>/api/plugins/<PluginName> so relative to Console application's protocol / domain / port at runtime. Not sure if that is safe enough in relation to changing base context root 😕

No, that will break context roots. We might need it for HAC as well :/

https://github.com/openshift/console/blob/master/cmd/bridge/main.go#L69

frontend/packages/console-dynamic-plugin-sdk/src/webpack/ConsoleAssetPlugin.ts

vojtechszocs · 2021-11-10T19:48:44Z

Updated PR to also fix #9198

openshift-ci · 2021-11-10T20:11:45Z

@vojtechszocs: This pull request references Bugzilla bug 2020428, which is invalid:

expected the bug to target the "4.10.0" release, but it targets "---" instead

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

In response to this:

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK

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/test-infra repository.

spadgett · 2021-11-10T20:12:28Z

/bugzilla refresh

openshift-ci · 2021-11-10T20:12:35Z

@spadgett: This pull request references Bugzilla bug 2020428, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.10.0) matches configured target release for branch (4.10.0)
bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/bugzilla 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 kubernetes/test-infra repository.

spadgett

/lgtm

openshift-ci · 2021-11-10T20:30:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: spadgett, 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:

~~OWNERS~~ [spadgett]

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

openshift-bot · 2021-11-10T21:19:06Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2021-11-11T16:45:53Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-ci · 2021-11-12T01:39:45Z

@vojtechszocs: All pull requests linked via external trackers have merged:

openshift/console#10433

Bugzilla bug 2020428 has been moved to the MODIFIED state.

In response to this:

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK

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/test-infra repository.

openshift-ci bot requested review from christianvogt and spadgett November 10, 2021 18:14

openshift-ci bot added the component/sdk Related to console-plugin-sdk label Nov 10, 2021

Adapt webpack 5 related code in dynamic plugin SDK

f5eb2da

vojtechszocs force-pushed the plugin-sdk-wp5 branch from f8132b6 to f5eb2da Compare November 10, 2021 18:29

vojtechszocs changed the title ~~Adapt webpack 5 related code in dynamic plugin SDK~~ Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK Nov 10, 2021

openshift-ci bot added bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Nov 10, 2021

spadgett reviewed Nov 10, 2021

View reviewed changes

Fix issue openshift#9198

5e01196

vojtechszocs mentioned this pull request Nov 10, 2021

[dynamic-plugin-sdk] Plugin fails to load if "eval-source-map" webpack devtool is used #9198

Closed

openshift-ci bot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Nov 10, 2021

openshift-ci bot removed the bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. label Nov 10, 2021

openshift-ci bot requested a review from yapei November 10, 2021 20:12

spadgett approved these changes Nov 10, 2021

View reviewed changes

openshift-ci bot assigned spadgett Nov 10, 2021

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 10, 2021

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 10, 2021

openshift-merge-robot merged commit 9ab6ddd into openshift:master Nov 12, 2021

spadgett added this to the v4.10 milestone Dec 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK #10433

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK #10433

vojtechszocs commented Nov 10, 2021 •

edited by spadgett

openshift-ci bot commented Nov 10, 2021

spadgett left a comment

spadgett Nov 10, 2021

spadgett Nov 10, 2021

vojtechszocs Nov 10, 2021

spadgett Nov 10, 2021

spadgett Nov 10, 2021

vojtechszocs commented Nov 10, 2021

openshift-ci bot commented Nov 10, 2021

spadgett commented Nov 10, 2021

openshift-ci bot commented Nov 10, 2021

spadgett left a comment

openshift-ci bot commented Nov 10, 2021

openshift-bot commented Nov 10, 2021

openshift-bot commented Nov 11, 2021

openshift-ci bot commented Nov 12, 2021

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK #10433

Bug 2020428: Adapt webpack 5 related code in dynamic plugin SDK #10433

Conversation

vojtechszocs commented Nov 10, 2021 • edited by spadgett

Improvements

Shared module configuration

openshift-ci bot commented Nov 10, 2021

spadgett left a comment

Choose a reason for hiding this comment

spadgett Nov 10, 2021

Choose a reason for hiding this comment

spadgett Nov 10, 2021

Choose a reason for hiding this comment

vojtechszocs Nov 10, 2021

Choose a reason for hiding this comment

spadgett Nov 10, 2021

Choose a reason for hiding this comment

spadgett Nov 10, 2021

Choose a reason for hiding this comment

vojtechszocs commented Nov 10, 2021

openshift-ci bot commented Nov 10, 2021

spadgett commented Nov 10, 2021

openshift-ci bot commented Nov 10, 2021

spadgett left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Nov 10, 2021

openshift-bot commented Nov 10, 2021

openshift-bot commented Nov 11, 2021

openshift-ci bot commented Nov 12, 2021

vojtechszocs commented Nov 10, 2021 •

edited by spadgett