react-relay 2.0.0-rc.2 → 5.0.0

package/lib/RelayMutationQueue.js

@@ -1,530 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- * 
- * @format
- */
-'use strict';
-
-var _defineProperty2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/defineProperty"));
-
-var _objectSpread3 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/objectSpread"));
-
-var transactionIDCounter = 0;
-/**
- * @internal
- *
- * Coordinates execution of concurrent mutations, including application and
- * rollback of optimistic payloads and enqueueing mutations with the same
- * collision key.
- */
-
-var RelayMutationQueue =
-/*#__PURE__*/
-function () {
-  function RelayMutationQueue(storeData) {
-    this._collisionQueueMap = {};
-    this._pendingTransactionMap = {};
-    this._queue = [];
-    this._storeData = storeData;
-    this._willBatchRefreshQueuedData = false;
-  }
-  /**
-   * High-level API for creating a RelayMutationTransaction from a
-   * RelayMutation.
-   */
-
-
-  var _proto = RelayMutationQueue.prototype;
-
-  _proto.createTransaction = function createTransaction(mutation, callbacks) {
-    return this.createTransactionWithPendingTransaction(null, function (id, mutationTransaction) {
-      return new RelayPendingTransaction({
-        id: id,
-        mutation: mutation,
-        mutationTransaction: mutationTransaction,
-        onFailure: callbacks && callbacks.onFailure,
-        onSuccess: callbacks && callbacks.onSuccess
-      });
-    });
-  };
-  /**
-   * @internal
-   *
-   * This is a lower-level API used to create transactions based on:
-   *
-   * - An object that conforms to the PendingTransaction type; or
-   * - A function that can build such an object.
-   *
-   * Used by the high-level `createTransaction` API, but also enables us to
-   * run classic and low-level mutations.
-   */
-
-
-  _proto.createTransactionWithPendingTransaction = function createTransactionWithPendingTransaction(pendingTransaction, transactionBuilder) {
-    !(pendingTransaction || transactionBuilder) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutationQueue: `createTransactionWithPendingTransaction()` ' + 'expects a PendingTransaction or TransactionBuilder.') : require("fbjs/lib/invariant")(false) : void 0;
-    var id = getNextID();
-    var mutationTransaction = new (require("./RelayMutationTransaction"))(this, id);
-    var transaction = pendingTransaction || transactionBuilder(id, mutationTransaction);
-    this._pendingTransactionMap[id] = transaction;
-
-    this._queue.push(transaction);
-
-    return mutationTransaction;
-  };
-
-  _proto.getTransaction = function getTransaction(id) {
-    var transaction = this._pendingTransactionMap[id];
-
-    if (transaction) {
-      return transaction.mutationTransaction;
-    }
-
-    return null;
-  };
-
-  _proto.getError = function getError(id) {
-    return this._get(id).error;
-  };
-
-  _proto.getStatus = function getStatus(id) {
-    return this._get(id).status;
-  };
-
-  _proto.applyOptimistic = function applyOptimistic(id) {
-    var transaction = this._get(id);
-
-    transaction.status = require("./RelayMutationTransactionStatus").UNCOMMITTED;
-    transaction.error = null;
-
-    this._handleOptimisticUpdate(transaction);
-  };
-
-  _proto.commit = function commit(id) {
-    var transaction = this._get(id);
-
-    var collisionKey = transaction.getCollisionKey();
-    var collisionQueue = collisionKey && this._collisionQueueMap[collisionKey];
-
-    if (collisionQueue) {
-      collisionQueue.push(transaction);
-      transaction.status = require("./RelayMutationTransactionStatus").COMMIT_QUEUED;
-      transaction.error = null;
-      return;
-    }
-
-    if (collisionKey) {
-      this._collisionQueueMap[collisionKey] = [transaction];
-    }
-
-    this._handleCommit(transaction);
-  };
-
-  _proto.rollback = function rollback(id) {
-    var transaction = this._get(id);
-
-    var collisionKey = transaction.getCollisionKey();
-
-    if (collisionKey) {
-      var collisionQueue = this._collisionQueueMap[collisionKey];
-
-      if (collisionQueue) {
-        var index = collisionQueue.indexOf(transaction);
-
-        if (index !== -1) {
-          collisionQueue.splice(index, 1);
-        }
-
-        if (collisionQueue.length === 0) {
-          delete this._collisionQueueMap[collisionKey];
-        }
-      }
-    }
-
-    this._handleRollback(transaction);
-  };
-
-  _proto._get = function _get(id) {
-    var transaction = this._pendingTransactionMap[id];
-    !transaction ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutationQueue: `%s` is not a valid pending transaction ID.', id) : require("fbjs/lib/invariant")(false) : void 0;
-    return transaction;
-  };
-
-  _proto._handleOptimisticUpdate = function _handleOptimisticUpdate(transaction) {
-    var optimisticResponse = transaction.getOptimisticResponse();
-    var optimisticQuery = transaction.getOptimisticQuery(this._storeData);
-
-    if (optimisticResponse && optimisticQuery) {
-      var configs = transaction.getOptimisticConfigs() || transaction.getConfigs();
-
-      this._storeData.handleUpdatePayload(optimisticQuery, optimisticResponse, {
-        configs: configs,
-        isOptimisticUpdate: true
-      });
-    }
-  };
-
-  _proto._handleCommitFailure = function _handleCommitFailure(transaction, error) {
-    var status = error ? require("./RelayMutationTransactionStatus").COMMIT_FAILED : require("./RelayMutationTransactionStatus").COLLISION_COMMIT_FAILED;
-    transaction.status = status;
-    transaction.error = error;
-    var shouldRollback = true;
-    var onFailure = transaction.onFailure;
-
-    if (onFailure) {
-      var preventAutoRollback = function preventAutoRollback() {
-        shouldRollback = false;
-      };
-
-      require("fbjs/lib/ErrorUtils").applyWithGuard(onFailure, null, [transaction.mutationTransaction, preventAutoRollback], null, 'RelayMutationTransaction:onCommitFailure');
-    }
-
-    if (error) {
-      this._failCollisionQueue(transaction);
-    } // Might have already been rolled back via `onFailure`.
-
-
-    if (shouldRollback && this._pendingTransactionMap.hasOwnProperty(transaction.id)) {
-      this._handleRollback(transaction);
-    }
-
-    this._batchRefreshQueuedData();
-  };
-
-  _proto._handleCommitSuccess = function _handleCommitSuccess(transaction, response) {
-    this._advanceCollisionQueue(transaction);
-
-    this._clearPendingTransaction(transaction);
-
-    this._refreshQueuedData();
-
-    this._storeData.handleUpdatePayload(transaction.getQuery(this._storeData), response[transaction.getCallName()], {
-      configs: transaction.getConfigs(),
-      isOptimisticUpdate: false
-    });
-
-    var onSuccess = transaction.onSuccess;
-
-    if (onSuccess) {
-      require("fbjs/lib/ErrorUtils").applyWithGuard(onSuccess, null, [response], null, 'RelayMutationTransaction:onCommitSuccess');
-    }
-  };
-
-  _proto._handleCommit = function _handleCommit(transaction) {
-    var _this = this;
-
-    transaction.status = require("./RelayMutationTransactionStatus").COMMITTING;
-    transaction.error = null;
-    var request = new (require("./RelayMutationRequest"))(transaction.getQuery(this._storeData), transaction.getFiles());
-
-    this._storeData.getNetworkLayer().sendMutation(request);
-
-    request.getPromise().then(function (result) {
-      return _this._handleCommitSuccess(transaction, result.response);
-    }, function (error) {
-      return _this._handleCommitFailure(transaction, error);
-    })["catch"](function (error) {
-      setTimeout(function () {
-        throw error;
-      }, 0);
-    });
-  };
-
-  _proto._handleRollback = function _handleRollback(transaction) {
-    this._clearPendingTransaction(transaction);
-
-    this._batchRefreshQueuedData();
-  };
-
-  _proto._clearPendingTransaction = function _clearPendingTransaction(transaction) {
-    delete this._pendingTransactionMap[transaction.id];
-    this._queue = this._queue.filter(function (tx) {
-      return tx !== transaction;
-    });
-  };
-
-  _proto._advanceCollisionQueue = function _advanceCollisionQueue(transaction) {
-    var collisionKey = transaction.getCollisionKey();
-
-    if (collisionKey) {
-      var collisionQueue = this._collisionQueueMap[collisionKey];
-
-      if (collisionQueue) {
-        // Remove the transaction that called this function.
-        collisionQueue.shift();
-
-        if (collisionQueue.length) {
-          this._handleCommit(collisionQueue[0]);
-        } else {
-          delete this._collisionQueueMap[collisionKey];
-        }
-      }
-    }
-  };
-
-  _proto._failCollisionQueue = function _failCollisionQueue(failedTransaction) {
-    var _this2 = this;
-
-    var collisionKey = failedTransaction.getCollisionKey();
-
-    if (collisionKey) {
-      var collisionQueue = this._collisionQueueMap[collisionKey];
-
-      if (collisionQueue) {
-        // Remove the transaction that called this function.
-        collisionQueue.forEach(function (queuedTransaction) {
-          if (queuedTransaction !== failedTransaction) {
-            _this2._handleCommitFailure(queuedTransaction, null);
-          }
-        });
-        delete this._collisionQueueMap[collisionKey];
-      }
-    }
-  };
-
-  _proto._batchRefreshQueuedData = function _batchRefreshQueuedData() {
-    var _this3 = this;
-
-    if (!this._willBatchRefreshQueuedData) {
-      this._willBatchRefreshQueuedData = true;
-
-      require("fbjs/lib/resolveImmediate")(function () {
-        _this3._willBatchRefreshQueuedData = false;
-
-        _this3._refreshQueuedData();
-      });
-    }
-  };
-
-  _proto._refreshQueuedData = function _refreshQueuedData() {
-    var _this4 = this;
-
-    this._storeData.clearQueuedData();
-
-    this._queue.forEach(function (transaction) {
-      return _this4._handleOptimisticUpdate(transaction);
-    });
-  };
-
-  return RelayMutationQueue;
-}();
-/**
- * @private
- */
-
-
-var RelayPendingTransaction =
-/*#__PURE__*/
-function () {
-  // Lazily computed and memoized private properties
-  function RelayPendingTransaction(transactionData) {
-    this.error = null;
-    this.id = transactionData.id;
-    this.mutation = transactionData.mutation;
-    this.mutationTransaction = transactionData.mutationTransaction;
-    this.onFailure = transactionData.onFailure;
-    this.onSuccess = transactionData.onSuccess;
-    this.status = require("./RelayMutationTransactionStatus").CREATED;
-  }
-
-  var _proto2 = RelayPendingTransaction.prototype;
-
-  _proto2.getCallName = function getCallName() {
-    if (!this._callName) {
-      this._callName = this.getMutationNode().calls[0].name;
-    }
-
-    return this._callName;
-  };
-
-  _proto2.getCollisionKey = function getCollisionKey() {
-    if (this._collisionKey === undefined) {
-      this._collisionKey = this.mutation.getCollisionKey() || null;
-    }
-
-    return this._collisionKey;
-  };
-
-  _proto2.getConfigs = function getConfigs() {
-    if (!this._configs) {
-      this._configs = this.mutation.getConfigs();
-    }
-
-    return this._configs;
-  };
-
-  _proto2.getFatQuery = function getFatQuery() {
-    if (!this._fatQuery) {
-      var fragment = require("./fromGraphQL").Fragment(this.mutation.getFatQuery());
-
-      !(fragment instanceof require("./RelayQuery").Fragment) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutationQueue: Expected `getFatQuery` to return a GraphQL ' + 'Fragment') : require("fbjs/lib/invariant")(false) : void 0;
-      this._fatQuery = require("nullthrows")(require("./flattenRelayQuery")(fragment, {
-        // TODO #10341736
-        // This used to be `preserveEmptyNodes: fragment.isPattern()`. We
-        // discovered that products were not marking their fat queries as
-        // patterns (by adding `@relay(pattern: true)`) which was causing
-        // `preserveEmptyNodes` to be false. This meant that empty fields,
-        // would be stripped instead of being used to produce an intersection
-        // with the tracked query. Products were able to do this because the
-        // Babel Relay plugin doesn't produce validation errors for empty
-        // fields. It should, and we will make it do so, but for now we're
-        // going to set this to `true` always, and make the plugin warn when
-        // it encounters an empty field that supports subselections in a
-        // non-pattern fragment. Revert this when done.
-        preserveEmptyNodes: true,
-        shouldRemoveFragments: true
-      }));
-    }
-
-    return this._fatQuery;
-  };
-
-  _proto2.getFiles = function getFiles() {
-    if (this._files === undefined) {
-      this._files = this.mutation.getFiles() || null;
-    }
-
-    return this._files;
-  };
-
-  _proto2.getInputVariable = function getInputVariable() {
-    if (!this._inputVariable) {
-      var inputVariable = (0, _objectSpread3["default"])({}, this.mutation.getVariables(), (0, _defineProperty2["default"])({}, require("relay-runtime").ConnectionInterface.get().CLIENT_MUTATION_ID, this.id));
-      this._inputVariable = inputVariable;
-    }
-
-    return this._inputVariable;
-  };
-
-  _proto2.getMutationNode = function getMutationNode() {
-    if (!this._mutationNode) {
-      var mutationNode = require("./QueryBuilder").getMutation(this.mutation.getMutation());
-
-      !mutationNode ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutation: Expected `getMutation` to return a mutation created ' + 'with Relay.QL`mutation { ... }`.') : require("fbjs/lib/invariant")(false) : void 0;
-      this._mutationNode = mutationNode;
-    }
-
-    return this._mutationNode;
-  };
-
-  _proto2.getOptimisticConfigs = function getOptimisticConfigs() {
-    if (this._optimisticConfigs === undefined) {
-      this._optimisticConfigs = this.mutation.getOptimisticConfigs() || null;
-    }
-
-    return this._optimisticConfigs;
-  };
-
-  _proto2.getOptimisticQuery = function getOptimisticQuery(storeData) {
-    if (this._optimisticQuery === undefined) {
-      if (process.env.NODE_ENV !== "production" && console.groupCollapsed && console.groupEnd) {
-        console.groupCollapsed('Optimistic query for `' + this.getCallName() + '`');
-      }
-
-      var optimisticResponse = this._getRawOptimisticResponse();
-
-      if (optimisticResponse) {
-        var optimisticConfigs = this.getOptimisticConfigs();
-        var tracker = getTracker(storeData);
-
-        if (optimisticConfigs) {
-          this._optimisticQuery = require("./RelayMutationQuery").buildQuery({
-            configs: optimisticConfigs,
-            fatQuery: this.getFatQuery(),
-            input: this.getInputVariable(),
-            mutationName: this.mutation.constructor.name,
-            mutation: this.getMutationNode(),
-            tracker: tracker
-          });
-        } else {
-          this._optimisticQuery = require("./RelayMutationQuery").buildQueryForOptimisticUpdate({
-            response: optimisticResponse,
-            fatQuery: this.getFatQuery(),
-            mutation: this.getMutationNode()
-          });
-        }
-      } else {
-        this._optimisticQuery = null;
-      }
-
-      if (process.env.NODE_ENV !== "production" && console.groupCollapsed && console.groupEnd) {
-        require("./RelayMutationDebugPrinter").printOptimisticMutation(this._optimisticQuery, optimisticResponse);
-
-        console.groupEnd();
-      }
-    }
-
-    return this._optimisticQuery;
-  };
-
-  _proto2._getRawOptimisticResponse = function _getRawOptimisticResponse() {
-    if (this._rawOptimisticResponse === undefined) {
-      var optimisticResponse = this.mutation.getOptimisticResponse() || null;
-
-      if (optimisticResponse) {
-        optimisticResponse[require("relay-runtime").ConnectionInterface.get().CLIENT_MUTATION_ID] = this.id;
-      }
-
-      this._rawOptimisticResponse = optimisticResponse;
-    }
-
-    return this._rawOptimisticResponse;
-  };
-
-  _proto2.getOptimisticResponse = function getOptimisticResponse() {
-    if (this._optimisticResponse === undefined) {
-      var optimisticResponse = this._getRawOptimisticResponse();
-
-      if (optimisticResponse) {
-        this._optimisticResponse = require("./RelayOptimisticMutationUtils").inferRelayPayloadFromData(optimisticResponse);
-      } else {
-        this._optimisticResponse = optimisticResponse;
-      }
-    }
-
-    return this._optimisticResponse;
-  };
-
-  _proto2.getQuery = function getQuery(storeData) {
-    if (!this._query) {
-      if (process.env.NODE_ENV !== "production" && console.groupCollapsed && console.groupEnd) {
-        console.groupCollapsed('Mutation query for `' + this.getCallName() + '`');
-      }
-
-      var tracker = getTracker(storeData);
-      this._query = require("./RelayMutationQuery").buildQuery({
-        configs: this.getConfigs(),
-        fatQuery: this.getFatQuery(),
-        input: this.getInputVariable(),
-        mutationName: this.getMutationNode().name,
-        mutation: this.getMutationNode(),
-        tracker: tracker
-      });
-
-      if (process.env.NODE_ENV !== "production" && console.groupCollapsed && console.groupEnd) {
-        require("./RelayMutationDebugPrinter").printMutation(this._query);
-
-        console.groupEnd();
-      }
-    }
-
-    return this._query;
-  };
-
-  return RelayPendingTransaction;
-}();
-
-function getTracker(storeData) {
-  var tracker = storeData.getQueryTracker();
-  !tracker ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayMutationQueue: a RelayQueryTracker was not configured but an ' + 'attempt to process a RelayMutation instance was made. Either use ' + 'RelayGraphQLMutation (which does not require a tracker), or use ' + '`RelayStoreData.injectQueryTracker()` to configure a tracker. Be ' + 'aware that trackers are provided by default, so if you are seeing ' + 'this error it means that somebody has explicitly intended to opt ' + 'out of query tracking.') : require("fbjs/lib/invariant")(false) : void 0;
-  return tracker;
-}
-
-function getNextID() {
-  return require("fbjs/lib/base62")(transactionIDCounter++);
-}
-
-module.exports = RelayMutationQueue;

