@theguild/federation-composition 0.5.0 → 0.5.1-rc-20231215091130-d3bef86

package/README.md

@@ -98,6 +98,21 @@ pnpm test
 - Look for `skipIf` or `skip` in the tests.
 - Refactor code (piece by piece) if you feel like it.
 
+### Compatibility
+
+The lack of a publicly available specification for Apollo Federation, coupled with the non
+open-source license of the Apollo Composition library, makes it difficult or even impossible to
+assure complete compatibility of our open-source composition library.
+
+Given that Apollo tools utilize their composition library, there is a potential for conflicting
+results between our composition library and Apollo's. This may lead to variations in the supergraph,
+differing composition errors, or, in some cases, conflicting composition outcomes.
+
+We are working to ensure that our composition library is as compatible as possible with Apollo's and
+will continue to do so as we learn more about the Federation specification.
+
+Your feedback and bug reports are welcome and appreciated.
+
 ## Supergraph SDL Composition
 
 ✅ Done

package/cjs/graphql/helpers.js

@@ -1,8 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDirectiveDefinition = void 0;
+exports.moveSchemaAndDirectiveDefinitionsToTop = exports.isDirectiveDefinition = void 0;
 const graphql_1 = require("graphql");
 function isDirectiveDefinition(node) {
     return node.kind === graphql_1.Kind.DIRECTIVE_DEFINITION;
 }
 exports.isDirectiveDefinition = isDirectiveDefinition;
+const kindOrderWeightMap = {
+    [graphql_1.Kind.SCHEMA_DEFINITION]: 0,
+    [graphql_1.Kind.SCHEMA_EXTENSION]: 1,
+    [graphql_1.Kind.DIRECTIVE_DEFINITION]: 2,
+};
+function moveSchemaAndDirectiveDefinitionsToTop(ast) {
+    return {
+        kind: graphql_1.Kind.DOCUMENT,
+        definitions: ast.definitions.slice().sort((a, b) => {
+            const aWeight = kindOrderWeightMap[a.kind] ?? 3;
+            const bWeight = kindOrderWeightMap[b.kind] ?? 3;
+            if (aWeight === bWeight) {
+                return 0;
+            }
+            return aWeight < bWeight ? -1 : 1;
+        }),
+    };
+}
+exports.moveSchemaAndDirectiveDefinitionsToTop = moveSchemaAndDirectiveDefinitionsToTop;

package/cjs/supergraph/composition/object-type.js

