remult 3.3.18 → 3.4.0-next.1

package/src/live-query/SseSubscriptionClient.js

@@ -5,7 +5,6 @@ var tslib_1 = require("tslib");
 var buildRestDataProvider_js_1 = require("../buildRestDataProvider.js");
 var remult_proxy_js_1 = require("../remult-proxy.js");
 var remult_static_js_1 = require("../remult-static.js");
-var remult3_js_1 = require("../remult3/remult3.js");
 var SubscriptionChannel_js_1 = require("./SubscriptionChannel.js");
 var SseSubscriptionClient = /** @class */ (function () {
     function SseSubscriptionClient() {
@@ -14,11 +13,54 @@ var SseSubscriptionClient = /** @class */ (function () {
         var connectionId;
         var channels = new Map();
         var provider = (0, buildRestDataProvider_js_1.buildRestDataProvider)(remult_proxy_js_1.remult.apiClient.httpClient);
-        var connected = false;
         var source;
+        var retryCount = 0;
+        var closed = false;
+        var connected = false;
+        var reconnectTimer;
+        var connectionReady;
+        var connectionPromise = new Promise(function (res) {
+            connectionReady = res;
+        });
+        function clearReconnectTimer() {
+            if (reconnectTimer !== undefined) {
+                clearTimeout(reconnectTimer);
+                reconnectTimer = undefined;
+            }
+        }
+        function scheduleReconnect() {
+            if (closed)
+                return;
+            clearReconnectTimer();
+            var delay = Math.min(500 * Math.pow(2, Math.min(retryCount, 5)), 8000);
+            retryCount++;
+            reconnectTimer = setTimeout(function () {
+                reconnectTimer = undefined;
+                createConnection();
+            }, delay);
+        }
+        function resume(force) {
+            if (closed)
+                return;
+            retryCount = 0;
+            clearReconnectTimer();
+            if (force) {
+                createConnection();
+                return;
+            }
+            var open = source &&
+                typeof EventSource !== 'undefined' &&
+                source.readyState !== EventSource.CLOSED;
+            if (!open)
+                createConnection();
+        }
         var client = {
+            lastServerEvent: Date.now(),
+            resume: resume,
             close: function () {
-                source.close();
+                closed = true;
+                clearReconnectTimer();
+                source === null || source === void 0 ? void 0 : source.close();
             },
             subscribe: function (channel, handler) {
                 return tslib_1.__awaiter(this, void 0, void 0, function () {
@@ -27,13 +69,17 @@ var SseSubscriptionClient = /** @class */ (function () {
                         switch (_a.label) {
                             case 0:
                                 listeners = channels.get(channel);
-                                if (!!listeners) return [3 /*break*/, 2];
+                                if (!!listeners) return [3 /*break*/, 3];
                                 channels.set(channel, (listeners = []));
-                                return [4 /*yield*/, subscribeToChannel(channel)];
+                                return [4 /*yield*/, connectionPromise];
                             case 1:
                                 _a.sent();
-                                _a.label = 2;
+                                if (!!closed) return [3 /*break*/, 3];
+                                return [4 /*yield*/, subscribeToChannel(channel)];
                             case 2:
+                                _a.sent();
+                                _a.label = 3;
+                            case 3:
                                 listeners.push(handler);
                                 return [2 /*return*/, function () {
                                         listeners.splice(listeners.indexOf(handler, 1));
@@ -52,80 +98,85 @@ var SseSubscriptionClient = /** @class */ (function () {
                 });
             },
         };
-        var createConnectionPromise = function () {
-            return new Promise(function (res) {
-                createConnection();
-                var retryCount = 0;
-                function createConnection() {
-                    var _this = this;
-                    if (source)
-                        source.close();
-                    source = SseSubscriptionClient.createEventSource(remult_proxy_js_1.remult.apiClient.url + '/' + SubscriptionChannel_js_1.streamUrl);
-                    source.onmessage = function (e) {
-                        var message = JSON.parse(e.data);
-                        var listeners = channels.get(message.channel);
-                        if (listeners)
-                            listeners.forEach(function (x) { return x(message.data); });
-                    };
-                    source.onerror = function (e) {
-                        console.error('Live Query Event Source Error', e);
-                        source.close();
-                        if (retryCount++ < remult3_js_1.flags.error500RetryCount) {
-                            setTimeout(function () {
-                                createConnection();
-                            }, 500);
-                        }
-                    };
-                    source.addEventListener('connectionId', function (e) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                        var _a, _b, channel, e_1_1;
-                        var e_1, _c;
-                        return tslib_1.__generator(this, function (_d) {
-                            switch (_d.label) {
-                                case 0:
-                                    //@ts-ignore
-                                    connectionId = e.data;
-                                    if (!connected) return [3 /*break*/, 9];
-                                    _d.label = 1;
-                                case 1:
-                                    _d.trys.push([1, 6, 7, 8]);
-                                    _a = tslib_1.__values(channels.keys()), _b = _a.next();
-                                    _d.label = 2;
-                                case 2:
-                                    if (!!_b.done) return [3 /*break*/, 5];
-                                    channel = _b.value;
-                                    return [4 /*yield*/, subscribeToChannel(channel)];
-                                case 3:
-                                    _d.sent();
-                                    _d.label = 4;
-                                case 4:
-                                    _b = _a.next();
-                                    return [3 /*break*/, 2];
-                                case 5: return [3 /*break*/, 8];
-                                case 6:
-                                    e_1_1 = _d.sent();
-                                    e_1 = { error: e_1_1 };
-                                    return [3 /*break*/, 8];
-                                case 7:
-                                    try {
-                                        if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
-                                    }
-                                    finally { if (e_1) throw e_1.error; }
-                                    return [7 /*endfinally*/];
-                                case 8:
-                                    onReconnect();
-                                    return [3 /*break*/, 10];
-                                case 9:
-                                    connected = true;
-                                    res(client);
-                                    _d.label = 10;
-                                case 10: return [2 /*return*/];
-                            }
-                        });
-                    }); });
-                }
+        function noteServerEvent() {
+            client.lastServerEvent = Date.now();
+        }
+        function createConnection() {
+            var _this = this;
+            if (closed)
+                return;
+            clearReconnectTimer();
+            if (source)
+                source.close();
+            source = SseSubscriptionClient.createEventSource(remult_proxy_js_1.remult.apiClient.url + '/' + SubscriptionChannel_js_1.streamUrl);
+            source.onmessage = function (e) {
+                noteServerEvent();
+                var message = JSON.parse(e.data);
+                var listeners = channels.get(message.channel);
+                if (listeners)
+                    listeners.forEach(function (x) { return x(message.data); });
+            };
+            source.addEventListener('keep-alive', function () {
+                noteServerEvent();
             });
-        };
-        return createConnectionPromise();
+            source.onerror = function (e) {
+                console.error('Live Query Event Source Error', e);
+                source.close();
+                if (closed)
+                    return;
+                scheduleReconnect();
+            };
+            source.addEventListener('connectionId', function (e) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                var _a, _b, channel, e_1_1;
+                var e_1, _c;
+                return tslib_1.__generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0:
+                            //@ts-ignore
+                            connectionId = e.data;
+                            retryCount = 0;
+                            noteServerEvent();
+                            if (!connected) return [3 /*break*/, 9];
+                            _d.label = 1;
+                        case 1:
+                            _d.trys.push([1, 6, 7, 8]);
+                            _a = tslib_1.__values(channels.keys()), _b = _a.next();
+                            _d.label = 2;
+                        case 2:
+                            if (!!_b.done) return [3 /*break*/, 5];
+                            channel = _b.value;
+                            return [4 /*yield*/, subscribeToChannel(channel)];
+                        case 3:
+                            _d.sent();
+                            _d.label = 4;
+                        case 4:
+                            _b = _a.next();
+                            return [3 /*break*/, 2];
+                        case 5: return [3 /*break*/, 8];
+                        case 6:
+                            e_1_1 = _d.sent();
+                            e_1 = { error: e_1_1 };
+                            return [3 /*break*/, 8];
+                        case 7:
+                            try {
+                                if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                            return [7 /*endfinally*/];
+                        case 8:
+                            onReconnect();
+                            return [3 /*break*/, 10];
+                        case 9:
+                            connected = true;
+                            connectionReady();
+                            _d.label = 10;
+                        case 10: return [2 /*return*/];
+                    }
+                });
+            }); });
+        }
+        createConnection();
+        return Promise.resolve(client);
         function subscribeToChannel(channel) {
             return tslib_1.__awaiter(this, void 0, void 0, function () {
                 var result;
@@ -139,12 +190,21 @@ var SseSubscriptionClient = /** @class */ (function () {
                             })];
                         case 1:
                             result = _a.sent();
-                            if (!(result === exports.ConnectionNotFoundError)) return [3 /*break*/, 3];
-                            return [4 /*yield*/, createConnectionPromise()];
+                            if (!(result === exports.ConnectionNotFoundError)) return [3 /*break*/, 4];
+                            connected = false;
+                            connectionPromise = new Promise(function (res) {
+                                connectionReady = res;
+                            });
+                            createConnection();
+                            return [4 /*yield*/, connectionPromise];
                         case 2:
                             _a.sent();
-                            _a.label = 3;
-                        case 3: return [2 /*return*/];
+                            if (!!closed) return [3 /*break*/, 4];
+                            return [4 /*yield*/, subscribeToChannel(channel)];
+                        case 3:
+                            _a.sent();
+                            _a.label = 4;
+                        case 4: return [2 /*return*/];
                     }
                 });
             });

package/src/live-query/SubscriptionChannel.d.ts

@@ -9,6 +9,10 @@ export type Unsubscribe = VoidFunction;
 export interface SubscriptionClientConnection {
     subscribe(channel: string, onMessage: (message: any) => void, onError: (err: any) => void): Promise<Unsubscribe>;
     close(): void;
+    /** SSE clients set this; missing means no heartbeat tracking (Ably, tests). */
+    lastServerEvent?: number;
+    /** Foreground / online: reconnect now, skip backoff. `force` kills an OPEN zombie. */
+    resume?: (force?: boolean) => void;
 }
 export interface SubscriptionClient {
     openConnection(onReconnect: VoidFunction): Promise<SubscriptionClientConnection>;
@@ -31,6 +35,10 @@ export declare type LiveQueryChange = {
     data: {
         id: any;
     };
+} | {
+    type: 'version';
+    from: number;
+    to: number;
 };
 /**
  * The `SubscriptionChannel` class is used to send messages from the backend to the frontend,

package/src/live-query/SubscriptionChannel.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionChannel = exports.liveQueryKeepAliveRoute = exports.LiveQuerySubscriber = exports.streamUrl = void 0;
+exports.onBrowserForeground = onBrowserForeground;
 var tslib_1 = require("tslib");
 var sort_js_1 = require("../sort.js");
 var remult_proxy_js_1 = require("../remult-proxy.js");
@@ -12,9 +13,12 @@ var LiveQuerySubscriber = /** @class */ (function () {
         this.repo = repo;
         this.query = query;
         this.unsubscribe = function () { };
+        this.unsubscribeChannel = function () { };
+        this.unsubscribeQuery = function () { };
         this.defaultQueryState = [];
         this.listeners = [];
         this.id = String(crypto.randomUUID());
+        this.version = 0;
         this.queryChannel = "users:".concat(userId, ":queries:").concat(this.id);
         this.id = this.queryChannel;
     }
@@ -35,6 +39,7 @@ var LiveQuerySubscriber = /** @class */ (function () {
                                 return items;
                             });
                         }, this.allItemsMessage(items));
+                        this.version = 0;
                         return [2 /*return*/];
                 }
             });