package/lib/RelayMutationRequest.js

@@ -1,103 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *  strict-local
- * @format
- */
-'use strict';
-
-var _inheritsLoose2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/inheritsLoose"));
-
-/**
- * @internal
- *
- * Instances of these are made available via `RelayNetworkLayer.sendMutation`.
- */
-var RelayMutationRequest =
-/*#__PURE__*/
-function (_Deferred) {
-  (0, _inheritsLoose2["default"])(RelayMutationRequest, _Deferred);
-
-  function RelayMutationRequest(mutation, files) {
-    var _this;
-
-    _this = _Deferred.call(this) || this;
-    _this._mutation = mutation;
-    _this._printedQuery = null;
-    _this._files = files;
-    return _this;
-  }
-  /**
-   * @public
-   *
-   * Gets a string name used to refer to this request for printing debug output.
-   */
-
-
-  var _proto = RelayMutationRequest.prototype;
-
-  _proto.getDebugName = function getDebugName() {
-    return this._mutation.getName();
-  };
-  /**
-   * @public
-   *
-   * Gets an optional map from name to File objects.
-   */
-
-
-  _proto.getFiles = function getFiles() {
-    return this._files;
-  };
-  /**
-   * @public
-   *
-   * Gets the variables used by the mutation. These variables should be
-   * serialized and sent in the GraphQL request.
-   */
-
-
-  _proto.getVariables = function getVariables() {
-    return this._getPrintedQuery().variables;
-  };
-  /**
-   * @public
-   *
-   * Gets a string representation of the GraphQL mutation.
-   */
-
-
-  _proto.getQueryString = function getQueryString() {
-    return this._getPrintedQuery().text;
-  };
-  /**
-   * @public
-   * @unstable
-   */
-
-
-  _proto.getMutation = function getMutation() {
-    return this._mutation;
-  };
-  /**
-   * @private
-   *
-   * Returns the memoized printed query.
-   */
-
-
-  _proto._getPrintedQuery = function _getPrintedQuery() {
-    if (!this._printedQuery) {
-      this._printedQuery = require("./printRelayQuery")(this._mutation);
-    }
-
-    return this._printedQuery;
-  };
-
-  return RelayMutationRequest;
-}(require("fbjs/lib/Deferred"));
-
-module.exports = RelayMutationRequest;