STRIPES-861 integration of module federation logic in the main branch. #173

JohnC-80 · 2025-12-05T16:56:18Z

This PR takes the logic from #105 and places it behind a conditional on an okapi.entitlementUrl field in the stripes-config object.

Further adjustment - StripesTranslationPlugin accumulates translations from included stripesDeps (stripes-acq-components, etc) so that those can be loaded at runtime when the dependent ui-module's translations are loaded.

StripesTranslationPlugin contains a conditional where it doesn't piggyback onto stripesConfigPlugin for federated module builds.

LocalFederationPlugin is used for spinning up a local set of remotes of the modules via local stripes-config. It loops through the modules and spawns a federate process. If modules is empty, this does nothing.

Conforms module federation behavior to serve --federate and build --federate commands.
Will pull shared dependencies from the locally installed copy of stripes-core, if possible, falling back to reach out to stripes-core on github if the local stripes-core can't be required.

* map the `sounds` directory for remote applications, analogous to how translations and icons are served * provide `/code` to make the registry human-readable * catch and display startup errors in case humans make stupid coding mistakes and need help finding them

Icons in stripes-components are imported as components whereas those in applications are just resources, so we need to load them differently.

github-actions · 2025-12-05T16:57:17Z

Jest Unit Test Results

0 tests ±0 0 ✅ ±0 0s ⏱️ ±0s
0 suites ±0 0 💤 ±0
0 files ±0 0 ❌ ±0

Results for commit dbbeef8. ± Comparison against base commit f0918da.

♻️ This comment has been updated with latest results.

…k into STRIPES-861-int

zburke

Most of this looks great and I am very excited to keep pushing ahead with it. That said, I have two big concerns:

I don't understand the use-case for stripes-local-federation-plugin.
I'm deeply concerned about hard-coding the versions of the peer-dep singletons.

Let's plan some time to talk about these. Maybe I don't understand the constraints very well, or maybe this is a great initial implementation and some of these gotchas can be mitigated with future work.

zburke · 2025-12-19T19:47:01Z

webpack/serve.js

+      // Start the local registry server if the entitlementUrl is not an absolute URL ex localhost:3001/registry
+      if (entitlementUrl.includes('localhost')) {
+        try {
+          registryServer.start(entitlementUrl);
+        }
+        catch (e) {
+          console.error(e)
+        }
+      }
+    }


This comment does not make sense to me, and it differs from the actual implementation. I think the impl is correct to only start the entitlement service on localhost, but that impl feels self-evident. Maybe we need a header comment at the top of the outer conditional explaining this at a high-level instead?

webpack/stripes-local-federation-plugin.js

webpack/stripes-translations-plugin.js

webpack/utils.js

consts.js

package.json

webpack.config.federate.remote.js

…ve commands

sonarqubecloud · 2026-01-14T21:02:11Z

Quality Gate failed

Failed conditions
3 Security Hotspots
0.0% Coverage on New Code (required ≥ 80%)
7.2% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

JohnC-80 · 2026-01-14T21:04:10Z

I don't understand the use-case for stripes-local-federation-plugin.

I'm deeply concerned about hard-coding the versions of the peer-dep singletons.

@zburke for posterity sake, stripes-local-federation-plugin is removed, as it _was unnecessary.
peer-dep singletons are now pulled in via installed stripes-core * or dynamically procurred via github, so the static list is no longer leaned on.

zburke

I have a lot of nitpicky comments, but that's all I really have. I'm still a bit confused about when it would be legit for stripes-core not to be available and we'd need to use the fallback, but the flipside is that it's great to see that we're trying to detect local stripes-core dependencies as the first approach to determining singletons and their versions.

Next step for me is to get this cloned locally alongside all the other WIP branches, make sure we can run local federated builds and generate monolithic and federate builds, and then I'll move this to approve!

zburke · 2026-01-15T17:40:15Z

webpack/federate.js

+  // publicPath for how remoteEntry will be accessed.
+  let url;
+  const port = options.port ?? await portfinder.getPortPromise();
+  const host = options.host ?? `http://localhost`;


Petty: quotes, not backticks. Hello lint? Wherrrrre arrrrre youuuuuuu?

zburke · 2026-01-15T17:45:45Z

webpack/federate.js

