@graphql-tools/federation 4.2.9 → 4.2.10-alpha-5aa2a8cb6ef1d254393e7926d9b26759d3df4901

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @graphql-tools/federation
 
+## 4.2.10-alpha-5aa2a8cb6ef1d254393e7926d9b26759d3df4901
+### Patch Changes
+
+
+
+- [#1916](https://github.com/graphql-hive/gateway/pull/1916) [`5aa2a8c`](https://github.com/graphql-hive/gateway/commit/5aa2a8cb6ef1d254393e7926d9b26759d3df4901) Thanks [@ardatan](https://github.com/ardatan)! - Do not pass `percent(x)` labels to the progressive override handler
+
+
+
+- [#1916](https://github.com/graphql-hive/gateway/pull/1916) [`5aa2a8c`](https://github.com/graphql-hive/gateway/commit/5aa2a8cb6ef1d254393e7926d9b26759d3df4901) Thanks [@ardatan](https://github.com/ardatan)! - Handle the type merging order correctly with custom labels and percentage labels for progressive override
+
 ## 4.2.9
 ### Patch Changes
 

package/dist/index.cjs

@@ -25,6 +25,92 @@ function getEnvStr(key, opts = {}) {
   return variable?.trim();
 }
 
+// Regexps involved with splitting words in various case formats.
+const SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
+const SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
+// Used to iterate over the initial split result and separate numbers.
+const SPLIT_SEPARATE_NUMBER_RE = /(\d)\p{Ll}|(\p{L})\d/u;
+// Regexp involved with stripping non-word characters from the result.
+const DEFAULT_STRIP_REGEXP = /[^\p{L}\d]+/giu;
+// The replacement value for splits.
+const SPLIT_REPLACE_VALUE = "$1\0$2";
+// The default characters to keep after transforming case.
+const DEFAULT_PREFIX_SUFFIX_CHARACTERS = "";
+/**
+ * Split any cased input strings into an array of words.
+ */
+function split(value) {
+    let result = value.trim();
+    result = result
+        .replace(SPLIT_LOWER_UPPER_RE, SPLIT_REPLACE_VALUE)
+        .replace(SPLIT_UPPER_UPPER_RE, SPLIT_REPLACE_VALUE);
+    result = result.replace(DEFAULT_STRIP_REGEXP, "\0");
+    let start = 0;
+    let end = result.length;
+    // Trim the delimiter from around the output string.
+    while (result.charAt(start) === "\0")
+        start++;
+    if (start === end)
+        return [];
+    while (result.charAt(end - 1) === "\0")
+        end--;
+    return result.slice(start, end).split(/\0/g);
+}
+/**
+ * Split the input string into an array of words, separating numbers.
+ */
+function splitSeparateNumbers(value) {
+    const words = split(value);
+    for (let i = 0; i < words.length; i++) {
+        const word = words[i];
+        const match = SPLIT_SEPARATE_NUMBER_RE.exec(word);
+        if (match) {
+            const offset = match.index + (match[1] ?? match[2]).length;
+            words.splice(i, 1, word.slice(0, offset), word.slice(offset));
+        }
+    }
+    return words;
+}
+/**
+ * Convert a string to constant case (`FOO_BAR`).
+ */
+function constantCase(input, options) {
+    const [prefix, words, suffix] = splitPrefixSuffix(input, options);
+    return (prefix +
+        words.map(upperFactory(options?.locale)).join("_") +
+        suffix);
+}
+function upperFactory(locale) {
+    return locale === false
+        ? (input) => input.toUpperCase()
+        : (input) => input.toLocaleUpperCase(locale);
+}
+function splitPrefixSuffix(input, options = {}) {
+    const splitFn = options.split ?? (options.separateNumbers ? splitSeparateNumbers : split);
+    const prefixCharacters = options.prefixCharacters ?? DEFAULT_PREFIX_SUFFIX_CHARACTERS;
+    const suffixCharacters = options.suffixCharacters ?? DEFAULT_PREFIX_SUFFIX_CHARACTERS;
+    let prefixIndex = 0;
+    let suffixIndex = input.length;
+    while (prefixIndex < input.length) {
+        const char = input.charAt(prefixIndex);
+        if (!prefixCharacters.includes(char))
+            break;
+        prefixIndex++;
+    }
+    while (suffixIndex > prefixIndex) {
+        const index = suffixIndex - 1;
+        const char = input.charAt(index);
+        if (!suffixCharacters.includes(char))
+            break;
+        suffixIndex = index;
+    }
+    return [
+        input.slice(0, prefixIndex),
+        splitFn(input.slice(prefixIndex, suffixIndex)),
+        input.slice(suffixIndex),
+    ];
+}
+
 const getArgsFromKeysForFederation = utils.memoize1(
   function getArgsFromKeysForFederation2(representations) {
     return { representations };
@@ -279,6 +365,7 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
   const orphanTypeMap = /* @__PURE__ */ new Map();
   const typeFieldASTMap = /* @__PURE__ */ new Map();
   const progressiveOverrideInfos = /* @__PURE__ */ new Map();
+  const progressiveOverrideInfosOpposite = /* @__PURE__ */ new Map();
   const overrideLabels = /* @__PURE__ */ new Set();
   for (const definition of supergraphAst.definitions) {
     if ("fields" in definition) {
@@ -461,7 +548,33 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                     from: overrideFromSubgraph,
                     label: overrideLabel
                   });
-                  overrideLabels.add(overrideLabel);
+                  if (!overrideLabel.startsWith("percent(")) {
+                    overrideLabels.add(overrideLabel);
+                  }
+                  const oppositeKey = constantCase(overrideFromSubgraph);
+                  let oppositeInfos = progressiveOverrideInfosOpposite.get(oppositeKey);
+                  if (!oppositeInfos) {
+                    oppositeInfos = /* @__PURE__ */ new Map();
+                    progressiveOverrideInfosOpposite.set(
+                      oppositeKey,
+                      oppositeInfos
+                    );
+                  }
+                  let existingOppositeInfos = oppositeInfos.get(
+                    typeNode.name.value
+                  );
+                  if (!existingOppositeInfos) {
+                    existingOppositeInfos = [];
+                    oppositeInfos.set(
+                      typeNode.name.value,
+                      existingOppositeInfos
+                    );
+                  }
+                  existingOppositeInfos.push({
+                    field: fieldNode.name.value,
+                    to: graphName,
+                    label: overrideLabel
+                  });
                 }
                 const providedExtraField = joinFieldDirectiveNode.arguments?.find(
                   (argumentNode) => argumentNode.name.value === "provides"
@@ -1239,6 +1352,37 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
         }
       }
     }
+    const progressiveOverrideOppositeInfosForSubgraph = progressiveOverrideInfosOpposite.get(constantCase(subgraphName));
+    if (progressiveOverrideOppositeInfosForSubgraph != null) {
+      for (const [
+        typeName,
+        fieldInfos
+      ] of progressiveOverrideOppositeInfosForSubgraph) {
+        let mergedConfig = mergeConfig[typeName];
+        if (!mergedConfig) {
+          mergedConfig = mergeConfig[typeName] = {};
+        }
+        for (const fieldInfo of fieldInfos) {
+          let fieldsConfig = mergedConfig.fields;
+          if (!fieldsConfig) {
+            fieldsConfig = mergedConfig.fields = {};
+          }
+          let fieldConfig = fieldsConfig[fieldInfo.field];
+          if (!fieldConfig) {
+            fieldConfig = fieldsConfig[fieldInfo.field] = {};
+          }
+          const label = fieldInfo.label;
+          const percent = extractPercentageFromLabel(label);
+          if (percent != null) {
+            const possibility = percent / 100;
+            fieldConfig.override = () => !progressiveOverridePossibilityHandler(possibility);
+          } else if (opts.handleProgressiveOverride) {
+            const progressiveOverrideHandler = opts.handleProgressiveOverride;
+            fieldConfig.override = (context, info) => !progressiveOverrideHandler(label, context, info);
+          }
+        }
+      }
+    }
     const subschemaConfig = {
       name: subgraphName,
       endpoint,

package/dist/index.d.cts

@@ -57,6 +57,11 @@ interface ProgressiveOverrideInfo {
     from: string;
     label: string;
 }
+interface ProgressiveOverrideInfoOpposite {
+    field: string;
+    to: string;
+    label: string;
+}
 declare function getStitchingOptionsFromSupergraphSdl(opts: GetStitchingOptionsFromSupergraphSdlOpts): {
     subschemas: SubschemaConfig<any, any, any, Record<string, any>>[];
     typeDefs: DocumentNode;
@@ -242,4 +247,4 @@ declare class SupergraphSchemaManager extends TypedEventTargetCtor<SupergraphSch
     [DisposableSymbols.dispose](): Promise<void>;
 }
 
-export { DEFAULT_UPLINKS, type FederationSubschemaConfig, type FetchError, type FetchSupergraphSdlFromManagedFederationOpts, type GetStitchedSchemaFromManagedFederationOpts, type GetStitchedSchemaFromSupergraphSdlOpts, type GetStitchingOptionsFromSupergraphSdlOpts, type ProgressiveOverrideHandler, type ProgressiveOverrideInfo, type RouterConfig, type RouterConfigWithSchema, SupergraphSchemaManager, type SupergraphSchemaManagerErrorEvent, type SupergraphSchemaManagerEvent, type SupergraphSchemaManagerFailureEvent, type SupergraphSchemaManagerLogEvent, type SupergraphSchemaManagerOptions, type SupergraphSchemaManagerSchemaEvent, type Unchanged, ensureSupergraphSDLAst, extractPercentageFromLabel, fetchSupergraphSdlFromManagedFederation, filterInternalFieldsAndTypes, getArgsFromKeysForFederation, getCacheKeyFnFromKey, getKeyFnForFederation, getNamedTypeNode, getStitchedSchemaFromManagedFederation, getStitchedSchemaFromSupergraphSdl, getStitchingOptionsFromSupergraphSdl, progressiveOverridePossibilityHandler, projectDataSelectionSet };
+export { DEFAULT_UPLINKS, type FederationSubschemaConfig, type FetchError, type FetchSupergraphSdlFromManagedFederationOpts, type GetStitchedSchemaFromManagedFederationOpts, type GetStitchedSchemaFromSupergraphSdlOpts, type GetStitchingOptionsFromSupergraphSdlOpts, type ProgressiveOverrideHandler, type ProgressiveOverrideInfo, type ProgressiveOverrideInfoOpposite, type RouterConfig, type RouterConfigWithSchema, SupergraphSchemaManager, type SupergraphSchemaManagerErrorEvent, type SupergraphSchemaManagerEvent, type SupergraphSchemaManagerFailureEvent, type SupergraphSchemaManagerLogEvent, type SupergraphSchemaManagerOptions, type SupergraphSchemaManagerSchemaEvent, type Unchanged, ensureSupergraphSDLAst, extractPercentageFromLabel, fetchSupergraphSdlFromManagedFederation, filterInternalFieldsAndTypes, getArgsFromKeysForFederation, getCacheKeyFnFromKey, getKeyFnForFederation, getNamedTypeNode, getStitchedSchemaFromManagedFederation, getStitchedSchemaFromSupergraphSdl, getStitchingOptionsFromSupergraphSdl, progressiveOverridePossibilityHandler, projectDataSelectionSet };

package/dist/index.d.ts

@@ -57,6 +57,11 @@ interface ProgressiveOverrideInfo {
     from: string;
     label: string;
 }
+interface ProgressiveOverrideInfoOpposite {
+    field: string;
+    to: string;
+    label: string;
+}
 declare function getStitchingOptionsFromSupergraphSdl(opts: GetStitchingOptionsFromSupergraphSdlOpts): {
     subschemas: SubschemaConfig<any, any, any, Record<string, any>>[];
     typeDefs: DocumentNode;
@@ -242,4 +247,4 @@ declare class SupergraphSchemaManager extends TypedEventTargetCtor<SupergraphSch
     [DisposableSymbols.dispose](): Promise<void>;
 }
 
-export { DEFAULT_UPLINKS, type FederationSubschemaConfig, type FetchError, type FetchSupergraphSdlFromManagedFederationOpts, type GetStitchedSchemaFromManagedFederationOpts, type GetStitchedSchemaFromSupergraphSdlOpts, type GetStitchingOptionsFromSupergraphSdlOpts, type ProgressiveOverrideHandler, type ProgressiveOverrideInfo, type RouterConfig, type RouterConfigWithSchema, SupergraphSchemaManager, type SupergraphSchemaManagerErrorEvent, type SupergraphSchemaManagerEvent, type SupergraphSchemaManagerFailureEvent, type SupergraphSchemaManagerLogEvent, type SupergraphSchemaManagerOptions, type SupergraphSchemaManagerSchemaEvent, type Unchanged, ensureSupergraphSDLAst, extractPercentageFromLabel, fetchSupergraphSdlFromManagedFederation, filterInternalFieldsAndTypes, getArgsFromKeysForFederation, getCacheKeyFnFromKey, getKeyFnForFederation, getNamedTypeNode, getStitchedSchemaFromManagedFederation, getStitchedSchemaFromSupergraphSdl, getStitchingOptionsFromSupergraphSdl, progressiveOverridePossibilityHandler, projectDataSelectionSet };
+export { DEFAULT_UPLINKS, type FederationSubschemaConfig, type FetchError, type FetchSupergraphSdlFromManagedFederationOpts, type GetStitchedSchemaFromManagedFederationOpts, type GetStitchedSchemaFromSupergraphSdlOpts, type GetStitchingOptionsFromSupergraphSdlOpts, type ProgressiveOverrideHandler, type ProgressiveOverrideInfo, type ProgressiveOverrideInfoOpposite, type RouterConfig, type RouterConfigWithSchema, SupergraphSchemaManager, type SupergraphSchemaManagerErrorEvent, type SupergraphSchemaManagerEvent, type SupergraphSchemaManagerFailureEvent, type SupergraphSchemaManagerLogEvent, type SupergraphSchemaManagerOptions, type SupergraphSchemaManagerSchemaEvent, type Unchanged, ensureSupergraphSDLAst, extractPercentageFromLabel, fetchSupergraphSdlFromManagedFederation, filterInternalFieldsAndTypes, getArgsFromKeysForFederation, getCacheKeyFnFromKey, getKeyFnForFederation, getNamedTypeNode, getStitchedSchemaFromManagedFederation, getStitchedSchemaFromSupergraphSdl, getStitchingOptionsFromSupergraphSdl, progressiveOverridePossibilityHandler, projectDataSelectionSet };

package/dist/index.js

@@ -23,6 +23,92 @@ function getEnvStr(key, opts = {}) {
   return variable?.trim();
 }
 
+// Regexps involved with splitting words in various case formats.
+const SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
+const SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
+// Used to iterate over the initial split result and separate numbers.
+const SPLIT_SEPARATE_NUMBER_RE = /(\d)\p{Ll}|(\p{L})\d/u;
+// Regexp involved with stripping non-word characters from the result.
+const DEFAULT_STRIP_REGEXP = /[^\p{L}\d]+/giu;
+// The replacement value for splits.
+const SPLIT_REPLACE_VALUE = "$1\0$2";
+// The default characters to keep after transforming case.
+const DEFAULT_PREFIX_SUFFIX_CHARACTERS = "";
+/**
+ * Split any cased input strings into an array of words.
+ */
+function split(value) {
+    let result = value.trim();
+    result = result
+        .replace(SPLIT_LOWER_UPPER_RE, SPLIT_REPLACE_VALUE)
+        .replace(SPLIT_UPPER_UPPER_RE, SPLIT_REPLACE_VALUE);
+    result = result.replace(DEFAULT_STRIP_REGEXP, "\0");
+    let start = 0;
+    let end = result.length;
+    // Trim the delimiter from around the output string.
+    while (result.charAt(start) === "\0")
+        start++;
+    if (start === end)
+        return [];
+    while (result.charAt(end - 1) === "\0")
+        end--;
+    return result.slice(start, end).split(/\0/g);
+}
+/**
+ * Split the input string into an array of words, separating numbers.
+ */
+function splitSeparateNumbers(value) {
+    const words = split(value);
+    for (let i = 0; i < words.length; i++) {
+        const word = words[i];
+        const match = SPLIT_SEPARATE_NUMBER_RE.exec(word);
+        if (match) {
+            const offset = match.index + (match[1] ?? match[2]).length;
+            words.splice(i, 1, word.slice(0, offset), word.slice(offset));
+        }
+    }
+    return words;
+}
+/**
+ * Convert a string to constant case (`FOO_BAR`).
+ */
+function constantCase(input, options) {
+    const [prefix, words, suffix] = splitPrefixSuffix(input, options);
+    return (prefix +
+        words.map(upperFactory(options?.locale)).join("_") +
+        suffix);
+}
+function upperFactory(locale) {
+    return locale === false
+        ? (input) => input.toUpperCase()
+        : (input) => input.toLocaleUpperCase(locale);
+}
+function splitPrefixSuffix(input, options = {}) {
+    const splitFn = options.split ?? (options.separateNumbers ? splitSeparateNumbers : split);
+    const prefixCharacters = options.prefixCharacters ?? DEFAULT_PREFIX_SUFFIX_CHARACTERS;
+    const suffixCharacters = options.suffixCharacters ?? DEFAULT_PREFIX_SUFFIX_CHARACTERS;
+    let prefixIndex = 0;
+    let suffixIndex = input.length;
+    while (prefixIndex < input.length) {
+        const char = input.charAt(prefixIndex);
+        if (!prefixCharacters.includes(char))
+            break;
+        prefixIndex++;
+    }
+    while (suffixIndex > prefixIndex) {
+        const index = suffixIndex - 1;
+        const char = input.charAt(index);
+        if (!suffixCharacters.includes(char))
+            break;
+        suffixIndex = index;
+    }
+    return [
+        input.slice(0, prefixIndex),
+        splitFn(input.slice(prefixIndex, suffixIndex)),
+        input.slice(suffixIndex),
+    ];
+}
+
 const getArgsFromKeysForFederation = memoize1(
   function getArgsFromKeysForFederation2(representations) {
     return { representations };
@@ -277,6 +363,7 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
   const orphanTypeMap = /* @__PURE__ */ new Map();
   const typeFieldASTMap = /* @__PURE__ */ new Map();
   const progressiveOverrideInfos = /* @__PURE__ */ new Map();
+  const progressiveOverrideInfosOpposite = /* @__PURE__ */ new Map();
   const overrideLabels = /* @__PURE__ */ new Set();
   for (const definition of supergraphAst.definitions) {
     if ("fields" in definition) {
@@ -459,7 +546,33 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
                     from: overrideFromSubgraph,
                     label: overrideLabel
                   });
-                  overrideLabels.add(overrideLabel);
+                  if (!overrideLabel.startsWith("percent(")) {
+                    overrideLabels.add(overrideLabel);
+                  }
+                  const oppositeKey = constantCase(overrideFromSubgraph);
+                  let oppositeInfos = progressiveOverrideInfosOpposite.get(oppositeKey);
+                  if (!oppositeInfos) {
+                    oppositeInfos = /* @__PURE__ */ new Map();
+                    progressiveOverrideInfosOpposite.set(
+                      oppositeKey,
+                      oppositeInfos
+                    );
+                  }
+                  let existingOppositeInfos = oppositeInfos.get(
+                    typeNode.name.value
+                  );
+                  if (!existingOppositeInfos) {
+                    existingOppositeInfos = [];
+                    oppositeInfos.set(
+                      typeNode.name.value,
+                      existingOppositeInfos
+                    );
+                  }
+                  existingOppositeInfos.push({
+                    field: fieldNode.name.value,
+                    to: graphName,
+                    label: overrideLabel
+                  });
                 }
                 const providedExtraField = joinFieldDirectiveNode.arguments?.find(
                   (argumentNode) => argumentNode.name.value === "provides"
@@ -1237,6 +1350,37 @@ function getStitchingOptionsFromSupergraphSdl(opts) {
         }
       }
     }
+    const progressiveOverrideOppositeInfosForSubgraph = progressiveOverrideInfosOpposite.get(constantCase(subgraphName));
+    if (progressiveOverrideOppositeInfosForSubgraph != null) {
+      for (const [
+        typeName,
+        fieldInfos
+      ] of progressiveOverrideOppositeInfosForSubgraph) {
+        let mergedConfig = mergeConfig[typeName];
+        if (!mergedConfig) {
+          mergedConfig = mergeConfig[typeName] = {};
+        }
+        for (const fieldInfo of fieldInfos) {
+          let fieldsConfig = mergedConfig.fields;
+          if (!fieldsConfig) {
+            fieldsConfig = mergedConfig.fields = {};
+          }
+          let fieldConfig = fieldsConfig[fieldInfo.field];
+          if (!fieldConfig) {
+            fieldConfig = fieldsConfig[fieldInfo.field] = {};
+          }
+          const label = fieldInfo.label;
+          const percent = extractPercentageFromLabel(label);
+          if (percent != null) {
+            const possibility = percent / 100;
+            fieldConfig.override = () => !progressiveOverridePossibilityHandler(possibility);
+          } else if (opts.handleProgressiveOverride) {
+            const progressiveOverrideHandler = opts.handleProgressiveOverride;
+            fieldConfig.override = (context, info) => !progressiveOverrideHandler(label, context, info);
+          }
+        }
+      }
+    }
     const subschemaConfig = {
       name: subgraphName,
       endpoint,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/federation",
-  "version": "4.2.9",
+  "version": "4.2.10-alpha-5aa2a8cb6ef1d254393e7926d9b26759d3df4901",
   "type": "module",
   "description": "Useful tools to create and manipulate GraphQL schemas.",
   "repository": {
@@ -59,6 +59,7 @@
     "@apollo/server-gateway-interface": "^2.0.0",
     "@apollo/subgraph": "^2.11.3",
     "@types/lodash": "4.17.23",
+    "change-case": "^5.4.4",
     "graphql": "^16.12.0",
     "graphql-federation-gateway-audit": "graphql-hive/federation-gateway-audit#cc224d26da54ad1c2393dfef3346893c315f351d",
     "pkgroll": "2.23.0"