Plural support for @deleteRecord directive (#3135)

Summary:
This adds support for using the new `deleteRecord` directive on a list of `ID` in addition to a single `ID`.

There's a few things around the implementation I'm looking for guidance on before this is ready for a real review.

Pull Request resolved: #3135

Reviewed By: tyao1

Differential Revision: D22932169

Pulled By: josephsavona

fbshipit-source-id: cf52a694153cf54df0dbcfec3ac8508f0be6620c

Author: zth

packages/relay-compiler/transforms/DeclarativeConnectionMutationTransform.js

@@ -65,11 +65,14 @@ function visitScalarField(field: ScalarField): ScalarField {
     return field;
   }
   const schema = this.getContext().getSchema();
-  if (!schema.isId(field.type)) {
+
+  if (!schema.isId(schema.getRawType(field.type))) {
     throw createUserError(
       `Invalid use of @${DELETE_RECORD} on field '${
         field.name
-      }'. Expected field type ID, got ${schema.getTypeString(field.type)}.`,
+      }'. Expected field to return an ID or list of ID values, got ${schema.getTypeString(
+        field.type,
+      )}.`,
       [deleteDirective.loc],
     );
   }

packages/relay-compiler/transforms/__tests__/__snapshots__/DeclarativeConnectionMutationTransform-test.js.snap

@@ -79,6 +79,25 @@ mutation CommentDeleteMutation(
 
 `;
 
+exports[`matches expected output: delete-from-store-plural.graphql 1`] = `
+~~~~~~~~~~ INPUT ~~~~~~~~~~
+mutation CommentsDeleteMutation($input: CommentsDeleteInput) {
+  commentsDelete(input: $input) {
+    deletedCommentIds @deleteRecord
+  }
+}
+
+~~~~~~~~~~ OUTPUT ~~~~~~~~~~
+mutation CommentsDeleteMutation(
+  $input: CommentsDeleteInput
+) {
+  commentsDelete(input: $input) {
+    deletedCommentIds @__clientField(handle: "deleteRecord")
+  }
+}
+
+`;
+
 exports[`matches expected output: delete-on-unspported-type.invalid.graphql 1`] = `
 ~~~~~~~~~~ INPUT ~~~~~~~~~~
 # expected-to-throw
@@ -91,7 +110,7 @@ mutation CommentDeleteMutation($input: CommentDeleteInput) {
 ~~~~~~~~~~ OUTPUT ~~~~~~~~~~
 THROWN EXCEPTION:
 
-Invalid use of @deleteRecord on field '__typename'. Expected field type ID, got String!.
+Invalid use of @deleteRecord on field '__typename'. Expected field to return an ID or list of ID values, got String!.
 
 Source: GraphQL request (4:16)
 3:   commentDelete(input: $input) {

packages/relay-compiler/transforms/__tests__/fixtures/declarative-connection-mutation-transform/delete-from-store-plural.graphql

@@ -0,0 +1,5 @@
+mutation CommentsDeleteMutation($input: CommentsDeleteInput) {
+  commentsDelete(input: $input) {
+    deletedCommentIds @deleteRecord
+  }
+}

packages/relay-runtime/handlers/connection/MutationHandlers.js

@@ -27,10 +27,18 @@ import type {
 const DeleteRecordHandler = {
   update: (store: RecordSourceProxy, payload: HandleFieldPayload) => {
     const record = store.get(payload.dataID);
+
     if (record != null) {
-      const id = record.getValue(payload.fieldKey);
-      if (typeof id === 'string') {
-        store.delete(id);
+      const idOrIds = record.getValue(payload.fieldKey);
+
+      if (typeof idOrIds === 'string') {
+        store.delete(idOrIds);
+      } else if (Array.isArray(idOrIds)) {
+        idOrIds.forEach(id => {
+          if (typeof id === 'string') {
+            store.delete(id);
+          }
+        });
       }
     }
   },

packages/relay-runtime/store/__tests__/RelayModernEnvironment-ExecuteMutationWithDeclarativeMutation-test.js

@@ -107,6 +107,7 @@ type Mutation {
   ): ApplicationRequestDeleteAllResponsePayload
   commentCreate(input: CommentCreateInput): CommentCreateResponsePayload
   commentDelete(input: CommentDeleteInput): CommentDeleteResponsePayload
+  commentsDelete(input: CommentsDeleteInput): CommentsDeleteResponsePayload
   feedbackLike(input: FeedbackLikeInput): FeedbackLikeResponsePayload
   feedbackLikeStrict(
     input: FeedbackLikeInputStrict!
@@ -167,6 +168,11 @@ input CommentDeleteInput {
   commentId: ID
 }
 
+input CommentsDeleteInput {
+  clientMutationId: String
+  commentIds: [ID]
+}
+
 input FeedbackLikeInput {
   clientMutationId: String
   feedbackId: ID
@@ -312,6 +318,12 @@ type CommentDeleteResponsePayload {
   feedback: Feedback
 }
 
+type CommentsDeleteResponsePayload {
+  clientMutationId: String
+  deletedCommentIds: [ID]
+  feedback: Feedback
+}
+
 type CommentsConnection {
   count: Int
   edges: [CommentsEdge]