feat: match upstream behavior for custom scalar type generator

Author: jquense

package.json

@@ -77,13 +77,13 @@
     "@artsy/auto-config": "^1.0.0",
     "@types/graphql": "^14.2.3",
     "@types/invariant": "2.2.30",
-    "@types/jest": "^22.0.1",
+    "@types/jest": "^24.0.17",
     "@types/node": "8.10.51",
     "@types/relay-runtime": "^5.0.3",
     "graphql": "^14.4.2",
     "husky": "^3.0.2",
-    "jest": "^23.6.0",
-    "jest-cli": "^23.6.0",
+    "jest": "^24.8.0",
+    "jest-cli": "^24.8.0",
     "lint-staged": "^9.2.1",
     "prettier": "^1.18.2",
     "relay-compiler": "^4.0.0",

src/TypeScriptTypeTransformers.ts

@@ -1,5 +1,3 @@
-import * as ts from "typescript";
-
 import {
   GraphQLEnumType,
   GraphQLInputObjectType,
@@ -12,8 +10,8 @@ import {
   GraphQLType,
   GraphQLUnionType
 } from "graphql";
-
 import { TypeGeneratorOptions } from "relay-compiler";
+import * as ts from "typescript";
 
 export type ScalarTypeMapping = {
   [type: string]: string;
@@ -75,6 +73,7 @@ function transformGraphQLScalarType(
   type: GraphQLScalarType,
   state: State
 ): ts.TypeNode {
+  const customType = state.customScalars[type.name];
   switch (state.customScalars[type.name] || type.name) {
     case "ID":
     case "String":
@@ -85,8 +84,11 @@ function transformGraphQLScalarType(
       return ts.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
     case "Boolean":
       return ts.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
+
     default:
-      return ts.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
+      return customType
+        ? ts.createTypeReferenceNode(customType, undefined)
+        : ts.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
   }
 }
 

test/TypeScriptGenerator-test.ts

@@ -1,9 +1,11 @@
-import {generateTestsFromFixtures} from 'relay-test-utils/lib/RelayModernTestUtils'
+import {
+  GraphQLCompilerContext,
+  IRTransforms,
+  transformASTSchema,
+} from 'relay-compiler'
+import { generateTestsFromFixtures } from 'relay-test-utils/lib/RelayModernTestUtils'
 import * as RelayTestSchema from 'relay-test-utils/lib/RelayTestSchema'
 import * as parseGraphQLText from 'relay-test-utils/lib/parseGraphQLText'
-
-import {GraphQLCompilerContext, IRTransforms, transformASTSchema} from 'relay-compiler'
-
 import * as TypeScriptGenerator from '../src/TypeScriptGenerator'
 
 function generate(text, options) {
@@ -37,17 +39,19 @@ function generate(text, options) {
         username: String
       }
     `,
-  ]);
-  const {definitions} = parseGraphQLText(schema, text);
+  ])
+  const { definitions } = parseGraphQLText(schema, text)
   return new GraphQLCompilerContext(RelayTestSchema, schema)
     .addAll(definitions)
     .applyTransforms(TypeScriptGenerator.transforms)
     .documents()
-    .map(doc => TypeScriptGenerator.generate(doc, {
-      ...options,
-      schema,
-    }))
-    .join('\n\n');
+    .map(doc =>
+      TypeScriptGenerator.generate(doc, {
+        ...options,
+        schema,
+      })
+    )
+    .join('\n\n')
 }
 
 describe('TypeScriptGenerator with a single artifact directory', () => {
@@ -60,9 +64,9 @@ describe('TypeScriptGenerator with a single artifact directory', () => {
       relayRuntimeModule: 'relay-runtime',
       useHaste: false,
       useSingleArtifactDirectory: true,
-    }),
-  );
-});
+    })
+  )
+})
 
 describe('TypeScriptGenerator without a single artifact directory', () => {
   generateTestsFromFixtures(`${__dirname}/fixtures/type-generator`, text =>
@@ -74,16 +78,16 @@ describe('TypeScriptGenerator without a single artifact directory', () => {
       relayRuntimeModule: 'relay-runtime',
       useHaste: false,
       useSingleArtifactDirectory: false,
-    }),
-  );
-});
+    })
+  )
+})
 
 describe('Does not add `%future added values` when the noFutureProofEnums option is set', () => {
   const text = `
     fragment ScalarField on User {
       traits
     }
-  `;
+  `
   const types = generate(text, {
     customScalars: {},
     enumsHasteModule: null,
@@ -92,10 +96,40 @@ describe('Does not add `%future added values` when the noFutureProofEnums option
     relayRuntimeModule: 'relay-runtime',
     useHaste: false,
     noFutureProofEnums: true,
-  });
+  })
 
   // Without the option, PersonalityTraits would be `"CHEERFUL" | ... | "%future added value");`
   expect(types).toContain(
-    'export type PersonalityTraits = "CHEERFUL" | "DERISIVE" | "HELPFUL" | "SNARKY";',
-  );
-});
+    'export type PersonalityTraits = "CHEERFUL" | "DERISIVE" | "HELPFUL" | "SNARKY";'
+  )
+})
+
+describe.each`
+  mapping     | type
+  ${'String'} | ${'string'}
+  ${'Url'}    | ${'string'}
+  ${'ID'}     | ${'string'}
+  ${'Int'}    | ${'number'}
+  ${'Color'}  | ${'Color'}
+  ${'{}'}     | ${'{}'}
+  ${'[]'}     | ${'[]'}
+`('Custom scalar mapping $mapping to $type', ({ mapping, type }) => {
+  const text = `
+    fragment Test on User {
+        color
+    }
+  `
+  const types = generate(text, {
+    customScalars: {
+      Color: mapping,
+    },
+    enumsHasteModule: null,
+    existingFragmentNames: new Set(['PhotoFragment']),
+    optionalInputFields: [],
+    relayRuntimeModule: 'relay-runtime',
+    useHaste: false,
+    useSingleArtifactDirectory: true,
+  })
+
+  expect(types).toContain(`color: ${type} | null`)
+})