Merge pull request #112 from relay-tools/feat/v4

feat(relay): Upgrade to version 4

Author: alloy

package.json

@@ -52,7 +52,7 @@
   "peerDependencies": {
     "@types/react-relay": ">=1.3.9",
     "@types/relay-runtime": ">=1.3.5",
-    "relay-compiler": ">=2.0.0",
+    "relay-compiler": ">=4.0.0",
     "relay-runtime": "*",
     "typescript": ">=2.9.1"
   },
@@ -69,9 +69,9 @@
     "jest-cli": "^23.6.0",
     "lint-staged": "^7.3.0",
     "prettier": "^1.10.2",
-    "relay-compiler": "^2.0.0",
-    "relay-runtime": "^2.0.0",
-    "relay-test-utils": "^2.0.0",
+    "relay-compiler": "^4.0.0",
+    "relay-runtime": "^4.0.0",
+    "relay-test-utils": "^4.0.0",
     "ts-jest": "^22.0.1",
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.15.0",

src/TypeScriptGenerator.ts

@@ -1,9 +1,13 @@
 import {
+  Fragment,
   IRTransforms,
+  IRVisitor,
+  Root,
+  SchemaUtils,
   TypeGenerator,
   TypeGeneratorOptions
 } from "relay-compiler";
-import * as RelayCompilerPublic from "relay-compiler/lib/RelayCompilerPublic";
+import * as RelayCompilerPublic from "relay-compiler";
 
 import { GraphQLNonNull } from "graphql";
 import * as ts from "typescript";
@@ -14,13 +18,6 @@ import {
   transformScalarType
 } from "./TypeScriptTypeTransformers";
 
-// Get the types
-import * as GraphQLCompilerTypes from "graphql-compiler";
-
-const GraphQLCompiler: typeof GraphQLCompilerTypes = RelayCompilerPublic;
-
-const { IRVisitor, SchemaUtils } = GraphQLCompiler;
-
 const { isAbstractType } = SchemaUtils;
 
 const REF_TYPE = " $refType";
@@ -241,7 +238,7 @@ function mergeSelections(a: SelectionMap, b: SelectionMap): SelectionMap {
   return merged;
 }
 
-function isPlural(node: GraphQLCompilerTypes.Fragment): boolean {
+function isPlural(node: Fragment): boolean {
   return Boolean(node.metadata && node.metadata.plural);
 }
 
@@ -472,10 +469,7 @@ function generateInputObjectTypes(state: State) {
   });
 }
 
-function generateInputVariablesType(
-  node: GraphQLCompilerTypes.Root,
-  state: State
-) {
+function generateInputVariablesType(node: Root, state: State) {
   return exportType(
     `${node.name}Variables`,
     exactObjectTypeAnnotation(
@@ -593,8 +587,12 @@ function getRefTypeName(name: string): string {
   return `${name}$ref`;
 }
 
+// Should match FLOW_TRANSFORMS array
+// https://github.com/facebook/relay/blob/v4.0.0/packages/relay-compiler/language/javascript/RelayFlowGenerator.js#L621-L627
 export const transforms: TypeGenerator["transforms"] = [
-  IRTransforms.commonTransforms[2], // RelayRelayDirectiveTransform.transform
-  IRTransforms.commonTransforms[3], // RelayMaskTransform.transform
-  IRTransforms.printTransforms[0] // FlattenTransform.transformWithOptions({})
+  IRTransforms.commonTransforms[1], // RelayRelayDirectiveTransform.transform,
+  IRTransforms.commonTransforms[2], // RelayMaskTransform.transform,
+  IRTransforms.commonTransforms[3], // RelayMatchTransform.transform,
+  IRTransforms.printTransforms[3], // FlattenTransform.transformWithOptions({}),
+  IRTransforms.commonTransforms[4] // RelayRefetchableFragmentTransform.transform,
 ];

test/TypeScriptGenerator-test.ts

@@ -10,13 +10,43 @@ function generate(text, options) {
   const schema = transformASTSchema(RelayTestSchema, [
     IRTransforms.schemaExtensions[1], // RelayMatchTransform.SCHEMA_EXTENSION,
     IRTransforms.schemaExtensions[2], // RelayRelayDirectiveTransform.SCHEMA_EXTENSION,
+    `
+      scalar Color
+      extend type User {
+        color: Color
+      }
+      type ExtraUser implements Actor {
+        address: StreetAddress
+        allPhones: [Phone]
+        birthdate: Date
+        emailAddresses: [String]
+        firstName(if: Boolean, unless: Boolean): String
+        friends(after: ID, before: ID, first: Int, last: Int, orderby: [String], find: String, isViewerFriend: Boolean, if: Boolean, unless: Boolean, traits: [PersonalityTraits]): FriendsConnection
+        hometown: Page
+        id: ID!
+        lastName: String
+        name: String
+        nameRenderer(supported: [String!]!): UserNameRenderer
+        nameRenderable(supported: [String!]!): UserNameRenderable
+        profilePicture(size: [Int], preset: PhotoSize): Image
+        screennames: [Screenname]
+        subscribeStatus: String
+        subscribers(first: Int): SubscribersConnection
+        url(relative: Boolean, site: String): String
+        websites: [String]
+        username: String
+      }
+    `,
   ]);
   const {definitions} = parseGraphQLText(schema, text);
   return new GraphQLCompilerContext(RelayTestSchema, schema)
     .addAll(definitions)
     .applyTransforms(TypeScriptGenerator.transforms)
     .documents()
-    .map(doc => TypeScriptGenerator.generate(doc, options))
+    .map(doc => TypeScriptGenerator.generate(doc, {
+      ...options,
+      schema,
+    }))
     .join('\n\n');
 }