@@ -88,18 +93,32 @@ var LiveQuerySubscriber = /** @class */ (function () {
     };
     LiveQuerySubscriber.prototype.handle = function (messages) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var x, loadedItems, index, element;
+            var ver, data, x, loadedItems, index, element;
             var _this = this;
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
+            var _a;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        x = messages.filter(function (_a) {
+                        ver = messages.find(function (m) {
+                            return m.type === 'version';
+                        });
+                        if (ver) {
+                            if (ver.from < this.version)
+                                return [2 /*return*/];
+                            if (ver.from > this.version) {
+                                this.version = ver.to;
+                                (_a = this.subscribeCode) === null || _a === void 0 ? void 0 : _a.call(this);
+                                return [2 /*return*/];
+                            }
+                        }
+                        data = messages.filter(function (m) { return m.type !== 'version'; });
+                        x = data.filter(function (_a) {
                             var type = _a.type;
                             return type == 'add' || type == 'replace';
                         });
                         return [4 /*yield*/, (0, repository_internals_js_1.getRepositoryInternals)(this.repo)._fromJsonArray(x.map(function (m) { return m.data.item; }), this.query.options)];
                     case 1:
-                        loadedItems = _a.sent();
+                        loadedItems = _b.sent();
                         for (index = 0; index < x.length; index++) {
                             element = x[index];
                             element.data.item = loadedItems[index];
@@ -137,21 +156,22 @@ var LiveQuerySubscriber = /** @class */ (function () {
                                     }
                                 };
                                 try {
-                                    for (var messages_1 = tslib_1.__values(messages), messages_1_1 = messages_1.next(); !messages_1_1.done; messages_1_1 = messages_1.next()) {
-                                        var message = messages_1_1.value;
+                                    for (var data_1 = tslib_1.__values(data), data_1_1 = data_1.next(); !data_1_1.done; data_1_1 = data_1.next()) {
+                                        var message = data_1_1.value;
                                         _loop_2(message);
                                     }
                                 }
                                 catch (e_2_1) { e_2 = { error: e_2_1 }; }
                                 finally {
                                     try {
-                                        if (messages_1_1 && !messages_1_1.done && (_a = messages_1.return)) _a.call(messages_1);
+                                        if (data_1_1 && !data_1_1.done && (_a = data_1.return)) _a.call(data_1);
                                     }
                                     finally { if (e_2) throw e_2.error; }
                                 }
                                 return items;
                             });
-                        }, messages);
+                        }, data);
+                        this.version = ver ? ver.to : this.version + (data.length > 0 ? 1 : 0);
                         return [2 /*return*/];
                 }
             });
