relay-runtime 13.0.0 → 13.1.0

package/util/RelayConcreteNode.js.flow

@@ -35,6 +35,8 @@ export type NormalizationRootNode =
   | ConcreteRequest
   | NormalizationSplitOperation;
 
+export type ProvidedVariablesType = {+[key: string]: {|get(): mixed|}};
+
 /**
  * Contains the parameters required for executing a GraphQL request.
  * The operation can either be provided as a persisted `id` or `text`. If given
@@ -48,7 +50,7 @@ export type RequestParameters =
       // common fields
       +name: string,
       +operationKind: 'mutation' | 'query' | 'subscription',
-      +providedVariables?: {[key: string]: {|get(): mixed|}},
+      +providedVariables?: ProvidedVariablesType,
       +metadata: {[key: string]: mixed, ...},
     |}
   | {|
@@ -58,7 +60,7 @@ export type RequestParameters =
       // common fields
       +name: string,
       +operationKind: 'mutation' | 'query' | 'subscription',
-      +providedVariables?: {[key: string]: {|get(): mixed|}},
+      +providedVariables?: ProvidedVariablesType,
       +metadata: {[key: string]: mixed, ...},
     |};
 

package/util/withProvidedVariables.js.flow

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @emails oncall+relay
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+import type {ProvidedVariablesType} from './RelayConcreteNode';
+import type {Variables} from './RelayRuntimeTypes';
+
+const areEqual = require('areEqual');
+const warning = require('warning');
+
+const WEAKMAP_SUPPORTED = typeof WeakMap === 'function';
+const debugCache = WEAKMAP_SUPPORTED ? new WeakMap() : new Map();
+
+function withProvidedVariables(
+  userSuppliedVariables: Variables,
+  providedVariables: ?ProvidedVariablesType,
+): Variables {
+  if (providedVariables != null) {
+    const operationVariables = {};
+    Object.assign(operationVariables, userSuppliedVariables);
+    Object.keys(providedVariables).forEach((varName: string) => {
+      const providerFunction = providedVariables[varName].get;
+      const providerResult = providerFunction();
+
+      // people like to ignore these warnings, so use the cache to
+      // enforce that we only compute the value the first time
+      if (!debugCache.has(providerFunction)) {
+        debugCache.set(providerFunction, providerResult);
+        operationVariables[varName] = providerResult;
+      } else {
+        const cachedResult = debugCache.get(providerFunction);
+
+        if (__DEV__) {
+          warning(
+            areEqual(providerResult, cachedResult),
+            'Relay: Expected function `%s` for provider `%s` to be a pure function, ' +
+              'but got conflicting return values `%s` and `%s`',
+            providerFunction.name,
+            varName,
+            providerResult,
+            cachedResult,
+          );
+        }
+        operationVariables[varName] = cachedResult;
+      }
+    });
+    return operationVariables;
+  } else {
+    return userSuppliedVariables;
+  }
+}
+
+module.exports = withProvidedVariables;

package/lib/util/getAllRootVariables.js

@@ -1,29 +0,0 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- * @emails oncall+relay
- */
-// flowlint ambiguous-object-type:error
-'use strict';
-
-function getAllRootVariables(userSuppliedVariables, parameters) {
-  var providedVariables = parameters.providedVariables;
-
-  if (providedVariables != null) {
-    var allVariables = {};
-    Object.assign(allVariables, userSuppliedVariables);
-    Object.keys(providedVariables).forEach(function (varName) {
-      allVariables[varName] = providedVariables[varName].get();
-    });
-    return allVariables;
-  } else {
-    return userSuppliedVariables;
-  }
-}
-
-module.exports = getAllRootVariables;

package/util/getAllRootVariables.js.flow

@@ -1,36 +0,0 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
- * @format
- * @emails oncall+relay
- */
-
-// flowlint ambiguous-object-type:error
-
-'use strict';
-
-import type {RequestParameters} from './RelayConcreteNode';
-import type {Variables} from './RelayRuntimeTypes';
-
-function getAllRootVariables(
-  userSuppliedVariables: Variables,
-  parameters: RequestParameters,
-): Variables {
-  const providedVariables = parameters.providedVariables;
-  if (providedVariables != null) {
-    const allVariables = {};
-    Object.assign(allVariables, userSuppliedVariables);
-    Object.keys(providedVariables).forEach((varName: string) => {
-      allVariables[varName] = providedVariables[varName].get();
-    });
-    return allVariables;
-  } else {
-    return userSuppliedVariables;
-  }
-}
-
-module.exports = getAllRootVariables;