fix: use fallback version in consume shared

webpack · tmpaul · Jun 21, 2023 · Jun 21, 2023 · Jun 21, 2023 · Jun 21, 2023
commit 4a3cc04977a47dd3810c6156bc0a937c7f28f907
diff --git a/declarations/plugins/container/ModuleFederationPlugin.d.ts b/declarations/plugins/container/ModuleFederationPlugin.d.ts
@@ -278,7 278,7 @@ export interface SharedConfig {
  */
  eager?: boolean;
  /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
  exclusionCriteria?: SharedExclusionCriteria;
  /**
@@ -315,7 315,7 @@ export interface SharedConfig {
  version?: false | string;
 }
 /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
 export interface SharedExclusionCriteria {
  /**

diff --git a/declarations/plugins/sharing/ConsumeSharedPlugin.d.ts b/declarations/plugins/sharing/ConsumeSharedPlugin.d.ts
@@ -43,10 43,7 @@ export interface ConsumesConfig {
  * Include the fallback module directly instead behind an async request. This allows to use fallback module in initial load too. All possible shared modules need to be eager too.
  */
  eager?: boolean;
- /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
- */
- exclusionCriteria?: SharedExclusionCriteria;
  exclusionCriteria?: SharedExclusionCriteriaWithFallbackVersion;
  /**
  * Fallback module if no shared module is found in share scope. Defaults to the property name.
  */
@@ -77,7 74,21 @@ export interface ConsumesConfig {
  strictVersion?: boolean;
 }
 /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * This interface was referenced by `ConsumeSharedPluginOptions`'s JSON-Schema
  * via the `definition` "SharedExclusionCriteriaWithFallbackVersion".
  */
 export interface SharedExclusionCriteriaWithFallbackVersion {
  /**
  * Version of the package provided by the fallback if there is one.
  */
  fallbackVersion?: string;
  /**
  * A version or semver range of the dependency to exclude from sharing.
  */
  version?: string;
 }
 /**
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
 export interface SharedExclusionCriteria {
  /**

diff --git a/declarations/plugins/sharing/ProvideSharedPlugin.d.ts b/declarations/plugins/sharing/ProvideSharedPlugin.d.ts
@@ -41,7 41,7 @@ export interface ProvidesConfig {
  */
  eager?: boolean;
  /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
  exclusionCriteria?: SharedExclusionCriteria;
  /**
@@ -58,7 58,7 @@ export interface ProvidesConfig {
  version?: false | string;
 }
 /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
 export interface SharedExclusionCriteria {
  /**

diff --git a/declarations/plugins/sharing/SharePlugin.d.ts b/declarations/plugins/sharing/SharePlugin.d.ts
@@ -44,7 44,7 @@ export interface SharedConfig {
  */
  eager?: boolean;
  /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
  exclusionCriteria?: SharedExclusionCriteria;
  /**
@@ -81,7 81,7 @@ export interface SharedConfig {
  version?: false | string;
 }
 /**
- * A set of exclusion criterias to use to decide if a module must participate in sharing.
  * A set of exclusion criteria to use to decide if a module must participate in sharing.
  */
 export interface SharedExclusionCriteria {
  /**

diff --git a/lib/sharing/ConsumeSharedModule.js b/lib/sharing/ConsumeSharedModule.js
@@ -16,8 16,8 @@ const makeSerializable = require("../util/makeSerializable");
 const { rangeToString, stringifyHoley } = require("../util/semver");
 const ConsumeSharedFallbackDependency = require("./ConsumeSharedFallbackDependency");
 
-/** @typedef {import("../../declarations/plugins/sharing/SharePlugin").SharedExclusionCriteria} SharedExclusionCriteria */
 /** @typedef {import("../../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptions */
 /** @typedef {import("../../declarations/plugins/sharing/ConsumeSharedPlugin").SharedExclusionCriteriaWithFallbackVersion} SharedExclusionCriteria */
 /** @typedef {import("../ChunkGraph")} ChunkGraph */
 /** @typedef {import("../ChunkGroup")} ChunkGroup */
 /** @typedef {import("../Compilation")} Compilation */

diff --git a/lib/sharing/ConsumeSharedPlugin.js b/lib/sharing/ConsumeSharedPlugin.js
@@ -4,6 4,7 @@
 */
 
 "use strict";
 
 const path = require("path");
 const ModuleNotFoundError = require("../ModuleNotFoundError");
 const RuntimeGlobals = require("../RuntimeGlobals");
@@ -255,28 256,45 @@ class ConsumeSharedPlugin {
  requiredVersion
  }
  );
  // Check if exclusion criteria is provided
  if (config.exclusionCriteria && config.exclusionCriteria.version) {
- const exclusionCriteriaWarning = details => {
- const error = new WebpackError(
- `Error while attempting to decide exclusion criteria with version: ${config.exclusionCriteria.version}. ${details}`
- );
- error.file = `shared module ${request}`;
- compilation.warnings.push(error);
- };
  // Without a resolved import, we cannot proceed with exclusion check
  if (!importResolved) {
  return consumedModule;
  }
  // If a fallback version is provided by the user, use that to check
  if (config.exclusionCriteria.fallbackVersion) {
  if (
  satisfy(
  parseRange(config.exclusionCriteria.version),
  config.exclusionCriteria.fallbackVersion
  )
  ) {
  return undefined;
  }
  return consumedModule;
  }
  return new Promise(resolve => {
  // Get the closest package.json file corresponding to the resolved import.
  // This version will be used for checking whether the dependency must be
  // excluded from consumption (in a share context). If such a version does
  // not exist in the package.json file, then we use the "version" property
  // set by users in the share config, which is passed here as fallbackVersion
  // a.k.a the version used to register the package in the scope.
  getDescriptionFile(
  compilation.inputFileSystem,
  path.dirname(importResolved),
  ["package.json"],
  (err, result) => {
  if (err) {
- console.error(err);
  return resolve(consumedModule);
  }
  const { data } = result;
- if (!data) {
- exclusionCriteriaWarning(
- `Unable to find description file in ${importResolved}.`
- );
  if (
  !data ||
  (data && !data.version) ||
  (data && data.name !== request)
  ) {
  // If we cannot determine exclusion, return the consumed module
  return resolve(consumedModule);
  }

diff --git a/lib/sharing/SharePlugin.js b/lib/sharing/SharePlugin.js
@@ -8,7 8,7 @@
 const { parseOptions } = require("../container/options");
 const ConsumeSharedPlugin = require("./ConsumeSharedPlugin");
 const ProvideSharedPlugin = require("./ProvideSharedPlugin");
-const { isRequiredVersion } = require("./utils");
 const { isRequiredVersion, validateShareOptions } = require("./utils");
 
 /** @typedef {import("../../declarations/plugins/sharing/ConsumeSharedPlugin").ConsumeSharedPluginOptions} ConsumeSharedPluginOptions */
 /** @typedef {import("../../declarations/plugins/sharing/ConsumeSharedPlugin").ConsumesConfig} ConsumesConfig */
@@ -43,13 43,19 @@ class SharePlugin {
  },
  item => item
  );
  validateShareOptions(sharedOptions);
  /** @type {Record<string, ConsumesConfig>[]} */
  const consumes = sharedOptions.map(([key, options]) => ({
  [key]: {
  import: options.import,
  shareKey: options.shareKey || key,
  shareScope: options.shareScope,
- exclusionCriteria: options.exclusionCriteria,
  exclusionCriteria: options.exclusionCriteria
  ? {
  ...options.exclusionCriteria,
  fallbackVersion: options.version ? options.version : undefined
  }
  : undefined,
  requiredVersion: options.requiredVersion,
  strictVersion: options.strictVersion,
  singleton: options.singleton,

diff --git a/lib/sharing/utils.js b/lib/sharing/utils.js
@@ -8,6 8,7 @@
 const { join, dirname, readJson } = require("../util/fs");
 
 /** @typedef {import("../util/fs").InputFileSystem} InputFileSystem */
 /** @typedef {import("../../declarations/plugins/sharing/SharePlugin").SharedConfig} SharedConfig */
 
 // Extreme shorthand only for github. eg: foo/bar
 const RE_URL_GITHUB_EXTREME_SHORT = /^[^/@:.\s][^/@:\s]*\/[^@:\s]*[^/@:\s]#\S /;
@@ -310,6 311,24 @@ function isRequiredVersion(str) {
  return VERSION_PATTERN_REGEXP.test(str);
 }
 
 /**
  * Additional validation logic for share options
  * @param {[string, SharedConfig][]} options options
  */
 function validateShareOptions(options) {
  for (let [key, option] of options) {
  if (!!option.exclusionCriteria && option.singleton === true) {
  throw new Error(
  `Cannot supply exclusionCriteria and singleton: true together for ${key} in shared configuration.
  Please set singleton: false or remove the exclusionCriteria from shared config
  `
  );
  }
  }
 }
 
 exports.validateShareOptions = validateShareOptions;
 
 exports.isRequiredVersion = isRequiredVersion;
 
 /**