OCPBUGS-3495: Add cacheBuster query string when requesting plugin entry scripts

[vojtechszocs]

This PR adds ?cacheBuster=${getRandomChars()} query string when requesting plugin-entry.js resources.

This is a backport of OpenShift dynamic plugin SDK PluginLoader script URL resolution code:

resolveURL(manifest.baseURL, scriptName, (url) => {
  url.searchParams.set('cacheBuster', uuidv4());
  return url;
})

Implementation notes:

• using the existing Console getRandomChars helper function (long term, we will adopt PluginLoader in Console)
• setting the query string via url.search instead of url.searchParams due to jsdom missing polyfill for the latter

How to verify:

1. build Console frontend

cd /path/to/console/frontend
yarn
yarn build-dev

2. build Console demo plugin and host it on a local server

cd /path/to/console/dynamic-demo-plugin
rm -rf node_modules ; yarn
yarn build-dev
yarn http-server

3. start Bridge server

oc login ...
oc-run-bridge -plugins console-demo-plugin=http://localhost:9001

4. open Console in browser and switch to developer tools / network tab

• any requests for plugin-entry.js should include ?cacheBuster=<random-chars>

[openshift-ci-robot]

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

• expected the bug to target the "4.14.0" version, but it targets "4.13" instead

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:

This PR adds ?cacheBuster=${getRandomChars()} query string when requesting plugin-entry.js resources.

This is a backport of OpenShift dynamic plugin SDK PluginLoader script URL resolution code:

resolveURL(manifest.baseURL, scriptName, (url) => {
 url.searchParams.set('cacheBuster', uuidv4());
 return url;
})

Implementation notes:

• using the existing Console getRandomChars helper function (long term, we will adopt PluginLoader in Console)
• setting the query string via url.search instead of url.searchParams due to jsdom missing polyfill for the latter

How to verify:

1. build Console frontend

cd /path/to/console/frontend
yarn
yarn build-dev

2. build Console demo plugin and host it on a local server

cd /path/to/console/dynamic-demo-plugin
rm -rf node_modules ; yarn
yarn build-dev
yarn http-server

3. start Bridge server

oc login ...
oc-run-bridge -plugins console-demo-plugin=http://localhost:9001

4. open Console in browser and switch to developer tools / network tab

• any requests for plugin-entry.js should include ?cacheBuster=<random-chars>

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.

[vojtechszocs]

Requesting approvals:

QE Approver:

/assign @yanpzhan
Docs Approver:

/assign @opayne1
PX Approver:
/assign @RickJWagner

This fixes a bug where the browser would use stale plugin scripts.

[vojtechszocs]

/jira refresh

[openshift-ci-robot]

@vojtechszocs: This pull request references Jira Issue OCPBUGS-3495, 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.14.0) matches configured target version for branch (4.14.0)
• bug is in the state ASSIGNED, 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 kubernetes/test-infra repository.

[opayne1]

/label docs-approved

[vojtechszocs]

/retest

[openshift-ci-robot]

@vojtechszocs: This pull request references Jira Issue OCPBUGS-3495, which is valid.

3 validation(s) were run on this bug

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

Requesting review from QA contact:
/cc @yapei

In response to this:

This PR adds ?cacheBuster=${getRandomChars()} query string when requesting plugin-entry.js resources.

This is a backport of OpenShift dynamic plugin SDK PluginLoader script URL resolution code:

resolveURL(manifest.baseURL, scriptName, (url) => {
 url.searchParams.set('cacheBuster', uuidv4());
 return url;
})

Implementation notes:

• using the existing Console getRandomChars helper function (long term, we will adopt PluginLoader in Console)
• setting the query string via url.search instead of url.searchParams due to jsdom missing polyfill for the latter

How to verify:

1. build Console frontend

cd /path/to/console/frontend
yarn
yarn build-dev

2. build Console demo plugin and host it on a local server

cd /path/to/console/dynamic-demo-plugin
rm -rf node_modules ; yarn
yarn build-dev
yarn http-server

3. start Bridge server

oc login ...
oc-run-bridge -plugins console-demo-plugin=http://localhost:9001

4. open Console in browser and switch to developer tools / network tab

• any requests for plugin-entry.js should include ?cacheBuster=<random-chars>

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.

[RickJWagner]

/label px-approved

[jhadvig]

/retest

[jhadvig]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, 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 [jhadvig,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/test-infra repository. I understand the commands that are listed here.

[openshift-ci-robot]

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

• openshift/console#13035

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

In response to this:

This PR adds ?cacheBuster=${getRandomChars()} query string when requesting plugin-entry.js resources.

This is a backport of OpenShift dynamic plugin SDK PluginLoader script URL resolution code:

resolveURL(manifest.baseURL, scriptName, (url) => {
 url.searchParams.set('cacheBuster', uuidv4());
 return url;
})

Implementation notes:

• using the existing Console getRandomChars helper function (long term, we will adopt PluginLoader in Console)
• setting the query string via url.search instead of url.searchParams due to jsdom missing polyfill for the latter

How to verify:

1. build Console frontend

cd /path/to/console/frontend
yarn
yarn build-dev

2. build Console demo plugin and host it on a local server

cd /path/to/console/dynamic-demo-plugin
rm -rf node_modules ; yarn
yarn build-dev
yarn http-server

3. start Bridge server

oc login ...
oc-run-bridge -plugins console-demo-plugin=http://localhost:9001

4. open Console in browser and switch to developer tools / network tab

• any requests for plugin-entry.js should include ?cacheBuster=<random-chars>

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.