@aws-amplify/datastore 3.12.12 → 3.12.13-ds-allow-applicable-data.6

package/lib-esm/sync/index.js

@@ -65,11 +65,11 @@ var __spread = (this && this.__spread) || function () {
     for (var ar = [], i = 0; i < arguments.length; i++) ar = ar.concat(__read(arguments[i]));
     return ar;
 };
-import { browserOrNode, ConsoleLogger as Logger } from '@aws-amplify/core';
+import { browserOrNode, ConsoleLogger as Logger, BackgroundProcessManager, } from '@aws-amplify/core';
 import { CONTROL_MSG as PUBSUB_CONTROL_MSG } from '@aws-amplify/pubsub';
 import Observable from 'zen-observable-ts';
 import { ModelPredicateCreator } from '../predicates';
-import { OpType, } from '../types';
+import { OpType, __modelMeta__, } from '../types';
 import { exhaustiveCheck, getNow, SYNC, USER } from '../util';
 import DataStoreConnectivity from './datastoreConnectivity';
 import { ModelMerger } from './merger';
@@ -77,7 +77,7 @@ import { MutationEventOutbox } from './outbox';
 import { MutationProcessor } from './processors/mutation';
 import { CONTROL_MSG, SubscriptionProcessor } from './processors/subscription';
 import { SyncProcessor } from './processors/sync';
-import { createMutationInstanceFromModelOperation, predicateToGraphQLCondition, } from './utils';
+import { createMutationInstanceFromModelOperation, getIdentifierValue, predicateToGraphQLCondition, } from './utils';
 var isNode = browserOrNode().isNode;
 var logger = new Logger('DataStore');
 var ownSymbol = Symbol('sync');
