relay-runtime 13.0.0 → 13.0.1

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.0.0
+ * Relay v13.0.1
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js.flow

@@ -70,6 +70,7 @@ const RelayProfiler = require('./util/RelayProfiler');
 const RelayReplaySubject = require('./util/RelayReplaySubject');
 const reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
 const stableCopy = require('./util/stableCopy');
+const withProvidedVariables = require('./util/withProvidedVariables');
 
 export type {ConnectionMetadata} from './handlers/connection/ConnectionHandler';
 export type {
@@ -362,5 +363,6 @@ module.exports = {
     getPromiseForActiveRequest: fetchQueryInternal.getPromiseForActiveRequest,
     getObservableForActiveRequest:
       fetchQueryInternal.getObservableForActiveRequest,
+    withProvidedVariables: withProvidedVariables,
   },
 };

package/lib/index.js

@@ -121,6 +121,8 @@ var reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
 
 var stableCopy = require('./util/stableCopy');
 
+var withProvidedVariables = require('./util/withProvidedVariables');
+
 // As early as possible, check for the existence of the JavaScript globals which
 // Relay Runtime relies upon, and produce a clear message if they do not exist.
 if (process.env.NODE_ENV !== "production") {
@@ -239,6 +241,7 @@ module.exports = {
     fetchQuery: fetchQueryInternal.fetchQuery,
     fetchQueryDeduped: fetchQueryInternal.fetchQueryDeduped,
     getPromiseForActiveRequest: fetchQueryInternal.getPromiseForActiveRequest,
-    getObservableForActiveRequest: fetchQueryInternal.getObservableForActiveRequest
+    getObservableForActiveRequest: fetchQueryInternal.getObservableForActiveRequest,
+    withProvidedVariables: withProvidedVariables
   }
 };

package/lib/mutations/readUpdatableQuery_EXPERIMENTAL.js

