relay-runtime 0.0.0-main-c3ad9027 → 0.0.0-main-74926b6f

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-c3ad9027
+ * Relay v0.0.0-main-74926b6f
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *

package/lib/store/RelayModernSelector.js

@@ -14,6 +14,7 @@ var _require = require('./RelayConcreteVariables'),
     getFragmentVariables = _require.getFragmentVariables;
 
 var _require2 = require('./RelayStoreUtils'),
+    CLIENT_EDGE_TRAVERSAL_PATH = _require2.CLIENT_EDGE_TRAVERSAL_PATH,
     FRAGMENT_OWNER_KEY = _require2.FRAGMENT_OWNER_KEY,
     FRAGMENTS_KEY = _require2.FRAGMENTS_KEY,
     ID_KEY = _require2.ID_KEY,
@@ -61,12 +62,14 @@ function getSingularSelector(fragment, item) {
   var fragments = item[FRAGMENTS_KEY];
   var mixedOwner = item[FRAGMENT_OWNER_KEY];
   var isWithinUnmatchedTypeRefinement = item[IS_WITHIN_UNMATCHED_TYPE_REFINEMENT] === true;
+  var mixedClientEdgeTraversalPath = item[CLIENT_EDGE_TRAVERSAL_PATH];
 
-  if (typeof dataID === 'string' && typeof fragments === 'object' && fragments !== null && typeof fragments[fragment.name] === 'object' && fragments[fragment.name] !== null && typeof mixedOwner === 'object' && mixedOwner !== null) {
+  if (typeof dataID === 'string' && typeof fragments === 'object' && fragments !== null && typeof fragments[fragment.name] === 'object' && fragments[fragment.name] !== null && typeof mixedOwner === 'object' && mixedOwner !== null && (mixedClientEdgeTraversalPath == null || Array.isArray(mixedClientEdgeTraversalPath))) {
     var owner = mixedOwner;
+    var clientEdgeTraversalPath = mixedClientEdgeTraversalPath;
     var argumentVariables = fragments[fragment.name];
     var fragmentVariables = getFragmentVariables(fragment, owner.variables, argumentVariables);
-    return createReaderSelector(fragment, dataID, fragmentVariables, owner, isWithinUnmatchedTypeRefinement);
+    return createReaderSelector(fragment, dataID, fragmentVariables, owner, isWithinUnmatchedTypeRefinement, clientEdgeTraversalPath);
   }
 
   if (process.env.NODE_ENV !== "production") {
@@ -296,10 +299,12 @@ function areEqualSelectors(thisSelector, thatSelector) {
 
 function createReaderSelector(fragment, dataID, variables, request) {
   var isWithinUnmatchedTypeRefinement = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
+  var clientEdgeTraversalPath = arguments.length > 5 ? arguments[5] : undefined;
   return {
     kind: 'SingularReaderSelector',
     dataID: dataID,
     isWithinUnmatchedTypeRefinement: isWithinUnmatchedTypeRefinement,
+    clientEdgeTraversalPath: clientEdgeTraversalPath !== null && clientEdgeTraversalPath !== void 0 ? clientEdgeTraversalPath : null,
     node: fragment,
     variables: variables,
     owner: request

package/lib/store/RelayReader.js

@@ -14,8 +14,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
 var _require = require('../util/RelayConcreteNode'),
     ACTOR_CHANGE = _require.ACTOR_CHANGE,
+    CLIENT_EDGE = _require.CLIENT_EDGE,
     CLIENT_EXTENSION = _require.CLIENT_EXTENSION,
     CONDITION = _require.CONDITION,
     DEFER = _require.DEFER,
@@ -40,6 +43,7 @@ var _require2 = require('./RelayStoreReactFlightUtils'),
     getReactFlightClientResponse = _require2.getReactFlightClientResponse;
 
 var _require3 = require('./RelayStoreUtils'),
+    CLIENT_EDGE_TRAVERSAL_PATH = _require3.CLIENT_EDGE_TRAVERSAL_PATH,
     FRAGMENT_OWNER_KEY = _require3.FRAGMENT_OWNER_KEY,
     FRAGMENT_PROP_NAME_KEY = _require3.FRAGMENT_PROP_NAME_KEY,
     FRAGMENTS_KEY = _require3.FRAGMENTS_KEY,
@@ -73,6 +77,10 @@ function read(recordSource, selector, resolverCache) {
 
 var RelayReader = /*#__PURE__*/function () {
   function RelayReader(recordSource, selector, resolverCache) {
+    var _selector$clientEdgeT;
+
+    this._clientEdgeTraversalPath = RelayFeatureFlags.ENABLE_CLIENT_EDGES && ((_selector$clientEdgeT = selector.clientEdgeTraversalPath) === null || _selector$clientEdgeT === void 0 ? void 0 : _selector$clientEdgeT.length) ? (0, _toConsumableArray2["default"])(selector.clientEdgeTraversalPath) : [];
+    this._missingClientEdges = [];
     this._isMissingData = false;
     this._isWithinUnmatchedTypeRefinement = false;
     this._missingRequiredFields = null;
@@ -152,12 +160,30 @@ var RelayReader = /*#__PURE__*/function () {
     return {
       data: data,
       isMissingData: this._isMissingData && isDataExpectedToBePresent,
+      missingClientEdges: RelayFeatureFlags.ENABLE_CLIENT_EDGES && this._missingClientEdges.length ? this._missingClientEdges : null,
       seenRecords: this._seenRecords,
       selector: this._selector,
       missingRequiredFields: this._missingRequiredFields
     };
   };
 
+  _proto._markDataAsMissing = function _markDataAsMissing() {
+    this._isMissingData = true;
+
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES && this._clientEdgeTraversalPath.length) {
+      var top = this._clientEdgeTraversalPath[this._clientEdgeTraversalPath.length - 1]; // Top can be null if we've traversed past a client edge into an ordinary
+      // client extension field; we never want to fetch in response to missing
+      // data off of a client extension field.
+
+      if (top !== null) {
+        this._missingClientEdges.push({
+          request: top.readerClientEdge.operation,
+          clientEdgeDestinationID: top.clientEdgeDestinationID
+        });
+      }
+    }
+  };
+
   _proto._traverse = function _traverse(node, dataID, prevData) {
     var record = this._recordSource.get(dataID);
 
@@ -165,7 +191,7 @@ var RelayReader = /*#__PURE__*/function () {
 
     if (record == null) {
       if (record === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return record;
@@ -321,7 +347,7 @@ var RelayReader = /*#__PURE__*/function () {
                 this._isMissingData = parentIsMissingData;
               } else if (implementsInterface == null) {
                 // Don't know if the type implements the interface or not
-                this._isMissingData = true;
+                this._markDataAsMissing();
               }
             }
 
@@ -358,10 +384,22 @@ var RelayReader = /*#__PURE__*/function () {
         case CLIENT_EXTENSION:
           {
             var isMissingData = this._isMissingData;
+            var alreadyMissingClientEdges = this._missingClientEdges.length;
+
+            if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+              this._clientEdgeTraversalPath.push(null);
+            }
+
+            var _hasExpectedData2 = this._traverseSelections(selection.selections, record, data); // The only case where we want to suspend due to missing data off of
+            // a client extension is if we reached a client edge that we might be
+            // able to fetch:
 
-            var _hasExpectedData2 = this._traverseSelections(selection.selections, record, data);
 
-            this._isMissingData = isMissingData;
+            this._isMissingData = isMissingData || this._missingClientEdges.length > alreadyMissingClientEdges;
+
+            if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+              this._clientEdgeTraversalPath.pop();
+            }
 
             if (!_hasExpectedData2) {
               return false;
@@ -395,6 +433,15 @@ var RelayReader = /*#__PURE__*/function () {
 
           break;
 
+        case CLIENT_EDGE:
+          if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+            this._readClientEdge(selection, record, data);
+          } else {
+            throw new Error('Client edges are not yet supported.');
+          }
+
+          break;
+
         default:
           selection;
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0;
@@ -434,6 +481,8 @@ var RelayReader = /*#__PURE__*/function () {
   _proto._readResolverField = function _readResolverField(field, record, data) {
     var _this = this;
 
+    var _field$alias;
+
     var resolverModule = field.resolverModule,
         fragment = field.fragment;
     var storageKey = getStorageKey(field, this._variables);
@@ -501,14 +550,53 @@ var RelayReader = /*#__PURE__*/function () {
       this._seenRecords.add(seenRecord);
     }
 
-    data[storageKey] = result;
-    return result;
+    var applicationName = (_field$alias = field.alias) !== null && _field$alias !== void 0 ? _field$alias : field.name;
+    data[applicationName] = result;
+  };
+
+  _proto._readClientEdge = function _readClientEdge(field, record, data) {
+    var _backingField$alias;
+
+    var backingField = field.backingField; // Because ReaderClientExtension doesn't have `alias` or `name` and so I don't know
+    // how to get its applicationName or storageKey yet:
+
+    !(backingField.kind !== 'ClientExtension') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Client extension client edges are not yet implemented.') : invariant(false) : void 0;
+    var applicationName = (_backingField$alias = backingField.alias) !== null && _backingField$alias !== void 0 ? _backingField$alias : backingField.name;
+    var backingFieldData = {};
+
+    this._traverseSelections([backingField], record, backingFieldData);
+
+    var destinationDataID = backingFieldData[applicationName];
+
+    if (destinationDataID == null) {
+      data[applicationName] = destinationDataID;
+      return;
+    }
+
+    !(typeof destinationDataID === 'string') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Plural client edges not are yet implemented') : invariant(false) : void 0; // FIXME support plural
+    // Not wrapping the push/pop in a try/finally because if we throw, the
+    // Reader object is not usable after that anyway.
+
+    this._clientEdgeTraversalPath.push({
+      readerClientEdge: field,
+      clientEdgeDestinationID: destinationDataID
+    });
+
+    var prevData = data[applicationName];
+    !(prevData == null || typeof prevData === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, RelayModernRecord.getDataID(record), prevData) : invariant(false) : void 0;
+
+    var value = this._traverse(field.linkedField, destinationDataID, // $FlowFixMe[incompatible-variance]
+    prevData);
+
+    data[applicationName] = value;
+
+    this._clientEdgeTraversalPath.pop();
   };
 
   _proto._readFlightField = function _readFlightField(field, record, data) {
-    var _field$alias;
+    var _field$alias2;
 
-    var applicationName = (_field$alias = field.alias) !== null && _field$alias !== void 0 ? _field$alias : field.name;
+    var applicationName = (_field$alias2 = field.alias) !== null && _field$alias2 !== void 0 ? _field$alias2 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var reactFlightClientResponseRecordID = RelayModernRecord.getLinkedRecordID(record, storageKey);
 
@@ -516,7 +604,7 @@ var RelayReader = /*#__PURE__*/function () {
       data[applicationName] = reactFlightClientResponseRecordID;
 
       if (reactFlightClientResponseRecordID === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return reactFlightClientResponseRecordID;
@@ -530,7 +618,7 @@ var RelayReader = /*#__PURE__*/function () {
       data[applicationName] = reactFlightClientResponseRecord;
 
       if (reactFlightClientResponseRecord === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return reactFlightClientResponseRecord;
@@ -542,14 +630,14 @@ var RelayReader = /*#__PURE__*/function () {
   };
 
   _proto._readScalar = function _readScalar(field, record, data) {
-    var _field$alias2;
+    var _field$alias3;
 
-    var applicationName = (_field$alias2 = field.alias) !== null && _field$alias2 !== void 0 ? _field$alias2 : field.name;
+    var applicationName = (_field$alias3 = field.alias) !== null && _field$alias3 !== void 0 ? _field$alias3 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var value = RelayModernRecord.getValue(record, storageKey);
 
     if (value === undefined) {
-      this._isMissingData = true;
+      this._markDataAsMissing();
     }
 
     data[applicationName] = value;
@@ -557,9 +645,9 @@ var RelayReader = /*#__PURE__*/function () {
   };
 
   _proto._readLink = function _readLink(field, record, data) {
-    var _field$alias3;
+    var _field$alias4;
 
-    var applicationName = (_field$alias3 = field.alias) !== null && _field$alias3 !== void 0 ? _field$alias3 : field.name;
+    var applicationName = (_field$alias4 = field.alias) !== null && _field$alias4 !== void 0 ? _field$alias4 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var linkedID = RelayModernRecord.getLinkedRecordID(record, storageKey);
 
@@ -567,7 +655,7 @@ var RelayReader = /*#__PURE__*/function () {
       data[applicationName] = linkedID;
 
       if (linkedID === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return linkedID;
@@ -583,9 +671,9 @@ var RelayReader = /*#__PURE__*/function () {
   };
 
   _proto._readActorChange = function _readActorChange(field, record, data) {
-    var _field$alias4;
+    var _field$alias5;
 
-    var applicationName = (_field$alias4 = field.alias) !== null && _field$alias4 !== void 0 ? _field$alias4 : field.name;
+    var applicationName = (_field$alias5 = field.alias) !== null && _field$alias5 !== void 0 ? _field$alias5 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var externalRef = RelayModernRecord.getActorLinkedRecordID(record, storageKey);
 
@@ -593,7 +681,7 @@ var RelayReader = /*#__PURE__*/function () {
       data[applicationName] = externalRef;
 
       if (externalRef === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return data[applicationName];
@@ -617,9 +705,9 @@ var RelayReader = /*#__PURE__*/function () {
   _proto._readPluralLink = function _readPluralLink(field, record, data) {
     var _this2 = this;
 
-    var _field$alias5;
+    var _field$alias6;
 
-    var applicationName = (_field$alias5 = field.alias) !== null && _field$alias5 !== void 0 ? _field$alias5 : field.name;
+    var applicationName = (_field$alias6 = field.alias) !== null && _field$alias6 !== void 0 ? _field$alias6 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var linkedIDs = RelayModernRecord.getLinkedRecordIDs(record, storageKey);
 
@@ -627,7 +715,7 @@ var RelayReader = /*#__PURE__*/function () {
       data[applicationName] = linkedIDs;
 
       if (linkedIDs === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return linkedIDs;
@@ -639,7 +727,7 @@ var RelayReader = /*#__PURE__*/function () {
     linkedIDs.forEach(function (linkedID, nextIndex) {
       if (linkedID == null) {
         if (linkedID === undefined) {
-          _this2._isMissingData = true;
+          _this2._markDataAsMissing();
         } // $FlowFixMe[cannot-write]
 
 
@@ -670,7 +758,7 @@ var RelayReader = /*#__PURE__*/function () {
 
     if (component == null) {
       if (component === undefined) {
-        this._isMissingData = true;
+        this._markDataAsMissing();
       }
 
       return;
@@ -708,6 +796,12 @@ var RelayReader = /*#__PURE__*/function () {
     fragmentPointers[fragmentSpread.name] = fragmentSpread.args ? getArgumentValues(fragmentSpread.args, this._variables) : {};
     data[FRAGMENT_OWNER_KEY] = this._owner;
     data[IS_WITHIN_UNMATCHED_TYPE_REFINEMENT] = this._isWithinUnmatchedTypeRefinement;
+
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+      if (this._clientEdgeTraversalPath.length > 0 && this._clientEdgeTraversalPath[this._clientEdgeTraversalPath.length - 1] !== null) {
+        data[CLIENT_EDGE_TRAVERSAL_PATH] = (0, _toConsumableArray2["default"])(this._clientEdgeTraversalPath);
+      }
+    }
   };
 
   _proto._createInlineDataOrResolverFragmentPointer = function _createInlineDataOrResolverFragmentPointer(fragmentSpreadOrFragment, record, data) {

package/lib/store/RelayStoreSubscriptions.js

@@ -93,6 +93,7 @@ var RelayStoreSubscriptions = /*#__PURE__*/function () {
         subscription.snapshot = {
           data: subscription.snapshot.data,
           isMissingData: backup.isMissingData,
+          missingClientEdges: backup.missingClientEdges,
           seenRecords: backup.seenRecords,
           selector: backup.selector,
           missingRequiredFields: backup.missingRequiredFields
@@ -142,6 +143,7 @@ var RelayStoreSubscriptions = /*#__PURE__*/function () {
     nextSnapshot = {
       data: nextData,
       isMissingData: nextSnapshot.isMissingData,
+      missingClientEdges: nextSnapshot.missingClientEdges,
       seenRecords: nextSnapshot.seenRecords,
       selector: nextSnapshot.selector,
       missingRequiredFields: nextSnapshot.missingRequiredFields

package/lib/store/RelayStoreUtils.js

@@ -193,6 +193,7 @@ function getModuleOperationKey(documentName) {
 
 var RelayStoreUtils = {
   ACTOR_IDENTIFIER_KEY: '__actorIdentifier',
+  CLIENT_EDGE_TRAVERSAL_PATH: '__clientEdgeTraversalPath',
   FRAGMENTS_KEY: '__fragments',
   FRAGMENT_OWNER_KEY: '__fragmentOwner',
   FRAGMENT_PROP_NAME_KEY: '__fragmentPropName',

package/lib/util/RelayConcreteNode.js

@@ -27,6 +27,7 @@ var RelayConcreteNode = {
   ACTOR_CHANGE: 'ActorChange',
   CONDITION: 'Condition',
   CLIENT_COMPONENT: 'ClientComponent',
+  CLIENT_EDGE: 'ClientEdge',
   CLIENT_EXTENSION: 'ClientExtension',
   DEFER: 'Defer',
   CONNECTION: 'Connection',

package/lib/util/RelayFeatureFlags.js

@@ -12,6 +12,7 @@
 
 var RelayFeatureFlags = {
   DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: false,
+  ENABLE_CLIENT_EDGES: false,
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: true,
   ENABLE_REACT_FLIGHT_COMPONENT_FIELD: false,
@@ -26,6 +27,7 @@ var RelayFeatureFlags = {
   ENABLE_CONTAINERS_SUBSCRIBE_ON_COMMIT: false,
   ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT: false,
   MAX_DATA_ID_LENGTH: null,
+  REFACTOR_SUSPENSE_RESOURCE: true,
   STRING_INTERN_LEVEL: 0,
   USE_REACT_CACHE: false
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "0.0.0-main-c3ad9027",
+  "version": "0.0.0-main-74926b6f",
   "keywords": [
     "graphql",
     "relay"