@@ -109,6 +109,7 @@ var SyncEngine = /** @class */ (function () {
         this.amplifyContext = amplifyContext;
         this.online = false;
         this.modelSyncedStatus = new WeakMap();
+        this.runningProcesses = new BackgroundProcessManager();
         var MutationEvent = this.modelClasses['MutationEvent'];
         this.outbox = new MutationEventOutbox(this.schema, MutationEvent, modelInstanceCreator, ownSymbol);
         this.modelMerger = new ModelMerger(this.outbox, ownSymbol);
@@ -125,7 +126,7 @@ var SyncEngine = /** @class */ (function () {
         return new Observable(function (observer) {
             logger.log('starting sync engine...');
             var subscriptions = [];
-            (function () { return __awaiter(_this, void 0, void 0, function () {
+            _this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
                 var err_1, startPromise, hasMutationsInOutbox;
                 var _this = this;
                 return __generator(this, function (_a) {
@@ -141,154 +142,184 @@ var SyncEngine = /** @class */ (function () {
                             observer.error(err_1);
                             return [2 /*return*/];
                         case 3:
-                            startPromise = new Promise(function (resolve) {
+                            startPromise = new Promise(function (doneStarting) {
                                 _this.datastoreConnectivity.status().subscribe(function (_a) {
                                     var online = _a.online;
                                     return __awaiter(_this, void 0, void 0, function () {
-                                        var ctlSubsObservable_1, dataSubsObservable, err_2, error_1;
-                                        var _b;
                                         var _this = this;
-                                        return __generator(this, function (_c) {
-                                            switch (_c.label) {
-                                                case 0:
-                                                    if (!(online && !this.online)) return [3 /*break*/, 10];
-                                                    this.online = online;
-                                                    observer.next({
-                                                        type: ControlMessage.SYNC_ENGINE_NETWORK_STATUS,
-                                                        data: {
-                                                            active: this.online,
-                                                        },
-                                                    });
-                                                    dataSubsObservable = void 0;
-                                                    if (!isNode) return [3 /*break*/, 1];
-                                                    logger.warn('Realtime disabled when in a server-side environment');
-                                                    return [3 /*break*/, 6];
-                                                case 1:
-                                                    //#region GraphQL Subscriptions
-                                                    _b = __read(this.subscriptionsProcessor.start(), 2), 
-                                                    // const ctlObservable: Observable<CONTROL_MSG>
-                                                    ctlSubsObservable_1 = _b[0], 
-                                                    // const dataObservable: Observable<[TransformerMutationType, SchemaModel, Readonly<{
-                                                    // id: string;
-                                                    // } & Record<string, any>>]>
-                                                    dataSubsObservable = _b[1];
-                                                    _c.label = 2;
-                                                case 2:
-                                                    _c.trys.push([2, 4, , 5]);
-                                                    return [4 /*yield*/, new Promise(function (resolve, reject) {
-                                                            var ctlSubsSubscription = ctlSubsObservable_1.subscribe({
-                                                                next: function (msg) {
-                                                                    if (msg === CONTROL_MSG.CONNECTED) {
-                                                                        resolve();
-                                                                    }
-                                                                },
-                                                                error: function (err) {
-                                                                    reject(err);
-                                                                    var handleDisconnect = _this.disconnectionHandler();
-                                                                    handleDisconnect(err);
-                                                                },
-                                                            });
-                                                            subscriptions.push(ctlSubsSubscription);
-                                                        })];
-                                                case 3:
-                                                    _c.sent();
-                                                    return [3 /*break*/, 5];
-                                                case 4:
-                                                    err_2 = _c.sent();
-                                                    observer.error(err_2);
-                                                    return [2 /*return*/];
-                                                case 5:
-                                                    logger.log('Realtime ready');
-                                                    observer.next({
-                                                        type: ControlMessage.SYNC_ENGINE_SUBSCRIPTIONS_ESTABLISHED,
+                                        return __generator(this, function (_b) {
+                                            return [2 /*return*/, this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                                                    var ctlSubsObservable_1, dataSubsObservable, err_2, error_1;
+                                                    var _a;
+                                                    var _this = this;
+                                                    return __generator(this, function (_b) {
+                                                        switch (_b.label) {
+                                                            case 0:
+                                                                if (!(online && !this.online)) return [3 /*break*/, 10];
+                                                                this.online = online;
+                                                                observer.next({
+                                                                    type: ControlMessage.SYNC_ENGINE_NETWORK_STATUS,
+                                                                    data: {
+                                                                        active: this.online,
+                                                                    },
+                                                                });
+                                                                dataSubsObservable = void 0;
+                                                                if (!isNode) return [3 /*break*/, 1];
+                                                                logger.warn('Realtime disabled when in a server-side environment');
+                                                                return [3 /*break*/, 6];
+                                                            case 1:
+                                                                //#region GraphQL Subscriptions
+                                                                _a = __read(this.subscriptionsProcessor.start(), 2), 
+                                                                // const ctlObservable: Observable<CONTROL_MSG>
+                                                                ctlSubsObservable_1 = _a[0], 
+                                                                // const dataObservable: Observable<[TransformerMutationType, SchemaModel, Readonly<{
+                                                                // id: string;
+                                                                // } & Record<string, any>>]>
+                                                                dataSubsObservable = _a[1];
+                                                                _b.label = 2;
+                                                            case 2:
+                                                                _b.trys.push([2, 4, , 5]);
+                                                                return [4 /*yield*/, new Promise(function (resolve, reject) {
+                                                                        var ctlSubsSubscription = ctlSubsObservable_1.subscribe({
+                                                                            next: function (msg) {
+                                                                                if (msg === CONTROL_MSG.CONNECTED) {
+                                                                                    resolve();
+                                                                                }
+                                                                            },
+                                                                            error: function (err) {
+                                                                                reject(err);
+                                                                                var handleDisconnect = _this.disconnectionHandler();
+                                                                                handleDisconnect(err);
+                                                                            },
+                                                                        });
+                                                                        subscriptions.push(ctlSubsSubscription);
+                                                                    })];
+                                                            case 3:
+                                                                _b.sent();
+                                                                return [3 /*break*/, 5];
+                                                            case 4:
+                                                                err_2 = _b.sent();
+                                                                observer.error(err_2);
+                                                                return [2 /*return*/];
+                                                            case 5:
+                                                                logger.log('Realtime ready');
+                                                                observer.next({
+                                                                    type: ControlMessage.SYNC_ENGINE_SUBSCRIPTIONS_ESTABLISHED,
+                                                                });
+                                                                _b.label = 6;
+                                                            case 6:
+                                                                _b.trys.push([6, 8, , 9]);
+                                                                return [4 /*yield*/, new Promise(function (resolve, reject) {
+                                                                        var syncQuerySubscription = _this.syncQueriesObservable().subscribe({
+                                                                            next: function (message) {
+                                                                                var type = message.type;
+                                                                                if (type ===
+                                                                                    ControlMessage.SYNC_ENGINE_SYNC_QUERIES_READY) {
+                                                                                    resolve();
+                                                                                }
+                                                                                observer.next(message);
+                                                                            },
+                                                                            complete: function () {
+                                                                                resolve();
+                                                                            },
+                                                                            error: function (error) {
+                                                                                reject(error);
+                                                                            },
+                                                                        });
+                                                                        if (syncQuerySubscription) {
+                                                                            subscriptions.push(syncQuerySubscription);
+                                                                        }
+                                                                    })];
+                                                            case 7:
+                                                                _b.sent();
+                                                                return [3 /*break*/, 9];
+                                                            case 8:
+                                                                error_1 = _b.sent();
+                                                                observer.error(error_1);
+                                                                return [2 /*return*/];
+                                                            case 9:
+                                                                //#endregion
+                                                                //#region process mutations (outbox)
+                                                                subscriptions.push(this.mutationsProcessor
+                                                                    .start()
+                                                                    .subscribe(function (_a) {
+                                                                    var modelDefinition = _a.modelDefinition, item = _a.model, hasMore = _a.hasMore;
+                                                                    return _this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                                                                        var modelConstructor, model;
+                                                                        var _this = this;
+                                                                        return __generator(this, function (_a) {
+                                                                            switch (_a.label) {
+                                                                                case 0:
+                                                                                    modelConstructor = this.userModelClasses[modelDefinition.name];
+                                                                                    model = this.modelInstanceCreator(modelConstructor, item);
+                                                                                    return [4 /*yield*/, this.storage.runExclusive(function (storage) {
+                                                                                            return _this.modelMerger.merge(storage, model, modelDefinition);
+                                                                                        })];
+                                                                                case 1:
+                                                                                    _a.sent();
+                                                                                    observer.next({
+                                                                                        type: ControlMessage.SYNC_ENGINE_OUTBOX_MUTATION_PROCESSED,
+                                                                                        data: {
+                                                                                            model: modelConstructor,
+                                                                                            element: model,
+                                                                                        },
+                                                                                    });
+                                                                                    observer.next({
+                                                                                        type: ControlMessage.SYNC_ENGINE_OUTBOX_STATUS,
+                                                                                        data: {
+                                                                                            isEmpty: !hasMore,
+                                                                                        },
+                                                                                    });
+                                                                                    return [2 /*return*/];
+                                                                            }
+                                                                        });
+                                                                    }); }, 'mutation processor event');
+                                                                }));
+                                                                //#endregion
+                                                                //#region Merge subscriptions buffer
+                                                                // TODO: extract to function
+                                                                if (!isNode) {
+                                                                    subscriptions.push(dataSubsObservable.subscribe(function (_a) {
+                                                                        var _b = __read(_a, 3), _transformerMutationType = _b[0], modelDefinition = _b[1], item = _b[2];
+                                                                        return _this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                                                                            var modelConstructor, model;
+                                                                            var _this = this;
+                                                                            return __generator(this, function (_a) {
+                                                                                switch (_a.label) {
+                                                                                    case 0:
+                                                                                        modelConstructor = this.userModelClasses[modelDefinition.name];
+                                                                                        model = this.modelInstanceCreator(modelConstructor, item);
+                                                                                        return [4 /*yield*/, this.storage.runExclusive(function (storage) {
+                                                                                                return _this.modelMerger.merge(storage, model, modelDefinition);
+                                                                                            })];
+                                                                                    case 1:
+                                                                                        _a.sent();
+                                                                                        return [2 /*return*/];
+                                                                                }
+                                                                            });
+                                                                        }); }, 'subscription dataSubsObservable event');
+                                                                    }));
+                                                                }
+                                                                return [3 /*break*/, 11];
+                                                            case 10:
+                                                                if (!online) {
+                                                                    this.online = online;
+                                                                    observer.next({
+                                                                        type: ControlMessage.SYNC_ENGINE_NETWORK_STATUS,
+                                                                        data: {
+                                                                            active: this.online,
+                                                                        },
+                                                                    });
+                                                                    subscriptions.forEach(function (sub) { return sub.unsubscribe(); });
+                                                                    subscriptions = [];
+                                                                }
+                                                                _b.label = 11;
+                                                            case 11:
+                                                                doneStarting();
+                                                                return [2 /*return*/];
+                                                        }
                                                     });
-                                                    _c.label = 6;
-                                                case 6:
-                                                    _c.trys.push([6, 8, , 9]);
-                                                    return [4 /*yield*/, new Promise(function (resolve, reject) {
-                                                            var syncQuerySubscription = _this.syncQueriesObservable().subscribe({
-                                                                next: function (message) {
-                                                                    var type = message.type;
-                                                                    if (type === ControlMessage.SYNC_ENGINE_SYNC_QUERIES_READY) {
-                                                                        resolve();
-                                                                    }
-                                                                    observer.next(message);
-                                                                },
-                                                                complete: function () {
-                                                                    resolve();
-                                                                },
-                                                                error: function (error) {
-                                                                    reject(error);
-                                                                },
-                                                            });
-                                                            if (syncQuerySubscription) {
-                                                                subscriptions.push(syncQuerySubscription);
-                                                            }
-                                                        })];
-                                                case 7:
-                                                    _c.sent();
-                                                    return [3 /*break*/, 9];
-                                                case 8:
-                                                    error_1 = _c.sent();
-                                                    observer.error(error_1);
-                                                    return [2 /*return*/];
-                                                case 9:
-                                                    //#endregion
-                                                    //#region process mutations
-                                                    subscriptions.push(this.mutationsProcessor
-                                                        .start()
-                                                        .subscribe(function (_a) {
-                                                        var modelDefinition = _a.modelDefinition, item = _a.model, hasMore = _a.hasMore;
-                                                        var modelConstructor = _this.userModelClasses[modelDefinition.name];
-                                                        var model = _this.modelInstanceCreator(modelConstructor, item);
-                                                        _this.storage.runExclusive(function (storage) {
-                                                            return _this.modelMerger.merge(storage, model);
-                                                        });
-                                                        observer.next({
-                                                            type: ControlMessage.SYNC_ENGINE_OUTBOX_MUTATION_PROCESSED,
-                                                            data: {
-                                                                model: modelConstructor,
-                                                                element: model,
-                                                            },
-                                                        });
-                                                        observer.next({
-                                                            type: ControlMessage.SYNC_ENGINE_OUTBOX_STATUS,
-                                                            data: {
-                                                                isEmpty: !hasMore,
-                                                            },
-                                                        });
-                                                    }));
-                                                    //#endregion
-                                                    //#region Merge subscriptions buffer
-                                                    // TODO: extract to function
-                                                    if (!isNode) {
-                                                        subscriptions.push(dataSubsObservable.subscribe(function (_a) {
-                                                            var _b = __read(_a, 3), _transformerMutationType = _b[0], modelDefinition = _b[1], item = _b[2];
-                                                            var modelConstructor = _this.userModelClasses[modelDefinition.name];
-                                                            var model = _this.modelInstanceCreator(modelConstructor, item);
-                                                            _this.storage.runExclusive(function (storage) {
-                                                                return _this.modelMerger.merge(storage, model);
-                                                            });
-                                                        }));
-                                                    }
-                                                    return [3 /*break*/, 11];
-                                                case 10:
-                                                    if (!online) {
-                                                        this.online = online;
-                                                        observer.next({
-                                                            type: ControlMessage.SYNC_ENGINE_NETWORK_STATUS,
-                                                            data: {
-                                                                active: this.online,
-                                                            },
-                                                        });
-                                                        subscriptions.forEach(function (sub) { return sub.unsubscribe(); });
-                                                        subscriptions = [];
-                                                    }
-                                                    _c.label = 11;
-                                                case 11:
-                                                    resolve();
-                                                    return [2 /*return*/];
-                                            }
+                                                }); }, 'datastore connectivity event')];
                                         });
                                     });
                                 });
@@ -304,38 +335,44 @@ var SyncEngine = /** @class */ (function () {
                                 next: function (_a) {
                                     var opType = _a.opType, model = _a.model, element = _a.element, condition = _a.condition;
                                     return __awaiter(_this, void 0, void 0, function () {
-                                        var namespace, MutationEventConstructor, graphQLCondition, mutationEvent;
+                                        var _this = this;
                                         return __generator(this, function (_b) {
-                                            switch (_b.label) {
-                                                case 0:
-                                                    namespace = this.schema.namespaces[this.namespaceResolver(model)];
-                                                    MutationEventConstructor = this.modelClasses['MutationEvent'];
-                                                    graphQLCondition = predicateToGraphQLCondition(condition);
-                                                    mutationEvent = createMutationInstanceFromModelOperation(namespace.relationships, this.getModelDefinition(model), opType, model, element, graphQLCondition, MutationEventConstructor, this.modelInstanceCreator);
-                                                    return [4 /*yield*/, this.outbox.enqueue(this.storage, mutationEvent)];
-                                                case 1:
-                                                    _b.sent();
-                                                    observer.next({
-                                                        type: ControlMessage.SYNC_ENGINE_OUTBOX_MUTATION_ENQUEUED,
-                                                        data: {
-                                                            model: model,
-                                                            element: element,
-                                                        },
-                                                    });
-                                                    observer.next({
-                                                        type: ControlMessage.SYNC_ENGINE_OUTBOX_STATUS,
-                                                        data: {
-                                                            isEmpty: false,
-                                                        },
+                                            return [2 /*return*/, this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                                                    var namespace, MutationEventConstructor, modelDefinition, graphQLCondition, mutationEvent;
+                                                    return __generator(this, function (_a) {
+                                                        switch (_a.label) {
+                                                            case 0:
+                                                                namespace = this.schema.namespaces[this.namespaceResolver(model)];
+                                                                MutationEventConstructor = this.modelClasses['MutationEvent'];
+                                                                modelDefinition = this.getModelDefinition(model);
+                                                                graphQLCondition = predicateToGraphQLCondition(condition, modelDefinition);
+                                                                mutationEvent = createMutationInstanceFromModelOperation(namespace.relationships, this.getModelDefinition(model), opType, model, element, graphQLCondition, MutationEventConstructor, this.modelInstanceCreator);
+                                                                return [4 /*yield*/, this.outbox.enqueue(this.storage, mutationEvent)];
+                                                            case 1:
+                                                                _a.sent();
+                                                                observer.next({
+                                                                    type: ControlMessage.SYNC_ENGINE_OUTBOX_MUTATION_ENQUEUED,
+                                                                    data: {
+                                                                        model: model,
+                                                                        element: element,
+                                                                    },
+                                                                });
+                                                                observer.next({
+                                                                    type: ControlMessage.SYNC_ENGINE_OUTBOX_STATUS,
+                                                                    data: {
+                                                                        isEmpty: false,
+                                                                    },
+                                                                });
+                                                                return [4 /*yield*/, startPromise];
+                                                            case 2:
+                                                                _a.sent();
+                                                                if (this.online) {
+                                                                    this.mutationsProcessor.resume();
+                                                                }
+                                                                return [2 /*return*/];
+                                                        }
                                                     });
-                                                    return [4 /*yield*/, startPromise];
-                                                case 2:
-                                                    _b.sent();
-                                                    if (this.online) {
-                                                        this.mutationsProcessor.resume();
-                                                    }
-                                                    return [2 /*return*/];
-                                            }
+                                                }); }, 'storage event')];
                                         });
                                     });
                                 },
@@ -361,10 +398,13 @@ var SyncEngine = /** @class */ (function () {
                             return [2 /*return*/];
                     }
                 });
-            }); })();
-            return function () {
-                subscriptions.forEach(function (sub) { return sub.unsubscribe(); });
-            };
+            }); }, 'sync start');
+            return _this.runningProcesses.addCleaner(function () { return __awaiter(_this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    subscriptions.forEach(function (sub) { return sub.unsubscribe(); });
+                    return [2 /*return*/];
+                });
+            }); }, 'sync start cleaner');
         });
     };
     SyncEngine.prototype.getModelsMetadataWithNextFullSync = function (currentTimeStamp) {
@@ -375,7 +415,7 @@ var SyncEngine = /** @class */ (function () {
                 switch (_b.label) {
                     case 0:
                         _a = Map.bind;
-                        return [4 /*yield*/, this.getModelsMetadata()];
+                        return [4 /*yield*/, this.runningProcesses.add(function () { return _this.getModelsMetadata(); }, 'sync/index getModelsMetadataWithNextFullSync')];
                     case 1:
                         modelLastSync = new (_a.apply(Map, [void 0, (_b.sent()).map(function (_a) {
                                 var namespace = _a.namespace, model = _a.model, lastSync = _a.lastSync, lastFullSync = _a.lastFullSync, fullSyncInterval = _a.fullSyncInterval, lastSyncPredicate = _a.lastSyncPredicate;
@@ -400,13 +440,13 @@ var SyncEngine = /** @class */ (function () {
         }
         return new Observable(function (observer) {
             var syncQueriesSubscription;
-            var waitTimeoutId;
-            (function () { return __awaiter(_this, void 0, void 0, function () {
-                var _loop_1, this_1;
+            _this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                var terminated, _loop_1, this_1;
                 var _this = this;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
+                            terminated = false;
                             _loop_1 = function () {
                                 var count, modelLastSync, paginatingModels, newestFullSyncStartedAt, theInterval, start, duration, newestStartedAt, msNextFullSync;
                                 return __generator(this, function (_a) {
@@ -423,11 +463,11 @@ var SyncEngine = /** @class */ (function () {
                                                         .subscribe({
                                                         next: function (_a) {
                                                             var namespace = _a.namespace, modelDefinition = _a.modelDefinition, items = _a.items, done = _a.done, startedAt = _a.startedAt, isFullSync = _a.isFullSync;
-                                                            return __awaiter(_this, void 0, void 0, function () {
+                                                            return _this.runningProcesses.add(function () { return __awaiter(_this, void 0, void 0, function () {
                                                                 var modelConstructor, modelName, modelMetadata_1, lastFullSync, fullSyncInterval, counts;
                                                                 var _this = this;
-                                                                return __generator(this, function (_b) {
-                                                                    switch (_b.label) {
+                                                                return __generator(this, function (_a) {
+                                                                    switch (_a.label) {
                                                                         case 0:
                                                                             modelConstructor = this.userModelClasses[modelDefinition.name];
                                                                             if (!count.has(modelConstructor)) {
@@ -456,7 +496,8 @@ var SyncEngine = /** @class */ (function () {
                                                                                                 idsInOutbox = _e.sent();
                                                                                                 oneByOne = [];
                                                                                                 page = items.filter(function (item) {
-                                                                                                    if (!idsInOutbox.has(item.id)) {
+                                                                                                    var itemId = getIdentifierValue(modelDefinition, item);
+                                                                                                    if (!idsInOutbox.has(itemId)) {
                                                                                                         return true;
                                                                                                     }
                                                                                                     oneByOne.push(item);
@@ -471,7 +512,7 @@ var SyncEngine = /** @class */ (function () {
                                                                                             case 3:
                                                                                                 if (!!oneByOne_1_1.done) return [3 /*break*/, 6];
                                                                                                 item = oneByOne_1_1.value;
-                                                                                                return [4 /*yield*/, this.modelMerger.merge(storage, item)];
+                                                                                                return [4 /*yield*/, this.modelMerger.merge(storage, item, modelDefinition)];
                                                                                             case 4:
                                                                                                 opType = _e.sent();
                                                                                                 if (opType !== undefined) {
@@ -495,7 +536,7 @@ var SyncEngine = /** @class */ (function () {
                                                                                             case 9:
                                                                                                 _b = (_a = opTypeCount.push).apply;
                                                                                                 _c = [opTypeCount];
-                                                                                                return [4 /*yield*/, this.modelMerger.mergePage(storage, modelConstructor, page)];
+                                                                                                return [4 /*yield*/, this.modelMerger.mergePage(storage, modelConstructor, page, modelDefinition)];
                                                                                             case 10:
                                                                                                 _b.apply(_a, _c.concat([__spread.apply(void 0, [(_e.sent())])]));
                                                                                                 counts = count.get(modelConstructor);
@@ -524,12 +565,12 @@ var SyncEngine = /** @class */ (function () {
                                                                              * If there are mutations in the outbox for a given id, those need to be
                                                                              * merged individually. Otherwise, we can merge them in batches.
                                                                              */
-                                                                            _b.sent();
+                                                                            _a.sent();
                                                                             if (!done) return [3 /*break*/, 4];
                                                                             modelName = modelDefinition.name;
                                                                             return [4 /*yield*/, this.getModelMetadata(namespace, modelName)];
                                                                         case 2:
-                                                                            modelMetadata_1 = _b.sent();
+                                                                            modelMetadata_1 = _a.sent();
                                                                             lastFullSync = modelMetadata_1.lastFullSync, fullSyncInterval = modelMetadata_1.fullSyncInterval;
                                                                             theInterval = fullSyncInterval;
                                                                             newestFullSyncStartedAt =
@@ -545,7 +586,7 @@ var SyncEngine = /** @class */ (function () {
                                                                             });
                                                                             return [4 /*yield*/, this.storage.save(modelMetadata_1, undefined, ownSymbol)];
                                                                         case 3:
-                                                                            _b.sent();
+                                                                            _a.sent();
                                                                             counts = count.get(modelConstructor);
                                                                             this.modelSyncedStatus.set(modelConstructor, true);
                                                                             observer.next({
@@ -566,11 +607,11 @@ var SyncEngine = /** @class */ (function () {
                                                                                 });
                                                                                 syncQueriesSubscription.unsubscribe();
                                                                             }
-                                                                            _b.label = 4;
+                                                                            _a.label = 4;
                                                                         case 4: return [2 /*return*/];
                                                                     }
                                                                 });
-                                                            });
+                                                            }); }, 'syncQueriesObservable syncQueriesSubscription event');
                                                         },
                                                         error: function (error) {
                                                             observer.error(error);
@@ -592,10 +633,47 @@ var SyncEngine = /** @class */ (function () {
                                                 theInterval -
                                                 (newestStartedAt + duration);
                                             logger.debug("Next fullSync in " + msNextFullSync / 1000 + " seconds. (" + new Date(Date.now() + msNextFullSync) + ")");
-                                            return [4 /*yield*/, new Promise(function (res) {
-                                                    waitTimeoutId = setTimeout(res, msNextFullSync);
-                                                })];
+                                            // TODO: create `BackgroundProcessManager.sleep()` ... but, need to put
+                                            // a lot of thought into what that contract looks like to
+                                            //  support possible use-cases:
+                                            //
+                                            //  1. non-cancelable
+                                            //  2. cancelable, unsleep on exit()
+                                            //  3. cancelable, throw Error on exit()
+                                            //  4. cancelable, callback first on exit()?
+                                            //  5. ... etc. ? ...
+                                            //
+                                            // TLDR; this is a lot of complexity here for a sleep(),
+                                            // but, it's not clear to me yet how to support an
+                                            // extensible, centralized cancelable `sleep()` elegantly.
+                                            return [4 /*yield*/, this_1.runningProcesses.add(function (onTerminate) { return __awaiter(_this, void 0, void 0, function () {
+                                                    var sleepTimer, unsleep, sleep;
+                                                    return __generator(this, function (_a) {
+                                                        sleep = new Promise(function (_unsleep) {
+                                                            unsleep = _unsleep;
+                                                            sleepTimer = setTimeout(unsleep, msNextFullSync);
+                                                        });
+                                                        onTerminate.then(function () {
+                                                            terminated = true;
+                                                            unsleep();
+                                                        });
+                                                        return [2 /*return*/, sleep];
+                                                    });
+                                                }); }, 'syncQueriesObservable sleep')];
                                         case 3:
+                                            // TODO: create `BackgroundProcessManager.sleep()` ... but, need to put
+                                            // a lot of thought into what that contract looks like to
+                                            //  support possible use-cases:
+                                            //
+                                            //  1. non-cancelable
+                                            //  2. cancelable, unsleep on exit()
+                                            //  3. cancelable, throw Error on exit()
+                                            //  4. cancelable, callback first on exit()?
+                                            //  5. ... etc. ? ...
+                                            //
+                                            // TLDR; this is a lot of complexity here for a sleep(),
+                                            // but, it's not clear to me yet how to support an
+                                            // extensible, centralized cancelable `sleep()` elegantly.
                                             _a.sent();
                                             return [2 /*return*/];
                                     }
@@ -604,7 +682,7 @@ var SyncEngine = /** @class */ (function () {
                             this_1 = this;
                             _a.label = 1;
                         case 1:
-                            if (!!observer.closed) return [3 /*break*/, 3];
+                            if (!(!observer.closed && !terminated)) return [3 /*break*/, 3];
                             return [5 /*yield**/, _loop_1()];
                         case 2:
                             _a.sent();
@@ -612,15 +690,16 @@ var SyncEngine = /** @class */ (function () {
                         case 3: return [2 /*return*/];
                     }
                 });
-            }); })();
-            return function () {
-                if (syncQueriesSubscription) {
-                    syncQueriesSubscription.unsubscribe();
-                }
-                if (waitTimeoutId) {
-                    clearTimeout(waitTimeoutId);
-                }
-            };
+            }); }, 'syncQueriesObservable main');
+            return _this.runningProcesses.addCleaner(function () { return __awaiter(_this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    logger.debug('cleaning syncQueriesObservable');
+                    if (syncQueriesSubscription) {
+                        syncQueriesSubscription.unsubscribe();
+                    }
+                    return [2 /*return*/];
+                });
+            }); }, 'syncQueriesObservable cleaner');
         });
     };
     SyncEngine.prototype.disconnectionHandler = function () {
@@ -636,16 +715,81 @@ var SyncEngine = /** @class */ (function () {
     SyncEngine.prototype.unsubscribeConnectivity = function () {
         this.datastoreConnectivity.unsubscribe();
     };
+    /**
+     * Stops all subscription activities and resolves when all activies report
+     * that they're disconnected, done retrying, etc..
+     */
+    SyncEngine.prototype.stop = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger.debug('stopping sync engine');
+                        /**
+                         * Gracefully disconnecting subscribers first just prevents *more* work
+                         * from entering the pipelines.
+                         */
+                        this.unsubscribeConnectivity();
+                        /**
+                         * aggressively shut down any lingering background processes.
+                         * some of this might be semi-redundant with unsubscribing. however,
+                         * unsubscribing doesn't allow us to wait for settling.
+                         * (Whereas `stop()` does.)
+                         */
+                        return [4 /*yield*/, this.mutationsProcessor.stop()];
+                    case 1:
+                        /**
+                         * aggressively shut down any lingering background processes.
+                         * some of this might be semi-redundant with unsubscribing. however,
+                         * unsubscribing doesn't allow us to wait for settling.
+                         * (Whereas `stop()` does.)
+                         */
+                        _a.sent();
+                        return [4 /*yield*/, this.subscriptionsProcessor.stop()];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, this.datastoreConnectivity.stop()];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, this.syncQueriesProcessor.stop()];
+                    case 4:
+                        _a.sent();
+                        /**
+                         * TODO: *consider* refactoring shutdowns ^ into this context as child
+                         * job contexts, as cleaner methods (added with `addCleaner()`), or by
+                         * passing this context through to child processes.
+                         */
+                        return [4 /*yield*/, this.runningProcesses.close()];
+                    case 5:
+                        /**
+                         * TODO: *consider* refactoring shutdowns ^ into this context as child
+                         * job contexts, as cleaner methods (added with `addCleaner()`), or by
+                         * passing this context through to child processes.
+                         */
+                        _a.sent();
+                        /**
+                         * Not 100% sure this is necessary. In most cases, we would expect the
+                         * sync engine to be replaced with a new instance after stopping.
+                         *
+                         * TODO: Remove this and see if everything still works.
+                         */
+                        this.runningProcesses = new BackgroundProcessManager();
+                        logger.debug('sync engine stopped and ready to restart');
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     SyncEngine.prototype.setupModels = function (params) {
         return __awaiter(this, void 0, void 0, function () {
-            var fullSyncInterval, ModelMetadata, models, savedModel, promises, result, _a, _b, modelMetadata, modelName, e_2_1;
+            var fullSyncInterval, ModelMetadataConstructor, models, savedModel, promises, result, _a, _b, modelMetadata, modelName, e_2_1;
             var e_2, _c;
             var _this = this;
             return __generator(this, function (_d) {
                 switch (_d.label) {
                     case 0:
                         fullSyncInterval = params.fullSyncInterval;
-                        ModelMetadata = this.modelClasses
+                        ModelMetadataConstructor = this.modelClasses
                             .ModelMetadata;
                         models = [];
                         Object.values(this.schema.namespaces).forEach(function (namespace) {
@@ -677,7 +821,7 @@ var SyncEngine = /** @class */ (function () {
                                                 ? JSON.stringify(syncPredicate)
                                                 : null;
                                             if (!(modelMetadata === undefined)) return [3 /*break*/, 3];
-                                            return [4 /*yield*/, this.storage.save(this.modelInstanceCreator(ModelMetadata, {
+                                            return [4 /*yield*/, this.storage.save(this.modelInstanceCreator(ModelMetadataConstructor, {
                                                     model: model.name,
                                                     namespace: namespace,
                                                     lastSync: null,
@@ -693,7 +837,7 @@ var SyncEngine = /** @class */ (function () {
                                                 ? modelMetadata.lastSyncPredicate
                                                 : null;
                                             syncPredicateUpdated_1 = prevSyncPredicate !== lastSyncPredicate;
-                                            return [4 /*yield*/, this.storage.save(this.modelClasses.ModelMetadata.copyOf(modelMetadata, function (draft) {
+                                            return [4 /*yield*/, this.storage.save(ModelMetadataConstructor.copyOf(modelMetadata, function (draft) {
                                                     draft.fullSyncInterval = fullSyncInterval;
                                                     // perform a base sync if the syncPredicate changed in between calls to DataStore.start
                                                     // ensures that the local store contains all the data specified by the syncExpression