Add matchingEnums to sdl validation rules

apollographql · Jun 14, 2019 · 006fde4 · 006fde4
1 parent bab5b34
commit 006fde4
Show file tree

Hide file tree

Showing 10 changed files with 531 additions and 259 deletions.
diff --git a/packages/apollo-federation/src/composition/__tests__/compose.test.ts b/packages/apollo-federation/src/composition/__tests__/compose.test.ts
diff --git a/packages/apollo-federation/src/composition/__tests__/composeAndValidate.test.ts b/packages/apollo-federation/src/composition/__tests__/composeAndValidate.test.ts
@@ -206,46 +206,3 @@ it('errors on invalid usages of default operation names', () => {
 });
 
 it.todo('errors on duplicate types where there is a mismatch of field types');
-
-fit('does not error with duplicate enums', () => {
-  const serviceA = {
-    typeDefs: gql`
-      type Query {
-        products: [Product]!
-      }
-
-      type Product @key(fields: "sku") {
-        sku: String!
-        upc: String!
-        type: ProductType
-      }
-
-      enum ProductType {
-        FURNITURE
-        BOOK
-        DIGITAL
-      }
-    `,
-    name: 'serviceA',
-  };
-
-  const serviceB = {
-    typeDefs: gql`
-      type Product @extends @key(fields: "sku") {
-        sku: String! @external
-        price: Int! @requires(fields: "sku")
-        productType: ProductType
-      }
-
-      enum ProductType {
-        FURNITURE
-        BOOK
-        DIGITAL
-      }
-    `,
-    name: 'serviceB',
-  };
-
-  const { schema, errors } = composeAndValidate([serviceA, serviceB]);
-  expect(errors).toHaveLength(0);
-});
diff --git a/packages/apollo-federation/src/composition/compose.ts b/packages/apollo-federation/src/composition/compose.ts
@@ -4,7 +4,6 @@ import {
   GraphQLSchema,
   extendSchema,
   Kind,
-  TypeDefinitionNode,
   TypeExtensionNode,
   isTypeDefinitionNode,
   isTypeExtensionNode,
@@ -33,13 +32,21 @@ import {
   ServiceName,
   ExternalFieldDefinition,
   ServiceNameToKeyDirectivesMap,
+  FederatedTypeDefinitionNode,
 } from './types';
 import { validateSDL } from 'graphql/validation/validate';
 import { compositionRules } from './rules';
 
+// type FederatedTypeDefinitionNode = TypeDefinitionNode & {
+//   serviceName: string | null
+// }
 // Map of all definitions to eventually be passed to extendSchema
+// interface DefinitionsMapEntry {
+//   definition: TypeDefinitionNode;
+//   serviceName: string | null;
+// }
 interface DefinitionsMap {
-  [name: string]: TypeDefinitionNode[];
+  [name: string]: FederatedTypeDefinitionNode[];
 }
 // Map of all extensions to eventually be passed to extendSchema
 interface ExtensionsMap {
@@ -157,9 +164,9 @@ export function buildMapsFromServiceList(serviceList: ServiceDefinition[]) {
          * take precedence). If not, create the definitions array and add it to the definitionsMap.
          */
         if (definitionsMap[typeName]) {
-          definitionsMap[typeName].push(definition);
+          definitionsMap[typeName].push({ ...definition, serviceName });
         } else {
-          definitionsMap[typeName] = [definition];
+          definitionsMap[typeName] = [{ ...definition, serviceName }];
         }
       } else if (isTypeExtensionNode(definition)) {
         const typeName = definition.name.value;
@@ -240,6 +247,7 @@ export function buildMapsFromServiceList(serviceList: ServiceDefinition[]) {
           kind: Kind.OBJECT_TYPE_DEFINITION,
           name: { kind: Kind.NAME, value: extensionTypeName },
           fields: [],
+          serviceName: null,
         },
       ];
 
@@ -266,6 +274,7 @@ export function buildSchemaFromDefinitionsAndExtensions({
   extensionsMap: ExtensionsMap;
 }) {
   let errors: GraphQLError[] | undefined = undefined;
+
   let schema = new GraphQLSchema({
     query: undefined,
     directives: [...specifiedDirectives, ...federationDirectives],

diff --git a/packages/apollo-federation/src/composition/rules.ts b/packages/apollo-federation/src/composition/rules.ts
@@ -1,6 +1,9 @@
 import { specifiedSDLRules } from 'graphql/validation/specifiedRules';
 
-import { UniqueTypeNamesWithoutEnumsOrScalars } from './validate/sdl';
+import {
+  UniqueTypeNamesWithoutEnumsOrScalars,
+  matchingEnums,
+} from './validate/sdl';
 
 const omit = [
   'UniqueDirectivesPerLocation',
@@ -10,4 +13,4 @@ const omit = [
 
 export const compositionRules = specifiedSDLRules
   .filter(rule => !omit.includes(rule.name))
-  .concat([UniqueTypeNamesWithoutEnumsOrScalars]);
+  .concat([UniqueTypeNamesWithoutEnumsOrScalars, matchingEnums]);
diff --git a/packages/apollo-federation/src/composition/types.ts b/packages/apollo-federation/src/composition/types.ts
@@ -1,4 +1,9 @@
-import { SelectionNode, DocumentNode, FieldDefinitionNode } from 'graphql';
+import {
+  SelectionNode,
+  DocumentNode,
+  FieldDefinitionNode,
+  TypeDefinitionNode,
+} from 'graphql';
 
 export type ServiceName = string | null;
 
@@ -74,3 +79,7 @@ declare module 'graphql/type/definition' {
     federation?: FederationField;
   }
 }
+
+export type FederatedTypeDefinitionNode = TypeDefinitionNode & {
+  serviceName: string | null;
+};
diff --git a/packages/apollo-federation/src/composition/validate/preComposition/duplicateEnumOrScalar.ts b/packages/apollo-federation/src/composition/validate/preComposition/duplicateEnumOrScalar.ts
@@ -1,9 +1,4 @@
-import {
-  visit,
-  GraphQLError,
-  EnumTypeDefinitionNode,
-  ScalarTypeDefinitionNode,
-} from 'graphql';
+import { visit, GraphQLError } from 'graphql';
 import { ServiceDefinition } from '../../types';
 
 import { logServiceAndType, errorWithCode } from '../../utils';
@@ -15,8 +10,8 @@ export const duplicateEnumOrScalar = ({
   const errors: GraphQLError[] = [];
 
   // keep track of every enum and scalar and error if there are ever duplicates
-  const enums: EnumTypeDefinitionNode[] = [];
-  const scalars: ScalarTypeDefinitionNode[] = [];
+  const enums: string[] = [];
+  const scalars: string[] = [];
 
   visit(typeDefs, {
     EnumTypeDefinition(definition) {

diff --git a/packages/apollo-federation/src/composition/validate/preComposition/duplicateEnumValue.ts b/packages/apollo-federation/src/composition/validate/preComposition/duplicateEnumValue.ts
@@ -1,4 +1,4 @@
-import { visit, GraphQLError, EnumTypeDefinitionNode } from 'graphql';
+import { visit, GraphQLError } from 'graphql';
 import { ServiceDefinition } from '../../types';
 
 import { logServiceAndType, errorWithCode } from '../../utils';
@@ -9,12 +9,15 @@ export const duplicateEnumValue = ({
 }: ServiceDefinition) => {
   const errors: GraphQLError[] = [];
 
-  const enums: Map<String, String[]> = {};
+  const enums: { [name: string]: string[] } = {};
 
   visit(typeDefs, {
     EnumTypeDefinition(definition) {
       const name = definition.name.value;
-      const enumValues = definition.values.map(value => value.name.value);
+      const enumValues =
+        definition.values && definition.values.map(value => value.name.value);
+
+      if (!enumValues) return definition;
 
       if (enums[name] && enums[name].length) {
         enumValues.map(valueName => {
@@ -38,7 +41,10 @@ export const duplicateEnumValue = ({
     },
     EnumTypeExtension(definition) {
       const name = definition.name.value;
-      const enumValues = definition.values.map(value => value.name.value);
+      const enumValues =
+        definition.values && definition.values.map(value => value.name.value);
+
+      if (!enumValues) return definition;
 
       if (enums[name] && enums[name].length) {
         enumValues.map(valueName => {