Merge pull request #748 from asollberger/main

feat(nf-runtime): added cacheTag option

Author: manfredsteyer

.eslintrc.json

@@ -38,6 +38,12 @@
       "files": "*.json",
       "parser": "jsonc-eslint-parser",
       "rules": {}
+    },
+    {
+      "files": ["*.ts"],
+      "rules": {
+        "@angular-eslint/prefer-standalone": "off"
+      }
     }
   ],
   "extends": ["./.eslintrc.base.json"]

apps/mfe1/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {

apps/mfe2/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {

apps/playground/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {

libs/mf-runtime/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {

libs/mf-tools/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {

libs/native-federation-node/src/lib/node/init-node-federation.ts

@@ -4,18 +4,21 @@ import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 
 import {
+  FederationInfo,
+  ImportMap,
+  InitFederationOptions,
+  mergeImportMaps,
   processHostInfo,
   processRemoteInfos,
-  FederationInfo,
 } from '@softarc/native-federation-runtime';
-import { ImportMap, mergeImportMaps } from '@softarc/native-federation-runtime';
 import { IMPORT_MAP_FILE_NAME } from '../utils/import-map-loader';
 import { resolver } from '../utils/loader-as-data-url';
 
 export type InitNodeFederationOptions = {
   remotesOrManifestUrl: Record<string, string> | string;
   relBundlePath: string;
   throwIfRemoteNotFound: boolean;
+  cacheTag?: string;
 };
 
 const defaultOptions: InitNodeFederationOptions = {
@@ -53,6 +56,7 @@ async function createNodeImportMap(
   const hostImportMap = await processHostInfo(hostInfo, relBundlePath);
   const remotesImportMap = await processRemoteInfos(remotes, {
     throwIfRemoteNotFound: options.throwIfRemoteNotFound,
+    cacheTag: options.cacheTag,
   });
 
   const importMap = mergeImportMaps(hostImportMap, remotesImportMap);
@@ -69,9 +73,13 @@ async function loadFsManifest(
 }
 
 async function loadFsFederationInfo(
-  relBundlePath: string
+  relBundlePath: string,
+  options?: InitFederationOptions
 ): Promise<FederationInfo> {
-  const manifestPath = path.join(relBundlePath, 'remoteEntry.json');
+  const manifestPath = path.join(
+    relBundlePath,
+    'remoteEntry.json' + options?.cacheTag ? `?t=${options.cacheTag}` : ''
+  );
   const content = await fs.readFile(manifestPath, 'utf-8');
   const manifest = JSON.parse(content) as FederationInfo;
   return manifest;

libs/native-federation-runtime/src/lib/init-federation.ts

@@ -1,26 +1,41 @@
 import {
-  Scopes,
-  Imports,
   ImportMap,
+  Imports,
   mergeImportMaps,
+  Scopes,
 } from './model/import-map';
 import { getExternalUrl, setExternalUrl } from './model/externals';
-import { joinPaths, getDirectory } from './utils/path-utils';
+import { getDirectory, joinPaths } from './utils/path-utils';
 import { addRemote } from './model/remotes';
 import { appendImportMap } from './utils/add-import-map';
-import { FederationInfo } from './model/federation-info';
-
+import {
+  FederationInfo,
+  InitFederationOptions,
+  ProcessRemoteInfoOptions,
+} from './model/federation-info';
+
+/**
+ * Initialize the federation runtime
+ * @param remotesOrManifestUrl
+ * @param options The cacheTag allows you to invalidate the cache of the remoteEntry.json files, pass a new value with every release (f.ex. the version number)
+ */
 export async function initFederation(
-  remotesOrManifestUrl: Record<string, string> | string = {}
+  remotesOrManifestUrl: Record<string, string> | string = {},
+  options?: InitFederationOptions
 ): Promise<ImportMap> {
+  const cacheOption = options?.cacheTag ? `?t=${options.cacheTag}` : '';
   const remotes =
     typeof remotesOrManifestUrl === 'string'
-      ? await loadManifest(remotesOrManifestUrl)
+      ? await loadManifest(remotesOrManifestUrl + cacheOption)
       : remotesOrManifestUrl;
 
-  const hostInfo = await loadFederationInfo('./remoteEntry.json');
+  const url = './remoteEntry.json' + cacheOption;
+  const hostInfo = await loadFederationInfo(url);
   const hostImportMap = await processHostInfo(hostInfo);
-  const remotesImportMap = await processRemoteInfos(remotes);
+  const remotesImportMap = await processRemoteInfos(remotes, {
+    throwIfRemoteNotFound: false,
+    ...options,
+  });
 
   const importMap = mergeImportMaps(hostImportMap, remotesImportMap);
   appendImportMap(importMap);
@@ -34,12 +49,17 @@ async function loadManifest(remotes: string): Promise<Record<string, string>> {
 
 export async function processRemoteInfos(
   remotes: Record<string, string>,
-  options: { throwIfRemoteNotFound: boolean } = { throwIfRemoteNotFound: false }
+  options: ProcessRemoteInfoOptions = { throwIfRemoteNotFound: false }
 ): Promise<ImportMap> {
   const processRemoteInfoPromises = Object.keys(remotes).map(
     async (remoteName) => {
       try {
-        const url = remotes[remoteName];
+        let url = remotes[remoteName];
+        if (options.cacheTag) {
+          const addAppend = remotes[remoteName].includes('?') ? '&' : '?';
+          url += `${addAppend}t=${options.cacheTag}`;
+        }
+
         return await processRemoteInfo(url, remoteName);
       } catch (e) {
         const error = `Error loading remote entry for ${remoteName} from file ${remotes[remoteName]}`;

libs/native-federation-runtime/src/lib/model/federation-info.ts

@@ -23,3 +23,11 @@ export interface FederationInfo {
   exposes: ExposesInfo[];
   shared: SharedInfo[];
 }
+
+export interface InitFederationOptions {
+  cacheTag?: string;
+}
+
+export interface ProcessRemoteInfoOptions extends InitFederationOptions {
+  throwIfRemoteNotFound: boolean;
+}

libs/playground-lib/.eslintrc.json

@@ -24,7 +24,8 @@
             "prefix": "angular-architects",
             "style": "kebab-case"
           }
-        ]
+        ],
+        "@angular-eslint/prefer-standalone": "off"
       }
     },
     {