@@ -4,11 +4,20 @@ exports.objectTypeBuilder = exports.isRealExtension = void 0;
 const ast_js_1 = require("./ast.js");
 const common_js_1 = require("./common.js");
 function isRealExtension(meta, version) {
-    return meta.extension
-        ? meta.extensionType !== '@extends' && version === 'v1.0'
-            ? false
-            : true
-        : false;
+    const hasExtendsDirective = meta.extensionType === '@extends';
+    if (meta.extension) {
+        if (version === 'v1.0' && !hasExtendsDirective) {
+            return false;
+        }
+        if (hasExtendsDirective) {
+            return true;
+        }
+        if (meta.hasDefinition) {
+            return false;
+        }
+        return true;
+    }
+    return false;
 }
 exports.isRealExtension = isRealExtension;
 function objectTypeBuilder() {
@@ -42,6 +51,7 @@ function objectTypeBuilder() {
             }
             type.interfaces.forEach(interfaceName => objectTypeState.interfaces.add(interfaceName));
             objectTypeState.byGraph.set(graph.id, {
+                hasDefinition: isDefinition,
                 extension: type.extension,
                 extensionType: type.extensionType,
                 external: type.external,
@@ -50,6 +60,7 @@ function objectTypeBuilder() {
                 shareable: type.shareable,
                 interfaces: type.interfaces,
             });
+            const typeInGraph = objectTypeState.byGraph.get(graph.id);
             for (const field of type.fields.values()) {
                 const fieldState = getOrCreateField(objectTypeState, field.name, field.type);
                 field.tags.forEach(tag => fieldState.tags.add(tag));
@@ -58,7 +69,7 @@ function objectTypeBuilder() {
                     fieldState.usedAsKey = true;
                 }
                 const isExternal = graph.version === 'v1.0'
-                    ? field.external && isRealExtension(type, graph.version)
+                    ? field.external && isRealExtension(typeInGraph, graph.version)
                     : field.external;
                 const shouldForceType = !usedAsKey && !isExternal && !fieldState.internal.seenNonExternal;
                 const shouldChangeType = shouldForceType ||
@@ -117,7 +128,7 @@ function objectTypeBuilder() {
                     if (arg.inaccessible) {
                         argState.inaccessible = true;
                     }
-                    if (!field.external) {
+                    if (arg.description && !argState.description) {
                         argState.description = arg.description;
                     }
                     if (arg.deprecated && !argState.deprecated) {

package/cjs/validate.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validate = exports.validateSubgraph = void 0;
 const constant_case_1 = require("constant-case");
+const helpers_js_1 = require("./graphql/helpers.js");
 const federation_js_1 = require("./specifications/federation.js");
 const state_js_1 = require("./subgraph/state.js");
 const validate_subgraph_js_1 = require("./subgraph/validation/validate-subgraph.js");
@@ -39,7 +40,7 @@ function buildGraphList(subgraphs) {
                 name,
                 id: proposedId + '_' + (count + 1),
                 url,
-                typeDefs,
+                typeDefs: (0, helpers_js_1.moveSchemaAndDirectiveDefinitionsToTop)(typeDefs),
             });
             idCounter.set(proposedId, count + 1);
         }
@@ -49,7 +50,7 @@ function buildGraphList(subgraphs) {
                 name,
                 id: proposedId,
                 url,
-                typeDefs,
+                typeDefs: (0, helpers_js_1.moveSchemaAndDirectiveDefinitionsToTop)(typeDefs),
             });
         }
     }

package/esm/graphql/helpers.js

@@ -2,3 +2,21 @@ import { Kind } from 'graphql';
 export function isDirectiveDefinition(node) {
     return node.kind === Kind.DIRECTIVE_DEFINITION;
 }
+const kindOrderWeightMap = {
+    [Kind.SCHEMA_DEFINITION]: 0,
+    [Kind.SCHEMA_EXTENSION]: 1,
+    [Kind.DIRECTIVE_DEFINITION]: 2,
+};
+export function moveSchemaAndDirectiveDefinitionsToTop(ast) {
+    return {
+        kind: Kind.DOCUMENT,
+        definitions: ast.definitions.slice().sort((a, b) => {
+            const aWeight = kindOrderWeightMap[a.kind] ?? 3;
+            const bWeight = kindOrderWeightMap[b.kind] ?? 3;
+            if (aWeight === bWeight) {
+                return 0;
+            }
+            return aWeight < bWeight ? -1 : 1;
+        }),
+    };
+}

package/esm/supergraph/composition/object-type.js

@@ -1,11 +1,20 @@
 import { createObjectTypeNode } from './ast.js';
 import { convertToConst } from './common.js';
 export function isRealExtension(meta, version) {
-    return meta.extension
-        ? meta.extensionType !== '@extends' && version === 'v1.0'
-            ? false
-            : true
-        : false;
+    const hasExtendsDirective = meta.extensionType === '@extends';
+    if (meta.extension) {
+        if (version === 'v1.0' && !hasExtendsDirective) {
+            return false;
+        }
+        if (hasExtendsDirective) {
+            return true;
+        }
+        if (meta.hasDefinition) {
+            return false;
+        }
+        return true;
+    }
+    return false;
 }
 export function objectTypeBuilder() {
     return {
@@ -38,6 +47,7 @@ export function objectTypeBuilder() {
             }
             type.interfaces.forEach(interfaceName => objectTypeState.interfaces.add(interfaceName));
             objectTypeState.byGraph.set(graph.id, {
+                hasDefinition: isDefinition,
                 extension: type.extension,
                 extensionType: type.extensionType,
                 external: type.external,
@@ -46,6 +56,7 @@ export function objectTypeBuilder() {
                 shareable: type.shareable,
                 interfaces: type.interfaces,
             });
+            const typeInGraph = objectTypeState.byGraph.get(graph.id);
             for (const field of type.fields.values()) {
                 const fieldState = getOrCreateField(objectTypeState, field.name, field.type);
                 field.tags.forEach(tag => fieldState.tags.add(tag));
@@ -54,7 +65,7 @@ export function objectTypeBuilder() {
                     fieldState.usedAsKey = true;
                 }
                 const isExternal = graph.version === 'v1.0'
-                    ? field.external && isRealExtension(type, graph.version)
+                    ? field.external && isRealExtension(typeInGraph, graph.version)
                     : field.external;
                 const shouldForceType = !usedAsKey && !isExternal && !fieldState.internal.seenNonExternal;
                 const shouldChangeType = shouldForceType ||
@@ -113,7 +124,7 @@ export function objectTypeBuilder() {
                     if (arg.inaccessible) {
                         argState.inaccessible = true;
                     }
-                    if (!field.external) {
+                    if (arg.description && !argState.description) {
                         argState.description = arg.description;
                     }
                     if (arg.deprecated && !argState.deprecated) {

package/esm/validate.js

@@ -1,4 +1,5 @@
 import { constantCase } from 'constant-case';
+import { moveSchemaAndDirectiveDefinitionsToTop } from './graphql/helpers.js';
 import { detectFederationVersion } from './specifications/federation.js';
 import { cleanSubgraphStateFromFederationSpec, cleanSubgraphStateFromLinkSpec, createSubgraphStateBuilder, } from './subgraph/state.js';
 import { validateSubgraph as internal_validateSubgraph, validateSubgraphCore, } from './subgraph/validation/validate-subgraph.js';
@@ -36,7 +37,7 @@ function buildGraphList(subgraphs) {
                 name,
                 id: proposedId + '_' + (count + 1),
                 url,
-                typeDefs,
+                typeDefs: moveSchemaAndDirectiveDefinitionsToTop(typeDefs),
             });
             idCounter.set(proposedId, count + 1);
         }
@@ -46,7 +47,7 @@ function buildGraphList(subgraphs) {
                 name,
                 id: proposedId,
                 url,
-                typeDefs,
+                typeDefs: moveSchemaAndDirectiveDefinitionsToTop(typeDefs),
             });
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theguild/federation-composition",
-  "version": "0.5.0",
+  "version": "0.5.1-rc-20231215091130-d3bef86",
   "description": "Open Source Composition library for Apollo Federation",
   "peerDependencies": {
     "graphql": "^16.0.0"

package/typings/graphql/helpers.d.cts

@@ -1,3 +1,4 @@
-import { type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
+import { DocumentNode, type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
 export declare function isDirectiveDefinition(node: DefinitionNode): node is DirectiveDefinitionNode;
+export declare function moveSchemaAndDirectiveDefinitionsToTop(ast: DocumentNode): DocumentNode;
 //# sourceMappingURL=helpers.d.ts.map

package/typings/graphql/helpers.d.ts

@@ -1,3 +1,4 @@
-import { type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
+import { DocumentNode, type DefinitionNode, type DirectiveDefinitionNode } from 'graphql';
 export declare function isDirectiveDefinition(node: DefinitionNode): node is DirectiveDefinitionNode;
+export declare function moveSchemaAndDirectiveDefinitionsToTop(ast: DocumentNode): DocumentNode;
 //# sourceMappingURL=helpers.d.ts.map

package/typings/supergraph/composition/object-type.d.cts

@@ -55,6 +55,7 @@ export type ObjectTypeFieldArgState = {
     };
 };
 export type ObjectTypeStateInGraph = {
+    hasDefinition: boolean;
     extension: boolean;
     extensionType?: '@extends' | 'extend';
     external: boolean;

package/typings/supergraph/composition/object-type.d.ts

@@ -55,6 +55,7 @@ export type ObjectTypeFieldArgState = {
     };
 };
 export type ObjectTypeStateInGraph = {
+    hasDefinition: boolean;
     extension: boolean;
     extensionType?: '@extends' | 'extend';
     external: boolean;