@tramvai/cli 2.111.0 → 2.112.0

package/src/library/webpack/plugins/ModuleFederationFixRange.ts

@@ -0,0 +1,174 @@
+import type webpack from 'webpack';
+import type { Compiler, NormalModule } from 'webpack';
+import { sync as resolve } from 'resolve';
+import type packageJson from 'package-json';
+import chalk from 'chalk';
+// eslint-disable-next-line no-restricted-imports
+import { parseRange } from 'webpack/lib/util/semver';
+import { isDependantLib, isUnifiedVersion } from '../../../utils/tramvaiVersions';
+
+const PLUGIN_NAME = 'ModuleFederationValidateDuplicates';
+
+type SemverRange = [number, number, number, number];
+
+interface SharedModuleOptions {
+  shareKey: string;
+  requiredVersion?: SemverRange;
+  importResolved: string;
+  singleton?: boolean;
+}
+
+interface SharedModule extends NormalModule {
+  options?: SharedModuleOptions;
+}
+
+const resolvePackageVersion = (name: string, basedir: string) => {
+  try {
+    const packageJsonPath = resolve(`${name}/package.json`, {
+      basedir,
+    });
+    const packageJson: packageJson.FullMetadataOptions = require(packageJsonPath);
+
+    return packageJson.version;
+  } catch (error: any) {
+    console.warn(`ModuleFederation: could not infer version for package "${name}"`);
+  }
+};
+
+export interface ModuleFederationFixRangeOptions {
+  flexibleTramvaiVersions: boolean;
+}
+
+export class ModuleFederationFixRange implements webpack.WebpackPluginInstance {
+  private flexibleTramvaiVersions: boolean;
+  // { name: { importResolved: { number }} }
+  private sharedModules: Map<string, Map<string, Set<number>>> = new Map();
+
+  constructor({ flexibleTramvaiVersions }: ModuleFederationFixRangeOptions) {
+    this.flexibleTramvaiVersions = flexibleTramvaiVersions ?? false;
+  }
+
+  apply(compiler: Compiler) {
+    compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (_, { normalModuleFactory }) => {
+      normalModuleFactory.hooks.factorize.intercept({
+        register: (tap) => {
+          if (tap.name === 'ConsumeSharedPlugin') {
+            const originalFn = tap.fn;
+            // eslint-disable-next-line no-param-reassign
+            tap.fn = async (...args) => {
+              const module: SharedModule | undefined = await originalFn(...args);
+
+              if (module?.options) {
+                this.fixVersionRange(module);
+              }
+
+              return module;
+            };
+          }
+
+          return tap;
+        },
+      });
+    });
+
+    compiler.hooks.done.tap(PLUGIN_NAME, () => {
+      const duplicates: Array<{ name: string; paths: string[] }> = [];
+      const criticalDuplicates: Array<{ name: string; path: string }> = [];
+
+      for (const [name, shared] of this.sharedModules) {
+        if (shared.size > 1) {
+          duplicates.push({
+            name,
+            paths: [...shared.keys()],
+          });
+        }
+
+        for (const [path, versions] of shared) {
+          if (versions.size > 1) {
+            criticalDuplicates.push({ name, path });
+          }
+        }
+      }
+
+      // reset sharedModules info after compilation has ended
+      this.sharedModules = new Map();
+
+      if (duplicates.length) {
+        console.warn(`⚠️  ModuleFederation: Found duplicates for next shared modules:
+${duplicates
+  .map(({ name, paths }) => {
+    return `\t${chalk.yellowBright(name)}: ${paths.join(', ')}`;
+  })
+  .join('\n')}
+        `);
+      }
+
+      if (criticalDuplicates.length) {
+        console.error(
+          `❗ ModuleFederation: Found duplicates for shared modules with different major versions that are resolved to the same path:
+${criticalDuplicates
+  .map(({ name, path }) => {
+    return `\t${chalk.red(name)}: ${path}`;
+  })
+  .join('\n')}`
+        );
+
+        throw new Error(
+          'ModuleFederation: Different major versions have resolved to the same path for shared modules, please review errors above'
+        );
+      }
+    });
+  }
+
+  fixVersionRange(module: SharedModule) {
+    const {
+      options,
+      options: { shareKey: name, singleton, importResolved },
+      context,
+    } = module;
+    let { requiredVersion } = options;
+
+    // ignore singletons as the actual version won't change anything
+    // and usually it is just a react and co libraries
+    if (!requiredVersion && context && !singleton) {
+      const version = resolvePackageVersion(name, context);
+      if (version) {
+        requiredVersion = parseRange(version);
+      }
+    }
+
+    if (!requiredVersion) {
+      return;
+    }
+
+    if (requiredVersion && this.flexibleTramvaiVersions) {
+      const isTramvai = isUnifiedVersion(name) || isDependantLib(name);
+
+      if (isTramvai && requiredVersion[0] > 2) {
+        // 1 is used for `^` range modifier
+        // see https://github.com/webpack/webpack/blob/56363993156e06a1230c9759eba277a22e6b6604/lib/util/semver.js#LL235C20-L235C20
+        requiredVersion[0] = 1;
+      }
+    }
+
+    // change version in webpack module
+    options.requiredVersion = requiredVersion;
+
+    let shared = this.sharedModules.get(name);
+
+    if (!shared) {
+      shared = new Map();
+      this.sharedModules.set(name, shared);
+    }
+
+    let versions = shared.get(importResolved);
+
+    if (!versions) {
+      versions = new Set();
+      shared.set(importResolved, versions);
+    }
+
+    // save major version of the semver array
+    versions.add(requiredVersion[1]);
+  }
+}

