feat(enhanced): Recursive search for versions of shared dependencies (#3078)

Co-authored-by: Zack Jackson <[email protected]>
Co-authored-by: ScriptedAlchemy <[email protected]>

Author: barabaiiika

.changeset/smooth-goats-knock.md

@@ -0,0 +1,5 @@
+---
+'@module-federation/enhanced': patch
+---
+
+Added recursively search for shared dependency versions

packages/enhanced/src/lib/sharing/ConsumeSharedPlugin.ts

@@ -129,7 +129,6 @@ class ConsumeSharedPlugin {
   }
 
   apply(compiler: Compiler): void {
-    //@ts-ignore
     new FederationRuntimePlugin().apply(compiler);
     process.env['FEDERATION_WEBPACK_PATH'] =
       process.env['FEDERATION_WEBPACK_PATH'] || getWebpackPath(compiler);
@@ -167,7 +166,6 @@ class ConsumeSharedPlugin {
               `No required version specified and unable to automatically determine one. ${details}`,
             );
             error.file = `shared module ${request}`;
-            //@ts-ignore
             compilation.warnings.push(error);
           };
           const directFallback =
@@ -198,7 +196,6 @@ class ConsumeSharedPlugin {
                   );
                   if (err) {
                     compilation.errors.push(
-                      //@ts-ignore
                       new ModuleNotFoundError(null, err, {
                         name: `resolving fallback for shared module ${request}`,
                       }),
@@ -235,39 +232,53 @@ class ConsumeSharedPlugin {
                 compilation.inputFileSystem,
                 context,
                 ['package.json'],
-                (err, result) => {
+                (err, result, checkedDescriptionFilePaths) => {
                   if (err) {
                     requiredVersionWarning(
                       `Unable to read description file: ${err}`,
                     );
                     return resolve(undefined);
                   }
-                  //@ts-ignore
-                  const { data, path: descriptionPath } = result;
+                  const { data } = /** @type {DescriptionFile} */ result || {};
                   if (!data) {
-                    requiredVersionWarning(
-                      `Unable to find description file in ${context}.`,
-                    );
+                    if (checkedDescriptionFilePaths?.length) {
+                      requiredVersionWarning(
+                        [
+                          `Unable to find required version for "${packageName}" in description file/s`,
+                          checkedDescriptionFilePaths.join('\n'),
+                          'It need to be in dependencies, devDependencies or peerDependencies.',
+                        ].join('\n'),
+                      );
+                    } else {
+                      requiredVersionWarning(
+                        `Unable to find description file in ${context}.`,
+                      );
+                    }
+
                     return resolve(undefined);
                   }
-                  //@ts-ignore
-                  if (data.name === packageName) {
+                  if (data['name'] === packageName) {
                     // Package self-referencing
                     return resolve(undefined);
                   }
                   const requiredVersion = getRequiredVersionFromDescriptionFile(
                     data,
                     packageName,
                   );
-                  if (typeof requiredVersion !== 'string') {
-                    requiredVersionWarning(
-                      `Unable to find required version for "${packageName}" in description file (${descriptionPath}). It need to be in dependencies, devDependencies or peerDependencies.`,
-                    );
-                    return resolve(undefined);
-                  }
+                  //TODO: align with webpck semver parser again
                   // @ts-ignore  webpack internal semver has some issue, use runtime semver , related issue: https://github.com/webpack/webpack/issues/17756
                   resolve(requiredVersion);
                 },
+                (result) => {
+                  if (!result) return false;
+                  const { data } = result;
+                  const maybeRequiredVersion =
+                    getRequiredVersionFromDescriptionFile(data, packageName);
+                  return (
+                    data['name'] === packageName ||
+                    typeof maybeRequiredVersion === 'string'
+                  );
+                },
               );
             }),
           ]).then(([importResolved, requiredVersion]) => {
@@ -315,7 +326,6 @@ class ConsumeSharedPlugin {
         );
         normalModuleFactory.hooks.createModule.tapPromise(
           PLUGIN_NAME,
-          //@ts-ignore
           ({ resource }, { context, dependencies }) => {
             if (
               dependencies[0] instanceof ConsumeSharedFallbackDependency ||
@@ -343,7 +353,6 @@ class ConsumeSharedPlugin {
             set.add(RuntimeGlobals.hasOwnProperty);
             compilation.addRuntimeModule(
               chunk,
-              //@ts-ignore
               new ConsumeSharedRuntimeModule(set),
             );
             // FIXME: need to remove webpack internal inject ShareRuntimeModule, otherwise there will be two ShareRuntimeModule

packages/enhanced/src/lib/sharing/utils.ts

@@ -12,35 +12,33 @@ const { join, dirname, readJson } = require(
 ) as typeof import('webpack/lib/util/fs');
 
 // Extreme shorthand only for github. eg: foo/bar
-const RE_URL_GITHUB_EXTREME_SHORT: RegExp =
-  /^[^/@:.\s][^/@:\s]*\/[^@:\s]*[^/@:\s]#\S+/;
+const RE_URL_GITHUB_EXTREME_SHORT = /^[^/@:.\s][^/@:\s]*\/[^@:\s]*[^/@:\s]#\S+/;
 
 // Short url with specific protocol. eg: github:foo/bar
-const RE_GIT_URL_SHORT: RegExp =
-  /^(github|gitlab|bitbucket|gist):\/?[^/.]+\/?/i;
+const RE_GIT_URL_SHORT = /^(github|gitlab|bitbucket|gist):\/?[^/.]+\/?/i;
 
 // Currently supported protocols
-const RE_PROTOCOL: RegExp =
+const RE_PROTOCOL =
   /^((git\+)?(ssh|https?|file)|git|github|gitlab|bitbucket|gist):$/i;
 
 // Has custom protocol
-const RE_CUSTOM_PROTOCOL: RegExp = /^((git\+)?(ssh|https?|file)|git):\/\//i;
+const RE_CUSTOM_PROTOCOL = /^((git\+)?(ssh|https?|file)|git):\/\//i;
 
 // Valid hash format for npm / yarn ...
-const RE_URL_HASH_VERSION: RegExp = /#(?:semver:)?(.+)/;
+const RE_URL_HASH_VERSION = /#(?:semver:)?(.+)/;
 
 // Simple hostname validate
-const RE_HOSTNAME: RegExp = /^(?:[^/.]+(\.[^/]+)+|localhost)$/;
+const RE_HOSTNAME = /^(?:[^/.]+(\.[^/]+)+|localhost)$/;
 
 // For hostname with colon. eg: ssh://user@github.com:foo/bar
-const RE_HOSTNAME_WITH_COLON: RegExp =
+const RE_HOSTNAME_WITH_COLON =
   /([^/@#:.]+(?:\.[^/@#:.]+)+|localhost):([^#/0-9]+)/;
 
 // Reg for url without protocol
-const RE_NO_PROTOCOL: RegExp = /^([^/@#:.]+(?:\.[^/@#:.]+)+)/;
+const RE_NO_PROTOCOL = /^([^/@#:.]+(?:\.[^/@#:.]+)+)/;
 
 // Specific protocol for short url without normal hostname
-const PROTOCOLS_FOR_SHORT: string[] = [
+const PROTOCOLS_FOR_SHORT = [
   'github:',
   'gitlab:',
   'bitbucket:',
@@ -49,7 +47,7 @@ const PROTOCOLS_FOR_SHORT: string[] = [
 ];
 
 // Default protocol for git url
-const DEF_GIT_PROTOCOL: string = 'git+ssh://';
+const DEF_GIT_PROTOCOL = 'git+ssh://';
 
 // thanks to https://github.com/npm/hosted-git-info/blob/latest/git-host-info.js
 const extractCommithashByDomain: {
@@ -330,32 +328,59 @@ function normalizeVersion(versionDesc: string): string {
 
 export { normalizeVersion };
 
+/** @typedef {{ data: Record<string, any>, path: string }} DescriptionFile */
+
+interface DescriptionFile {
+  data: Record<string, any>;
+  path: string;
+}
+
 /**
  *
  * @param {InputFileSystem} fs file system
  * @param {string} directory directory to start looking into
  * @param {string[]} descriptionFiles possible description filenames
- * @param {function((Error | null)=, {data: object, path: string}=): void} callback callback
+ * @param {function((Error | null)=, {data?: DescriptionFile, path?: string}=, (checkedDescriptionFilePaths: string[])=): void} callback callback
+ * @param {function({data: DescriptionFile}=): boolean} satisfiesDescriptionFileData file data compliance check
+ * @param {Set<string>} [checkedFilePaths] optional set to track checked file paths
  */
-const getDescriptionFile = (
+function getDescriptionFile(
   fs: InputFileSystem,
   directory: string,
   descriptionFiles: string[],
-  callback: (err: Error | null, data?: { data: object; path: string }) => void,
-) => {
+  callback: (
+    err: Error | null,
+    data?: DescriptionFile,
+    checkedDescriptionFilePaths?: string[],
+  ) => void,
+  satisfiesDescriptionFileData?: (data?: DescriptionFile) => boolean,
+  checkedFilePaths: Set<string> = new Set<string>(), // Default to a new Set if not provided
+) {
   let i = 0;
+
+  // Create an object to hold the function and the shared checkedFilePaths
+  const satisfiesDescriptionFileDataInternal = {
+    check: satisfiesDescriptionFileData,
+    checkedFilePaths: checkedFilePaths, // Use the passed Set instance
+  };
+
   const tryLoadCurrent = () => {
     if (i >= descriptionFiles.length) {
       const parentDirectory = dirname(fs, directory);
       if (!parentDirectory || parentDirectory === directory) {
-        //@ts-ignore
-        return callback();
+        return callback(
+          null,
+          undefined,
+          Array.from(satisfiesDescriptionFileDataInternal.checkedFilePaths),
+        );
       }
       return getDescriptionFile(
         fs,
         parentDirectory,
         descriptionFiles,
         callback,
+        satisfiesDescriptionFileDataInternal.check,
+        satisfiesDescriptionFileDataInternal.checkedFilePaths, // Pass the same Set
       );
     }
     const filePath = join(fs, directory, descriptionFiles[i]);
@@ -372,11 +397,19 @@ const getDescriptionFile = (
           new Error(`Description file ${filePath} is not an object`),
         );
       }
+      if (
+        typeof satisfiesDescriptionFileDataInternal.check === 'function' &&
+        !satisfiesDescriptionFileDataInternal.check({ data, path: filePath })
+      ) {
+        i++;
+        satisfiesDescriptionFileDataInternal.checkedFilePaths.add(filePath);
+        return tryLoadCurrent();
+      }
       callback(null, { data, path: filePath });
     });
   };
   tryLoadCurrent();
-};
+}
 export { getDescriptionFile };
 /**
  * Get required version from description file

packages/enhanced/test/configCases/sharing/share-plugin-dual-mode/cjs/index.js

@@ -0,0 +1,7 @@
+it('should provide own dependency', async () => {
+  expect(await import('lib')).toEqual(
+    expect.objectContaining({
+      default: '[email protected] with [email protected]',
+    }),
+  );
+});

packages/enhanced/test/configCases/sharing/share-plugin-dual-mode/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

packages/enhanced/test/configCases/sharing/share-plugin-dual-mode/node_modules/lib/index.js

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "lib": "^1.0.0"
+  }
+}