Stabilize LiveResolverStore as the new implementation of RelayModernS…

…tore (#4806)

Summary:
For the last several years we've maintained RelayModernStore and LiveResolverStore in parallel. This was because the the Relay store needed to gain some additional features in order to support [Resolvers](https://relay.dev/docs/next/guides/relay-resolvers/introduction/) and [Live Resolvers](https://relay.dev/docs/next/guides/relay-resolvers/live-fields/).

The upshot was the using Relay Resolvers required adopting a special store. We've now been using this store on ~all surfaces internally for quite a while and have not seen any issues. I believe it should now be safe to unify the implementations and bring the features of the LiveResolver store to the default store: RelayModernStore.

This should allow us to make Relay Resolvers and Live Resolvers as stable (not requiring any additional configuration or feature flags) in an upcoming release. I'll followup with another PR to remove the last feature flag.

Pull Request resolved: #4806

Reviewed By: tyao1

Differential Revision: D63488011

Pulled By: captbaritone

fbshipit-source-id: b70d3fdfb0e37a2c07f890b772588121632741ea

packages/react-relay/__tests__/Catch-test.js

@@ -16,7 +16,7 @@ const {RelayEnvironmentProvider, useLazyLoadQuery} = require('react-relay');
 const TestRenderer = require('react-test-renderer');
 const {RelayFeatureFlags} = require('relay-runtime');
 const {graphql} = require('relay-runtime');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore');
 const RelayRecordSource = require('relay-runtime/store/RelayRecordSource');
 const {createMockEnvironment} = require('relay-test-utils');
 const {
@@ -126,7 +126,7 @@ it('should catch a @required(action: THROW) error', () => {
 
 it('should catch Relay Resolver errors', () => {
   const environment = createMockEnvironment({
-    store: new LiveResolverStore(new RelayRecordSource()),
+    store: new RelayModernStore(new RelayRecordSource()),
   });
   function TestComponent() {
     return (

packages/react-relay/__tests__/ClientEdges-test.js

@@ -22,7 +22,7 @@ const {
   graphql,
 } = require('relay-runtime');
 const RelayObservable = require('relay-runtime/network/RelayObservable');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore');
 const {
   disallowConsoleErrors,
   disallowWarnings,
@@ -51,7 +51,7 @@ beforeEach(() => {
   );
 
   environment = new Environment({
-    store: new LiveResolverStore(
+    store: new RelayModernStore(
       new RecordSource({
         'client:root': {
           __id: 'client:root',

packages/react-relay/__tests__/LiveResolvers-test.js

@@ -33,11 +33,11 @@ const {
 const {
   counter_no_fragment: counterNoFragmentResolver,
 } = require('relay-runtime/store/__tests__/resolvers/LiveCounterNoFragment');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore');
 const RelayModernEnvironment = require('relay-runtime/store/RelayModernEnvironment');
 const {
   createOperationDescriptor,
 } = require('relay-runtime/store/RelayModernOperationDescriptor');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore');
 const RelayRecordSource = require('relay-runtime/store/RelayRecordSource');
 const {
   disallowConsoleErrors,
@@ -77,7 +77,7 @@ test('Can read an external state resolver directly', () => {
   `;
 
   const operation = createOperationDescriptor(FooQuery, {});
-  const store = new LiveResolverStore(source, {
+  const store = new RelayModernStore(source, {
     gcReleaseBufferSize: 0,
   });
 
@@ -116,7 +116,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -188,7 +188,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -261,7 +261,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -289,7 +289,7 @@ describe.each([true, false])(
           name: 'Alice',
         },
       });
-      const store = new LiveResolverStore(source, {gcReleaseBufferSize: 0});
+      const store = new RelayModernStore(source, {gcReleaseBufferSize: 0});
 
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
@@ -363,7 +363,7 @@ describe.each([true, false])(
         }
       `;
 
-      const store = new LiveResolverStore(source, {gcReleaseBufferSize: 0});
+      const store = new RelayModernStore(source, {gcReleaseBufferSize: 0});
 
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
@@ -453,7 +453,7 @@ describe.each([true, false])(
         }
       `;
 
-      const store = new LiveResolverStore(source, {gcReleaseBufferSize: 0});
+      const store = new RelayModernStore(source, {gcReleaseBufferSize: 0});
 
       const mockPayload = Promise.resolve({
         data: {
@@ -525,7 +525,7 @@ describe.each([true, false])(
         }
       `;
 
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -596,7 +596,7 @@ describe.each([true, false])(
         }
       `;
 
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -701,7 +701,7 @@ describe.each([true, false])(
       function createEnvironment(source: MutableRecordSource) {
         return new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(source),
+          store: new RelayModernStore(source),
         });
       }
 
@@ -940,7 +940,7 @@ describe.each([true, false])(
         function createEnvironment(source: MutableRecordSource) {
           return new RelayModernEnvironment({
             network: RelayNetwork.create(jest.fn()),
-            store: new LiveResolverStore(source),
+            store: new RelayModernStore(source),
             relayFieldLogger,
           });
         }
@@ -1068,7 +1068,7 @@ describe.each([true, false])(
       function createEnvironment(source: MutableRecordSource) {
         return new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(source),
+          store: new RelayModernStore(source),
         });
       }
 
@@ -1172,7 +1172,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -1214,7 +1214,7 @@ describe.each([true, false])(
       function createEnvironment(source: MutableRecordSource) {
         return new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(source),
+          store: new RelayModernStore(source),
         });
       }
 
@@ -1281,7 +1281,7 @@ describe.each([true, false])(
       function createEnvironment(source: MutableRecordSource) {
         return new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(source),
+          store: new RelayModernStore(source),
         });
       }
 
@@ -1337,7 +1337,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -1357,7 +1357,7 @@ describe.each([true, false])(
     test('live resolver with the edge that always suspend', () => {
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(
+        store: new RelayModernStore(
           RelayRecordSource.create({
             'client:root': {
               __id: 'client:root',
@@ -1445,7 +1445,7 @@ describe.each([true, false])(
       test('correctly suspend on fragments with client-only data', () => {
         const environment = new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(RelayRecordSource.create()),
+          store: new RelayModernStore(RelayRecordSource.create()),
         });
         environment.commitPayload(
           createOperationDescriptor(
@@ -1481,7 +1481,7 @@ describe.each([true, false])(
       test('invariant for invalid liveState value in the Relay store.', () => {
         const environment = new RelayModernEnvironment({
           network: RelayNetwork.create(jest.fn()),
-          store: new LiveResolverStore(RelayRecordSource.create()),
+          store: new RelayModernStore(RelayRecordSource.create()),
         });
         environment.commitPayload(
           createOperationDescriptor(
@@ -1525,7 +1525,7 @@ describe.each([true, false])(
     });
 
     test('Subscriptions cleaned up correctly after GC', () => {
-      const store = new LiveResolverStore(RelayRecordSource.create(), {
+      const store = new RelayModernStore(RelayRecordSource.create(), {
         gcReleaseBufferSize: 0,
       });
       const environment = new RelayModernEnvironment({
@@ -1645,7 +1645,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -1675,7 +1675,7 @@ describe.each([true, false])(
       `;
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
       });
 
@@ -1707,7 +1707,7 @@ describe.each([true, false])(
       const operation = createOperationDescriptor(FooQuery, {});
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(source, {
+        store: new RelayModernStore(source, {
           gcReleaseBufferSize: 0,
         }),
       });
@@ -1741,7 +1741,7 @@ describe.each([true, false])(
       const operation = createOperationDescriptor(FooQuery, {});
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(source, {
+        store: new RelayModernStore(source, {
           gcReleaseBufferSize: 0,
         }),
       });
@@ -1763,7 +1763,7 @@ describe.each([true, false])(
       const operation = createOperationDescriptor(FooQuery, {});
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(RelayRecordSource.create(), {
+        store: new RelayModernStore(RelayRecordSource.create(), {
           gcReleaseBufferSize: 0,
         }),
       });
@@ -1785,7 +1785,7 @@ describe.each([true, false])(
       const operation = createOperationDescriptor(FooQuery, {});
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(RelayRecordSource.create(), {
+        store: new RelayModernStore(RelayRecordSource.create(), {
           gcReleaseBufferSize: 0,
           resolverContext: {
             greeting: {myHello: 'Hello Allemaal!'},
@@ -1810,7 +1810,7 @@ describe.each([true, false])(
       const operation = createOperationDescriptor(FooQuery, {});
       const environment = new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
-        store: new LiveResolverStore(RelayRecordSource.create(), {
+        store: new RelayModernStore(RelayRecordSource.create(), {
           gcReleaseBufferSize: 0,
           resolverContext: {
             greeting: {
@@ -1851,7 +1851,7 @@ describe.each([true, false])(
       };
 
       const operation = createOperationDescriptor(FooQuery, {});
-      const store = new LiveResolverStore(source, {
+      const store = new RelayModernStore(source, {
         gcReleaseBufferSize: 0,
         resolverContext: {
           counter: Observable.create<number>(observer => {

packages/react-relay/__tests__/RelayClient3DModule-test.js

@@ -32,8 +32,8 @@ import {
 import RelayNetwork from 'relay-runtime/network/RelayNetwork';
 import {graphql} from 'relay-runtime/query/GraphQLTag';
 import {resetStore} from 'relay-runtime/store/__tests__/resolvers/ExampleTodoStore';
-import LiveResolverStore from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
 import RelayModernEnvironment from 'relay-runtime/store/RelayModernEnvironment';
+import RelayModernStore from 'relay-runtime/store/RelayModernStore';
 import RelayRecordSource from 'relay-runtime/store/RelayRecordSource';
 import {
   disallowConsoleErrors,
@@ -124,7 +124,7 @@ describe('ClientUser', () => {
   let environment;
 
   beforeEach(() => {
-    store = new LiveResolverStore(RelayRecordSource.create(), {
+    store = new RelayModernStore(RelayRecordSource.create(), {
       log: logFn,
     });
     environment = new RelayModernEnvironment({
@@ -192,7 +192,7 @@ describe('SpecialUser', () => {
   let environment;
   let store;
   beforeEach(() => {
-    store = new LiveResolverStore(RelayRecordSource.create(), {
+    store = new RelayModernStore(RelayRecordSource.create(), {
       log: logFn,
     });
     environment = new RelayModernEnvironment({

packages/react-relay/__tests__/RelayResolverInterface-test.js

@@ -22,8 +22,8 @@ const {RecordSource} = require('relay-runtime');
 const {RelayFeatureFlags} = require('relay-runtime');
 const RelayNetwork = require('relay-runtime/network/RelayNetwork');
 const {graphql} = require('relay-runtime/query/GraphQLTag');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore.js');
 const RelayModernEnvironment = require('relay-runtime/store/RelayModernEnvironment');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore.js');
 const {
   disallowConsoleErrors,
   disallowWarnings,
@@ -57,7 +57,7 @@ function EnvironmentWrapper({
 let environment;
 let store;
 beforeEach(() => {
-  store = new LiveResolverStore(
+  store = new RelayModernStore(
     new RecordSource({
       'client:root': {
         __id: 'client:root',

packages/react-relay/__tests__/RelayResolverModel-test.js

@@ -42,8 +42,8 @@ const {
 const {
   LiveColorSubscriptions,
 } = require('relay-runtime/store/__tests__/resolvers/TodoDescription');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore.js');
 const RelayModernEnvironment = require('relay-runtime/store/RelayModernEnvironment');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore.js');
 const RelayRecordSource = require('relay-runtime/store/RelayRecordSource');
 const {
   disallowConsoleErrors,
@@ -92,7 +92,7 @@ describe.each([true, false])(
         let environment;
         let store;
         beforeEach(() => {
-          store = new LiveResolverStore(RelayRecordSource.create(), {
+          store = new RelayModernStore(RelayRecordSource.create(), {
             log: logFn,
           });
           environment = new RelayModernEnvironment({

packages/react-relay/__tests__/RelayResolverNullableModelClientEdge-test.js

@@ -28,7 +28,7 @@ const {
 const {
   addTodo,
 } = require('relay-runtime/store/__tests__/resolvers/ExampleTodoStore');
-const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore');
+const RelayModernStore = require('relay-runtime/store/RelayModernStore');
 const {createMockEnvironment} = require('relay-test-utils');
 
 /**
@@ -194,7 +194,7 @@ function logFn(event: LogEvent): void {
 function createEnvironment() {
   return new Environment({
     network: Network.create(jest.fn()),
-    store: new LiveResolverStore(RecordSource.create(), {
+    store: new RelayModernStore(RecordSource.create(), {
       log: logFn,
     }),
     log: logFn,