fix Cannot read property 'some' of undefined in apollo-server-c… (#2924)

fix Cannot read property 'some' of undefined in apollo-server-core/di…
apollographql · Jun 26, 2019 · 5d4b790 · 5d4b790
2 parents 34ba026 + 489cbb4
commit 5d4b790
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ The version headers in this history reflect the versions of Apollo Server itself
 
 > The changes noted within this `vNEXT` section have not been released yet.  New PRs and commits which introduce changes should include an entry in this `vNEXT` section as part of their development.  When a release is being prepared, a new header will be (manually) created below and the the appropriate changes within that release will be moved into the new section.
 
+- `apollo-server-core`: Guard against undefined property access in `isDirectiveDefined`. [PR #2924](https://github.com/apollographql/apollo-server/pull/2924)
+
 ### v2.6.6
 
 - `apollo-server-core`: Avoid duplicate `cacheControl` directives being added via `isDirectiveDefined`, re-landing the implementation reverted in v2.6.1 which first surfaced in v2.6.0. [PR #2762](https://github.com/apollographql/apollo-server/pull/2762) [Reversion PR #2754](https://github.com/apollographql/apollo-server/pull/2754) [Original PR #2428](https://github.com/apollographql/apollo-server/pull/2428)

diff --git a/packages/apollo-server-core/src/ApolloServer.ts b/packages/apollo-server-core/src/ApolloServer.ts
@@ -269,7 +269,7 @@ export class ApolloServerBase {
         );
       }
 
-      let augmentedTypeDefs = Array.isArray(typeDefs) ? typeDefs : [typeDefs];
+      const augmentedTypeDefs = Array.isArray(typeDefs) ? typeDefs : [typeDefs];
 
       // We augment the typeDefs with the @cacheControl directive and associated
       // scope enum, so makeExecutableSchema won't fail SDL validation

diff --git a/packages/apollo-server-core/src/__tests__/isDirectiveDefined.test.ts b/packages/apollo-server-core/src/__tests__/isDirectiveDefined.test.ts
@@ -23,6 +23,19 @@ describe('isDirectiveDefined', () => {
     ) on FIELD_DEFINITION | OBJECT | INTERFACE
   `;
 
+  describe('When passed a DocumentNode', () => {
+    it('returns false when a directive is not defined', () => {
+      expect(isDirectiveDefined(gql(noCacheControl), 'cacheControl')).toBe(
+        false,
+      );
+    });
+    it('returns true when a directive is defined', () => {
+      expect(isDirectiveDefined(gql(hasCacheControl), 'cacheControl')).toBe(
+        true,
+      );
+    });
+  });
+
   describe('When passed an array of DocumentNode', () => {
     it('returns false when a directive is not defined', () => {
       expect(isDirectiveDefined([gql(noCacheControl)], 'cacheControl')).toBe(
@@ -36,6 +49,15 @@ describe('isDirectiveDefined', () => {
     });
   });
 
+  describe('When passed an array of strings', () => {
+    it('returns false when a directive is not defined', () => {
+      expect(isDirectiveDefined([noCacheControl], 'cacheControl')).toBe(false);
+    });
+    it('returns true when a directive is defined', () => {
+      expect(isDirectiveDefined([hasCacheControl], 'cacheControl')).toBe(true);
+    });
+  });
+
   describe('When passed a string', () => {
     it('returns false when a directive is not defined', () => {
       expect(isDirectiveDefined(noCacheControl, 'cacheControl')).toBe(false);

diff --git a/packages/apollo-server-core/src/types.ts b/packages/apollo-server-core/src/types.ts
@@ -68,7 +68,7 @@ type BaseConfig = Pick<
 // fields that are not specific to a single integration
 export interface Config extends BaseConfig {
   modules?: GraphQLSchemaModule[];
-  typeDefs?: DocumentNode | Array<DocumentNode>;
+  typeDefs?: DocumentNode | Array<DocumentNode> | string | Array<string>;
   parseOptions?: GraphQLParseOptions;
   resolvers?: IResolvers;
   schema?: GraphQLSchema;

diff --git a/packages/apollo-server-core/src/utils/isDirectiveDefined.ts b/packages/apollo-server-core/src/utils/isDirectiveDefined.ts
@@ -2,17 +2,21 @@ import { DocumentNode, Kind } from 'graphql/language';
 import { gql } from '../';
 
 export const isDirectiveDefined = (
-  typeDefs: DocumentNode[] | string,
+  typeDefs: (DocumentNode | string)[],
   directiveName: string,
 ): boolean => {
-  if (typeof typeDefs === 'string') {
-    return isDirectiveDefined([gql(typeDefs)], directiveName);
-  }
-  return typeDefs.some(typeDef =>
-    typeDef.definitions.some(
+  // If we didn't receive an array of what we want, ensure it's an array.
+  typeDefs = Array.isArray(typeDefs) ? typeDefs : [typeDefs];
+
+  return typeDefs.some(typeDef => {
+    if (typeof typeDef === 'string') {
+      typeDef = gql(typeDef);
+    }
+
+    return typeDef.definitions.some(
       definition =>
         definition.kind === Kind.DIRECTIVE_DEFINITION &&
         definition.name.value === directiveName,
-    ),
-  );
+    );
+  });
 };