remult 3.3.19-next.2 → 3.4.0-next.2

package/src/live-query/LiveQueryClient.js

@@ -5,6 +5,7 @@ var tslib_1 = require("tslib");
 var buildRestDataProvider_js_1 = require("../buildRestDataProvider.js");
 var rest_data_provider_js_1 = require("../data-providers/rest-data-provider.js");
 var remult_static_js_1 = require("../remult-static.js");
+var remult3_js_1 = require("../remult3/remult3.js");
 var repository_internals_js_1 = require("../remult3/repository-internals.js");
 var SubscriptionChannel_js_1 = require("./SubscriptionChannel.js");
 /* @internal*/
@@ -14,6 +15,9 @@ var LiveQueryClient = /** @class */ (function () {
         this.getUserId = getUserId;
         this.queries = new Map();
         this.channels = new Map();
+        this.lastKeepAliveAt = 0;
+        this.keepAliveBackoffMs = remult3_js_1.flags.liveQueryPollWhenStaleMs;
+        this.detachForeground = function () { };
     }
     LiveQueryClient.prototype.wrapMessageHandling = function (handleMessage) {
         var x = this.apiProvider().wrapMessageHandling;
@@ -31,6 +35,7 @@ var LiveQueryClient = /** @class */ (function () {
     LiveQueryClient.prototype.close = function () {
         this.queries.clear();
         this.channels.clear();
+        this.detachForeground();
         this.closeIfNoListeners();
     };
     LiveQueryClient.prototype.subscribeChannel = function (key, onResult) {
@@ -88,13 +93,15 @@ var LiveQueryClient = /** @class */ (function () {
         });
     };
     LiveQueryClient.prototype.closeIfNoListeners = function () {
-        if (this.client)
-            if (this.queries.size === 0 && this.channels.size === 0) {
-                this.runPromise(this.client.then(function (x) { return x.close(); }));
-                this.client = undefined;
-                clearInterval(this.interval);
-                this.interval = undefined;
-            }
+        if (this.queries.size === 0 && this.channels.size === 0) {
+            if (this.client)
+                this.runPromise(this.client.then(function (x) { return x.close(); }).catch(function () { }));
+            this.client = undefined;
+            this.openedConnection = undefined;
+            this.detachForeground();
+            clearInterval(this.interval);
+            this.interval = undefined;
+        }
     };
     LiveQueryClient.prototype.subscribe = function (repo, options, listener) {
         var _this = this;
@@ -115,43 +122,56 @@ var LiveQueryClient = /** @class */ (function () {
             if (!q) {
                 _this.queries.set(eventTypeKey, (q = new SubscriptionChannel_js_1.LiveQuerySubscriber(repo, { entityKey: repo.metadata.key, options: options }, _this.getUserId())));
                 q.subscribeCode = function () {
-                    if (q.unsubscribe) {
-                        q.unsubscribe();
+                    q.unsubscribeChannel();
+                    var unsubscribeToChannel = function () { };
+                    q.unsubscribeChannel = function () {
+                        unsubscribeToChannel();
+                        unsubscribeToChannel = function () { };
+                    };
+                    q.unsubscribe = function () {
                         q.unsubscribe = function () { };
-                    }
+                        q.unsubscribeChannel();
+                        q.unsubscribeQuery();
+                    };
+                    var snapshotDone = false;
+                    var applySnapshot = function (r) {
+                        if (q.listeners.length === 0) {
+                            r.unsubscribe();
+                            return;
+                        }
+                        q.unsubscribeQuery = function () {
+                            _this.runPromise(r.unsubscribe());
+                        };
+                        snapshotDone = true;
+                        return _this.runPromise(q.setAllItems(r.result));
+                    };
                     _this.runPromise(_this.subscribeChannel(q.queryChannel, {
                         next: function (value) { return _this.runPromise(q.handle(value)); },
                         complete: function () { },
                         error: function (er) {
                             q.listeners.forEach(function (l) { return l.error(er); });
                         },
-                    }).then(function (unsubscribeToChannel) {
+                    })
+                        .then(function (unsub) {
                         if (q.listeners.length == 0) {
-                            unsubscribeToChannel();
+                            unsub();
                             return;
                         }
-                        _this.runPromise(subscribe(q.queryChannel)
-                            .then(function (r) {
-                            if (q.listeners.length === 0) {
-                                r.unsubscribe();
-                                unsubscribeToChannel();
-                                return;
-                            }
-                            _this.runPromise(q.setAllItems(r.result));
-                            q.unsubscribe = function () {
-                                q.unsubscribe = function () { };
-                                unsubscribeToChannel();
-                                _this.runPromise(r.unsubscribe());
-                            };
-                        })
-                            .catch(function (err) {
-                            q.listeners.forEach(function (l) { return l.error(err); });
-                            unsubscribeToChannel();
-                            _this.queries.delete(eventTypeKey);
-                        }));
-                    })).catch(function (err) {
+                        unsubscribeToChannel = unsub;
+                        if (snapshotDone)
+                            return _this.runPromise(_this.runKeepAlive({ checkVersions: true }));
+                    })
+                        .catch(function (err) {
+                        q.listeners.forEach(function (l) { return l.error(err); });
+                    }));
+                    _this.runPromise(subscribe(q.queryChannel)
+                        .then(applySnapshot)
+                        .catch(function (err) {
                         q.listeners.forEach(function (l) { return l.error(err); });
-                    });
+                        unsubscribeToChannel();
+                        _this.queries.delete(eventTypeKey);
+                        _this.closeIfNoListeners();
+                    }));
                 };
                 q.subscribeCode();
             }
@@ -176,84 +196,182 @@ var LiveQueryClient = /** @class */ (function () {
             onUnsubscribe();
         };
     };
-    LiveQueryClient.prototype.openIfNoOpened = function () {
-        var _this = this;
-        if (!this.client) {
-            this.interval = setInterval(function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                var ids, _a, _b, q, p_1, invalidIds, _c, invalidIds_1, invalidIds_1_1, id, _d, _e, q;
-                var e_1, _f, e_2, _g, e_3, _h;
-                return tslib_1.__generator(this, function (_j) {
-                    switch (_j.label) {
-                        case 0:
-                            ids = [];
+    LiveQueryClient.prototype.isSseStale = function () {
+        var conn = this.openedConnection;
+        if (!conn || conn.lastServerEvent === undefined)
+            return false;
+        return Date.now() - conn.lastServerEvent > remult3_js_1.flags.sseStaleMs;
+    };
+    LiveQueryClient.prototype.runKeepAlive = function (opts) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                if (this.keepAliveInFlight)
+                    return [2 /*return*/, this.keepAliveInFlight];
+                this.keepAliveInFlight = this.sendKeepAlive(opts).finally(function () {
+                    _this.keepAliveInFlight = undefined;
+                });
+                return [2 /*return*/, this.keepAliveInFlight];
+            });
+        });
+    };
+    LiveQueryClient.prototype.sendKeepAlive = function (opts) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var ids, _a, _b, q, p, raw, unknownIds, versions, stale, reloaded, _c, _d, q, serverVersion, unknown, mismatch;
+            var e_1, _e, e_2, _f;
+            var _g, _h;
+            return tslib_1.__generator(this, function (_j) {
+                switch (_j.label) {
+                    case 0:
+                        ids = [];
+                        try {
+                            for (_a = tslib_1.__values(this.queries.values()), _b = _a.next(); !_b.done; _b = _a.next()) {
+                                q = _b.value;
+                                ids.push(q.queryChannel);
+                            }
+                        }
+                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        finally {
                             try {
-                                for (_a = tslib_1.__values(this.queries.values()), _b = _a.next(); !_b.done; _b = _a.next()) {
-                                    q = _b.value;
-                                    ids.push(q.queryChannel);
-                                }
+                                if (_b && !_b.done && (_e = _a.return)) _e.call(_a);
                             }
-                            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-                            finally {
-                                try {
-                                    if (_b && !_b.done && (_f = _a.return)) _f.call(_a);
+                            finally { if (e_1) throw e_1.error; }
+                        }
+                        if (ids.length === 0)
+                            return [2 /*return*/];
+                        p = this.apiProvider();
+                        return [4 /*yield*/, this.runPromise(remult_static_js_1.remultStatic.actionInfo.runActionWithoutBlockingUI(function () {
+                                return (0, buildRestDataProvider_js_1.buildRestDataProvider)(p.httpClient).post(p.url + '/' + SubscriptionChannel_js_1.liveQueryKeepAliveRoute, { queryIds: ids });
+                            }))];
+                    case 1:
+                        raw = _j.sent();
+                        unknownIds = Array.isArray(raw)
+                            ? raw
+                            : ((_g = raw === null || raw === void 0 ? void 0 : raw.unknownQueryIds) !== null && _g !== void 0 ? _g : []);
+                        versions = Array.isArray(raw)
+                            ? {}
+                            : ((_h = raw === null || raw === void 0 ? void 0 : raw.versions) !== null && _h !== void 0 ? _h : {});
+                        stale = (opts === null || opts === void 0 ? void 0 : opts.checkVersions) || this.isSseStale();
+                        reloaded = false;
+                        try {
+                            for (_c = tslib_1.__values(this.queries.values()), _d = _c.next(); !_d.done; _d = _c.next()) {
+                                q = _d.value;
+                                serverVersion = versions[q.queryChannel];
+                                unknown = unknownIds.includes(q.queryChannel);
+                                mismatch = stale && serverVersion !== undefined && serverVersion !== q.version;
+                                if (unknown || mismatch) {
+                                    reloaded = true;
+                                    if (serverVersion !== undefined)
+                                        q.version = serverVersion;
+                                    q.subscribeCode();
                                 }
-                                finally { if (e_1) throw e_1.error; }
                             }
-                            if (!(ids.length > 0)) return [3 /*break*/, 3];
-                            p_1 = this.apiProvider();
-                            _c = this.runPromise;
-                            return [4 /*yield*/, remult_static_js_1.remultStatic.actionInfo.runActionWithoutBlockingUI(function () {
-                                    return (0, buildRestDataProvider_js_1.buildRestDataProvider)(p_1.httpClient).post(p_1.url + '/' + SubscriptionChannel_js_1.liveQueryKeepAliveRoute, ids);
-                                })];
-                        case 1: return [4 /*yield*/, _c.apply(this, [_j.sent()])];
-                        case 2:
-                            invalidIds = _j.sent();
+                        }
+                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                        finally {
                             try {
-                                for (invalidIds_1 = tslib_1.__values(invalidIds), invalidIds_1_1 = invalidIds_1.next(); !invalidIds_1_1.done; invalidIds_1_1 = invalidIds_1.next()) {
-                                    id = invalidIds_1_1.value;
-                                    try {
-                                        for (_d = (e_3 = void 0, tslib_1.__values(this.queries.values())), _e = _d.next(); !_e.done; _e = _d.next()) {
-                                            q = _e.value;
-                                            if (q.queryChannel === id)
-                                                q.subscribeCode();
-                                        }
-                                    }
-                                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
-                                    finally {
-                                        try {
-                                            if (_e && !_e.done && (_h = _d.return)) _h.call(_d);
-                                        }
-                                        finally { if (e_3) throw e_3.error; }
-                                    }
-                                }
-                            }
-                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                            finally {
-                                try {
-                                    if (invalidIds_1_1 && !invalidIds_1_1.done && (_g = invalidIds_1.return)) _g.call(invalidIds_1);
-                                }
-                                finally { if (e_2) throw e_2.error; }
+                                if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
                             }
-                            _j.label = 3;
-                        case 3: return [2 /*return*/];
-                    }
-                });
-            }); }, 30000);
-            return this.runPromise((this.client = this.apiProvider().subscriptionClient.openConnection(function () {
-                var e_4, _a;
+                            finally { if (e_2) throw e_2.error; }
+                        }
+                        if (this.isSseStale()) {
+                            this.keepAliveBackoffMs = reloaded
+                                ? remult3_js_1.flags.liveQueryPollWhenStaleMs
+                                : Math.min(this.keepAliveBackoffMs * 2, remult3_js_1.flags.liveQueryKeepAliveMs);
+                        }
+                        else {
+                            this.keepAliveBackoffMs = remult3_js_1.flags.liveQueryPollWhenStaleMs;
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    LiveQueryClient.prototype.maybeKeepAlive = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var stale, interval;
+            var _a, _b;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        stale = this.isSseStale();
+                        if (!stale)
+                            this.keepAliveBackoffMs = remult3_js_1.flags.liveQueryPollWhenStaleMs;
+                        interval = stale
+                            ? this.keepAliveBackoffMs
+                            : remult3_js_1.flags.liveQueryKeepAliveMs;
+                        if (Date.now() - this.lastKeepAliveAt < interval)
+                            return [2 /*return*/];
+                        this.lastKeepAliveAt = Date.now();
+                        if (stale)
+                            (_b = (_a = this.openedConnection) === null || _a === void 0 ? void 0 : _a.resume) === null || _b === void 0 ? void 0 : _b.call(_a, true);
+                        return [4 /*yield*/, this.runKeepAlive()];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    LiveQueryClient.prototype.attachForeground = function () {
+        var _this = this;
+        this.detachForeground();
+        var unsub = (0, SubscriptionChannel_js_1.onBrowserForeground)(function () {
+            var _a, _b;
+            (_b = (_a = _this.openedConnection) === null || _a === void 0 ? void 0 : _a.resume) === null || _b === void 0 ? void 0 : _b.call(_a);
+            if (_this.foregroundKeepAliveTimer !== undefined)
+                clearTimeout(_this.foregroundKeepAliveTimer);
+            _this.foregroundKeepAliveTimer = setTimeout(function () {
+                _this.foregroundKeepAliveTimer = undefined;
+                _this.keepAliveBackoffMs = remult3_js_1.flags.liveQueryPollWhenStaleMs;
+                _this.lastKeepAliveAt = 0;
+                _this.runPromise(_this.runKeepAlive({ checkVersions: true }));
+            }, 300);
+        });
+        this.detachForeground = function () {
+            unsub();
+            if (_this.foregroundKeepAliveTimer !== undefined) {
+                clearTimeout(_this.foregroundKeepAliveTimer);
+                _this.foregroundKeepAliveTimer = undefined;
+            }
+            _this.detachForeground = function () { };
+        };
+    };
+    LiveQueryClient.prototype.openIfNoOpened = function () {
+        var _this = this;
+        if (!this.client) {
+            this.lastKeepAliveAt = Date.now();
+            this.keepAliveBackoffMs = remult3_js_1.flags.liveQueryPollWhenStaleMs;
+            this.attachForeground();
+            this.interval = setInterval(function () {
+                _this.runPromise(_this.maybeKeepAlive());
+            }, Math.min(remult3_js_1.flags.liveQueryPollWhenStaleMs, remult3_js_1.flags.liveQueryKeepAliveMs));
+            return this.runPromise((this.client = this.apiProvider()
+                .subscriptionClient.openConnection(function () {
+                var e_3, _a;
                 try {
                     for (var _b = tslib_1.__values(_this.queries.values()), _c = _b.next(); !_c.done; _c = _b.next()) {
                         var q = _c.value;
                         q.subscribeCode();
                     }
                 }
-                catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                catch (e_3_1) { e_3 = { error: e_3_1 }; }
                 finally {
                     try {
                         if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
                     }
-                    finally { if (e_4) throw e_4.error; }
+                    finally { if (e_3) throw e_3.error; }
                 }
+            })
+                .then(function (c) {
+                _this.openedConnection = c;
+                return c;
+            })
+                .catch(function (err) {
+                _this.client = undefined;
+                _this.openedConnection = undefined;
+                _this.closeIfNoListeners();
+                throw err;
             })));
         }
         return this.client;
@@ -269,7 +387,7 @@ var MessageChannel = /** @class */ (function () {
     MessageChannel.prototype.handle = function (message) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var _a, _b, l;
-            var e_5, _c;
+            var e_4, _c;
             return tslib_1.__generator(this, function (_d) {
                 try {
                     for (_a = tslib_1.__values(this.listeners), _b = _a.next(); !_b.done; _b = _a.next()) {
@@ -277,12 +395,12 @@ var MessageChannel = /** @class */ (function () {
                         l.next(message);
                     }
                 }
-                catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                catch (e_4_1) { e_4 = { error: e_4_1 }; }
                 finally {
                     try {
                         if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
                     }
-                    finally { if (e_5) throw e_5.error; }
+                    finally { if (e_4) throw e_4.error; }
                 }
                 return [2 /*return*/];
             });