Detect composed directives without spec

the-guild-org · Dec 15, 2023 · 9195942 · 9195942
1 parent 3196317
commit 9195942
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 0 deletions.
diff --git a/.changeset/nasty-ligers-exercise.md b/.changeset/nasty-ligers-exercise.md
@@ -0,0 +1,5 @@
+---
+'@theguild/federation-composition': minor
+---
+
+Detect composed directives without spec
diff --git a/__tests__/subgraph/errors/DIRECTIVE_COMPOSITION_ERROR.spec.ts b/__tests__/subgraph/errors/DIRECTIVE_COMPOSITION_ERROR.spec.ts
@@ -58,5 +58,37 @@ testVersions((api, version) => {
         ]),
       }),
     );
+
+    expect(
+      api.composeServices([
+        {
+          name: 'foo',
+          typeDefs: graphql`
+          directive @composeDirective(name: String!) repeatable on SCHEMA
+          directive @block on FIELD_DEFINITION
+          extend schema @link(url: "https://specs.apollo.dev/federation/${version}", import: ["@composeDirective"]) @composeDirective(name: "@block")
+
+         type Query {
+          foo: String @block
+         } 
+        `,
+        },
+      ]),
+    ).toEqual(
+      expect.objectContaining({
+        errors: expect.arrayContaining([
+          version === 'v2.0'
+            ? expect.any(Object)
+            : expect.objectContaining({
+                message: expect.stringContaining(
+                  `Directive "@block" in subgraph "foo" cannot be composed because it is not a member of a core feature`,
+                ),
+                extensions: expect.objectContaining({
+                  code: 'DIRECTIVE_COMPOSITION_ERROR',
+                }),
+              }),
+        ]),
+      }),
+    );
   });
 });
diff --git a/src/subgraph/validation/rules/elements/compose-directive.ts b/src/subgraph/validation/rules/elements/compose-directive.ts
@@ -28,6 +28,30 @@ export function ComposeDirectiveRules(context: SubgraphValidationContext): ASTVi
       const matchingDirective = definedDirectives.find(directive => directive.name.value === name);
 
       if (matchingDirective) {
+        // check if it has a linked spec
+        const hasSpec = context.stateBuilder.state.links.some(link =>
+          link.imports.some(
+            im =>
+              im.kind === 'directive' &&
+              (im.alias ? im.alias.replace(/^@/, '') === name : im.name.replace(/^@/, '') === name),
+          ),
+        );
+
+        if (!hasSpec) {
+          context.reportError(
+            new GraphQLError(
+              `Directive "@${name}" in subgraph "${context.getSubgraphName()}" cannot be composed because it is not a member of a core feature`,
+              {
+                extensions: {
+                  code: 'DIRECTIVE_COMPOSITION_ERROR',
+                  subgraphName: context.getSubgraphName(),
+                },
+              },
+            ),
+          );
+          return;
+        }
+
         context.stateBuilder.directive.setComposed(matchingDirective.name.value);
         context.stateBuilder.composedDirectives.add(matchingDirective.name.value);
       } else {