relay-runtime 10.0.1 → 10.1.0

package/lib/util/reportMissingRequiredFields.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * 
+ * @emails oncall+relay
+ * @format
+ */
+'use strict';
+
+function reportMissingRequiredFields(environment, missingRequiredFields) {
+  switch (missingRequiredFields.action) {
+    case 'THROW':
+      {
+        var _missingRequiredField = missingRequiredFields.field,
+            path = _missingRequiredField.path,
+            owner = _missingRequiredField.owner; // This gives the consumer the chance to throw their own error if they so wish.
+
+        environment.requiredFieldLogger({
+          kind: 'missing_field.throw',
+          owner: owner,
+          fieldPath: path
+        });
+        throw new Error("Relay: Missing @required value at path '".concat(path, "' in '").concat(owner, "'."));
+      }
+
+    case 'LOG':
+      missingRequiredFields.fields.forEach(function (_ref) {
+        var path = _ref.path,
+            owner = _ref.owner;
+        environment.requiredFieldLogger({
+          kind: 'missing_field.log',
+          owner: owner,
+          fieldPath: path
+        });
+      });
+      break;
+
+    default:
+      {
+        missingRequiredFields.action;
+      }
+  }
+}
+
+module.exports = reportMissingRequiredFields;

package/mutations/commitMutation.js.flow

@@ -13,7 +13,6 @@
 'use strict';
 
 const RelayDeclarativeMutationConfig = require('./RelayDeclarativeMutationConfig');
-const RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
 const invariant = require('invariant');
 const isRelayModernEnvironment = require('../store/isRelayModernEnvironment');
