feat(external-fallbacks): enable modules to have external fallbacks #984

JAdshead · 2023-04-25T15:57:14Z

This PR requires release and update of Holocron with the changes outlined in americanexpress/holocron#143

Description

Enable modules which require externals to use a fallback when the root module does not provide one.
Record each modules required externals when the module is required by one-app.
When rendering html to the client include all the fallback script tags required for the modules used in the initial render.
pass the registry of required externals down to the client then hydrate when client initializes

Motivation and Context

This will allow more flexibility to holocron modules when a required external is missing. It also provides an additional upgrade path for major versions of external dependencies.

How Has This Been Tested?

Types of Changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation (adding or updating documentation)
Dependency update
Security update

Checklist:

My change requires a change to the documentation and I have updated the documentation accordingly.
These changes should be applied to a maintenance branch.
This change requires cross browser checks.
Performance tests should be ran against the server prior to merging.
This change impacts caching for client browsers.
This change impacts HTTP headers.
This change adds additional environment variable requirements for One App users.
I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using One App?

github-actions · 2023-04-25T16:00:40Z

Size Change: +21.7 kB (+3%)

Total Size: 710 kB

Filename	Size	Change
`./build/app/app.js`	164 kB	+31 B (0%)
`./build/app/app~vendors.js`	411 kB	+21.7 kB (+6%)	🔍

ℹ️ View Unchanged

Filename	Size
`./build/app/runtime.js`	7.07 kB
`./build/app/service-worker-client.js`	7.25 kB
`./build/app/vendors.js`	121 kB

_{compressed-size-action}

.gitignore

src/client/initClient.jsx

src/server/plugins/reactHtml/index.jsx

src/server/utils/onModuleLoad.js

package.json

__tests__/server/utils/getModulesToUpdate.spec.js

package.json

code-forger · 2023-09-01T09:52:50Z

src/client/initClient.jsx