+  // publicPath for how remoteEntry will be accessed.
+  let url;
+  const port = options.port ?? await portfinder.getPortPromise();
+  const host = options.host ?? `http://localhost`;
+  if (options.publicPath) {
+    url = `${options.publicPath}/remoteEntry.js`
+  } else {
+    url = `${host}:${port}/remoteEntry.js`;
+  }


Comments would be helpful here, e.g. what is remoteEntry? Can/should we consider moving some of this below the if (options.build) conditional, or is it easier to leave it up here since config is the return value of a function that receives options and we don't want to have to massage that data again later?

zburke · 2026-01-15T19:24:11Z

webpack/federate.js

+    .catch(error => {
+      console.error(`Registry not found. Please check ${entitlementUrl}`);
+      process.exit();
+    });


Since we're using async, let's do

try { async whatever(); } catch (err) { ... }

instead of tacking on a .catch(err => { ... }) to the promise.

zburke · 2026-01-15T19:24:51Z

webpack/federate.js

    try {
-      await axios.delete(entitlementUrl, { data: metadata });
+      await fetch(entitlementUrl, {
+        method: 'DELETE',
+        headers: requestHeader,
+        body: JSON.stringify(metadata),
+      }).catch(error => {
+        throw new Error(error);
+      });
+      // await axios.delete(entitlementUrl, { data: metadata });
    } catch (error) {
      console.error(`registry not found. Please check ${entitlementUrl}`);
    }


Remove duplicate catch clause

zburke · 2026-01-15T19:29:30Z

webpack/registryServer.js

+    const app = express();
+
+    app.use(express.json());
+    app.use(cors());


Sonar gets panicky about configuring cors wide-open like this. Maybe this is a case of "Shut up Sonar, this is dev-mode and we can't know what our config will be, so wide-open is perfect." Or maybe we could restrict this to localhost. Dunno; thoughts?

Yes. Total case of sonar being over-protective.

zburke · 2026-01-15T20:02:55Z

consts.js

+    console.log('Unable to locate local stripes-core package.json, fetching from Github...');
+    try {
+      const octokit = new Octokit();
+      corePkg = await octokit.request('GET /repos/folio-org/stripes-core/contents/package.json', {
+        headers: {
+          accept: 'application/vnd.github.raw+json'
+        }
+      });
+
+      if (corePkg.status !== 200) {
+        throw new Error('Error retrieving singletons list from platform. Falling back to static list');
+      }
+    } catch (e) {
+      console.log(e);
+      return singletons;
+    }


On the one hand, it's nice that we're trying to be resilient. OTOH, is there a legit circumstance for a remote-app not to depend on the host-app, which is the only reason we could possible end up down here, right? IOW, should this be a recoverable error with a fall back or should it just be a fatal error?

Related, what branch/tag are these values being pulled from?

Removed this fallback for now. If we ever *do determine that we need it, it's an option for dynamically getting those values.

zburke · 2026-01-15T20:03:12Z

consts.js

+const defaultentitlementUrl = 'http://localhost:3001/registry';
+
+module.exports = {
+  defaultentitlementUrl,


petty: defaultEntitlementUrl?

zburke · 2026-01-15T20:09:44Z

webpack.config.federate.remote.js

+        }
+      ]
+    },
+    // TODO: remove this after stripes-config is gone.


What, specifically, will allow us to kill stripes-config? Can we point to a Jira that spells out the details if we don't want to spell them out here?

leftover from POC... will remove.

zburke · 2026-01-15T20:16:43Z

webpack.config.federate.remote.js