@@ -115,6 +114,7 @@ function commitMutation<T: MutationParameters>(
   const operation = createOperationDescriptor(
     mutation,
     variables,
+    cacheConfig,
     generateUniqueClientID(),
   );
   // TODO: remove this check after we fix flow.
@@ -142,7 +142,6 @@ function commitMutation<T: MutationParameters>(
   const errors = [];
   const subscription = environment
     .executeMutation({
-      cacheConfig,
       operation,
       optimisticResponse,
       optimisticUpdater,

package/mutations/validateMutation.js.flow

@@ -19,16 +19,19 @@ import type {
 import type {ConcreteRequest} from '../util/RelayConcreteNode';
 import type {Variables} from '../util/RelayRuntimeTypes';
 
-type ValidationContext = {
+type ValidationContext = {|
   visitedPaths: Set<string>,
   path: string,
   variables: Variables,
   missingDiff: Object,
   extraDiff: Object,
-  ...
-};
+  moduleImportPaths: Set<string>,
+|};
+
 const warning = require('warning');
 
+const hasOwnProperty = Object.prototype.hasOwnProperty;
+
 let validateMutation = () => {};
 if (__DEV__) {
   const addFieldToDiff = (path: string, diff: Object, isScalar) => {
@@ -55,6 +58,7 @@ if (__DEV__) {
       variables: variables || {},
       missingDiff: {},
       extraDiff: {},
+      moduleImportPaths: new Set(),
     };
     validateSelections(
       optimisticResponse,
@@ -97,6 +101,7 @@ if (__DEV__) {
         return;
       case 'ScalarField':
       case 'LinkedField':
+      case 'FlightField':
         return validateField(optimisticResponse, selection, context);
       case 'InlineFragment':
         const type = selection.type;
@@ -114,6 +119,7 @@ if (__DEV__) {
         });
         return;
       case 'ModuleImport':
+        return validateModuleImport(context);
       case 'LinkedHandle':
       case 'ScalarHandle':
       case 'Defer':
@@ -128,6 +134,10 @@ if (__DEV__) {
     }
   };
 
+  const validateModuleImport = (context: ValidationContext) => {
+    context.moduleImportPaths.add(context.path);
+  };
+
   const validateField = (
     optimisticResponse: Object,
     field: NormalizationField,
@@ -138,7 +148,7 @@ if (__DEV__) {
     context.visitedPaths.add(path);
     switch (field.kind) {
       case 'ScalarField':
-        if (optimisticResponse.hasOwnProperty(fieldName) === false) {
+        if (hasOwnProperty.call(optimisticResponse, fieldName) === false) {
           addFieldToDiff(path, context.missingDiff, true);
         }
         return;
@@ -146,7 +156,7 @@ if (__DEV__) {
         const selections = field.selections;
         if (
           optimisticResponse[fieldName] === null ||
-          (Object.hasOwnProperty(fieldName) &&
+          (hasOwnProperty.call(optimisticResponse, fieldName) &&
             optimisticResponse[fieldName] === undefined)
         ) {
           return;
@@ -178,6 +188,21 @@ if (__DEV__) {
             return;
           }
         }
+      case 'FlightField':
+        if (
+          optimisticResponse[fieldName] === null ||
+          (hasOwnProperty.call(optimisticResponse, fieldName) &&
+            optimisticResponse[fieldName] === undefined)
+        ) {
+          return;
+        }
+        throw new Error(
+          'validateMutation: Flight fields are not compatible with ' +
+            'optimistic updates, as React does not have the component code ' +
+            'necessary to process new data on the client. Instead, you ' +
+            'should update your code to require a full refetch of the Flight ' +
+            'field so your UI can be updated.',
+        );
     }
   };
 
@@ -196,6 +221,10 @@ if (__DEV__) {
     Object.keys(optimisticResponse).forEach((key: string) => {
       const value = optimisticResponse[key];
       const path = `${context.path}.${key}`;
+      // if it's a module import path we don't have an ast so we cannot validate it
+      if (context.moduleImportPaths.has(path)) {
+        return;
+      }
       if (!context.visitedPaths.has(path)) {
         addFieldToDiff(path, context.extraDiff);
         return;

package/network/RelayNetworkTypes.js.flow

@@ -121,3 +121,25 @@ export type SubscribeFunction = (
 
 export type Uploadable = File | Blob;
 export type UploadableMap = {[key: string]: Uploadable, ...};
+
+/**
+ * React Flight tree created on the server.
+ */
+export type ReactFlightServerTree = mixed;
+export type ReactFlightPayloadQuery = {|
+  +id: mixed,
+  +module: mixed,
+  +response: GraphQLSingularResponse,
+  +variables: Variables,
+|};
+/**
+ * Data that is returned by a Flight compliant GraphQL server.
+ *
+ * - tree: an array of values that will be iterated and fed into
+ *     ReactFlightDOMRelayClient.
+ * - queries: an array of queries that the server preloaded for the client.
+ */
+export type ReactFlightPayloadData = {|
+  +tree: Array<ReactFlightServerTree>,
+  +queries: Array<ReactFlightPayloadQuery>,
+|};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "10.0.1",
+  "version": "10.1.0",
   "keywords": [
     "graphql",
     "relay"
@@ -12,7 +12,7 @@
   "repository": "facebook/relay",
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "fbjs": "^1.0.0"
+    "fbjs": "^3.0.0"
   },
   "directories": {
     "": "./"

package/query/GraphQLTag.js.flow

@@ -44,7 +44,8 @@ function graphql(strings: Array<string>): GraphQLTaggedNode {
     false,
     'graphql: Unexpected invocation at runtime. Either the Babel transform ' +
       'was not set up, or it failed to identify this call site. Make sure it ' +
-      'is being used verbatim as `graphql`.',
+      'is being used verbatim as `graphql`. Note also that there cannot be ' +
+      'a space between graphql and the backtick that follows.',
   );
 }
 
@@ -155,6 +156,7 @@ function getInlineDataFragment(
 
 module.exports = {
   getFragment,
+  getNode,
   getPaginationFragment,
   getRefetchableFragment,
   getRequest,

package/query/fetchQuery.js.flow

@@ -37,9 +37,9 @@ function fetchQuery<T: OperationType>(
   if (query.params.operationKind !== 'query') {
     throw new Error('fetchQuery: Expected query operation');
   }
-  const operation = createOperationDescriptor(query, variables);
+  const operation = createOperationDescriptor(query, variables, cacheConfig);
   return environment
-    .execute({operation, cacheConfig})
+    .execute({operation})
     .map(() => environment.lookup(operation.fragment).data)
     .toPromise();
 }

package/query/fetchQueryInternal.js.flow

@@ -24,7 +24,6 @@ import type {
   OperationDescriptor,
   RequestDescriptor,
 } from '../store/RelayStoreTypes';
-import type {CacheConfig} from '../util/RelayRuntimeTypes';
 import type {RequestIdentifier} from '../util/getRequestIdentifier';
 
 type RequestCacheEntry = {|
@@ -106,14 +105,10 @@ const requestCachesByEnvironment = WEAKMAP_SUPPORTED
 function fetchQuery(
   environment: IEnvironment,
   operation: OperationDescriptor,
-  options?: {|
-    networkCacheConfig?: CacheConfig,
-  |},
 ): Observable<GraphQLResponse> {
   return fetchQueryDeduped(environment, operation.request.identifier, () =>
     environment.execute({
       operation,
-      cacheConfig: options?.networkCacheConfig,
     }),
   );
 }