package/src/models/config.spec.ts

@@ -103,6 +103,7 @@ it('should populate defaults for config', () => {
           "serverApiDir": "src/api",
           "shared": {
             "deps": [],
+            "flexibleTramvaiVersions": true,
           },
           "sourceMap": false,
           "splitChunks": {
@@ -159,6 +160,7 @@ it('should populate defaults for config', () => {
           "root": "packages/child-app",
           "shared": {
             "deps": [],
+            "flexibleTramvaiVersions": true,
           },
           "sourceMap": false,
           "terser": {
@@ -336,6 +338,7 @@ it('should populate defaults for overridable options', () => {
           "serverApiDir": "src/api",
           "shared": {
             "deps": [],
+            "flexibleTramvaiVersions": true,
           },
           "sourceMap": false,
           "splitChunks": {
@@ -406,6 +409,7 @@ it('should populate defaults for overridable options', () => {
           "root": "packages/child-app",
           "shared": {
             "deps": [],
+            "flexibleTramvaiVersions": true,
           },
           "sourceMap": {
             "development": true,

package/src/schema/autogeneratedSchema.json

@@ -1225,7 +1225,13 @@
           "properties": {
             "defaultTramvaiDependencies": {
               "title": "Should default dependencies list be added to shared list",
-              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of",
+              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of tramvai/module-child-app is specified in package.json\nand for child-apps",
+              "type": "boolean"
+            },
+            "flexibleTramvaiVersions": {
+              "title": "add caret range specifier for tramvai dependencies",
+              "description": "minimal versions are inferred from package.json",
+              "default": true,
               "type": "boolean"
             },
             "deps": {
@@ -1746,7 +1752,13 @@
           "properties": {
             "defaultTramvaiDependencies": {
               "title": "Should default dependencies list be added to shared list",
-              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of",
+              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of tramvai/module-child-app is specified in package.json\nand for child-apps",
+              "type": "boolean"
+            },
+            "flexibleTramvaiVersions": {
+              "title": "add caret range specifier for tramvai dependencies",
+              "description": "minimal versions are inferred from package.json",
+              "default": true,
               "type": "boolean"
             },
             "deps": {
@@ -2267,7 +2279,13 @@
           "properties": {
             "defaultTramvaiDependencies": {
               "title": "Should default dependencies list be added to shared list",
-              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of",
+              "description": "It includes the list of commonly used dependencies in the child-apps\nBy default, it is enabled in application in case of tramvai/module-child-app is specified in package.json\nand for child-apps",
+              "type": "boolean"
+            },
+            "flexibleTramvaiVersions": {
+              "title": "add caret range specifier for tramvai dependencies",
+              "description": "minimal versions are inferred from package.json",
+              "default": true,
               "type": "boolean"
             },
             "deps": {

package/src/schema/tramvai.spec.ts

@@ -126,6 +126,7 @@ describe('JSON schema для tramvai.json', () => {
             "serverApiDir": "src/api",
             "shared": {
               "deps": [],
+              "flexibleTramvaiVersions": true,
             },
             "sourceMap": false,
             "splitChunks": {
@@ -182,6 +183,7 @@ describe('JSON schema для tramvai.json', () => {
             "root": "src/module",
             "shared": {
               "deps": [],
+              "flexibleTramvaiVersions": true,
             },
             "sourceMap": false,
             "terser": {

package/src/typings/configEntry/cli.ts

@@ -287,10 +287,16 @@ export interface CliConfigEntry extends ConfigEntry {
     /**
      * @title Should default dependencies list be added to shared list
      * @description It includes the list of commonly used dependencies in the child-apps
-     * By default, it is enabled in application in case of @tramvai/module-child-app is specified in package.json
+     * By default, it is enabled in application in case of tramvai/module-child-app is specified in package.json
      * and for child-apps
      */
     defaultTramvaiDependencies?: boolean;
+    /**
+     * @title add caret range specifier for tramvai dependencies
+     * @description minimal versions are inferred from package.json
+     * @default true
+     */
+    flexibleTramvaiVersions: boolean;
     /**
      * @title list of the dependencies that will be shared
      * @default []

package/src/utils/detectPortSync.ts

@@ -1,7 +1,23 @@
 import { execSync } from 'child_process';
 
-export const detectPortSync = (port: number): number => {
-  const commandResult = execSync(`npx detect-port ${port}`);
+interface Payload {
+  request?: number;
+  fallback: number;
+}
+
+/**
+ * Try to detect port synchronously considering the fact, that if user requests
+ * a port explicitly, we should not try to detect a free one.
+ *
+ * Also, handle zero port (it means any random port) as the edge case,
+ * because we must pass a final number to the config manager.
+ */
+export const detectPortSync = ({ request, fallback }: Payload): number => {
+  if (request !== undefined && request !== 0) {
+    return request;
+  }
+
+  const commandResult = execSync(`npx detect-port ${request ?? fallback}`);
 
   return parseInt(commandResult.toString('utf-8'), 10);
 };

package/src/utils/tramvaiVersions.ts

@@ -0,0 +1,26 @@
+// map of packages that is not in unified versioning
+// but we still want to update it
+// actual version to update will be calculated from the some of the @tramvai/module
+export const DEPENDANT_LIBS_MAP = new Map([
+  ['@tinkoff/logger', '@tramvai/module-log'],
+  ['@tinkoff/dippy', '@tramvai/core'],
+  ['@tinkoff/router', '@tramvai/module-router'],
+  ['@tinkoff/url', '@tramvai/module-common'],
+  ['@tinkoff/errors', '@tramvai/module-common'],
+  ['@tinkoff/roles', '@tramvai/module-authenticate'],
+  ['@tinkoff/pubsub', '@tramvai/module-common'],
+  ['@tinkoff/hook-runner', '@tramvai/module-common'],
+  ['@tinkoff/htmlpagebuilder', '@tramvai/module-render'],
+  ['@tinkoff/browser-timings', '@tramvai/module-metrics'],
+  ['@tinkoff/meta-tags-generate', '@tramvai/module-render'],
+  ['@tinkoff/pack-polyfills', ''],
+  ['@tinkoff/browserslist-config', '@tramvai/cli'],
+]);
+
+export const isUnifiedVersion = (name: string) => {
+  return name.startsWith('@tramvai');
+};
+
+export const isDependantLib = (name: string) => {
+  return DEPENDANT_LIBS_MAP.has(name);
+};