+  const configSingletons = await getHostAppSingletons();
+  const shared = processShared(configSingletons, { singleton: true });
+
+  const config = {


I feel like all these keys need some comments, or at least a pointer at the top to a particular section of the webpack manual. Otherwise, I wanna know what is publicPath vs path? I wanna know what happens if I don't provide it and it defaults to auto? I wanna know what you're thinking, tell me what's on your mind.

zburke · 2026-01-15T20:21:18Z

webpack.config.federate.remote.js

+        {
+          test: /\.(woff2?)$/,
+          type: 'asset/resource',
+          generator: {
+            filename: './fonts/[name].[contenthash].[ext]',
+          },
+        },
+        {
+          test: /\.(mp3|m4a)$/,
+          type: 'asset/resource',
+          generator: {
+            filename: './sound/[name].[contenthash].[ext]',
+          },
+        },


Many of these entries are already duplicated across webpack.config.base.js and webpack.config.cli.transpile.js and now webpack.config.federate.remote.js. Is it worth trying to consolidate, or do you think that would just lead to even more config files and an even worse experience?

…k into STRIPES-861-int

… webpack config

mkuklis and others added 23 commits October 28, 2024 16:30

STRIPES-861: Setup module federation

bc644ce

Cleanup

b9431f1

Cleanup

467f390

cleanup

7c3576a

Use shutdown hook

2deed9e

Cleanup

49189bd

Cleanup

12cc324

Cleanup

60b5dae

Add required version to shared singletons

97ba155

Start remotes automatically

8c47f56

Expose icons via public endpoint

84c0199

react-query provides a context, so must be a singleton

54db9c9

current versions

42cac16

separate handling of stripes-components and application icons

12613ed

Icons in stripes-components are imported as components whereas those in applications are just resources, so we need to load them differently.

resolve conflicts

0c73e79

provide registry url in stripes-config

626a7c8

resolve conflict

b399047

collect translations from 'StripesDeps' modules in built translations

08068ed

get the app's main entry from package.json

8889e08

ensure there are aliases before member access

a8b5fb0

expand the singletons for the platform

fddfec2

make module-federation opt-in via stripes-config

52d545f

JohnC-80 mentioned this pull request Dec 5, 2025

STRIPES-861 - integration of module federation logic with main branch. folio-org/stripes-core#1679

Open

JohnC-80 changed the title ~~Stripes-861 integration of module federation logic in the main branch.~~ STRIPES-861 integration of module federation logic in the main branch. Dec 5, 2025

JohnC-80 added 4 commits December 16, 2025 15:44

sync up stripes-config-plugin

2c8dbae

Merge branch 'main' into STRIPES-861-int

dbd8bde

tweak local federation commands

c915218

Merge branch 'STRIPES-861-int' of github.com:folio-org/stripes-webpac…

0b23f66

…k into STRIPES-861-int

JohnC-80 added 2 commits December 17, 2025 11:14

add tests for StripesTranslationPlugin federate mode

a3b01e5

use base webpack config from main branch

9639baa

JohnC-80 marked this pull request as ready for review December 17, 2025 20:39

JohnC-80 requested a review from a team as a code owner December 17, 2025 20:39

JohnC-80 added 4 commits December 17, 2025 14:44

add comment to top of federate remote webpack config

2018a55

log changes

0ef9438

log more changes

17ff134

add loader entry for sound file

eea2bb9

zburke reviewed Dec 19, 2025

View reviewed changes

JohnC-80 added 8 commits December 22, 2025 14:38

remove StripesLocalFederationPlugin

7cf2de0

remove commented svg rules in federate config

c9182a9

remove axios

6d4e80a

high level comments and mod-fed vs monolithic translation differences

55c989a

dynamically fetch versions for platform singletons

cef8363

configure for module-federation with --federate flag on build and ser…

84dd206

…ve commands

clean and comment edit

7d47eb9

Merge branch 'main' into STRIPES-861-int

dbbeef8

zburke reviewed Jan 15, 2026

View reviewed changes

JohnC-80 added 10 commits January 16, 2026 15:04

buildConfig is now async

093724d

Merge branch 'STRIPES-861-int' of github.com:folio-org/stripes-webpac…

08f7281

…k into STRIPES-861-int

remove async fallback for platform singletons

b9c3344

shape dev registry response closer to actual entitlement response

4e83e7b

remove the await for buildConfig

4e58dc6

add tenant name to registry server for spoofing the metadata endpoint

bded4e7

look in same folder for module-level builds

f2099e8

const/let in stripes-translations-plugin, ts loader rules in federate…

7fc5d00

… webpack config

add extensions to resolve in federate webpack config

a799aa6

add more 'include' paths for module-level builds

43b1d09

STRIPES-861 integration of module federation logic in the main branch. #173

Are you sure you want to change the base?

STRIPES-861 integration of module federation logic in the main branch. #173

Uh oh!

Conversation

JohnC-80 commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jest Unit Test Results

Uh oh!

zburke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 14, 2026

Quality Gate failed

Uh oh!

JohnC-80 commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zburke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JohnC-80 commented Dec 5, 2025 •

edited

Loading

github-actions bot commented Dec 5, 2025 •

edited

Loading

JohnC-80 commented Jan 14, 2026 •

edited

Loading