Make LiveState and suspenseSentinel top level exports of Relay

Reviewed By: voideanvalue Differential Revision: D51287170 fbshipit-source-id: a08b0091b68c084f89da281630b854867a09aebf
facebook · Nov 14, 2023 · 400090b · 400090b
1 parent 59f5d60
commit 400090b
Show file tree

Hide file tree

Showing 31 changed files with 67 additions and 68 deletions.
diff --git a/packages/relay-runtime/index.js b/packages/relay-runtime/index.js
@@ -34,6 +34,9 @@ const {
 } = require('./store/ClientID');
 const createFragmentSpecResolver = require('./store/createFragmentSpecResolver');
 const createRelayContext = require('./store/createRelayContext');
+const {
+  suspenseSentinel,
+} = require('./store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
 const isRelayModernEnvironment = require('./store/isRelayModernEnvironment');
 const normalizeResponse = require('./store/normalizeResponse');
 const readInlineData = require('./store/readInlineData');
@@ -162,6 +165,7 @@ export type {
   StoreUpdater,
   UpdatableData,
   TaskScheduler,
+  LiveState,
 } from './store/RelayStoreTypes';
 export type {
   GraphQLSubscriptionConfig,
@@ -300,6 +304,7 @@ module.exports = {
   graphql: GraphQLTag.graphql,
   isFragment: GraphQLTag.isFragment,
   isInlineDataFragment: GraphQLTag.isInlineDataFragment,
+  suspenseSentinel,
   isRequest: GraphQLTag.isRequest,
   readInlineData,
 

diff --git a/packages/relay-runtime/store/RelayStoreTypes.js b/packages/relay-runtime/store/RelayStoreTypes.js
@@ -1290,3 +1290,25 @@ export interface PublishQueue {
 export type ConcreteClientEdgeResolverReturnType<T = any> = {
   +id: T & DataID,
 };
+
+/**
+ * The return type of a Live Resolver. Models an external value which can
+ * be read lazily and which might change over time. The subscribe method
+ * returns a callback which should be called when the value _may_ have changed.
+ *
+ * While over-notification (subscription notifications when the read value has
+ * not actually changed) is suported, for performance reasons, it is recommended
+ * that the provider of the LiveState value confirms that the value has indeed
+ * change before notifying Relay of the change.
+ */
+export type LiveState<+T> = {
+  /**
+   * Returns the current value of the live state.
+   */
+  read(): T,
+  /**
+   * Subscribes to changes in the live state. The state provider should
+   * call the callback when the value of the live state changes.
+   */
+  subscribe(cb: () => void): () => void,
+};
diff --git a/packages/relay-runtime/store/__tests__/resolvers/CounterSuspendsWhenOdd.js b/packages/relay-runtime/store/__tests__/resolvers/CounterSuspendsWhenOdd.js
@@ -12,13 +12,10 @@
 'use strict';
 
 import type {CounterSuspendsWhenOdd$key} from './__generated__/CounterSuspendsWhenOdd.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
-const {graphql} = require('relay-runtime');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {graphql, suspenseSentinel} = require('relay-runtime');
 const {readFragment} = require('relay-runtime/store/ResolverFragments');
 
 /**

diff --git a/packages/relay-runtime/store/__tests__/resolvers/CounterSuspendsWhenOddOnUser.js b/packages/relay-runtime/store/__tests__/resolvers/CounterSuspendsWhenOddOnUser.js
@@ -11,12 +11,10 @@
 
 'use strict';
 
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {suspenseSentinel} = require('relay-runtime');
 
 /**
  * @RelayResolver

diff --git a/packages/relay-runtime/store/__tests__/resolvers/InnerResolver.js b/packages/relay-runtime/store/__tests__/resolvers/InnerResolver.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {InnerResolver$key} from './__generated__/InnerResolver.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 const {graphql} = require('relay-runtime');

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveConstantClientEdgeResolver.js b/packages/relay-runtime/store/__tests__/resolvers/LiveConstantClientEdgeResolver.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {ConcreteClientEdgeResolverReturnType} from 'relay-runtime';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 /**
  * @RelayResolver

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveCounterNoFragment.js b/packages/relay-runtime/store/__tests__/resolvers/LiveCounterNoFragment.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveCounterNoFragmentWithArg.js b/packages/relay-runtime/store/__tests__/resolvers/LiveCounterNoFragmentWithArg.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveCounterResolver.js b/packages/relay-runtime/store/__tests__/resolvers/LiveCounterResolver.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {LiveCounterResolver$key} from './__generated__/LiveCounterResolver.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 const {graphql} = require('relay-runtime');

diff --git a/...y-runtime/store/__tests__/resolvers/LiveCounterWithPossibleMissingFragmentDataResolver.js b/...y-runtime/store/__tests__/resolvers/LiveCounterWithPossibleMissingFragmentDataResolver.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {LiveCounterWithPossibleMissingFragmentDataResolverFragment$key} from './__generated__/LiveCounterWithPossibleMissingFragmentDataResolverFragment.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 const {graphql} = require('relay-runtime');

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveExternalGreeting.js b/packages/relay-runtime/store/__tests__/resolvers/LiveExternalGreeting.js
@@ -12,12 +12,9 @@
 'use strict';
 
 import type {LiveExternalGreetingFragment$key} from './__generated__/LiveExternalGreetingFragment.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
-const {graphql} = require('relay-runtime');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {graphql, suspenseSentinel} = require('relay-runtime');
 const {readFragment} = require('relay-runtime/store/ResolverFragments');
 
 /**

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LivePingPongResolver.js b/packages/relay-runtime/store/__tests__/resolvers/LivePingPongResolver.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {LivePingPongResolver$key} from './__generated__/LivePingPongResolver.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {graphql} = require('relay-runtime');
 const {readFragment} = require('relay-runtime/store/ResolverFragments');

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveResolvers-test.js b/packages/relay-runtime/store/__tests__/resolvers/LiveResolvers-test.js
@@ -15,17 +15,14 @@ import type {Snapshot} from '../../RelayStoreTypes';
 const {
   live_external_greeting: LiveExternalGreeting,
 } = require('./LiveExternalGreeting');
-const {RelayFeatureFlags} = require('relay-runtime');
+const {RelayFeatureFlags, suspenseSentinel} = require('relay-runtime');
 const RelayNetwork = require('relay-runtime/network/RelayNetwork');
 const {graphql} = require('relay-runtime/query/GraphQLTag');
 const {
   GLOBAL_STORE,
   resetStore,
 } = require('relay-runtime/store/__tests__/resolvers/ExampleExternalStateStore');
 const LiveResolverStore = require('relay-runtime/store/experimental-live-resolvers/LiveResolverStore');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
 const RelayModernEnvironment = require('relay-runtime/store/RelayModernEnvironment');
 const {
   createOperationDescriptor,

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveUserAlwaysSuspendResolver.js b/packages/relay-runtime/store/__tests__/resolvers/LiveUserAlwaysSuspendResolver.js
@@ -12,11 +12,9 @@
 'use strict';
 
 import type {ConcreteClientEdgeResolverReturnType} from 'relay-runtime';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {suspenseSentinel} = require('relay-runtime');
 
 /**
  * @RelayResolver

diff --git a/packages/relay-runtime/store/__tests__/resolvers/LiveUserSuspendsWhenOdd.js b/packages/relay-runtime/store/__tests__/resolvers/LiveUserSuspendsWhenOdd.js
@@ -12,12 +12,10 @@
 'use strict';
 
 import type {DataID} from 'relay-runtime';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {suspenseSentinel} = require('relay-runtime');
 
 /**
  * @RelayResolver

diff --git a/packages/relay-runtime/store/__tests__/resolvers/MutableModel.js b/packages/relay-runtime/store/__tests__/resolvers/MutableModel.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 type Entity = {
   name: string,

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverReturnsUndefined.js b/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverReturnsUndefined.js
@@ -11,6 +11,8 @@
 
 'use strict';
 
+import type {LiveState} from 'relay-runtime';
+
 /**
  * @RelayResolver
  * @fieldName live_resolver_return_undefined
@@ -19,8 +21,6 @@
  *
  * A @live resolver that throws
  */
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
-
 // $FlowFixMe - this resolver returns undefined, but should return LiveState
 function live_resolver_return_undefined(): LiveState<$FlowFixMe> {}
 

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverThrows.js b/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverThrows.js
@@ -11,6 +11,8 @@
 
 'use strict';
 
+import type {LiveState} from 'relay-runtime';
+
 /**
  * @RelayResolver
  * @fieldName live_resolver_throws
@@ -19,8 +21,6 @@
  *
  * A @live resolver that throws
  */
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
-
 function live_resolver_throws(): LiveState<null> {
   throw new Error('What?');
 }

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverThrowsOnRead.js b/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverThrowsOnRead.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
 

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverWithBadReturnValue.js b/packages/relay-runtime/store/__tests__/resolvers/QueryLiveResolverWithBadReturnValue.js
@@ -10,6 +10,7 @@
  */
 
 'use strict';
+import type {LiveState} from 'relay-runtime';
 
 /**
  * @RelayResolver
@@ -19,8 +20,6 @@
  *
  * A @live resolver that does not return a LiveObject
  */
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
-
 function live_resolver_with_bad_return_value(): LiveState<string> {
   // $FlowFixMe The purpose of this resolver is to test a bad return value.
   return 'Oops!';

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryManyLiveTodos.js b/packages/relay-runtime/store/__tests__/resolvers/QueryManyLiveTodos.js
@@ -10,8 +10,7 @@
  */
 
 'use strict';
-
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {
   Selectors,

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryNonLiveResolverWithLiveReturnValue.js b/packages/relay-runtime/store/__tests__/resolvers/QueryNonLiveResolverWithLiveReturnValue.js
@@ -10,6 +10,7 @@
  */
 
 'use strict';
+import type {LiveState} from 'relay-runtime';
 
 /**
  * @RelayResolver
@@ -18,8 +19,6 @@
  *
  * A non-@live resolver that returns a LiveObject
  */
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
-
 function non_live_resolver_with_live_return_value(): LiveState<string> {
   return {
     read() {

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryTodo.js b/packages/relay-runtime/store/__tests__/resolvers/QueryTodo.js
@@ -11,8 +11,8 @@
 
 'use strict';
 
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
 import type {Query__todo$normalization as ReturnType} from './__generated__/Query__todo$normalization.graphql';
+import type {LiveState} from 'relay-runtime';
 
 const {
   Selectors,

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryTodos.js b/packages/relay-runtime/store/__tests__/resolvers/QueryTodos.js
@@ -11,8 +11,8 @@
 
 'use strict';
 
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
 import type {Query__todos$normalization as ReturnType} from './__generated__/Query__todos$normalization.graphql';
+import type {LiveState} from 'relay-runtime';
 
 const {
   Selectors,

diff --git a/packages/relay-runtime/store/__tests__/resolvers/QueryVirgoLiveSuspendsWhenOddResolver.js b/packages/relay-runtime/store/__tests__/resolvers/QueryVirgoLiveSuspendsWhenOddResolver.js
@@ -12,12 +12,10 @@
 'use strict';
 
 import type {AstrologicalSignID} from './AstrologicalSignUtils';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {suspenseSentinel} = require('relay-runtime');
 
 /**
  * @RelayResolver Query.virgo_suspends_when_counter_is_odd: AstrologicalSign

diff --git a/packages/relay-runtime/store/__tests__/resolvers/ResolverThatThrows.js b/packages/relay-runtime/store/__tests__/resolvers/ResolverThatThrows.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {ResolverThatThrows$key} from './__generated__/ResolverThatThrows.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {graphql} = require('relay-runtime');
 const {readFragment} = require('relay-runtime/store/ResolverFragments');

diff --git a/packages/relay-runtime/store/__tests__/resolvers/TodoModel.js b/packages/relay-runtime/store/__tests__/resolvers/TodoModel.js
@@ -15,19 +15,16 @@ import type {TodoModelCapitalizedID$key} from './__generated__/TodoModelCapitali
 import type {TodoModelCapitalizedIDLegacy$key} from './__generated__/TodoModelCapitalizedIDLegacy.graphql';
 import type {TodoDescription} from './TodoDescription';
 import type {ConcreteClientEdgeResolverReturnType} from 'relay-runtime';
+import type {LiveState} from 'relay-runtime';
 import type {TodoItem} from 'relay-runtime/store/__tests__/resolvers/ExampleTodoStore';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
 
 const {readFragment} = require('../../ResolverFragments');
 const {createTodoDescription} = require('./TodoDescription');
-const {graphql} = require('relay-runtime');
+const {graphql, suspenseSentinel} = require('relay-runtime');
 const {
   Selectors,
   TODO_STORE,
 } = require('relay-runtime/store/__tests__/resolvers/ExampleTodoStore');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
 
 type TodoModelType = ?TodoItem;
 

diff --git a/packages/relay-runtime/store/__tests__/resolvers/TodoSelfResolver.js b/packages/relay-runtime/store/__tests__/resolvers/TodoSelfResolver.js
@@ -11,8 +11,8 @@
 
 'use strict';
 
-import type {LiveState} from '../../experimental-live-resolvers/LiveResolverStore';
 import type {TodoSelfResolverFragment$key} from './__generated__/TodoSelfResolverFragment.graphql';
+import type {LiveState} from 'relay-runtime';
 import type {TodoItem} from 'relay-runtime/store/__tests__/resolvers/ExampleTodoStore';
 
 const {graphql} = require('relay-runtime');

diff --git a/...lay-runtime/store/__tests__/resolvers/UserProfilePictureUriSuspendsWhenTheCounterIsOdd.js b/...lay-runtime/store/__tests__/resolvers/UserProfilePictureUriSuspendsWhenTheCounterIsOdd.js
@@ -12,13 +12,10 @@
 'use strict';
 
 import type {UserProfilePictureUriSuspendsWhenTheCounterIsOdd$key} from './__generated__/UserProfilePictureUriSuspendsWhenTheCounterIsOdd.graphql';
-import type {LiveState} from 'relay-runtime/store/experimental-live-resolvers/LiveResolverStore';
+import type {LiveState} from 'relay-runtime';
 
 const {GLOBAL_STORE, Selectors} = require('./ExampleExternalStateStore');
-const {graphql} = require('relay-runtime');
-const {
-  suspenseSentinel,
-} = require('relay-runtime/store/experimental-live-resolvers/LiveResolverSuspenseSentinel');
+const {graphql, suspenseSentinel} = require('relay-runtime');
 const {readFragment} = require('relay-runtime/store/ResolverFragments');
 
 /**