@@ -160,6 +180,24 @@ var LiveQuerySubscriber = /** @class */ (function () {
     return LiveQuerySubscriber;
 }());
 exports.LiveQuerySubscriber = LiveQuerySubscriber;
+//@internal
+function onBrowserForeground(handler) {
+    if (typeof document === 'undefined')
+        return function () { };
+    function onForeground() {
+        if (document.visibilityState === 'hidden')
+            return;
+        handler();
+    }
+    document.addEventListener('visibilitychange', onForeground);
+    window.addEventListener('online', onForeground);
+    window.addEventListener('pageshow', onForeground);
+    return function () {
+        document.removeEventListener('visibilitychange', onForeground);
+        window.removeEventListener('online', onForeground);
+        window.removeEventListener('pageshow', onForeground);
+    };
+}
 exports.liveQueryKeepAliveRoute = '_liveQueryKeepAlive';
 /**
  * The `SubscriptionChannel` class is used to send messages from the backend to the frontend,

package/src/live-query/SubscriptionServer.d.ts

@@ -8,12 +8,16 @@ export interface LiveQueryStorage {
         query: StoredQuery;
         setData(data: any): Promise<void>;
     }) => Promise<void>): Promise<void>;
-    keepAliveAndReturnUnknownQueryIds(queryIds: string[]): Promise<string[]>;
+    keepAliveAndReturnUnknownQueryIds(queryIds: string[]): Promise<LiveQueryKeepAliveResult>;
 }
+export type LiveQueryKeepAliveResult = {
+    unknownQueryIds: string[];
+    versions: Record<string, number>;
+};
 export declare class InMemoryLiveQueryStorage implements LiveQueryStorage {
     debugFileSaver: (x: any) => void;
     debug(): void;
-    keepAliveAndReturnUnknownQueryIds(ids: string[]): Promise<string[]>;
+    keepAliveAndReturnUnknownQueryIds(ids: string[]): Promise<LiveQueryKeepAliveResult>;
     queries: (StoredQuery & {
         lastUsed: string;
     })[];
@@ -35,4 +39,5 @@ export interface QueryData {
     findOptionsJson: any;
     requestJson: any;
     lastIds: any[];
+    version?: number;
 }

package/src/live-query/SubscriptionServer.js

@@ -26,15 +26,16 @@ var LiveQueryPublisher = /** @class */ (function () {
                                     case 0:
                                         query = tslib_1.__assign({}, q.data);
                                         return [4 /*yield*/, this.performWithContext(query.requestJson, entityKey, function (repo) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                                                var messages, currentItems, currentIds, _loop_1, _a, _b, id, _loop_2, currentItems_1, currentItems_1_1, item;
+                                                var messages, currentItems, currentIds, _loop_1, _a, _b, id, _loop_2, currentItems_1, currentItems_1_1, item, from;
                                                 var e_1, _c, e_2, _d;
-                                                return tslib_1.__generator(this, function (_e) {
-                                                    switch (_e.label) {
+                                                var _e;
+                                                return tslib_1.__generator(this, function (_f) {
+                                                    switch (_f.label) {
                                                         case 0:
                                                             messages = [];
                                                             return [4 /*yield*/, repo.find((0, rest_data_provider_js_1.findOptionsFromJson)(query.findOptionsJson, repo.metadata))];
                                                         case 1:
-                                                            currentItems = _e.sent();
+                                                            currentItems = _f.sent();
                                                             currentIds = currentItems.map(function (x) {
                                                                 return repo.getEntityRef(x).getId();
                                                             });
@@ -103,9 +104,14 @@ var LiveQueryPublisher = /** @class */ (function () {
                                                                 messages: messages,
                                                             });
                                                             query.lastIds = currentIds;
+                                                            if (messages.length > 0) {
+                                                                from = (_e = query.version) !== null && _e !== void 0 ? _e : 0;
+                                                                query.version = from + 1;
+                                                                messages.push({ type: 'version', from: from, to: query.version });
+                                                            }
                                                             return [4 /*yield*/, setData(query)];
                                                         case 2:
-                                                            _e.sent();
+                                                            _f.sent();
                                                             if (messages.length > 0)
                                                                 this.subscriptionServer().publishMessage(q.id, messages);
                                                             return [2 /*return*/];
@@ -139,17 +145,20 @@ var InMemoryLiveQueryStorage = /** @class */ (function () {
     };
     InMemoryLiveQueryStorage.prototype.keepAliveAndReturnUnknownQueryIds = function (ids) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var result, _loop_3, this_1, ids_1, ids_1_1, id;
+            var unknownQueryIds, versions, _loop_3, this_1, ids_1, ids_1_1, id;
             var e_3, _a;
-            return tslib_1.__generator(this, function (_b) {
-                result = [];
+            var _b, _c;
+            return tslib_1.__generator(this, function (_d) {
+                unknownQueryIds = [];
+                versions = {};
                 _loop_3 = function (id) {
                     var q = this_1.queries.find(function (q) { return q.id === id; });
                     if (q) {
                         q.lastUsed = new Date().toISOString();
+                        versions[id] = (_c = (_b = q.data) === null || _b === void 0 ? void 0 : _b.version) !== null && _c !== void 0 ? _c : 0;
                     }
                     else
-                        result.push(id);
+                        unknownQueryIds.push(id);
                 };
                 this_1 = this;
                 try {
@@ -166,13 +175,14 @@ var InMemoryLiveQueryStorage = /** @class */ (function () {
                     finally { if (e_3) throw e_3.error; }
                 }
                 this.debug();
-                return [2 /*return*/, result];
+                return [2 /*return*/, { unknownQueryIds: unknownQueryIds, versions: versions }];
             });
         });
     };
     InMemoryLiveQueryStorage.prototype.add = function (query) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
+                this.queries = this.queries.filter(function (q) { return q.id !== query.id; });
                 this.queries.push(tslib_1.__assign(tslib_1.__assign({}, query), { lastUsed: new Date().toISOString() }));
                 this.debug();
                 return [2 /*return*/];

package/src/remult3/remult3.d.ts

@@ -1220,4 +1220,10 @@ export type ClassFieldDecorator<entityType, valueType> = ((target: any, context:
 };
 export declare const flags: {
     error500RetryCount: number;
+    /** Client treats SSE as dead if no event for this long */
+    sseStaleMs: number;
+    /** HTTP keep-alive while SSE is healthy (touches lastUsed) */
+    liveQueryKeepAliveMs: number;
+    /** Version poll while SSE is stale */
+    liveQueryPollWhenStaleMs: number;
 };

package/src/remult3/remult3.js

@@ -19,6 +19,12 @@ var wnn = [
 ];
 exports.flags = {
     error500RetryCount: 4,
+    /** Client treats SSE as dead if no event for this long */
+    sseStaleMs: 20000,
+    /** HTTP keep-alive while SSE is healthy (touches lastUsed) */
+    liveQueryKeepAliveMs: 30000,
+    /** Version poll while SSE is stale */
+    liveQueryPollWhenStaleMs: 1000,
 };
 /*p1 - issues in https://stackblitz.com/edit/demo-allow-delete-based-on-other-entity:
   - don't like the ensure schema