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

.changeset/smooth-goats-knock.md

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

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

@@ -235,19 +235,29 @@ 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 } = result || {};
                   if (!data) {
-                    requiredVersionWarning(
-                      `Unable to find description file in ${context}.`,
-                    );
+                    if (checkedDescriptionFilePaths) {
+                      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
@@ -259,15 +269,17 @@ class ConsumeSharedPlugin {
                     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);
-                  }
                   // @ts-ignore  webpack internal semver has some issue, use runtime semver , related issue: https://github.com/webpack/webpack/issues/17756
                   resolve(requiredVersion);
                 },
+                ({ data }) => {
+                  const maybeRequiredVersion =
+                    getRequiredVersionFromDescriptionFile(data, packageName);
+                  return (
+                    data['name'] === packageName ||
+                    typeof maybeRequiredVersion === 'string'
+                  );
+                },
               );
             }),
           ]).then(([importResolved, requiredVersion]) => {

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

@@ -335,27 +335,48 @@ export { normalizeVersion };
  * @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?: object, path?: string}=, (checkedDescriptionFilePaths: string[])=): void} callback callback
+ * @param {function({data: Record<string, any>, path: string}=): boolean} satisfiesDescriptionFileData file data compliance check
  */
 const getDescriptionFile = (
   fs: InputFileSystem,
   directory: string,
   descriptionFiles: string[],
-  callback: (err: Error | null, data?: { data: object; path: string }) => void,
+  callback: (
+    err: Error | null,
+    data?: { data: object; path: string },
+    checkedDescriptionFilePaths?: string[],
+  ) => void,
+  satisfiesDescriptionFileData?: (data: {
+    data: Record<string, any>;
+    path: string;
+  }) => boolean,
 ) => {
   let i = 0;
+
+  // use a function property to store the list of visited files inside the recursive lookup
+  // instead of the public getDescriptionFile property
+  const satisfiesDescriptionFileDataInternal:
+    | (typeof satisfiesDescriptionFileData & { checkedFilePaths?: Set<string> })
+    | undefined = satisfiesDescriptionFileData;
+
   const tryLoadCurrent = () => {
     if (i >= descriptionFiles.length) {
       const parentDirectory = dirname(fs, directory);
       if (!parentDirectory || parentDirectory === directory) {
-        //@ts-ignore
-        return callback();
+        return callback(
+          null,
+          undefined,
+          satisfiesDescriptionFileDataInternal?.checkedFilePaths &&
+            Array.from(satisfiesDescriptionFileDataInternal?.checkedFilePaths),
+        );
       }
       return getDescriptionFile(
         fs,
         parentDirectory,
         descriptionFiles,
         callback,
+        satisfiesDescriptionFileDataInternal,
       );
     }
     const filePath = join(fs, directory, descriptionFiles[i]);
@@ -372,6 +393,23 @@ const getDescriptionFile = (
           new Error(`Description file ${filePath} is not an object`),
         );
       }
+      if (typeof satisfiesDescriptionFileDataInternal === 'function') {
+        if (!satisfiesDescriptionFileDataInternal({ data, path: filePath })) {
+          i++;
+
+          if (
+            satisfiesDescriptionFileDataInternal.checkedFilePaths instanceof Set
+          ) {
+            satisfiesDescriptionFileDataInternal.checkedFilePaths.add(filePath);
+          } else {
+            satisfiesDescriptionFileDataInternal.checkedFilePaths = new Set([
+              filePath,
+            ]);
+          }
+
+          return tryLoadCurrent();
+        }
+      }
       callback(null, { data, path: filePath });
     });
   };

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/package.json

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

packages/enhanced/test/configCases/sharing/share-plugin-dual-mode/webpack.config.js

@@ -0,0 +1,14 @@
+const { SharePlugin } = require('../../../../dist/src');
+
+/** @type {import("../../../../").Configuration} */
+module.exports = {
+  context: `${__dirname}/cjs`,
+  plugins: [
+    new SharePlugin({
+      shared: {
+        lib: {},
+        transitive_lib: {},
+      },
+    }),
+  ],
+};

packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/index.js

@@ -0,0 +1,15 @@
+it('should provide library from own package.json', async () => {
+  expect(await import('lib1')).toEqual(
+    expect.objectContaining({
+      default: '[email protected]',
+    }),
+  );
+});
+
+it('should provide library from parent package.json', async () => {
+  expect(await import('lib2')).toEqual(
+    expect.objectContaining({
+      default: '[email protected]',
+    }),
+  );
+});

packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "lib2": "^2.0.0"
+  }
+}

packages/enhanced/test/configCases/sharing/share-plugin-monorepo/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "lib1": "^1.0.0",
+    "lib2": "^1.0.0"
+  }
+}

packages/enhanced/test/configCases/sharing/share-plugin-monorepo/webpack.config.js

@@ -0,0 +1,16 @@
+const { SharePlugin } = require('../../../../dist/src');
+
+/** @type {import("../../../../").Configuration} */
+module.exports = {
+  context: `${__dirname}/app1`,
+  plugins: [
+    new SharePlugin({
+      shared: {
+        lib1: {},
+        lib2: {
+          singleton: true,
+        },
+      },
+    }),
+  ],
+};