@@ -29,6 +29,8 @@ export default async function initClient() {
  try {
    // eslint-disable-next-line no-underscore-dangle
    setModuleMap(global.__CLIENT_HOLOCRON_MODULE_MAP__);
+    // eslint-disable-next-line no-underscore-dangle
+    setRequiredExternalsRegistry(global.__HOLOCRON_EXTERNALS__);


NIT: for consistency with __CLIENT_HOLOCRON_MODULE_MAP__, why not __CLIENT_HOLOCRON_EXTERNALS__?

__CLIENT_HOLOCRON_MODULE_MAP__ is the only key with the CLIENT prefix, this is probably as the module map being set is specifically for the client and differs from the module map loaded on the server.

code-forger · 2023-09-01T09:57:50Z

src/server/utils/onModuleLoad.js

-
-export const setModulesUsingExternals = (moduleNames) => {
-  modulesUsingExternals = new ImmutableSet(moduleNames);
-};


Removing parts of the old system? is this still backwards compatible and this functionality is now achieved in a different way?

for the most part this has been reimplemented in holocron - https://github.com/americanexpress/holocron/pull/143/files#diff-c59d732ae8137c4f28a025d9cabd09b4fd3166326f1822eb6b9a94089d89d777R68-R77

it does appear that the call to clearModulesUsingExternals has been removed when it should not have.

code-forger

Approved with 1 NIT and 1 question

src/server/plugins/reactHtml/index.jsx

github-actions bot added Feature one-app-team-review-requested labels Apr 25, 2023

JAdshead mentioned this pull request May 15, 2023

DRAFT feat(externals): sharedExternals WIP #906

Closed

14 tasks

Matthew-Mallimo suggested changes Jun 21, 2023

View reviewed changes

JAdshead force-pushed the feat/module-external-fallback branch 3 times, most recently from 595c686 to 46f41c3 Compare August 3, 2023 17:35

JAdshead requested a review from Matthew-Mallimo August 3, 2023 18:02

Matthew-Mallimo reviewed Aug 9, 2023

View reviewed changes

__tests__/server/utils/getModulesToUpdate.spec.js Outdated Show resolved Hide resolved

Matthew-Mallimo suggested changes Aug 9, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

JAdshead force-pushed the feat/module-external-fallback branch from b9c2af3 to f5d90ab Compare August 9, 2023 18:31

Matthew-Mallimo added the Critical label Aug 15, 2023

Matthew-Mallimo previously approved these changes Aug 15, 2023

View reviewed changes

JAdshead dismissed Matthew-Mallimo’s stale review via 98e897b August 18, 2023 17:28

JAdshead marked this pull request as ready for review August 18, 2023 17:36

JAdshead requested review from a team as code owners August 18, 2023 17:36

Matthew-Mallimo previously approved these changes Aug 18, 2023

View reviewed changes

JAdshead requested a review from a team August 24, 2023 17:22

JAdshead dismissed Matthew-Mallimo’s stale review via b8e9254 August 24, 2023 21:31

Matthew-Mallimo previously approved these changes Aug 28, 2023

View reviewed changes

JAdshead requested a review from a team August 29, 2023 19:30

code-forger reviewed Sep 1, 2023

View reviewed changes

code-forger previously approved these changes Sep 1, 2023

View reviewed changes

JAdshead dismissed stale reviews from code-forger and Matthew-Mallimo via ce02f90 September 4, 2023 18:16

Matthew-Mallimo previously approved these changes Sep 5, 2023

View reviewed changes

feat(external-fallbacks): enable modules to have external fallbacks

266fca7

JAdshead and others added 20 commits September 8, 2023 11:51

test(initClient): ensure hydrates required external registry

ebc44c0

feat(server-responsed-html): remove duplicate external scripts

cb948c5

chore(onModuleLoad): update external api

ea2c47f

feat(externals): root module enable missing fallbacks

81a8059

chore: working on node server module load

b0d1c2a

chore: moved externals registry to holocron

89d0e05

fix(onModuleLoad): only load fallback externals for failed validation

8f65db2

chore(holocron): include tgz for testing

0b2132e

fix: unit testing

a97e137

chore: support for legacy externals

460bbe2

chore(holcron): use new build

ed7c6fe

fix(onModuleLoad): call validateSafeRequestRestrictedAttributes

a531322

chore(holocron): update tgz

7aceb09

chore(rebase): fix conflicts

047db0d

chore(holocron): updated tgz

6dcafb2

chore(holocron): use latest tgz

1a3a4f2

test(getModulesToUpdate): fix mock

d17eaa3

chore(holocron): use released version

f516629

fix(holocron): update with patch

cffc858

fix(onModuleLoad): clearModulesUsingExternals when root loaded

86eb04c

JAdshead dismissed Matthew-Mallimo’s stale review via 86eb04c September 8, 2023 19:00

JAdshead force-pushed the feat/module-external-fallback branch from 00b529e to 86eb04c Compare September 8, 2023 19:00

Merge branch 'main' into feat/module-external-fallback

575f1a8

dogpatch626 reviewed Sep 11, 2023

View reviewed changes

src/server/plugins/reactHtml/index.jsx Show resolved Hide resolved

dogpatch626 approved these changes Sep 11, 2023

View reviewed changes

Merge branch 'main' into feat/module-external-fallback

15df8f2

Matthew-Mallimo approved these changes Sep 12, 2023

View reviewed changes

JAdshead merged commit 7d51efe into main Sep 12, 2023
9 checks passed

JAdshead deleted the feat/module-external-fallback branch September 12, 2023 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(external-fallbacks): enable modules to have external fallbacks #984

feat(external-fallbacks): enable modules to have external fallbacks #984

JAdshead commented Apr 25, 2023 •

edited

Loading

github-actions bot commented Apr 25, 2023 •

edited

Loading

code-forger Sep 1, 2023

JAdshead Sep 4, 2023

code-forger Sep 1, 2023

JAdshead Sep 4, 2023

code-forger left a comment

feat(external-fallbacks): enable modules to have external fallbacks #984

feat(external-fallbacks): enable modules to have external fallbacks #984

Conversation

JAdshead commented Apr 25, 2023 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of Changes

Checklist:

What is the Impact to Developers Using One App?

github-actions bot commented Apr 25, 2023 • edited Loading

code-forger Sep 1, 2023

Choose a reason for hiding this comment

JAdshead Sep 4, 2023

Choose a reason for hiding this comment

code-forger Sep 1, 2023

Choose a reason for hiding this comment

JAdshead Sep 4, 2023

Choose a reason for hiding this comment

code-forger left a comment

Choose a reason for hiding this comment

JAdshead commented Apr 25, 2023 •

edited

Loading

github-actions bot commented Apr 25, 2023 •

edited

Loading