react-relay 15.0.0 → 16.0.0

package/ReactRelayContext.js

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

package/ReactRelayQueryFetcher.js.flow

@@ -27,11 +27,7 @@ const {
   isRelayModernEnvironment,
 } = require('relay-runtime');
 
-type OnDataChange = ({
-  error?: Error,
-  snapshot?: Snapshot,
-  ...
-}) => void;
+type OnDataChange = ({error?: Error, snapshot?: Snapshot, ...}) => void;
 
 /** The external API of 'fetch' **/
 export type FetchOptions = {

package/ReactRelayQueryRenderer.js.flow

@@ -27,7 +27,6 @@ const ReactRelayQueryFetcher = require('./ReactRelayQueryFetcher');
 const ReactRelayQueryRendererContext = require('./ReactRelayQueryRendererContext');
 const areEqual = require('areEqual');
 const React = require('react');
-const {RelayFeatureFlags} = require('relay-runtime');
 const {
   createOperationDescriptor,
   deepFreeze,
@@ -37,11 +36,7 @@ const {
 type RetryCallbacks = {
   handleDataChange:
     | null
-    | (({
-        error?: Error,
-        snapshot?: Snapshot,
-        ...
-      }) => void),
+    | (({error?: Error, snapshot?: Snapshot, ...}) => void),
   handleRetryAfterError: null | ((error: Error) => void),
 };
 
@@ -66,14 +61,14 @@ const queryRendererContext: ReactRelayQueryRendererContextType = {
   rootIsQueryRenderer: true,
 };
 
-export type Props = {
+export type Props = $ReadOnly<{
   cacheConfig?: ?CacheConfig,
   fetchPolicy?: 'store-and-network' | 'network-only',
   environment: IEnvironment,
   query: ?GraphQLTaggedNode,
   render: (renderProps: RenderProps<Object>) => React.Node,
   variables: Variables,
-};
+}>;
 
 type State = {
   error: Error | null,
@@ -131,6 +126,7 @@ class ReactRelayQueryRenderer extends React.Component<Props, State> {
 
     this._maybeHiddenOrFastRefresh = false;
 
+    // $FlowFixMe[incompatible-type]
     this.state = {
       prevPropsEnvironment: props.environment,
       prevPropsVariables: props.variables,
@@ -149,7 +145,7 @@ class ReactRelayQueryRenderer extends React.Component<Props, State> {
   static getDerivedStateFromProps(
     nextProps: Props,
     prevState: State,
-  ): $Shape<State> | null {
+  ): Partial<State> | null {
     if (
       prevState.prevQuery !== nextProps.query ||
       prevState.prevPropsEnvironment !== nextProps.environment ||
@@ -174,31 +170,8 @@ class ReactRelayQueryRenderer extends React.Component<Props, State> {
         const newState = resetQueryStateForUpdate(this.props, prevState);
         const {requestCacheKey, queryFetcher} = newState;
         if (requestCacheKey != null && requestCache[requestCacheKey] != null) {
-          if (RelayFeatureFlags.ENABLE_QUERY_RENDERER_SET_STATE_PREVENTION) {
-            const fetchResult = queryFetcher.getFetchResult();
-            if (fetchResult != null) {
-              const snapshot = fetchResult.snapshot ?? null;
-              const error = fetchResult.error ?? null;
-
-              const {requestCacheKey: prevRequestCacheKey} = prevState;
-              if (prevRequestCacheKey != null) {
-                delete requestCache[prevRequestCacheKey];
-              }
-
-              newState.renderProps = getRenderProps(
-                error,
-                snapshot,
-                queryFetcher,
-                prevState.retryCallbacks,
-              );
-              newState.snapshot = snapshot;
-              newState.requestCacheKey = null;
-            } else {
-              queryFetcher.setOnDataChange(this._handleDataChange);
-            }
-          } else {
-            queryFetcher.setOnDataChange(this._handleDataChange);
-          }
+          // $FlowFixMe[incompatible-use]
+          queryFetcher.setOnDataChange(this._handleDataChange);
         }
         return newState;
       });
@@ -366,7 +339,7 @@ function getRequestCacheKey(
 function resetQueryStateForUpdate(
   props: Props,
   prevState: State,
-): $Shape<State> {
+): Partial<State> {
   const {query} = props;
 
   const prevSelectionReferences =
@@ -403,7 +376,7 @@ function fetchQueryAndComputeStateFromProps(
   queryFetcher: ReactRelayQueryFetcher,
   retryCallbacks: RetryCallbacks,
   requestCacheKey: ?string,
-): $Shape<State> {
+): Partial<State> {
   const {environment, query, variables, cacheConfig} = props;
   const genericEnvironment = (environment: IEnvironment);
   if (query) {

package/ReactRelayTypes.js.flow

@@ -102,6 +102,7 @@ export type $FragmentRef<T> = {
  * `props.relay` and returns the props of the container.
  */
 // prettier-ignore
+// $FlowFixMe[extra-type-arg] xplat redux flow type error
 export type $RelayProps<Props, RelayPropT = RelayProp> = $ObjMap<
   $Diff<Props, { relay: RelayPropT | void, ... }>,
   & (<T: { +$fragmentType: empty, ... }>( T) =>  T)

package/buildReactRelayContainer.js.flow

@@ -54,7 +54,9 @@ function buildReactRelayContainer<TBase: React$ComponentType<any>>(
 
   function forwardRef(
     props: any,
-    ref: ((null | any) => mixed) | {current: null | any, ...},
+    ref:
+      | ((null | React$ElementRef<TBase>) => mixed)
+      | {-current: null | React$ElementRef<TBase>, ...},
   ) {
     const context = useContext(ReactRelayContext);
     invariant(

package/hooks.js

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

package/index.js

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

package/legacy.js

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

package/lib/ReactRelayContainerUtils.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall relay
- */
-
 'use strict';
 
 function getComponentName(component) {

package/lib/ReactRelayContext.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall relay
- */
-
 'use strict';
 
 var React = require('react');

package/lib/ReactRelayFragmentContainer.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall relay
- */
-
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
@@ -29,40 +18,25 @@ var _require3 = require('relay-runtime'),
   createFragmentSpecResolver = _require3.createFragmentSpecResolver,
   getDataIDsFromObject = _require3.getDataIDsFromObject,
   isScalarAndEqual = _require3.isScalarAndEqual;
-/**
- * Composes a React component class, returning a new class that intercepts
- * props, resolving them with the provided fragments and subscribing for
- * updates.
- */
 function createContainerWithFragments(Component, fragments) {
   var _class;
   var containerName = getContainerName(Component);
   return _class = /*#__PURE__*/function (_React$Component) {
     (0, _inheritsLoose2["default"])(_class, _React$Component);
-    // $FlowFixMe[missing-local-annot]
-
     function _class(props) {
       var _props$__rootIsQueryR, _this;
       _this = _React$Component.call(this, props) || this;
       (0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "_handleFragmentDataUpdate", function () {
         var resolverFromThisUpdate = _this.state.resolver;
         _this.setState(function (updatedState) {
-          return (
-            // If this event belongs to the current data source, update.
-            // Otherwise we should ignore it.
-            resolverFromThisUpdate === updatedState.resolver ? {
-              data: updatedState.resolver.resolve(),
-              relayProp: getRelayProp(updatedState.relayProp.environment)
-            } : null
-          );
+          return resolverFromThisUpdate === updatedState.resolver ? {
+            data: updatedState.resolver.resolve(),
+            relayProp: getRelayProp(updatedState.relayProp.environment)
+          } : null;
         });
       });
       var relayContext = assertRelayContext(props.__relayContext);
       var rootIsQueryRenderer = (_props$__rootIsQueryR = props.__rootIsQueryRenderer) !== null && _props$__rootIsQueryR !== void 0 ? _props$__rootIsQueryR : false;
-      // Do not provide a subscription/callback here.
-      // It is possible for this render to be interrupted or aborted,
-      // In which case the subscription would cause a leak.
-      // We will add the subscription in componentDidMount().
       var resolver = createFragmentSpecResolver(relayContext, containerName, fragments, props, rootIsQueryRenderer);
       _this.state = {
         data: resolver.resolve(),
@@ -73,33 +47,15 @@ function createContainerWithFragments(Component, fragments) {
       };
       return _this;
     }
-
-    /**
-     * When new props are received, read data for the new props and subscribe
-     * for updates. Props may be the same in which case previous data and
-     * subscriptions can be reused.
-     */
     _class.getDerivedStateFromProps = function getDerivedStateFromProps(nextProps, prevState) {
       var _nextProps$__rootIsQu;
-      // Any props change could impact the query, so we mirror props in state.
-      // This is an unusual pattern, but necessary for this container usecase.
       var prevProps = prevState.prevProps;
       var relayContext = assertRelayContext(nextProps.__relayContext);
       var rootIsQueryRenderer = (_nextProps$__rootIsQu = nextProps.__rootIsQueryRenderer) !== null && _nextProps$__rootIsQu !== void 0 ? _nextProps$__rootIsQu : false;
       var prevIDs = getDataIDsFromObject(fragments, prevProps);
       var nextIDs = getDataIDsFromObject(fragments, nextProps);
       var resolver = prevState.resolver;
-
-      // If the environment has changed or props point to new records then
-      // previously fetched data and any pending fetches no longer apply:
-      // - Existing references are on the old environment.
-      // - Existing references are based on old variables.
-      // - Pending fetches are for the previous records.
       if (prevState.prevPropsContext.environment !== relayContext.environment || !areEqual(prevIDs, nextIDs)) {
-        // Do not provide a subscription/callback here.
-        // It is possible for this render to be interrupted or aborted,
-        // In which case the subscription would cause a leak.
-        // We will add the subscription in componentDidUpdate().
         resolver = createFragmentSpecResolver(relayContext, containerName, fragments, nextProps, rootIsQueryRenderer);
         return {
           data: resolver.resolve(),
@@ -138,12 +94,9 @@ function createContainerWithFragments(Component, fragments) {
       this.state.resolver.dispose();
     };
     _proto.shouldComponentUpdate = function shouldComponentUpdate(nextProps, nextState) {
-      // Short-circuit if any Relay-related data has changed
       if (nextState.data !== this.state.data) {
         return true;
       }
-      // Otherwise, for convenience short-circuit if all non-Relay props
-      // are scalar and equal
       var keys = Object.keys(nextProps);
       for (var ii = 0; ii < keys.length; ii++) {
         var key = keys[ii];
@@ -158,17 +111,11 @@ function createContainerWithFragments(Component, fragments) {
         }
       }
       return false;
-    }
-
-    /**
-     * Render new data for the existing props/context.
-     */;
+    };
     _proto._rerenderIfStoreHasChanged = function _rerenderIfStoreHasChanged() {
       var _this$state = this.state,
         data = _this$state.data,
         resolver = _this$state.resolver;
-      // External values could change between render and commit.
-      // Check for this case, even though it requires an extra store read.
       var maybeNewData = resolver.resolve();
       if (data !== maybeNewData) {
         this.setState({
@@ -181,24 +128,14 @@ function createContainerWithFragments(Component, fragments) {
         data = _this$state2.data,
         resolver = _this$state2.resolver;
       var maybeNewData = resolver.resolve();
-
-      // Event listeners are only safe to add during the commit phase,
-      // So they won't leak if render is interrupted or errors.
       resolver.setCallback(this.props, this._handleFragmentDataUpdate);
-
-      // External values could change between render and commit.
-      // Check for this case, even though it requires an extra store read.
       if (data !== maybeNewData) {
         this.setState({
           data: maybeNewData
         });
       }
-    }
-
-    // $FlowFixMe[missing-local-annot]
-    ;
+    };
     _proto.render = function render() {
-      // eslint-disable-next-line no-unused-vars
       var _this$props = this.props,
         componentRef = _this$props.componentRef,
         __relayContext = _this$props.__relayContext,
@@ -217,16 +154,7 @@ function getRelayProp(environment) {
     environment: environment
   };
 }
-
-/**
- * Wrap the basic `createContainer()` function with logic to adapt to the
- * `context.relay.environment` in which it is rendered. Specifically, the
- * extraction of the environment-specific version of fragments in the
- * `fragmentSpec` is memoized once per environment, rather than once per
- * instance of the container constructed/rendered.
- */
 function createContainer(Component, fragmentSpec) {
-  // $FlowFixMe[incompatible-return]
   return buildReactRelayContainer(Component, fragmentSpec, createContainerWithFragments);
 }
 module.exports = {

package/lib/ReactRelayFragmentMockRenderer.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall relay
- */
-
 'use strict';
 
 var ReactRelayContext = require('./ReactRelayContext');

package/lib/ReactRelayLocalQueryRenderer.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall relay
- */
-
 'use strict';
 
 var ReactRelayContext = require('./ReactRelayContext');
@@ -51,9 +40,6 @@ function ReactRelayLocalQueryRenderer(props) {
       environment: environment
     };
   }, [environment]);
-
-  // Use a ref to prevent rendering twice when data changes
-  // because of props change
   var dataRef = useRef(null);
   var _useState = useState(null),
     forceUpdate = _useState[1];
@@ -62,9 +48,6 @@ function ReactRelayLocalQueryRenderer(props) {
     environment.check(operation);
     var res = environment.lookup(operation.fragment);
     dataRef.current = res.data;
-
-    // Run effects here so that the data can be retained
-    // and subscribed before the component commits
     var retainDisposable = environment.retain(operation);
     var subscribeDisposable = environment.subscribe(res, function (newSnapshot) {
       dataRef.current = newSnapshot.data;