relay-runtime 20.1.0 → 21.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "20.1.0",
+  "version": "21.0.0",
   "keywords": [
     "graphql",
     "relay"
@@ -23,5 +23,6 @@
     "": "./"
   },
   "main": "index.js",
+  "types": "index.d.ts",
   "haste_commonjs": true
 }

package/query/GraphQLTag.js.flow

@@ -46,7 +46,7 @@ export type GraphQLTaggedNode =
  * Runtime function to correspond to the `graphql` tagged template function.
  * All calls to this function should be transformed by the plugin.
  */
-function graphql(strings: $ReadOnlyArray<string>): any {
+function graphql(strings: ReadonlyArray<string>): any {
   invariant(
     false,
     'graphql: Unexpected invocation at runtime. Either the Babel transform ' +
@@ -65,7 +65,7 @@ function getNode(
   | ConcreteUpdatableQuery {
   let node = taggedNode;
   if (typeof node === 'function') {
-    node = (node(): ReaderFragment | ConcreteRequest);
+    node = node() as ReaderFragment | ConcreteRequest;
     warning(
       false,
       'RelayGraphQLTag: node `%s` unexpectedly wrapped in a function.',
@@ -82,6 +82,8 @@ function isFragment(node: GraphQLTaggedNode): boolean {
   const fragment = getNode(node);
   return (
     typeof fragment === 'object' &&
+    /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+     * roll out. See https://fburl.com/workplace/5whu3i34. */
     fragment !== null &&
     fragment.kind === RelayConcreteNode.FRAGMENT
   );
@@ -91,6 +93,8 @@ function isRequest(node: GraphQLTaggedNode): boolean {
   const request = getNode(node);
   return (
     typeof request === 'object' &&
+    /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+     * roll out. See https://fburl.com/workplace/5whu3i34. */
     request !== null &&
     request.kind === RelayConcreteNode.REQUEST
   );
@@ -100,6 +104,8 @@ function isUpdatableQuery(node: GraphQLTaggedNode): boolean {
   const updatableQuery = getNode(node);
   return (
     typeof updatableQuery === 'object' &&
+    /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+     * roll out. See https://fburl.com/workplace/5whu3i34. */
     updatableQuery !== null &&
     updatableQuery.kind === RelayConcreteNode.UPDATABLE_QUERY
   );
@@ -109,6 +115,8 @@ function isInlineDataFragment(node: GraphQLTaggedNode): boolean {
   const fragment = getNode(node);
   return (
     typeof fragment === 'object' &&
+    /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+     * roll out. See https://fburl.com/workplace/5whu3i34. */
     fragment !== null &&
     fragment.kind === RelayConcreteNode.INLINE_DATA_FRAGMENT
   );
@@ -121,7 +129,7 @@ function getFragment(taggedNode: GraphQLTaggedNode): ReaderFragment {
     'GraphQLTag: Expected a fragment, got `%s`.',
     JSON.stringify(fragment),
   );
-  return (fragment: any);
+  return fragment as any;
 }
 
 function getPaginationFragment(
@@ -131,6 +139,8 @@ function getPaginationFragment(
   const refetch = fragment.metadata?.refetch;
   const connection = refetch?.connection;
   if (
+    /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+     * roll out. See https://fburl.com/workplace/5whu3i34. */
     refetch === null ||
     typeof refetch !== 'object' ||
     connection === null ||
@@ -138,7 +148,7 @@ function getPaginationFragment(
   ) {
     return null;
   }
-  return (fragment: any);
+  return fragment as any;
 }
 
 function getRefetchableFragment(
@@ -146,10 +156,12 @@ function getRefetchableFragment(
 ): ReaderRefetchableFragment | null {
   const fragment = getFragment(taggedNode);
   const refetch = fragment.metadata?.refetch;
+  /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+   * roll out. See https://fburl.com/workplace/5whu3i34. */
   if (refetch === null || typeof refetch !== 'object') {
     return null;
   }
-  return (fragment: any);
+  return fragment as any;
 }
 
 function getRequest(taggedNode: GraphQLTaggedNode): ConcreteRequest {
@@ -159,7 +171,7 @@ function getRequest(taggedNode: GraphQLTaggedNode): ConcreteRequest {
     'GraphQLTag: Expected a request, got `%s`.',
     JSON.stringify(request),
   );
-  return (request: any);
+  return request as any;
 }
 
 function getUpdatableQuery(
@@ -171,7 +183,7 @@ function getUpdatableQuery(
     'GraphQLTag: Expected a request, got `%s`.',
     JSON.stringify(updatableQuery),
   );
-  return (updatableQuery: any);
+  return updatableQuery as any;
 }
 
 function getInlineDataFragment(
@@ -183,20 +195,20 @@ function getInlineDataFragment(
     'GraphQLTag: Expected an inline data fragment, got `%s`.',
     JSON.stringify(fragment),
   );
-  return (fragment: any);
+  return fragment as any;
 }
 
 module.exports = {
   getFragment,
+  getInlineDataFragment,
   getNode,
   getPaginationFragment,
   getRefetchableFragment,
   getRequest,
   getUpdatableQuery,
-  getInlineDataFragment,
   graphql,
   isFragment,
+  isInlineDataFragment,
   isRequest,
   isUpdatableQuery,
-  isInlineDataFragment,
 };

package/query/fetchQuery.js.flow

@@ -112,11 +112,11 @@ const invariant = require('invariant');
  * ```
  * NOTE: When using .toPromise(), the request cannot be cancelled.
  */
-function fetchQuery<TVariables: Variables, TData, TRawResponse>(
+function fetchQuery<TVariables extends Variables, TData, TRawResponse>(
   environment: IEnvironment,
   query: Query<TVariables, TData, TRawResponse>,
   variables: NoInfer<TVariables>,
-  options?: $ReadOnly<{
+  options?: Readonly<{
     fetchPolicy?: FetchQueryFetchPolicy,
     networkCacheConfig?: CacheConfig,
   }>,
@@ -139,7 +139,7 @@ function fetchQuery<TVariables: Variables, TData, TRawResponse>(
 
   function readData(snapshot: Snapshot): TData {
     handlePotentialSnapshotErrors(environment, snapshot.fieldErrors);
-    /* $FlowFixMe[incompatible-return] we assume readData returns the right
+    /* $FlowFixMe[incompatible-type] we assume readData returns the right
      * data just having written it from network or checked availability. */
     return snapshot.data;
   }
@@ -151,22 +151,35 @@ function fetchQuery<TVariables: Variables, TData, TRawResponse>(
       );
     }
     case 'store-or-network': {
-      if (environment.check(operation).status === 'available') {
-        return RelayObservable.from<Snapshot>(
+      const queryAvailability = environment.check(operation);
+      const shouldFetch = queryAvailability.status !== 'available';
+      let observable;
+      if (!shouldFetch) {
+        observable = RelayObservable.from<Snapshot>(
           environment.lookup(operation.fragment),
         ).map(readData);
+      } else {
+        observable = getNetworkObservable<$FlowFixMe>(
+          environment,
+          operation,
+        ).map(readData);
       }
-      return getNetworkObservable<$FlowFixMe>(environment, operation).map(
-        readData,
-      );
+      environment.__log({
+        name: 'fetchquery.fetch',
+        operation,
+        fetchPolicy,
+        queryAvailability,
+        shouldFetch,
+      });
+      return observable;
     }
     default:
-      (fetchPolicy: empty);
+      fetchPolicy as empty;
       throw new Error('fetchQuery: Invalid fetchPolicy ' + fetchPolicy);
   }
 }
 
-function getNetworkObservable<TQuery: OperationType>(
+function getNetworkObservable<TQuery extends OperationType>(
   environment: IEnvironment,
   operation: OperationDescriptor,
 ): RelayObservable<TQuery['response']> {

package/query/fetchQuery_DEPRECATED.js.flow

@@ -26,7 +26,7 @@ const {getRequest} = require('./GraphQLTag');
  * order to be accessible in the result object.
  */
 
-function fetchQuery_DEPRECATED<T: OperationType>(
+function fetchQuery_DEPRECATED<T extends OperationType>(
   environment: IEnvironment,
   taggedNode: GraphQLTaggedNode,
   variables: T['variables'],

package/store/DataChecker.js.flow

@@ -68,7 +68,7 @@ function check(
   getTargetForActor: (actorIdentifier: ActorIdentifier) => MutableRecordSource,
   defaultActorIdentifier: ActorIdentifier,
   selector: NormalizationSelector,
-  handlers: $ReadOnlyArray<MissingFieldHandler>,
+  handlers: ReadonlyArray<MissingFieldHandler>,
   operationLoader: ?OperationLoader,
   getDataID: GetDataID,
   shouldProcessClientComponents: ?boolean,
@@ -108,7 +108,7 @@ function check(
  * @private
  */
 class DataChecker {
-  _handlers: $ReadOnlyArray<MissingFieldHandler>;
+  _handlers: ReadonlyArray<MissingFieldHandler>;
   _mostRecentlyInvalidatedAt: number | null;
   _mutator: RelayRecordSourceMutator;
   _operationLoader: OperationLoader | null;
@@ -136,7 +136,7 @@ class DataChecker {
     ) => MutableRecordSource,
     defaultActorIdentifier: ActorIdentifier,
     variables: Variables,
-    handlers: $ReadOnlyArray<MissingFieldHandler>,
+    handlers: ReadonlyArray<MissingFieldHandler>,
     operationLoader: ?OperationLoader,
     getDataID: GetDataID,
     shouldProcessClientComponents: ?boolean,
@@ -193,16 +193,16 @@ class DataChecker {
 
     return this._recordWasMissing === true
       ? {
-          status: 'missing',
           mostRecentlyInvalidatedAt: this._mostRecentlyInvalidatedAt,
+          status: 'missing',
         }
       : {
-          status: 'available',
           mostRecentlyInvalidatedAt: this._mostRecentlyInvalidatedAt,
+          status: 'available',
         };
   }
 
-  _getVariableValue(name: string): mixed {
+  _getVariableValue(name: string): unknown {
     invariant(
       this._variables.hasOwnProperty(name),
       'RelayAsyncLoader(): Undefined variable `%s`.',
@@ -218,7 +218,7 @@ class DataChecker {
   _handleMissingScalarField(
     field: NormalizationScalarField,
     dataID: DataID,
-  ): mixed {
+  ): unknown {
     if (field.name === 'id' && field.alias == null && isClientID(dataID)) {
       return undefined;
     }
@@ -239,6 +239,15 @@ class DataChecker {
         }
       }
     }
+    if (this._log != null) {
+      this._log({
+        name: 'store.datachecker.missing',
+        kind: 'scalar',
+        dataID,
+        fieldName: field.name,
+        storageKey: getStorageKey(field, this._variables),
+      });
+    }
     this._handleMissing();
   }
 
@@ -266,6 +275,15 @@ class DataChecker {
         }
       }
     }
+    if (this._log != null) {
+      this._log({
+        name: 'store.datachecker.missing',
+        kind: 'linked',
+        dataID,
+        fieldName: field.name,
+        storageKey: getStorageKey(field, this._variables),
+      });
+    }
     this._handleMissing();
   }
 
@@ -299,12 +317,28 @@ class DataChecker {
         }
       }
     }
+    if (this._log != null) {
+      this._log({
+        name: 'store.datachecker.missing',
+        kind: 'pluralLinked',
+        dataID,
+        fieldName: field.name,
+        storageKey: getStorageKey(field, this._variables),
+      });
+    }
     this._handleMissing();
   }
 
   _traverse(node: NormalizationNode, dataID: DataID): void {
     const status = this._mutator.getStatus(dataID);
     if (status === UNKNOWN) {
+      if (this._log != null) {
+        this._log({
+          name: 'store.datachecker.missing',
+          kind: 'unknown_record',
+          dataID,
+        });
+      }
       this._handleMissing();
     }
 
@@ -323,7 +357,7 @@ class DataChecker {
   }
 
   _traverseSelections(
-    selections: $ReadOnlyArray<NormalizationSelection>,
+    selections: ReadonlyArray<NormalizationSelection>,
     dataID: DataID,
   ): void {
     selections.forEach(selection => {
@@ -470,7 +504,7 @@ class DataChecker {
           }
           break;
         default:
-          (selection: empty);
+          selection as empty;
           invariant(
             false,
             'RelayAsyncLoader(): Unexpected ast kind `%s`.',