work with initialCount

facebook · Jul 7, 2020 · b58a501 · b58a501
1 parent e441592
commit b58a501
Show file tree

Hide file tree

Showing 10 changed files with 160 additions and 12 deletions.
diff --git a/packages/relay-compiler/core/IR.js b/packages/relay-compiler/core/IR.js
@@ -109,7 +109,7 @@ export type Stream = {|
   +selections: $ReadOnlyArray<Selection>,
   +label: string,
   +if: ArgumentValue | null,
-  +initialCount: ArgumentValue,
+  +initialCount: Argument,
   +useCustomizedBatch: ArgumentValue | null,
 |};
 

diff --git a/packages/relay-compiler/core/IRPrinter.js b/packages/relay-compiler/core/IRPrinter.js
@@ -197,9 +197,9 @@ function printSelection(
       streamStr += `, if: ${printValue(schema, selection.if, null) ?? ''}`;
     }
     if (selection.initialCount !== null) {
-      streamStr += `, initial_count: ${printValue(
+      streamStr += `, ${selection.initialCount.name}: ${printValue(
         schema,
-        selection.initialCount,
+        selection.initialCount.value,
         null,
       ) ?? ''}`;
     }

diff --git a/packages/relay-compiler/transforms/ApplyFragmentArgumentTransform.js b/packages/relay-compiler/transforms/ApplyFragmentArgumentTransform.js
@@ -165,9 +165,9 @@ function transformDeferStreamNode<T: Defer | Stream>(
   }
   if (nextNode.initialCount) {
     //$FlowFixMe nextNode is uniquely owned
-    nextNode.initialCount = transformValue(
+    nextNode.initialCount.value = transformValue(
       scope,
-      nextNode.initialCount,
+      nextNode.initialCount.value,
       errorContext,
     );
   }

diff --git a/packages/relay-compiler/transforms/ConnectionTransform.js b/packages/relay-compiler/transforms/ConnectionTransform.js
@@ -109,7 +109,8 @@ const SCHEMA_EXTENSION = `
     key: String!
     filters: [String]
     handler: String
-    initial_count: Int!
+    initial_count: Int
+    initialCount: Int
     if: Boolean = true
     use_customized_batch: Boolean = false
     dynamicKey_UNSTABLE: String
@@ -294,7 +295,7 @@ function buildConnectionArguments(
   let stream = null;
   if (connectionDirective.name === STREAM_CONNECTION) {
     const initialCountArg = connectionDirective.args.find(
-      arg => arg.name === 'initial_count',
+      arg => arg.name === 'initial_count' || arg.name === 'initialCount',
     );
     const useCustomizedBatchArg = connectionDirective.args.find(
       arg => arg.name === 'use_customized_batch',

diff --git a/packages/relay-compiler/transforms/DeferStreamTransform.js b/packages/relay-compiler/transforms/DeferStreamTransform.js
@@ -118,11 +118,11 @@ function visitLinkedField(
     return transformedField;
   }
   const initialCount = streamDirective.args.find(
-    arg => arg.name === 'initial_count',
+    arg => arg.name === 'initial_count' || arg.name === 'initialCount',
   );
   if (initialCount == null) {
     throw createUserError(
-      "Invalid use of @stream, the 'initial_count' argument is required.",
+      "Invalid use of @stream, the 'initial_count' or 'initialCount' argument is required.",
       [streamDirective.loc],
     );
   }
@@ -136,7 +136,7 @@ function visitLinkedField(
   state.recordLabel(transformedLabel, streamDirective);
   return {
     if: ifArg?.value ?? null,
-    initialCount: initialCount.value,
+    initialCount: initialCount,
     useCustomizedBatch: useCustomizedBatch?.value ?? null,
     kind: 'Stream',
     label: transformedLabel,

diff --git a/packages/relay-compiler/transforms/__tests__/__snapshots__/ConnectionTransform-test.js.snap b/packages/relay-compiler/transforms/__tests__/__snapshots__/ConnectionTransform-test.js.snap
@@ -1137,6 +1137,82 @@ query NodeQuery(
 }
 `;
 
+exports[`matches expected output: stream-connection-oss.graphql 1`] = `
+~~~~~~~~~~ INPUT ~~~~~~~~~~
+query NodeQuery($id: ID!) {
+  node(id: $id) {
+    id
+    ... on Story {
+      comments(first: 10)
+        @stream_connection(key: "NodeQuery_comments", initialCount: 0) {
+        edges {
+          node {
+            actor {
+              name
+            }
+          }
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+      }
+    }
+  }
+}
+
+~~~~~~~~~~ OUTPUT ~~~~~~~~~~
+query NodeQuery(
+  $id: ID!
+) {
+  node(id: $id) {
+    id
+    ... on Story {
+      comments(first: 10) @__clientField(handle: "connection", key: "NodeQuery_comments") {
+        edges @stream(initialCount: 0, label: "NodeQuery_comments") {
+          node {
+            actor {
+              name
+            }
+          }
+          ... on CommentsEdge {
+            cursor
+            node {
+              __typename
+            }
+          }
+        }
+        ... @defer(label: "NodeQuery$defer$NodeQuery_comments$pageInfo") {
+          pageInfo {
+            endCursor
+            hasNextPage
+            ... on PageInfo {
+              endCursor
+              hasNextPage
+            }
+          }
+        }
+      }
+    }
+  }
+}
+# Metadata:
+{
+  "connection": [
+    {
+      "count": null,
+      "cursor": null,
+      "direction": "forward",
+      "path": [
+        "node",
+        "comments"
+      ],
+      "stream": true
+    }
+  ]
+}
+`;
+
 exports[`matches expected output: stream-connection-with-aliased-edges.invalid.graphql 1`] = `
 ~~~~~~~~~~ INPUT ~~~~~~~~~~
 # expected-to-throw

diff --git a/packages/relay-compiler/transforms/__tests__/__snapshots__/DeferStreamTransform-test.js.snap b/packages/relay-compiler/transforms/__tests__/__snapshots__/DeferStreamTransform-test.js.snap
@@ -446,6 +446,42 @@ fragment FeedbackFragment on Feedback {
 
 `;
 
+exports[`DeferStreamTransform when streaming is enabled matches expected output: fragment-with-stream-initial-count-arg-oss.graphql 1`] = `
+~~~~~~~~~~ INPUT ~~~~~~~~~~
+query QueryWithFragmentWithStream($id: ID!, $initialCount: Int) {
+  node(id: $id) {
+    id
+    ...FeedbackFragment
+  }
+}
+
+fragment FeedbackFragment on Feedback {
+  id
+  actors @stream(initialCount: $initialCount, label: "StreamedActorsLabel") {
+    name
+  }
+}
+
+~~~~~~~~~~ OUTPUT ~~~~~~~~~~
+query QueryWithFragmentWithStream(
+  $id: ID!
+  $initialCount: Int
+) {
+  node(id: $id) {
+    id
+    ...FeedbackFragment
+  }
+}
+
+fragment FeedbackFragment on Feedback {
+  id
+  actors @stream(label: "FeedbackFragment$stream$StreamedActorsLabel", initialCount: $initialCount) {
+    name
+  }
+}
+
+`;
+
 exports[`DeferStreamTransform when streaming is enabled matches expected output: fragment-with-stream-missing-initial-count-arg.invalid.graphql 1`] = `
 ~~~~~~~~~~ INPUT ~~~~~~~~~~
 # expected-to-throw
@@ -467,7 +503,7 @@ fragment FeedbackFragment on Feedback {
 ~~~~~~~~~~ OUTPUT ~~~~~~~~~~
 THROWN EXCEPTION:
 
-Invalid use of @stream, the 'initial_count' argument is required.
+Invalid use of @stream, the 'initial_count' or 'initialCount' argument is required.
 
 Source: GraphQL request (11:10)
 10:   id

diff --git a/...compiler/transforms/__tests__/fixtures/connection-transform/stream-connection-oss.graphql b/...compiler/transforms/__tests__/fixtures/connection-transform/stream-connection-oss.graphql
@@ -0,0 +1,21 @@
+query NodeQuery($id: ID!) {
+  node(id: $id) {
+    id
+    ... on Story {
+      comments(first: 10)
+        @stream_connection(key: "NodeQuery_comments", initialCount: 0) {
+        edges {
+          node {
+            actor {
+              name
+            }
+          }
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+      }
+    }
+  }
+}
diff --git a/.../fixtures/relay-defer-stream-transform/fragment-with-stream-initial-count-arg-oss.graphql b/.../fixtures/relay-defer-stream-transform/fragment-with-stream-initial-count-arg-oss.graphql
@@ -0,0 +1,13 @@
+query QueryWithFragmentWithStream($id: ID!, $initialCount: Int) {
+  node(id: $id) {
+    id
+    ...FeedbackFragment
+  }
+}
+
+fragment FeedbackFragment on Feedback {
+  id
+  actors @stream(initialCount: $initialCount, label: "StreamedActorsLabel") {
+    name
+  }
+}
diff --git a/packages/relay-test-utils-internal/testschema.graphql b/packages/relay-test-utils-internal/testschema.graphql
@@ -17,7 +17,8 @@ directive @defer(
 
 directive @stream(
   label: String!
-  initial_count: Int!
+  initial_count: Int
+  initialCount: Int
   if: Boolean = true
   use_customized_batch: Boolean = false
 ) on FIELD