@airtable/blocks 1.8.0 → 1.9.0-experimental

package/dist/cjs/models/query_manager.js

@@ -0,0 +1,327 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+require("core-js/modules/es.symbol");
+
+require("core-js/modules/es.symbol.description");
+
+require("core-js/modules/es.array.iterator");
+
+require("core-js/modules/es.map");
+
+require("core-js/modules/es.object.to-string");
+
+require("core-js/modules/es.promise");
+
+require("core-js/modules/web.dom-collections.for-each");
+
+require("core-js/modules/web.dom-collections.iterator");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.QueryManager = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+require("regenerator-runtime/runtime");
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error_utils = require("../error_utils");
+
+var _private_utils = require("../private_utils");
+
+/**
+ * This provides a singleton instance which is responsible for all queries sent
+ * to PublicAirtableInterface.
+ *
+ * This can allow looking up queries by queryId.
+ *
+ * @internal
+ */
+var QueryManager =
+/*#__PURE__*/
+function () {
+  function QueryManager(sdk) {
+    (0, _classCallCheck2.default)(this, QueryManager);
+    (0, _defineProperty2.default)(this, "_airtableInterface", void 0);
+    (0, _defineProperty2.default)(this, "_sdk", void 0);
+    (0, _defineProperty2.default)(this, "_queryRegistrationInfosByWatchKey", new Map());
+    (0, _defineProperty2.default)(this, "fetchAndSubscribeToQueryAsync", (query, querySubscriptionOptions) => {
+      var queryResponse;
+      return _regenerator.default.async(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return _regenerator.default.awrap(this._airtableInterface.subscribeToQueryAndPopulateStoresAsync(query, querySubscriptionOptions !== null && querySubscriptionOptions !== void 0 ? querySubscriptionOptions : {}));
+
+            case 2:
+              queryResponse = _context.sent;
+
+              if (queryResponse.success) {
+                _context.next = 5;
+                break;
+              }
+
+              throw (0, _error_utils.spawnError)('Subscription to query failed - unhandled error');
+
+            case 5:
+              return _context.abrupt("return", queryResponse.blockQueryId);
+
+            case 6:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, null, this);
+    });
+    (0, _defineProperty2.default)(this, "unsubscribeFromQueryIds", queryIds => {
+      var _iteratorNormalCompletion = true;
+      var _didIteratorError = false;
+      var _iteratorError = undefined;
+
+      try {
+        for (var _iterator = queryIds[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+          var queryId = _step.value;
+          // TODO: (#proj-blocks-sdk-record-limits) Add support for unsubscribing multiple at the same time
+          this.unsubscribeFromQueryId(queryId);
+        }
+      } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion && _iterator.return != null) {
+            _iterator.return();
+          }
+        } finally {
+          if (_didIteratorError) {
+            throw _iteratorError;
+          }
+        }
+      }
+    });
+    (0, _defineProperty2.default)(this, "unsubscribeFromQueryId", queryId => {
+      (0, _private_utils.fireAndForgetPromise)(() => this._airtableInterface.unsubscribeFromQueryIdsAsync([queryId]));
+    });
+    (0, _defineProperty2.default)(this, "watchWithQuerySpec", (query, watchableModel, watchKey, watchOnChangeCallback, callbackForRegistration, context) => {
+      var isOnChangeCallbackCanceled = false;
+
+      var callbackForCancelOnChange = () => isOnChangeCallbackCanceled = true;
+
+      var onChangeCallback = changes => {
+        if (isOnChangeCallbackCanceled) {
+          return;
+        }
+
+        watchableModel.__incrementOnChangeCount();
+
+        watchOnChangeCallback(changes);
+      };
+
+      var blockQueryIdPromise = this.fetchAndSubscribeToQueryAsync(query, {
+        onChangeCallback
+      });
+
+      var queryRegistrationInfosForKey = this._queryRegistrationInfosByWatchKey.get(watchKey);
+
+      if (!queryRegistrationInfosForKey) {
+        queryRegistrationInfosForKey = [];
+
+        this._queryRegistrationInfosByWatchKey.set(watchKey, queryRegistrationInfosForKey);
+      } // It is safe to push onto queryRegistrationInfosForKey (vs copying) as long
+      // as we don't release the event loop when we iterate over it, which only
+      // happens in unwatchFromQueryKeys
+
+
+      queryRegistrationInfosForKey.push({
+        blockQueryIdPromise,
+        callbackForCancelOnChange,
+        callbackForRegistration,
+        context,
+        onChangeCallback,
+        watchableModel
+      });
+    });
+    (0, _defineProperty2.default)(this, "_unwatchFromQueryRegistrationInfoAsync", queryRegistrationInfo => {
+      var blockQueryIdPromise, callbackForCancelOnChange, queryId;
+      return _regenerator.default.async(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              blockQueryIdPromise = queryRegistrationInfo.blockQueryIdPromise, callbackForCancelOnChange = queryRegistrationInfo.callbackForCancelOnChange;
+              callbackForCancelOnChange();
+              _context2.next = 4;
+              return _regenerator.default.awrap(blockQueryIdPromise);
+
+            case 4:
+              queryId = _context2.sent;
+              this.unsubscribeFromQueryId(queryId);
+
+            case 6:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, null, this);
+    });
+    (0, _defineProperty2.default)(this, "unwatchFromQueryKey", (watchKey, callbackForRegistration, context) => {
+      var queryRegistrationInfos = this._queryRegistrationInfosByWatchKey.get(watchKey);
+
+      if (queryRegistrationInfos) {
+        var watchersToUnwatch = [];
+        var watchersToKeep = [];
+        queryRegistrationInfos.forEach(watcher => {
+          var isCallbackToUnwatch = watcher.callbackForRegistration === callbackForRegistration && watcher.context === context;
+
+          if (isCallbackToUnwatch) {
+            watchersToUnwatch.push(watcher);
+          } else {
+            watchersToKeep.push(watcher);
+          }
+        });
+
+        if (watchersToKeep.length > 0) {
+          this._queryRegistrationInfosByWatchKey.set(watchKey, watchersToKeep);
+        } else {
+          this._queryRegistrationInfosByWatchKey.delete(watchKey);
+        }
+
+        if (watchersToUnwatch.length > 0) {
+          // Do not await the response since unwatch is not async
+          watchersToUnwatch.forEach(this._unwatchFromQueryRegistrationInfoAsync);
+        }
+      }
+    });
+    this._airtableInterface = sdk.__airtableInterface;
+    this._sdk = sdk;
+  }
+
+  (0, _createClass2.default)(QueryManager, [{
+    key: "_onChange",
+    value: function _onChange(watchableModel, watchKey) {
+      var queryRegistrationInfos = this._queryRegistrationInfosByWatchKey.get(watchKey);
+
+      if (!queryRegistrationInfos) {
+        return;
+      }
+
+      var _iteratorNormalCompletion2 = true;
+      var _didIteratorError2 = false;
+      var _iteratorError2 = undefined;
+
+      try {
+        for (var _iterator2 = queryRegistrationInfos[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
+          var watcher = _step2.value;
+
+          if (watcher.watchableModel === watchableModel) {
+            watcher.onChangeCallback([]);
+          }
+        }
+      } catch (err) {
+        _didIteratorError2 = true;
+        _iteratorError2 = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion2 && _iterator2.return != null) {
+            _iterator2.return();
+          }
+        } finally {
+          if (_didIteratorError2) {
+            throw _iteratorError2;
+          }
+        }
+      }
+    }
+  }, {
+    key: "onLoadKeys",
+    value: function onLoadKeys(watchableModel, watchKeys) {
+      var _iteratorNormalCompletion3 = true;
+      var _didIteratorError3 = false;
+      var _iteratorError3 = undefined;
+
+      try {
+        for (var _iterator3 = watchKeys[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
+          var key = _step3.value;
+
+          this._onChange(watchableModel, key);
+        }
+      } catch (err) {
+        _didIteratorError3 = true;
+        _iteratorError3 = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion3 && _iterator3.return != null) {
+            _iterator3.return();
+          }
+        } finally {
+          if (_didIteratorError3) {
+            throw _iteratorError3;
+          }
+        }
+      }
+    }
+  }, {
+    key: "forceUnloadWatchesOnWatchableModel",
+    value: function forceUnloadWatchesOnWatchableModel(watchableModel) {
+      var _iteratorNormalCompletion4 = true;
+      var _didIteratorError4 = false;
+      var _iteratorError4 = undefined;
+
+      try {
+        for (var _iterator4 = this._queryRegistrationInfosByWatchKey.values()[Symbol.iterator](), _step4; !(_iteratorNormalCompletion4 = (_step4 = _iterator4.next()).done); _iteratorNormalCompletion4 = true) {
+          var queryRegistrationInfos = _step4.value;
+          var _iteratorNormalCompletion5 = true;
+          var _didIteratorError5 = false;
+          var _iteratorError5 = undefined;
+
+          try {
+            for (var _iterator5 = queryRegistrationInfos[Symbol.iterator](), _step5; !(_iteratorNormalCompletion5 = (_step5 = _iterator5.next()).done); _iteratorNormalCompletion5 = true) {
+              var watcher = _step5.value;
+
+              if (watcher.watchableModel === watchableModel) {
+                this._unwatchFromQueryRegistrationInfoAsync(watcher);
+              }
+            }
+          } catch (err) {
+            _didIteratorError5 = true;
+            _iteratorError5 = err;
+          } finally {
+            try {
+              if (!_iteratorNormalCompletion5 && _iterator5.return != null) {
+                _iterator5.return();
+              }
+            } finally {
+              if (_didIteratorError5) {
+                throw _iteratorError5;
+              }
+            }
+          }
+        }
+      } catch (err) {
+        _didIteratorError4 = true;
+        _iteratorError4 = err;
+      } finally {
+        try {
+          if (!_iteratorNormalCompletion4 && _iterator4.return != null) {
+            _iterator4.return();
+          }
+        } finally {
+          if (_didIteratorError4) {
+            throw _iteratorError4;
+          }
+        }
+      }
+    }
+  }]);
+  return QueryManager;
+}();
+
+exports.QueryManager = QueryManager;