@aws-amplify/datastore 3.5.2 → 3.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.6.0](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.5.2...@aws-amplify/datastore@3.6.0) (2021-11-12)
+
+
+### Features
+
+* **@aws-amplify/datastore:** ObserveQuery performance and type enhancements ([#9141](https://github.com/aws-amplify/amplify-js/issues/9141)) ([755ce09](https://github.com/aws-amplify/amplify-js/commit/755ce09f5152c54d215f023089f30b2c98ace33a))
+
+
+
+
+
 ## [3.5.2](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.5.1...@aws-amplify/datastore@3.5.2) (2021-11-09)
 
 

package/dist/aws-amplify-datastore.js

@@ -70458,7 +70458,7 @@ var getAmplifyUserAgent = function getAmplifyUserAgent() {
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "version", function() { return version; });
 // generated by genversion
-var version = '4.3.4';
+var version = '4.3.5';
 
 /***/ }),
 
@@ -82341,6 +82341,23 @@ function () {
         var deletedItemIds = [];
         var handle;
 
+        var generateAndEmitSnapshot = function generateAndEmitSnapshot() {
+          var snapshot = generateSnapshot();
+          emitSnapshot(snapshot);
+        }; // a mechanism to return data after X amount of seconds OR after the
+        // "limit" (itemsChanged >= this.syncPageSize) has been reached, whichever comes first
+
+
+        var limitTimerRace = new _util__WEBPACK_IMPORTED_MODULE_9__["DeferredCallbackResolver"]({
+          callback: generateAndEmitSnapshot,
+          errorHandler: observer.error,
+          maxInterval: 2000
+        });
+        var sort = (options || {}).sort;
+        var sortOptions = sort ? {
+          sort: sort
+        } : undefined;
+
         (function () {
           return __awaiter(_this, void 0, void 0, function () {
             var err_1;
@@ -82354,7 +82371,7 @@ function () {
 
                   return [4
                   /*yield*/
-                  , this.query(model, criteria, options)];
+                  , this.query(model, criteria, sortOptions)];
 
                 case 1:
                   // first, query and return any locally-available records
@@ -82380,10 +82397,15 @@ function () {
 
                     var isSynced = _this.sync.getModelSyncedStatus(model);
 
-                    if (itemsChanged.size - deletedItemIds.length >= _this.syncPageSize || isSynced) {
-                      generateAndEmitSnapshot();
-                    }
-                  }); // will return any locally-available items in the first snapshot
+                    var limit = itemsChanged.size - deletedItemIds.length >= _this.syncPageSize;
+
+                    if (limit || isSynced) {
+                      limitTimerRace.resolve();
+                    } // kicks off every subsequent race as results sync down
+
+
+                    limitTimerRace.start();
+                  }); // returns a set of initial/locally-available results
 
                   generateAndEmitSnapshot();
                   return [3
@@ -82438,11 +82460,6 @@ function () {
           deletedItemIds = [];
         };
 
-        var generateAndEmitSnapshot = function generateAndEmitSnapshot() {
-          var snapshot = generateSnapshot();
-          emitSnapshot(snapshot);
-        };
-
         var sortItems = function sortItems(itemsToSort) {
           var modelDefinition = getModelDefinition(model);
 
@@ -82821,7 +82838,7 @@ _aws_amplify_core__WEBPACK_IMPORTED_MODULE_0__["Amplify"].register(instance);
 /*!**************************!*\
   !*** ./lib-esm/index.js ***!
   \**************************/
-/*! exports provided: DataStore, DataStoreClass, initSchema, Predicates, ModelPredicateCreator, ModelSortPredicateCreator, utils, isSchemaModel, isAssociatedWith, isTargetNameAssociation, isModelAttributeAuth, isModelAttributeKey, isModelAttributePrimaryKey, isModelAttributeCompositeKey, ModelAttributeAuthAllow, ModelAttributeAuthProvider, GraphQLScalarType, isGraphQLScalarType, isModelFieldType, isNonModelFieldType, isEnumFieldType, OpType, isPredicateObj, isPredicateGroup, QueryOne, SortDirection, AuthModeStrategyType, ModelOperation, syncExpression, DISCARD */
+/*! exports provided: DataStore, DataStoreClass, initSchema, Predicates, ModelPredicateCreator, ModelSortPredicateCreator, utils, isSchemaModel, isAssociatedWith, isTargetNameAssociation, isModelAttributeAuth, isModelAttributeKey, isModelAttributePrimaryKey, isModelAttributeCompositeKey, ModelAttributeAuthAllow, ModelAttributeAuthProvider, GraphQLScalarType, isGraphQLScalarType, isModelFieldType, isNonModelFieldType, isEnumFieldType, OpType, isPredicateObj, isPredicateGroup, QueryOne, SortDirection, AuthModeStrategyType, ModelOperation, syncExpression, DISCARD, LimitTimerRaceResolvedValues */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -82889,6 +82906,8 @@ __webpack_require__.r(__webpack_exports__);
 
 /* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "DISCARD", function() { return _types__WEBPACK_IMPORTED_MODULE_3__["DISCARD"]; });
 
+/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "LimitTimerRaceResolvedValues", function() { return _types__WEBPACK_IMPORTED_MODULE_3__["LimitTimerRaceResolvedValues"]; });
+
 
 
 
@@ -94599,7 +94618,7 @@ function getTokenForCustomAuth(authMode, amplifyConfig) {
 /*!**************************!*\
   !*** ./lib-esm/types.js ***!
   \**************************/
-/*! exports provided: isSchemaModel, isAssociatedWith, isTargetNameAssociation, isModelAttributeAuth, isModelAttributeKey, isModelAttributePrimaryKey, isModelAttributeCompositeKey, ModelAttributeAuthAllow, ModelAttributeAuthProvider, GraphQLScalarType, isGraphQLScalarType, isModelFieldType, isNonModelFieldType, isEnumFieldType, OpType, isPredicateObj, isPredicateGroup, QueryOne, SortDirection, AuthModeStrategyType, ModelOperation, syncExpression, DISCARD */
+/*! exports provided: isSchemaModel, isAssociatedWith, isTargetNameAssociation, isModelAttributeAuth, isModelAttributeKey, isModelAttributePrimaryKey, isModelAttributeCompositeKey, ModelAttributeAuthAllow, ModelAttributeAuthProvider, GraphQLScalarType, isGraphQLScalarType, isModelFieldType, isNonModelFieldType, isEnumFieldType, OpType, isPredicateObj, isPredicateGroup, QueryOne, SortDirection, AuthModeStrategyType, ModelOperation, syncExpression, DISCARD, LimitTimerRaceResolvedValues */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -94627,6 +94646,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "ModelOperation", function() { return ModelOperation; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "syncExpression", function() { return syncExpression; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DISCARD", function() { return DISCARD; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "LimitTimerRaceResolvedValues", function() { return LimitTimerRaceResolvedValues; });
 /* harmony import */ var _util__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./util */ "./lib-esm/util.js");
 var __awaiter = undefined && undefined.__awaiter || function (thisArg, _arguments, P, generator) {
   function adopt(value) {
@@ -94977,7 +94997,13 @@ function syncExpression(modelConstructor, conditionProducer) {
     });
   });
 }
-var DISCARD = Symbol('DISCARD'); //#endregion
+var DISCARD = Symbol('DISCARD');
+var LimitTimerRaceResolvedValues;
+
+(function (LimitTimerRaceResolvedValues) {
+  LimitTimerRaceResolvedValues["LIMIT"] = "LIMIT";
+  LimitTimerRaceResolvedValues["TIMER"] = "TIMER";
+})(LimitTimerRaceResolvedValues || (LimitTimerRaceResolvedValues = {})); //#endregion
 
 /***/ }),
 
@@ -94985,7 +95011,7 @@ var DISCARD = Symbol('DISCARD'); //#endregion
 /*!*************************!*\
   !*** ./lib-esm/util.js ***!
   \*************************/
-/*! exports provided: exhaustiveCheck, isNullOrUndefined, validatePredicate, validatePredicateField, isModelConstructor, registerNonModelClass, isNonModelConstructor, processCompositeKeys, establishRelationAndKeys, traverseModel, getIndex, getIndexFromAssociation, NAMESPACES, USER, SYNC, STORAGE, DATASTORE, isPrivateMode, monotonicUlidFactory, getNow, sortCompareFunction, valuesEqual, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress */
+/*! exports provided: exhaustiveCheck, isNullOrUndefined, validatePredicate, validatePredicateField, isModelConstructor, registerNonModelClass, isNonModelConstructor, processCompositeKeys, establishRelationAndKeys, traverseModel, getIndex, getIndexFromAssociation, NAMESPACES, USER, SYNC, STORAGE, DATASTORE, isPrivateMode, monotonicUlidFactory, getNow, sortCompareFunction, valuesEqual, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress, DeferredPromise, DeferredCallbackResolver */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -95021,6 +95047,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isAWSURL", function() { return isAWSURL; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isAWSPhone", function() { return isAWSPhone; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isAWSIPAddress", function() { return isAWSIPAddress; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DeferredPromise", function() { return DeferredPromise; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DeferredCallbackResolver", function() { return DeferredCallbackResolver; });
 /* harmony import */ var buffer__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! buffer */ "../../node_modules/buffer/index.js");
 /* harmony import */ var buffer__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(buffer__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var ulid__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ulid */ "../../node_modules/ulid/dist/index.esm.js");
@@ -95884,6 +95912,117 @@ var isAWSIPAddress = function isAWSIPAddress(val) {
   return !!/((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?$))$/.exec(val);
 };
 
+var DeferredPromise =
+/** @class */
+function () {
+  function DeferredPromise() {
+    var self = this;
+    this.promise = new Promise(function (resolve, reject) {
+      self.resolve = resolve;
+      self.reject = reject;
+    });
+  }
+
+  return DeferredPromise;
+}();
+
+
+
+var DeferredCallbackResolver =
+/** @class */
+function () {
+  function DeferredCallbackResolver(options) {
+    this.limitPromise = new DeferredPromise();
+    this.raceInFlight = false;
+
+    this.callback = function () {};
+
+    this.defaultErrorHandler = function (msg) {
+      if (msg === void 0) {
+        msg = 'DeferredCallbackResolver error';
+      }
+
+      throw new Error(msg);
+    };
+
+    this.callback = options.callback;
+    this.errorHandler = options.errorHandler || this.defaultErrorHandler;
+    this.maxInterval = options.maxInterval || 2000;
+  }
+
+  DeferredCallbackResolver.prototype.startTimer = function () {
+    var _this = this;
+
+    this.timerPromise = new Promise(function (resolve, reject) {
+      _this.timer = setTimeout(function () {
+        resolve(_types__WEBPACK_IMPORTED_MODULE_3__["LimitTimerRaceResolvedValues"].TIMER);
+      }, _this.maxInterval);
+    });
+  };
+
+  DeferredCallbackResolver.prototype.racePromises = function () {
+    return __awaiter(this, void 0, void 0, function () {
+      var winner, err_1;
+      return __generator(this, function (_c) {
+        switch (_c.label) {
+          case 0:
+            _c.trys.push([0, 2, 3, 4]);
+
+            this.raceInFlight = true;
+            this.startTimer();
+            return [4
+            /*yield*/
+            , Promise.race([this.timerPromise, this.limitPromise.promise])];
+
+          case 1:
+            winner = _c.sent();
+            this.callback();
+            return [3
+            /*break*/
+            , 4];
+
+          case 2:
+            err_1 = _c.sent();
+            this.errorHandler(err_1);
+            return [3
+            /*break*/
+            , 4];
+
+          case 3:
+            // reset for the next race
+            this.clear();
+            this.raceInFlight = false;
+            this.limitPromise = new DeferredPromise();
+            return [2
+            /*return*/
+            , winner];
+
+          case 4:
+            return [2
+            /*return*/
+            ];
+        }
+      });
+    });
+  };
+
+  DeferredCallbackResolver.prototype.start = function () {
+    if (!this.raceInFlight) this.racePromises();
+  };
+
+  DeferredCallbackResolver.prototype.clear = function () {
+    clearTimeout(this.timer);
+  };
+
+  DeferredCallbackResolver.prototype.resolve = function () {
+    this.limitPromise.resolve(_types__WEBPACK_IMPORTED_MODULE_3__["LimitTimerRaceResolvedValues"].LIMIT);
+  };
+
+  return DeferredCallbackResolver;
+}();
+
+
+
 /***/ }),
 
 /***/ "./node_modules/immer/dist/immer.esm.js":