@@ -37,7 +37,7 @@ function readUpdatableQuery_EXPERIMENTAL(query, variables, proxy) {
 }
 
 function updateProxyFromSelections(mutableUpdatableProxy, recordProxy, queryVariables, selections, root) {
-  var _selection$alias, _selection$alias2;
+  var _selection$alias3;
 
   var _iterator = (0, _createForOfIteratorHelper2["default"])(selections),
       _step;
@@ -48,21 +48,23 @@ function updateProxyFromSelections(mutableUpdatableProxy, recordProxy, queryVari
 
       switch (selection.kind) {
         case 'LinkedField':
-          // Linked fields are assignable if they contain fragment spreads or
-          // read-only otherwise.
-          var isAssignable = selection.selections.some(function (item) {
-            return item.kind === 'FragmentSpread';
-          });
-          var set = !isAssignable ? undefined : selection.plural ? createSetterForPluralLinkedField(selection, queryVariables, recordProxy, root) : createSetterForSingularLinkedField(selection, queryVariables, recordProxy, root);
-          var get = selection.plural ? createGetterForPluralLinkedField(selection, queryVariables, recordProxy, root) : createGetterForSingularLinkedField(selection, queryVariables, recordProxy, root);
-          Object.defineProperty(mutableUpdatableProxy, (_selection$alias = selection.alias) !== null && _selection$alias !== void 0 ? _selection$alias : selection.name, {
-            get: get,
-            set: set
-          });
+          if (selection.plural) {
+            Object.defineProperty(mutableUpdatableProxy, (_selection$alias = selection.alias) !== null && _selection$alias !== void 0 ? _selection$alias : selection.name, {
+              // $FlowFixMe[incompatible-call] these getters and setters have different types on purpose
+              get: createGetterForPluralLinkedField(selection, queryVariables, recordProxy, root),
+              set: createSetterForPluralLinkedField(selection, queryVariables, recordProxy, root)
+            });
+          } else {
+            Object.defineProperty(mutableUpdatableProxy, (_selection$alias2 = selection.alias) !== null && _selection$alias2 !== void 0 ? _selection$alias2 : selection.name, {
+              get: createGetterForSingularLinkedField(selection, queryVariables, recordProxy, root),
+              set: createSetterForSingularLinkedField(selection, queryVariables, recordProxy, root)
+            });
+          }
+
           break;
 
         case 'ScalarField':
-          var scalarFieldName = (_selection$alias2 = selection.alias) !== null && _selection$alias2 !== void 0 ? _selection$alias2 : selection.name;
+          var scalarFieldName = (_selection$alias3 = selection.alias) !== null && _selection$alias3 !== void 0 ? _selection$alias3 : selection.name;
           Object.defineProperty(mutableUpdatableProxy, scalarFieldName, {
             get: function get() {
               var _selection$args;
@@ -106,6 +108,10 @@ function updateProxyFromSelections(mutableUpdatableProxy, recordProxy, queryVari
     };
 
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var _selection$alias;
+
+      var _selection$alias2;
+
       _loop();
     }
   } catch (err) {
@@ -122,8 +128,7 @@ function createSetterForPluralLinkedField(selection, queryVariables, recordProxy
     var variables = getArgumentValues((_selection$args3 = selection.args) !== null && _selection$args3 !== void 0 ? _selection$args3 : [], queryVariables);
 
     if (newValue == null) {
-      // $FlowFixMe[unclear-type] No good way to type these variables
-      recordProxy.setValue(null, selection.name, variables);
+      throw new Error('Do not assign null to plural linked fields; assign an empty array instead.');
     } else {
       var recordProxies = newValue.map(function (item) {
         if (item == null) {

package/lib/network/RelayNetwork.js

@@ -10,6 +10,8 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var withProvidedVariables = require('../util/withProvidedVariables');
+
 var _require = require('./ConvertToExecuteFunction'),
     convertFetch = _require.convertFetch;
 
@@ -25,22 +27,24 @@ function create(fetchFn, subscribe) {
   var observeFetch = convertFetch(fetchFn);
 
   function execute(request, variables, cacheConfig, uploadables, logRequestInfo) {
+    var operationVariables = withProvidedVariables(variables, request);
+
     if (request.operationKind === 'subscription') {
       !subscribe ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayNetwork: This network layer does not support Subscriptions. ' + 'To use Subscriptions, provide a custom network layer.') : invariant(false) : void 0;
       !!uploadables ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayNetwork: Cannot provide uploadables while subscribing.') : invariant(false) : void 0;
-      return subscribe(request, variables, cacheConfig);
+      return subscribe(request, operationVariables, cacheConfig);
     }
 
     var pollInterval = cacheConfig.poll;
 
     if (pollInterval != null) {
       !!uploadables ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayNetwork: Cannot provide uploadables while polling.') : invariant(false) : void 0;
-      return observeFetch(request, variables, {
+      return observeFetch(request, operationVariables, {
         force: true
       }).poll(pollInterval);
     }
 
-    return observeFetch(request, variables, cacheConfig, uploadables, logRequestInfo);
+    return observeFetch(request, operationVariables, cacheConfig, uploadables, logRequestInfo);
   }
 
   return {

package/lib/query/fetchQuery.js

@@ -122,6 +122,9 @@ function fetchQuery(environment, query, variables, options) {
     if (snapshot.missingRequiredFields != null) {
       reportMissingRequiredFields(environment, snapshot.missingRequiredFields);
     }
+    /* $FlowFixMe[incompatible-return] we assume readData returns the right
+     * data just having written it from network or checked availability. */
+
 
     return snapshot.data;
   }

package/lib/store/RelayConcreteVariables.js

@@ -68,13 +68,15 @@ function getFragmentVariables(fragment, rootVariables, argumentVariables) {
 }
 /**
  * Determines the variables that are in scope for a given operation given values
- * for some/all of its arguments. Extraneous input variables are filtered from
- * the output, and missing variables are set to default values (if given in the
+ * for some/all of its arguments.
+ * - extraneous input variables are filtered from the output
+ * - missing variables are set to default values (if given in the
  * operation's definition).
+ * - variables with provider modules are added
  */
 
 
-function getOperationVariables(operation, variables) {
+function getOperationVariables(operation, parameters, variables) {
   var operationVariables = {};
   operation.argumentDefinitions.forEach(function (def) {
     var value = def.defaultValue;
@@ -85,6 +87,14 @@ function getOperationVariables(operation, variables) {
 
     operationVariables[def.name] = value;
   });
+  var providedVariables = parameters.providedVariables;
+
+  if (providedVariables != null) {
+    Object.keys(providedVariables).forEach(function (varName) {
+      operationVariables[varName] = providedVariables[varName].get();
+    });
+  }
+
   return operationVariables;
 }
 

package/lib/store/RelayModernOperationDescriptor.js

@@ -34,7 +34,7 @@ var _require3 = require('./RelayStoreUtils'),
 function createOperationDescriptor(request, variables, cacheConfig) {
   var dataID = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : ROOT_ID;
   var operation = request.operation;
-  var operationVariables = getOperationVariables(operation, variables);
+  var operationVariables = getOperationVariables(operation, request.params, variables);
   var requestDescriptor = createRequestDescriptor(request, operationVariables, cacheConfig);
   var operationDescriptor = {
     fragment: createReaderSelector(request.fragment, dataID, operationVariables, requestDescriptor),

package/lib/util/{getAllRootVariables.js → withProvidedVariables.js}

@@ -11,19 +11,19 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-function getAllRootVariables(userSuppliedVariables, parameters) {
+function withProvidedVariables(userSuppliedVariables, parameters) {
   var providedVariables = parameters.providedVariables;
 
   if (providedVariables != null) {
-    var allVariables = {};
-    Object.assign(allVariables, userSuppliedVariables);
+    var operationVariables = {};
+    Object.assign(operationVariables, userSuppliedVariables);
     Object.keys(providedVariables).forEach(function (varName) {
-      allVariables[varName] = providedVariables[varName].get();
+      operationVariables[varName] = providedVariables[varName].get();
     });
-    return allVariables;
+    return operationVariables;
   } else {
     return userSuppliedVariables;
   }
 }
 
-module.exports = getAllRootVariables;
+module.exports = withProvidedVariables;

package/mutations/readUpdatableQuery_EXPERIMENTAL.js.flow

@@ -55,50 +55,46 @@ function updateProxyFromSelections<TQuery: OperationType>(
   for (const selection of selections) {
     switch (selection.kind) {
       case 'LinkedField':
-        // Linked fields are assignable if they contain fragment spreads or
-        // read-only otherwise.
-        const isAssignable = selection.selections.some(
-          item => item.kind === 'FragmentSpread',
-        );
-
-        const set = !isAssignable
-          ? undefined
-          : selection.plural
-          ? createSetterForPluralLinkedField(
-              selection,
-              queryVariables,
-              recordProxy,
-              root,
-            )
-          : createSetterForSingularLinkedField(
-              selection,
-              queryVariables,
-              recordProxy,
-              root,
-            );
-
-        const get = selection.plural
-          ? createGetterForPluralLinkedField(
-              selection,
-              queryVariables,
-              recordProxy,
-              root,
-            )
-          : createGetterForSingularLinkedField(
-              selection,
-              queryVariables,
-              recordProxy,
-              root,
-            );
-
-        Object.defineProperty(
-          mutableUpdatableProxy,
-          selection.alias ?? selection.name,
-          {
-            get,
-            set,
-          },
-        );
+        if (selection.plural) {
+          Object.defineProperty(
+            mutableUpdatableProxy,
+            selection.alias ?? selection.name,
+            {
+              // $FlowFixMe[incompatible-call] these getters and setters have different types on purpose
+              get: createGetterForPluralLinkedField(
+                selection,
+                queryVariables,
+                recordProxy,
+                root,
+              ),
+              set: createSetterForPluralLinkedField(
+                selection,
+                queryVariables,
+                recordProxy,
+                root,
+              ),
+            },
+          );
+        } else {
+          Object.defineProperty(
+            mutableUpdatableProxy,
+            selection.alias ?? selection.name,
+            {
+              get: createGetterForSingularLinkedField(
+                selection,
+                queryVariables,
+                recordProxy,
+                root,
+              ),
+              set: createSetterForSingularLinkedField(
+                selection,
+                queryVariables,
+                recordProxy,
+                root,
+              ),
+            },
+          );
+        }
         break;
       case 'ScalarField':
         const scalarFieldName = selection.alias ?? selection.name;
@@ -171,11 +167,12 @@ function createSetterForPluralLinkedField<TQuery: OperationType>(
   recordProxy: RecordProxy,
   root: RecordSourceProxy,
 ) {
-  return function set(newValue: ?$ReadOnlyArray<{__id: string, ...}>) {
+  return function set(newValue: $ReadOnlyArray<{__id: string, ...}>) {
     const variables = getArgumentValues(selection.args ?? [], queryVariables);
     if (newValue == null) {
-      // $FlowFixMe[unclear-type] No good way to type these variables
-      recordProxy.setValue(null, selection.name, (variables: any));
+      throw new Error(
+        'Do not assign null to plural linked fields; assign an empty array instead.',
+      );
     } else {
       const recordProxies = newValue.map(item => {
         if (item == null) {
@@ -206,6 +203,7 @@ function createSetterForPluralLinkedField<TQuery: OperationType>(
     }
   };
 }
+
 function createSetterForSingularLinkedField<TQuery: OperationType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],

package/network/RelayNetwork.js.flow

@@ -24,6 +24,7 @@ import type {
 } from './RelayNetworkTypes';
 import type RelayObservable from './RelayObservable';
 
+const withProvidedVariables = require('../util/withProvidedVariables');
 const {convertFetch} = require('./ConvertToExecuteFunction');
 const invariant = require('invariant');
 
@@ -45,6 +46,7 @@ function create(
     uploadables?: ?UploadableMap,
     logRequestInfo: ?LogRequestInfoFunction,
   ): RelayObservable<GraphQLResponse> {
+    const operationVariables = withProvidedVariables(variables, request);
     if (request.operationKind === 'subscription') {
       invariant(
         subscribe,
@@ -56,7 +58,7 @@ function create(
         !uploadables,
         'RelayNetwork: Cannot provide uploadables while subscribing.',
       );
-      return subscribe(request, variables, cacheConfig);
+      return subscribe(request, operationVariables, cacheConfig);
     }
 
     const pollInterval = cacheConfig.poll;
@@ -65,12 +67,14 @@ function create(
         !uploadables,
         'RelayNetwork: Cannot provide uploadables while polling.',
       );
-      return observeFetch(request, variables, {force: true}).poll(pollInterval);
+      return observeFetch(request, operationVariables, {force: true}).poll(
+        pollInterval,
+      );
     }
 
     return observeFetch(
       request,
-      variables,
+      operationVariables,
       cacheConfig,
       uploadables,
       logRequestInfo,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "13.0.0",
+  "version": "13.0.1",
   "keywords": [
     "graphql",
     "relay"

package/query/fetchQuery.js.flow

@@ -22,9 +22,9 @@ import type {
   CacheConfig,
   FetchQueryFetchPolicy,
   OperationType,
-  VariablesOf,
+  Query,
+  Variables,
 } from '../util/RelayRuntimeTypes';
-import type {GraphQLTaggedNode} from './GraphQLTag';
 
 const RelayObservable = require('../network/RelayObservable');
 const {
@@ -112,15 +112,15 @@ const invariant = require('invariant');
  * ```
  * NOTE: When using .toPromise(), the request cannot be cancelled.
  */
-function fetchQuery<TQuery: OperationType>(
+function fetchQuery<TVariables: Variables, TData, TRawResponse>(
   environment: IEnvironment,
-  query: GraphQLTaggedNode,
-  variables: VariablesOf<TQuery>,
+  query: Query<TVariables, TData, TRawResponse>,
+  variables: TVariables,
   options?: $ReadOnly<{|
     fetchPolicy?: FetchQueryFetchPolicy,
     networkCacheConfig?: CacheConfig,
   |}>,
-): RelayObservable<TQuery['response']> {
+): RelayObservable<TData> {
   const queryNode = getRequest(query);
   invariant(
     queryNode.params.operationKind === 'query',
@@ -137,10 +137,12 @@ function fetchQuery<TQuery: OperationType>(
   );
   const fetchPolicy = options?.fetchPolicy ?? 'network-only';
 
-  function readData(snapshot: Snapshot) {
+  function readData(snapshot: Snapshot): TData {
     if (snapshot.missingRequiredFields != null) {
       reportMissingRequiredFields(environment, snapshot.missingRequiredFields);
     }
+    /* $FlowFixMe[incompatible-return] we assume readData returns the right
+     * data just having written it from network or checked availability. */
     return snapshot.data;
   }