@cloudbase/database 0.9.17-beta → 0.9.19

package/dist/esm/realtime/virtual-websocket-client.js

@@ -1,988 +1,733 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-var __spread = (this && this.__spread) || function () {
-    for (var ar = [], i = 0; i < arguments.length; i++) ar = ar.concat(__read(arguments[i]));
-    return ar;
-};
-import set from 'lodash.set';
-import unset from 'lodash.unset';
-import cloneDeep from 'lodash.clonedeep';
-import { genRequestId } from './message';
-import { CloudSDKError, isTimeoutError, CancelledError, isCancelledError } from '../utils/error';
-import { ERR_CODE } from '../config/error.config';
-import { sleep } from '../utils/utils';
-import { RealtimeListener } from './listener';
-import { Snapshot } from './snapshot';
-import { isRealtimeErrorMessageError } from './error';
-var WATCH_STATUS;
-(function (WATCH_STATUS) {
-    WATCH_STATUS["LOGGINGIN"] = "LOGGINGIN";
-    WATCH_STATUS["INITING"] = "INITING";
-    WATCH_STATUS["REBUILDING"] = "REBUILDING";
-    WATCH_STATUS["ACTIVE"] = "ACTIVE";
-    WATCH_STATUS["ERRORED"] = "ERRORED";
-    WATCH_STATUS["CLOSING"] = "CLOSING";
-    WATCH_STATUS["CLOSED"] = "CLOSED";
-    WATCH_STATUS["PAUSED"] = "PAUSED";
-    WATCH_STATUS["RESUMING"] = "RESUMING";
-})(WATCH_STATUS || (WATCH_STATUS = {}));
-var DEFAULT_WAIT_TIME_ON_UNKNOWN_ERROR = 100;
-var DEFAULT_MAX_AUTO_RETRY_ON_ERROR = 2;
-var DEFAULT_MAX_SEND_ACK_AUTO_RETRY_ON_ERROR = 2;
-var DEFAULT_SEND_ACK_DEBOUNCE_TIMEOUT = 10 * 1000;
-var DEFAULT_INIT_WATCH_TIMEOUT = 10 * 1000;
-var DEFAULT_REBUILD_WATCH_TIMEOUT = 10 * 1000;
-var VirtualWebSocketClient = (function () {
-    function VirtualWebSocketClient(options) {
-        var _this = this;
-        this.watchStatus = WATCH_STATUS.INITING;
-        this._login = function (envId, refresh) { return __awaiter(_this, void 0, void 0, function () {
-            var loginResult;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        this.watchStatus = WATCH_STATUS.LOGGINGIN;
-                        return [4, this.login(envId, refresh)];
-                    case 1:
-                        loginResult = _a.sent();
-                        if (!this.envId) {
-                            this.envId = loginResult.envId;
-                        }
-                        return [2, loginResult];
-                }
-            });
-        }); };
-        this.initWatch = function (forceRefreshLogin) { return __awaiter(_this, void 0, void 0, function () {
-            var success;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this._initWatchPromise) {
-                            return [2, this._initWatchPromise];
-                        }
-                        this._initWatchPromise = new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-                            var envId, initWatchMsg, initEventMsg, _a, events, currEvent, events_1, events_1_1, e, snapshot, e_1;
-                            var e_2, _b;
-                            return __generator(this, function (_c) {
-                                switch (_c.label) {
-                                    case 0:
-                                        _c.trys.push([0, 3, , 4]);
-                                        if (this.watchStatus === WATCH_STATUS.PAUSED) {
-                                            console.log('[realtime] initWatch cancelled on pause');
-                                            return [2, resolve()];
-                                        }
-                                        return [4, this._login(this.envId, forceRefreshLogin)];
-                                    case 1:
-                                        envId = (_c.sent()).envId;
-                                        if (this.watchStatus === WATCH_STATUS.PAUSED) {
-                                            console.log('[realtime] initWatch cancelled on pause');
-                                            return [2, resolve()];
-                                        }
-                                        this.watchStatus = WATCH_STATUS.INITING;
-                                        initWatchMsg = {
-                                            watchId: this.watchId,
-                                            requestId: genRequestId(),
-                                            msgType: 'INIT_WATCH',
-                                            msgData: {
-                                                envId: envId,
-                                                collName: this.collectionName,
-                                                query: this.query,
-                                                limit: this.limit,
-                                                orderBy: this.orderBy
-                                            }
-                                        };
-                                        return [4, this.send({
-                                                msg: initWatchMsg,
-                                                waitResponse: true,
-                                                skipOnMessage: true,
-                                                timeout: DEFAULT_INIT_WATCH_TIMEOUT
-                                            })];
-                                    case 2:
-                                        initEventMsg = _c.sent();
-                                        _a = initEventMsg.msgData, events = _a.events, currEvent = _a.currEvent;
-                                        this.sessionInfo = {
-                                            queryID: initEventMsg.msgData.queryID,
-                                            currentEventId: currEvent - 1,
-                                            currentDocs: []
-                                        };
-                                        if (events.length > 0) {
-                                            try {
-                                                for (events_1 = __values(events), events_1_1 = events_1.next(); !events_1_1.done; events_1_1 = events_1.next()) {
-                                                    e = events_1_1.value;
-                                                    e.ID = currEvent;
-                                                }
-                                            }
-                                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                                            finally {
-                                                try {
-                                                    if (events_1_1 && !events_1_1.done && (_b = events_1.return)) _b.call(events_1);
-                                                }
-                                                finally { if (e_2) throw e_2.error; }
-                                            }
-                                            this.handleServerEvents(initEventMsg);
-                                        }
-                                        else {
-                                            this.sessionInfo.currentEventId = currEvent;
-                                            snapshot = new Snapshot({
-                                                id: currEvent,
-                                                docChanges: [],
-                                                docs: [],
-                                                type: 'init'
-                                            });
-                                            this.listener.onChange(snapshot);
-                                            this.scheduleSendACK();
-                                        }
-                                        this.onWatchStart(this, this.sessionInfo.queryID);
-                                        this.watchStatus = WATCH_STATUS.ACTIVE;
-                                        this._availableRetries.INIT_WATCH = DEFAULT_MAX_AUTO_RETRY_ON_ERROR;
-                                        resolve();
-                                        return [3, 4];
-                                    case 3:
-                                        e_1 = _c.sent();
-                                        this.handleWatchEstablishmentError(e_1, {
-                                            operationName: 'INIT_WATCH',
-                                            resolve: resolve,
-                                            reject: reject
-                                        });
-                                        return [3, 4];
-                                    case 4: return [2];
-                                }
-                            });
-                        }); });
-                        success = false;
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, , 3, 4]);
-                        return [4, this._initWatchPromise];
-                    case 2:
-                        _a.sent();
-                        success = true;
-                        return [3, 4];
-                    case 3:
-                        this._initWatchPromise = undefined;
-                        return [7];
-                    case 4:
-                        console.log("[realtime] initWatch " + (success ? 'success' : 'fail'));
-                        return [2];
-                }
-            });
-        }); };
-        this.rebuildWatch = function (forceRefreshLogin) { return __awaiter(_this, void 0, void 0, function () {
-            var success;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this._rebuildWatchPromise) {
-                            return [2, this._rebuildWatchPromise];
-                        }
-                        this._rebuildWatchPromise = new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-                            var envId, rebuildWatchMsg, nextEventMsg, e_3;
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0:
-                                        _a.trys.push([0, 3, , 4]);
-                                        if (this.watchStatus === WATCH_STATUS.PAUSED) {
-                                            console.log('[realtime] rebuildWatch cancelled on pause');
-                                            return [2, resolve()];
-                                        }
-                                        return [4, this._login(this.envId, forceRefreshLogin)];
-                                    case 1:
-                                        envId = (_a.sent()).envId;
-                                        if (!this.sessionInfo) {
-                                            throw new Error('can not rebuildWatch without a successful initWatch (lack of sessionInfo)');
-                                        }
-                                        if (this.watchStatus === WATCH_STATUS.PAUSED) {
-                                            console.log('[realtime] rebuildWatch cancelled on pause');
-                                            return [2, resolve()];
-                                        }
-                                        this.watchStatus = WATCH_STATUS.REBUILDING;
-                                        rebuildWatchMsg = {
-                                            watchId: this.watchId,
-                                            requestId: genRequestId(),
-                                            msgType: 'REBUILD_WATCH',
-                                            msgData: {
-                                                envId: envId,
-                                                collName: this.collectionName,
-                                                queryID: this.sessionInfo.queryID,
-                                                eventID: this.sessionInfo.currentEventId
-                                            }
-                                        };
-                                        return [4, this.send({
-                                                msg: rebuildWatchMsg,
-                                                waitResponse: true,
-                                                skipOnMessage: false,
-                                                timeout: DEFAULT_REBUILD_WATCH_TIMEOUT
-                                            })];
-                                    case 2:
-                                        nextEventMsg = _a.sent();
-                                        this.handleServerEvents(nextEventMsg);
-                                        this.watchStatus = WATCH_STATUS.ACTIVE;
-                                        this._availableRetries.REBUILD_WATCH = DEFAULT_MAX_AUTO_RETRY_ON_ERROR;
-                                        resolve();
-                                        return [3, 4];
-                                    case 3:
-                                        e_3 = _a.sent();
-                                        this.handleWatchEstablishmentError(e_3, {
-                                            operationName: 'REBUILD_WATCH',
-                                            resolve: resolve,
-                                            reject: reject
-                                        });
-                                        return [3, 4];
-                                    case 4: return [2];
-                                }
-                            });
-                        }); });
-                        success = false;
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, , 3, 4]);
-                        return [4, this._rebuildWatchPromise];
-                    case 2:
-                        _a.sent();
-                        success = true;
-                        return [3, 4];
-                    case 3:
-                        this._rebuildWatchPromise = undefined;
-                        return [7];
-                    case 4:
-                        console.log("[realtime] rebuildWatch " + (success ? 'success' : 'fail'));
-                        return [2];
-                }
-            });
-        }); };
-        this.handleWatchEstablishmentError = function (e, options) { return __awaiter(_this, void 0, void 0, function () {
-            var isInitWatch, abortWatch, retry;
-            var _this = this;
-            return __generator(this, function (_a) {
-                isInitWatch = options.operationName === 'INIT_WATCH';
-                abortWatch = function () {
-                    _this.closeWithError(new CloudSDKError({
-                        errCode: isInitWatch
-                            ? ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_INIT_WATCH_FAIL
-                            : ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_REBUILD_WATCH_FAIL,
-                        errMsg: e
-                    }));
-                    options.reject(e);
-                };
-                retry = function (refreshLogin) {
-                    if (_this.useRetryTicket(options.operationName)) {
-                        if (isInitWatch) {
-                            _this._initWatchPromise = undefined;
-                            options.resolve(_this.initWatch(refreshLogin));
-                        }
-                        else {
-                            _this._rebuildWatchPromise = undefined;
-                            options.resolve(_this.rebuildWatch(refreshLogin));
-                        }
-                    }
-                    else {
-                        abortWatch();
-                    }
-                };
-                this.handleCommonError(e, {
-                    onSignError: function () { return retry(true); },
-                    onTimeoutError: function () { return retry(false); },
-                    onNotRetryableError: abortWatch,
-                    onCancelledError: options.reject,
-                    onUnknownError: function () { return __awaiter(_this, void 0, void 0, function () {
-                        var onWSDisconnected, e_4;
-                        var _this = this;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    _a.trys.push([0, 8, , 9]);
-                                    onWSDisconnected = function () { return __awaiter(_this, void 0, void 0, function () {
-                                        return __generator(this, function (_a) {
-                                            switch (_a.label) {
-                                                case 0:
-                                                    this.pause();
-                                                    return [4, this.onceWSConnected()];
-                                                case 1:
-                                                    _a.sent();
-                                                    retry(true);
-                                                    return [2];
-                                            }
-                                        });
-                                    }); };
-                                    if (!!this.isWSConnected()) return [3, 2];
-                                    return [4, onWSDisconnected()];
-                                case 1:
-                                    _a.sent();
-                                    return [3, 7];
-                                case 2: return [4, sleep(DEFAULT_WAIT_TIME_ON_UNKNOWN_ERROR)];
-                                case 3:
-                                    _a.sent();
-                                    if (!(this.watchStatus === WATCH_STATUS.PAUSED)) return [3, 4];
-                                    options.reject(new CancelledError(options.operationName + " cancelled due to pause after unknownError"));
-                                    return [3, 7];
-                                case 4:
-                                    if (!!this.isWSConnected()) return [3, 6];
-                                    return [4, onWSDisconnected()];
-                                case 5:
-                                    _a.sent();
-                                    return [3, 7];
-                                case 6:
-                                    retry(false);
-                                    _a.label = 7;
-                                case 7: return [3, 9];
-                                case 8:
-                                    e_4 = _a.sent();
-                                    retry(true);
-                                    return [3, 9];
-                                case 9: return [2];
-                            }
-                        });
-                    }); }
-                });
-                return [2];
-            });
-        }); };
-        this.closeWatch = function () { return __awaiter(_this, void 0, void 0, function () {
-            var queryId, closeWatchMsg, e_5;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        queryId = this.sessionInfo ? this.sessionInfo.queryID : '';
-                        if (this.watchStatus !== WATCH_STATUS.ACTIVE) {
-                            this.watchStatus = WATCH_STATUS.CLOSED;
-                            this.onWatchClose(this, queryId);
-                            return [2];
-                        }
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, 4, 5]);
-                        this.watchStatus = WATCH_STATUS.CLOSING;
-                        closeWatchMsg = {
-                            watchId: this.watchId,
-                            requestId: genRequestId(),
-                            msgType: 'CLOSE_WATCH',
-                            msgData: null
-                        };
-                        return [4, this.send({
-                                msg: closeWatchMsg
-                            })];
-                    case 2:
-                        _a.sent();
-                        this.sessionInfo = undefined;
-                        this.watchStatus = WATCH_STATUS.CLOSED;
-                        return [3, 5];
-                    case 3:
-                        e_5 = _a.sent();
-                        this.closeWithError(new CloudSDKError({
-                            errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CLOSE_WATCH_FAIL,
-                            errMsg: e_5
-                        }));
-                        return [3, 5];
-                    case 4:
-                        this.onWatchClose(this, queryId);
-                        return [7];
-                    case 5: return [2];
-                }
-            });
-        }); };
-        this.scheduleSendACK = function () {
-            _this.clearACKSchedule();
-            _this._ackTimeoutId = setTimeout(function () {
-                if (_this._waitExpectedTimeoutId) {
-                    _this.scheduleSendACK();
-                }
-                else {
-                    _this.sendACK();
-                }
-            }, DEFAULT_SEND_ACK_DEBOUNCE_TIMEOUT);
-        };
-        this.clearACKSchedule = function () {
-            if (_this._ackTimeoutId) {
-                clearTimeout(_this._ackTimeoutId);
-            }
-        };
-        this.sendACK = function () { return __awaiter(_this, void 0, void 0, function () {
-            var ackMsg, e_6, msg;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        if (this.watchStatus !== WATCH_STATUS.ACTIVE) {
-                            this.scheduleSendACK();
-                            return [2];
-                        }
-                        if (!this.sessionInfo) {
-                            console.warn('[realtime listener] can not send ack without a successful initWatch (lack of sessionInfo)');
-                            return [2];
-                        }
-                        ackMsg = {
-                            watchId: this.watchId,
-                            requestId: genRequestId(),
-                            msgType: 'CHECK_LAST',
-                            msgData: {
-                                queryID: this.sessionInfo.queryID,
-                                eventID: this.sessionInfo.currentEventId
-                            }
-                        };
-                        return [4, this.send({
-                                msg: ackMsg
-                            })];
-                    case 1:
-                        _a.sent();
-                        this.scheduleSendACK();
-                        return [3, 3];
-                    case 2:
-                        e_6 = _a.sent();
-                        if (isRealtimeErrorMessageError(e_6)) {
-                            msg = e_6.payload;
-                            switch (msg.msgData.code) {
-                                case 'CHECK_LOGIN_FAILED':
-                                case 'SIGN_EXPIRED_ERROR':
-                                case 'SIGN_INVALID_ERROR':
-                                case 'SIGN_PARAM_INVALID': {
-                                    this.rebuildWatch();
-                                    return [2];
-                                }
-                                case 'QUERYID_INVALID_ERROR':
-                                case 'SYS_ERR':
-                                case 'INVALIID_ENV':
-                                case 'COLLECTION_PERMISSION_DENIED': {
-                                    this.closeWithError(new CloudSDKError({
-                                        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CHECK_LAST_FAIL,
-                                        errMsg: msg.msgData.code
-                                    }));
-                                    return [2];
-                                }
-                                default: {
-                                    break;
-                                }
-                            }
-                        }
-                        if (this._availableRetries.CHECK_LAST &&
-                            this._availableRetries.CHECK_LAST > 0) {
-                            this._availableRetries.CHECK_LAST--;
-                            this.scheduleSendACK();
-                        }
-                        else {
-                            this.closeWithError(new CloudSDKError({
-                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CHECK_LAST_FAIL,
-                                errMsg: e_6
-                            }));
-                        }
-                        return [3, 3];
-                    case 3: return [2];
-                }
-            });
-        }); };
-        this.handleCommonError = function (e, options) {
-            if (isRealtimeErrorMessageError(e)) {
-                var msg = e.payload;
-                switch (msg.msgData.code) {
-                    case 'CHECK_LOGIN_FAILED':
-                    case 'SIGN_EXPIRED_ERROR':
-                    case 'SIGN_INVALID_ERROR':
-                    case 'SIGN_PARAM_INVALID': {
-                        options.onSignError(e);
-                        return;
-                    }
-                    case 'QUERYID_INVALID_ERROR':
-                    case 'SYS_ERR':
-                    case 'INVALIID_ENV':
-                    case 'COLLECTION_PERMISSION_DENIED': {
-                        options.onNotRetryableError(e);
-                        return;
-                    }
-                    default: {
-                        options.onNotRetryableError(e);
-                        return;
-                    }
-                }
-            }
-            else if (isTimeoutError(e)) {
-                options.onTimeoutError(e);
-                return;
-            }
-            else if (isCancelledError(e)) {
-                options.onCancelledError(e);
-                return;
-            }
-            options.onUnknownError(e);
-        };
-        this.watchId = "watchid_" + +new Date() + "_" + Math.random();
-        this.envId = options.envId;
-        this.collectionName = options.collectionName;
-        this.query = options.query;
-        this.limit = options.limit;
-        this.orderBy = options.orderBy;
-        this.send = options.send;
-        this.login = options.login;
-        this.isWSConnected = options.isWSConnected;
-        this.onceWSConnected = options.onceWSConnected;
-        this.getWaitExpectedTimeoutLength = options.getWaitExpectedTimeoutLength;
-        this.onWatchStart = options.onWatchStart;
-        this.onWatchClose = options.onWatchClose;
-        this.debug = options.debug;
-        this._availableRetries = {
-            INIT_WATCH: DEFAULT_MAX_AUTO_RETRY_ON_ERROR,
-            REBUILD_WATCH: DEFAULT_MAX_AUTO_RETRY_ON_ERROR,
-            CHECK_LAST: DEFAULT_MAX_SEND_ACK_AUTO_RETRY_ON_ERROR
-        };
-        this.listener = new RealtimeListener({
-            close: this.closeWatch,
-            onChange: options.onChange,
-            onError: options.onError,
-            debug: this.debug,
-            virtualClient: this
-        });
-        this.initWatch();
-    }
-    VirtualWebSocketClient.prototype.useRetryTicket = function (operationName) {
-        if (this._availableRetries[operationName] &&
-            this._availableRetries[operationName] > 0) {
-            this._availableRetries[operationName]--;
-            console.log("[realtime] " + operationName + " use a retry ticket, now only " + this._availableRetries[operationName] + " retry left");
-            return true;
-        }
-        return false;
-    };
-    VirtualWebSocketClient.prototype.handleServerEvents = function (msg) {
-        return __awaiter(this, void 0, void 0, function () {
-            var e_7;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        this.scheduleSendACK();
-                        return [4, this._handleServerEvents(msg)];
-                    case 1:
-                        _a.sent();
-                        this._postHandleServerEventsValidityCheck(msg);
-                        return [3, 3];
-                    case 2:
-                        e_7 = _a.sent();
-                        console.error('[realtime listener] internal non-fatal error: handle server events failed with error: ', e_7);
-                        throw e_7;
-                    case 3: return [2];
-                }
-            });
-        });
-    };
-    VirtualWebSocketClient.prototype._handleServerEvents = function (msg) {
-        return __awaiter(this, void 0, void 0, function () {
-            var requestId, events, msgType, sessionInfo, allChangeEvents, docs, initEncountered, _loop_1, this_1, i, len, state_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        requestId = msg.requestId;
-                        events = msg.msgData.events;
-                        msgType = msg.msgType;
-                        if (!events.length || !this.sessionInfo) {
-                            return [2];
-                        }
-                        sessionInfo = this.sessionInfo;
-                        try {
-                            allChangeEvents = events.map(getPublicEvent);
-                        }
-                        catch (e) {
-                            this.closeWithError(new CloudSDKError({
-                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_RECEIVE_INVALID_SERVER_DATA,
-                                errMsg: e
-                            }));
-                            return [2];
-                        }
-                        docs = __spread(sessionInfo.currentDocs);
-                        initEncountered = false;
-                        _loop_1 = function (i, len) {
-                            var change, localDoc, doc, fieldPath, _a, _b, fieldPath, err, err, doc, doc, err, ind, ind, docsSnapshot, docChanges, snapshot;
-                            var e_8, _c;
-                            return __generator(this, function (_d) {
-                                switch (_d.label) {
-                                    case 0:
-                                        change = allChangeEvents[i];
-                                        if (!(sessionInfo.currentEventId >= change.id)) return [3, 1];
-                                        if (!allChangeEvents[i - 1] || change.id > allChangeEvents[i - 1].id) {
-                                            console.warn("[realtime] duplicate event received, cur " + sessionInfo.currentEventId + " but got " + change.id);
-                                        }
-                                        else {
-                                            console.error("[realtime listener] server non-fatal error: events out of order (the latter event's id is smaller than that of the former) (requestId " + requestId + ")");
-                                        }
-                                        return [2, "continue"];
-                                    case 1:
-                                        if (!(sessionInfo.currentEventId === change.id - 1)) return [3, 2];
-                                        switch (change.dataType) {
-                                            case 'update': {
-                                                if (!change.doc) {
-                                                    switch (change.queueType) {
-                                                        case 'update':
-                                                        case 'dequeue': {
-                                                            localDoc = docs.find(function (doc) { return doc._id === change.docId; });
-                                                            if (localDoc) {
-                                                                doc = cloneDeep(localDoc);
-                                                                if (change.updatedFields) {
-                                                                    for (fieldPath in change.updatedFields) {
-                                                                        set(doc, fieldPath, change.updatedFields[fieldPath]);
-                                                                    }
-                                                                }
-                                                                if (change.removedFields) {
-                                                                    try {
-                                                                        for (_a = (e_8 = void 0, __values(change.removedFields)), _b = _a.next(); !_b.done; _b = _a.next()) {
-                                                                            fieldPath = _b.value;
-                                                                            unset(doc, fieldPath);
-                                                                        }
-                                                                    }
-                                                                    catch (e_8_1) { e_8 = { error: e_8_1 }; }
-                                                                    finally {
-                                                                        try {
-                                                                            if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
-                                                                        }
-                                                                        finally { if (e_8) throw e_8.error; }
-                                                                    }
-                                                                }
-                                                                change.doc = doc;
-                                                            }
-                                                            else {
-                                                                console.error('[realtime listener] internal non-fatal server error: unexpected update dataType event where no doc is associated.');
-                                                            }
-                                                            break;
-                                                        }
-                                                        case 'enqueue': {
-                                                            err = new CloudSDKError({
-                                                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
-                                                                errMsg: "HandleServerEvents: full doc is not provided with dataType=\"update\" and queueType=\"enqueue\" (requestId " + msg.requestId + ")"
-                                                            });
-                                                            this_1.closeWithError(err);
-                                                            throw err;
-                                                        }
-                                                        default: {
-                                                            break;
-                                                        }
-                                                    }
-                                                }
-                                                break;
-                                            }
-                                            case 'replace': {
-                                                if (!change.doc) {
-                                                    err = new CloudSDKError({
-                                                        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
-                                                        errMsg: "HandleServerEvents: full doc is not provided with dataType=\"replace\" (requestId " + msg.requestId + ")"
-                                                    });
-                                                    this_1.closeWithError(err);
-                                                    throw err;
-                                                }
-                                                break;
-                                            }
-                                            case 'remove': {
-                                                doc = docs.find(function (doc) { return doc._id === change.docId; });
-                                                if (doc) {
-                                                    change.doc = doc;
-                                                }
-                                                else {
-                                                    console.error('[realtime listener] internal non-fatal server error: unexpected remove event where no doc is associated.');
-                                                }
-                                                break;
-                                            }
-                                            case 'limit': {
-                                                if (!change.doc) {
-                                                    switch (change.queueType) {
-                                                        case 'dequeue': {
-                                                            doc = docs.find(function (doc) { return doc._id === change.docId; });
-                                                            if (doc) {
-                                                                change.doc = doc;
-                                                            }
-                                                            else {
-                                                                console.error('[realtime listener] internal non-fatal server error: unexpected limit dataType event where no doc is associated.');
-                                                            }
-                                                            break;
-                                                        }
-                                                        case 'enqueue': {
-                                                            err = new CloudSDKError({
-                                                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
-                                                                errMsg: "HandleServerEvents: full doc is not provided with dataType=\"limit\" and queueType=\"enqueue\" (requestId " + msg.requestId + ")"
-                                                            });
-                                                            this_1.closeWithError(err);
-                                                            throw err;
-                                                        }
-                                                        default: {
-                                                            break;
-                                                        }
-                                                    }
-                                                }
-                                                break;
-                                            }
-                                        }
-                                        switch (change.queueType) {
-                                            case 'init': {
-                                                if (!initEncountered) {
-                                                    initEncountered = true;
-                                                    docs = [change.doc];
-                                                }
-                                                else {
-                                                    docs.push(change.doc);
-                                                }
-                                                break;
-                                            }
-                                            case 'enqueue': {
-                                                docs.push(change.doc);
-                                                break;
-                                            }
-                                            case 'dequeue': {
-                                                ind = docs.findIndex(function (doc) { return doc._id === change.docId; });
-                                                if (ind > -1) {
-                                                    docs.splice(ind, 1);
-                                                }
-                                                else {
-                                                    console.error('[realtime listener] internal non-fatal server error: unexpected dequeue event where no doc is associated.');
-                                                }
-                                                break;
-                                            }
-                                            case 'update': {
-                                                ind = docs.findIndex(function (doc) { return doc._id === change.docId; });
-                                                if (ind > -1) {
-                                                    docs[ind] = change.doc;
-                                                }
-                                                else {
-                                                    console.error('[realtime listener] internal non-fatal server error: unexpected queueType update event where no doc is associated.');
-                                                }
-                                                break;
-                                            }
-                                        }
-                                        if (i === len - 1 ||
-                                            (allChangeEvents[i + 1] && allChangeEvents[i + 1].id !== change.id)) {
-                                            docsSnapshot = __spread(docs);
-                                            docChanges = allChangeEvents
-                                                .slice(0, i + 1)
-                                                .filter(function (c) { return c.id === change.id; });
-                                            this_1.sessionInfo.currentEventId = change.id;
-                                            this_1.sessionInfo.currentDocs = docs;
-                                            snapshot = new Snapshot({
-                                                id: change.id,
-                                                docChanges: docChanges,
-                                                docs: docsSnapshot,
-                                                msgType: msgType
-                                            });
-                                            this_1.listener.onChange(snapshot);
-                                        }
-                                        return [3, 4];
-                                    case 2:
-                                        console.warn("[realtime listener] event received is out of order, cur " + this_1.sessionInfo.currentEventId + " but got " + change.id);
-                                        return [4, this_1.rebuildWatch()];
-                                    case 3:
-                                        _d.sent();
-                                        return [2, { value: void 0 }];
-                                    case 4: return [2];
-                                }
-                            });
-                        };
-                        this_1 = this;
-                        i = 0, len = allChangeEvents.length;
-                        _a.label = 1;
-                    case 1:
-                        if (!(i < len)) return [3, 4];
-                        return [5, _loop_1(i, len)];
-                    case 2:
-                        state_1 = _a.sent();
-                        if (typeof state_1 === "object")
-                            return [2, state_1.value];
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3, 1];
-                    case 4: return [2];
-                }
-            });
-        });
-    };
-    VirtualWebSocketClient.prototype._postHandleServerEventsValidityCheck = function (msg) {
-        if (!this.sessionInfo) {
-            console.error('[realtime listener] internal non-fatal error: sessionInfo lost after server event handling, this should never occur');
-            return;
-        }
-        if (this.sessionInfo.expectEventId &&
-            this.sessionInfo.currentEventId >= this.sessionInfo.expectEventId) {
-            this.clearWaitExpectedEvent();
-        }
-        if (this.sessionInfo.currentEventId < msg.msgData.currEvent) {
-            console.warn('[realtime listener] internal non-fatal error: client eventId does not match with server event id after server event handling');
-            return;
-        }
-    };
-    VirtualWebSocketClient.prototype.clearWaitExpectedEvent = function () {
-        if (this._waitExpectedTimeoutId) {
-            clearTimeout(this._waitExpectedTimeoutId);
-            this._waitExpectedTimeoutId = undefined;
-        }
-    };
-    VirtualWebSocketClient.prototype.onMessage = function (msg) {
-        var _this = this;
-        switch (this.watchStatus) {
-            case WATCH_STATUS.PAUSED: {
-                if (msg.msgType !== 'ERROR') {
-                    return;
-                }
-                break;
-            }
-            case WATCH_STATUS.LOGGINGIN:
-            case WATCH_STATUS.INITING:
-            case WATCH_STATUS.REBUILDING: {
-                console.warn("[realtime listener] internal non-fatal error: unexpected message received while " + this.watchStatus);
-                return;
-            }
-            case WATCH_STATUS.CLOSED: {
-                console.warn('[realtime listener] internal non-fatal error: unexpected message received when the watch has closed');
-                return;
-            }
-            case WATCH_STATUS.ERRORED: {
-                console.warn('[realtime listener] internal non-fatal error: unexpected message received when the watch has ended with error');
-                return;
-            }
-        }
-        if (!this.sessionInfo) {
-            console.warn('[realtime listener] internal non-fatal error: sessionInfo not found while message is received.');
-            return;
-        }
-        this.scheduleSendACK();
-        switch (msg.msgType) {
-            case 'NEXT_EVENT': {
-                console.warn("nextevent " + msg.msgData.currEvent + " ignored", msg);
-                this.handleServerEvents(msg);
-                break;
-            }
-            case 'CHECK_EVENT': {
-                if (this.sessionInfo.currentEventId < msg.msgData.currEvent) {
-                    this.sessionInfo.expectEventId = msg.msgData.currEvent;
-                    this.clearWaitExpectedEvent();
-                    this._waitExpectedTimeoutId = setTimeout(function () {
-                        _this.rebuildWatch();
-                    }, this.getWaitExpectedTimeoutLength());
-                    console.log("[realtime] waitExpectedTimeoutLength " + this.getWaitExpectedTimeoutLength());
-                }
-                break;
-            }
-            case 'ERROR': {
-                this.closeWithError(new CloudSDKError({
-                    errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_SERVER_ERROR_MSG,
-                    errMsg: msg.msgData.code + " - " + msg.msgData.message
-                }));
-                break;
-            }
-            default: {
-                console.warn("[realtime listener] virtual client receive unexpected msg " + msg.msgType + ": ", msg);
-                break;
-            }
-        }
-    };
-    VirtualWebSocketClient.prototype.closeWithError = function (error) {
-        this.watchStatus = WATCH_STATUS.ERRORED;
-        this.clearACKSchedule();
-        this.listener.onError(error);
-        this.onWatchClose(this, (this.sessionInfo && this.sessionInfo.queryID) || '');
-        console.log("[realtime] client closed (" + this.collectionName + " " + this.query + ") (watchId " + this.watchId + ")");
-    };
-    VirtualWebSocketClient.prototype.pause = function () {
-        this.watchStatus = WATCH_STATUS.PAUSED;
-        console.log("[realtime] client paused (" + this.collectionName + " " + this.query + ") (watchId " + this.watchId + ")");
-    };
-    VirtualWebSocketClient.prototype.resume = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var e_9;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        this.watchStatus = WATCH_STATUS.RESUMING;
-                        console.log("[realtime] client resuming with " + (this.sessionInfo ? 'REBUILD_WATCH' : 'INIT_WATCH') + " (" + this.collectionName + " " + this.query + ") (" + this.watchId + ")");
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4, (this.sessionInfo ? this.rebuildWatch() : this.initWatch())];
-                    case 2:
-                        _a.sent();
-                        console.log("[realtime] client successfully resumed (" + this.collectionName + " " + this.query + ") (" + this.watchId + ")");
-                        return [3, 4];
-                    case 3:
-                        e_9 = _a.sent();
-                        console.error("[realtime] client resume failed (" + this.collectionName + " " + this.query + ") (" + this.watchId + ")", e_9);
-                        return [3, 4];
-                    case 4: return [2];
-                }
-            });
-        });
-    };
-    return VirtualWebSocketClient;
-}());
-export { VirtualWebSocketClient };
-function getPublicEvent(event) {
-    var e = {
-        id: event.ID,
-        dataType: event.DataType,
-        queueType: event.QueueType,
-        docId: event.DocID,
-        doc: event.Doc && event.Doc !== '{}' ? JSON.parse(event.Doc) : undefined
-    };
-    if (event.DataType === 'update') {
-        if (event.UpdatedFields) {
-            e.updatedFields = JSON.parse(event.UpdatedFields);
-        }
-        if (event.removedFields || event.RemovedFields) {
-            e.removedFields = JSON.parse(event.removedFields);
-        }
-    }
-    return e;
-}
+import set from 'lodash.set';
+import unset from 'lodash.unset';
+import cloneDeep from 'lodash.clonedeep';
+import { genRequestId } from './message';
+import { CloudSDKError, isTimeoutError, CancelledError, isCancelledError } from '../utils/error';
+import { ERR_CODE } from '../config/error.config';
+import { sleep } from '../utils/utils';
+import { RealtimeListener } from './listener';
+import { Snapshot } from './snapshot';
+import { isRealtimeErrorMessageError } from './error';
+var WATCH_STATUS;
+(function (WATCH_STATUS) {
+    WATCH_STATUS["LOGGINGIN"] = "LOGGINGIN";
+    WATCH_STATUS["INITING"] = "INITING";
+    WATCH_STATUS["REBUILDING"] = "REBUILDING";
+    WATCH_STATUS["ACTIVE"] = "ACTIVE";
+    WATCH_STATUS["ERRORED"] = "ERRORED";
+    WATCH_STATUS["CLOSING"] = "CLOSING";
+    WATCH_STATUS["CLOSED"] = "CLOSED";
+    WATCH_STATUS["PAUSED"] = "PAUSED";
+    WATCH_STATUS["RESUMING"] = "RESUMING";
+})(WATCH_STATUS || (WATCH_STATUS = {}));
+const DEFAULT_WAIT_TIME_ON_UNKNOWN_ERROR = 100;
+const DEFAULT_MAX_AUTO_RETRY_ON_ERROR = 2;
+const DEFAULT_MAX_SEND_ACK_AUTO_RETRY_ON_ERROR = 2;
+const DEFAULT_SEND_ACK_DEBOUNCE_TIMEOUT = 10 * 1000;
+const DEFAULT_INIT_WATCH_TIMEOUT = 10 * 1000;
+const DEFAULT_REBUILD_WATCH_TIMEOUT = 10 * 1000;
+export class VirtualWebSocketClient {
+    constructor(options) {
+        this.watchStatus = WATCH_STATUS.INITING;
+        this._login = async (envId, refresh) => {
+            this.watchStatus = WATCH_STATUS.LOGGINGIN;
+            const loginResult = await this.login(envId, refresh);
+            if (!this.envId) {
+                this.envId = loginResult.envId;
+            }
+            return loginResult;
+        };
+        this.initWatch = async (forceRefreshLogin) => {
+            if (this._initWatchPromise) {
+                return this._initWatchPromise;
+            }
+            this._initWatchPromise = new Promise(async (resolve, reject) => {
+                try {
+                    if (this.watchStatus === WATCH_STATUS.PAUSED) {
+                        console.log('[realtime] initWatch cancelled on pause');
+                        return resolve();
+                    }
+                    const { envId } = await this._login(this.envId, forceRefreshLogin);
+                    if (this.watchStatus === WATCH_STATUS.PAUSED) {
+                        console.log('[realtime] initWatch cancelled on pause');
+                        return resolve();
+                    }
+                    this.watchStatus = WATCH_STATUS.INITING;
+                    const initWatchMsg = {
+                        watchId: this.watchId,
+                        requestId: genRequestId(),
+                        msgType: 'INIT_WATCH',
+                        msgData: {
+                            envId,
+                            collName: this.collectionName,
+                            query: this.query,
+                            limit: this.limit,
+                            orderBy: this.orderBy
+                        }
+                    };
+                    const initEventMsg = await this.send({
+                        msg: initWatchMsg,
+                        waitResponse: true,
+                        skipOnMessage: true,
+                        timeout: DEFAULT_INIT_WATCH_TIMEOUT
+                    });
+                    const { events, currEvent } = initEventMsg.msgData;
+                    this.sessionInfo = {
+                        queryID: initEventMsg.msgData.queryID,
+                        currentEventId: currEvent - 1,
+                        currentDocs: []
+                    };
+                    if (events.length > 0) {
+                        for (const e of events) {
+                            e.ID = currEvent;
+                        }
+                        this.handleServerEvents(initEventMsg);
+                    }
+                    else {
+                        this.sessionInfo.currentEventId = currEvent;
+                        const snapshot = new Snapshot({
+                            id: currEvent,
+                            docChanges: [],
+                            docs: [],
+                            type: 'init'
+                        });
+                        this.listener.onChange(snapshot);
+                        this.scheduleSendACK();
+                    }
+                    this.onWatchStart(this, this.sessionInfo.queryID);
+                    this.watchStatus = WATCH_STATUS.ACTIVE;
+                    this._availableRetries.INIT_WATCH = DEFAULT_MAX_AUTO_RETRY_ON_ERROR;
+                    resolve();
+                }
+                catch (e) {
+                    this.handleWatchEstablishmentError(e, {
+                        operationName: 'INIT_WATCH',
+                        resolve,
+                        reject
+                    });
+                }
+            });
+            let success = false;
+            try {
+                await this._initWatchPromise;
+                success = true;
+            }
+            finally {
+                this._initWatchPromise = undefined;
+            }
+            console.log(`[realtime] initWatch ${success ? 'success' : 'fail'}`);
+        };
+        this.rebuildWatch = async (forceRefreshLogin) => {
+            if (this._rebuildWatchPromise) {
+                return this._rebuildWatchPromise;
+            }
+            this._rebuildWatchPromise = new Promise(async (resolve, reject) => {
+                try {
+                    if (this.watchStatus === WATCH_STATUS.PAUSED) {
+                        console.log('[realtime] rebuildWatch cancelled on pause');
+                        return resolve();
+                    }
+                    const { envId } = await this._login(this.envId, forceRefreshLogin);
+                    if (!this.sessionInfo) {
+                        throw new Error('can not rebuildWatch without a successful initWatch (lack of sessionInfo)');
+                    }
+                    if (this.watchStatus === WATCH_STATUS.PAUSED) {
+                        console.log('[realtime] rebuildWatch cancelled on pause');
+                        return resolve();
+                    }
+                    this.watchStatus = WATCH_STATUS.REBUILDING;
+                    const rebuildWatchMsg = {
+                        watchId: this.watchId,
+                        requestId: genRequestId(),
+                        msgType: 'REBUILD_WATCH',
+                        msgData: {
+                            envId,
+                            collName: this.collectionName,
+                            queryID: this.sessionInfo.queryID,
+                            eventID: this.sessionInfo.currentEventId
+                        }
+                    };
+                    const nextEventMsg = await this.send({
+                        msg: rebuildWatchMsg,
+                        waitResponse: true,
+                        skipOnMessage: false,
+                        timeout: DEFAULT_REBUILD_WATCH_TIMEOUT
+                    });
+                    this.handleServerEvents(nextEventMsg);
+                    this.watchStatus = WATCH_STATUS.ACTIVE;
+                    this._availableRetries.REBUILD_WATCH = DEFAULT_MAX_AUTO_RETRY_ON_ERROR;
+                    resolve();
+                }
+                catch (e) {
+                    this.handleWatchEstablishmentError(e, {
+                        operationName: 'REBUILD_WATCH',
+                        resolve,
+                        reject
+                    });
+                }
+            });
+            let success = false;
+            try {
+                await this._rebuildWatchPromise;
+                success = true;
+            }
+            finally {
+                this._rebuildWatchPromise = undefined;
+            }
+            console.log(`[realtime] rebuildWatch ${success ? 'success' : 'fail'}`);
+        };
+        this.handleWatchEstablishmentError = async (e, options) => {
+            const isInitWatch = options.operationName === 'INIT_WATCH';
+            const abortWatch = () => {
+                this.closeWithError(new CloudSDKError({
+                    errCode: isInitWatch
+                        ? ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_INIT_WATCH_FAIL
+                        : ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_REBUILD_WATCH_FAIL,
+                    errMsg: e
+                }));
+                options.reject(e);
+            };
+            const retry = (refreshLogin) => {
+                if (this.useRetryTicket(options.operationName)) {
+                    if (isInitWatch) {
+                        this._initWatchPromise = undefined;
+                        options.resolve(this.initWatch(refreshLogin));
+                    }
+                    else {
+                        this._rebuildWatchPromise = undefined;
+                        options.resolve(this.rebuildWatch(refreshLogin));
+                    }
+                }
+                else {
+                    abortWatch();
+                }
+            };
+            this.handleCommonError(e, {
+                onSignError: () => retry(true),
+                onTimeoutError: () => retry(false),
+                onNotRetryableError: abortWatch,
+                onCancelledError: options.reject,
+                onUnknownError: async () => {
+                    try {
+                        const onWSDisconnected = async () => {
+                            this.pause();
+                            await this.onceWSConnected();
+                            retry(true);
+                        };
+                        if (!this.isWSConnected()) {
+                            await onWSDisconnected();
+                        }
+                        else {
+                            await sleep(DEFAULT_WAIT_TIME_ON_UNKNOWN_ERROR);
+                            if (this.watchStatus === WATCH_STATUS.PAUSED) {
+                                options.reject(new CancelledError(`${options.operationName} cancelled due to pause after unknownError`));
+                            }
+                            else if (!this.isWSConnected()) {
+                                await onWSDisconnected();
+                            }
+                            else {
+                                retry(false);
+                            }
+                        }
+                    }
+                    catch (e) {
+                        retry(true);
+                    }
+                }
+            });
+        };
+        this.closeWatch = async () => {
+            const queryId = this.sessionInfo ? this.sessionInfo.queryID : '';
+            if (this.watchStatus !== WATCH_STATUS.ACTIVE) {
+                this.watchStatus = WATCH_STATUS.CLOSED;
+                this.onWatchClose(this, queryId);
+                return;
+            }
+            try {
+                this.watchStatus = WATCH_STATUS.CLOSING;
+                const closeWatchMsg = {
+                    watchId: this.watchId,
+                    requestId: genRequestId(),
+                    msgType: 'CLOSE_WATCH',
+                    msgData: null
+                };
+                await this.send({
+                    msg: closeWatchMsg
+                });
+                this.sessionInfo = undefined;
+                this.watchStatus = WATCH_STATUS.CLOSED;
+            }
+            catch (e) {
+                this.closeWithError(new CloudSDKError({
+                    errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CLOSE_WATCH_FAIL,
+                    errMsg: e
+                }));
+            }
+            finally {
+                this.onWatchClose(this, queryId);
+            }
+        };
+        this.scheduleSendACK = () => {
+            this.clearACKSchedule();
+            this._ackTimeoutId = setTimeout(() => {
+                if (this._waitExpectedTimeoutId) {
+                    this.scheduleSendACK();
+                }
+                else {
+                    this.sendACK();
+                }
+            }, DEFAULT_SEND_ACK_DEBOUNCE_TIMEOUT);
+        };
+        this.clearACKSchedule = () => {
+            if (this._ackTimeoutId) {
+                clearTimeout(this._ackTimeoutId);
+            }
+        };
+        this.sendACK = async () => {
+            try {
+                if (this.watchStatus !== WATCH_STATUS.ACTIVE) {
+                    this.scheduleSendACK();
+                    return;
+                }
+                if (!this.sessionInfo) {
+                    console.warn('[realtime listener] can not send ack without a successful initWatch (lack of sessionInfo)');
+                    return;
+                }
+                const ackMsg = {
+                    watchId: this.watchId,
+                    requestId: genRequestId(),
+                    msgType: 'CHECK_LAST',
+                    msgData: {
+                        queryID: this.sessionInfo.queryID,
+                        eventID: this.sessionInfo.currentEventId
+                    }
+                };
+                await this.send({
+                    msg: ackMsg
+                });
+                this.scheduleSendACK();
+            }
+            catch (e) {
+                if (isRealtimeErrorMessageError(e)) {
+                    const msg = e.payload;
+                    switch (msg.msgData.code) {
+                        case 'CHECK_LOGIN_FAILED':
+                        case 'SIGN_EXPIRED_ERROR':
+                        case 'SIGN_INVALID_ERROR':
+                        case 'SIGN_PARAM_INVALID': {
+                            this.rebuildWatch();
+                            return;
+                        }
+                        case 'QUERYID_INVALID_ERROR':
+                        case 'SYS_ERR':
+                        case 'INVALIID_ENV':
+                        case 'COLLECTION_PERMISSION_DENIED': {
+                            this.closeWithError(new CloudSDKError({
+                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CHECK_LAST_FAIL,
+                                errMsg: msg.msgData.code
+                            }));
+                            return;
+                        }
+                        default: {
+                            break;
+                        }
+                    }
+                }
+                if (this._availableRetries.CHECK_LAST &&
+                    this._availableRetries.CHECK_LAST > 0) {
+                    this._availableRetries.CHECK_LAST--;
+                    this.scheduleSendACK();
+                }
+                else {
+                    this.closeWithError(new CloudSDKError({
+                        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_CHECK_LAST_FAIL,
+                        errMsg: e
+                    }));
+                }
+            }
+        };
+        this.handleCommonError = (e, options) => {
+            if (isRealtimeErrorMessageError(e)) {
+                const msg = e.payload;
+                switch (msg.msgData.code) {
+                    case 'CHECK_LOGIN_FAILED':
+                    case 'SIGN_EXPIRED_ERROR':
+                    case 'SIGN_INVALID_ERROR':
+                    case 'SIGN_PARAM_INVALID': {
+                        options.onSignError(e);
+                        return;
+                    }
+                    case 'QUERYID_INVALID_ERROR':
+                    case 'SYS_ERR':
+                    case 'INVALIID_ENV':
+                    case 'COLLECTION_PERMISSION_DENIED': {
+                        options.onNotRetryableError(e);
+                        return;
+                    }
+                    default: {
+                        options.onNotRetryableError(e);
+                        return;
+                    }
+                }
+            }
+            else if (isTimeoutError(e)) {
+                options.onTimeoutError(e);
+                return;
+            }
+            else if (isCancelledError(e)) {
+                options.onCancelledError(e);
+                return;
+            }
+            options.onUnknownError(e);
+        };
+        this.watchId = `watchid_${+new Date()}_${Math.random()}`;
+        this.envId = options.envId;
+        this.collectionName = options.collectionName;
+        this.query = options.query;
+        this.limit = options.limit;
+        this.orderBy = options.orderBy;
+        this.send = options.send;
+        this.login = options.login;
+        this.isWSConnected = options.isWSConnected;
+        this.onceWSConnected = options.onceWSConnected;
+        this.getWaitExpectedTimeoutLength = options.getWaitExpectedTimeoutLength;
+        this.onWatchStart = options.onWatchStart;
+        this.onWatchClose = options.onWatchClose;
+        this.debug = options.debug;
+        this._availableRetries = {
+            INIT_WATCH: DEFAULT_MAX_AUTO_RETRY_ON_ERROR,
+            REBUILD_WATCH: DEFAULT_MAX_AUTO_RETRY_ON_ERROR,
+            CHECK_LAST: DEFAULT_MAX_SEND_ACK_AUTO_RETRY_ON_ERROR
+        };
+        this.listener = new RealtimeListener({
+            close: this.closeWatch,
+            onChange: options.onChange,
+            onError: options.onError,
+            debug: this.debug,
+            virtualClient: this
+        });
+        this.initWatch();
+    }
+    useRetryTicket(operationName) {
+        if (this._availableRetries[operationName] &&
+            this._availableRetries[operationName] > 0) {
+            this._availableRetries[operationName]--;
+            console.log(`[realtime] ${operationName} use a retry ticket, now only ${this._availableRetries[operationName]} retry left`);
+            return true;
+        }
+        return false;
+    }
+    async handleServerEvents(msg) {
+        try {
+            this.scheduleSendACK();
+            await this._handleServerEvents(msg);
+            this._postHandleServerEventsValidityCheck(msg);
+        }
+        catch (e) {
+            console.error('[realtime listener] internal non-fatal error: handle server events failed with error: ', e);
+            throw e;
+        }
+    }
+    async _handleServerEvents(msg) {
+        const { requestId } = msg;
+        const { events } = msg.msgData;
+        const { msgType } = msg;
+        if (!events.length || !this.sessionInfo) {
+            return;
+        }
+        const sessionInfo = this.sessionInfo;
+        let allChangeEvents;
+        try {
+            allChangeEvents = events.map(getPublicEvent);
+        }
+        catch (e) {
+            this.closeWithError(new CloudSDKError({
+                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_RECEIVE_INVALID_SERVER_DATA,
+                errMsg: e
+            }));
+            return;
+        }
+        let docs = [...sessionInfo.currentDocs];
+        let initEncountered = false;
+        for (let i = 0, len = allChangeEvents.length; i < len; i++) {
+            const change = allChangeEvents[i];
+            if (sessionInfo.currentEventId >= change.id) {
+                if (!allChangeEvents[i - 1] || change.id > allChangeEvents[i - 1].id) {
+                    console.warn(`[realtime] duplicate event received, cur ${sessionInfo.currentEventId} but got ${change.id}`);
+                }
+                else {
+                    console.error(`[realtime listener] server non-fatal error: events out of order (the latter event's id is smaller than that of the former) (requestId ${requestId})`);
+                }
+                continue;
+            }
+            else if (sessionInfo.currentEventId === change.id - 1) {
+                switch (change.dataType) {
+                    case 'update': {
+                        if (!change.doc) {
+                            switch (change.queueType) {
+                                case 'update':
+                                case 'dequeue': {
+                                    const localDoc = docs.find(doc => doc._id === change.docId);
+                                    if (localDoc) {
+                                        const doc = cloneDeep(localDoc);
+                                        if (change.updatedFields) {
+                                            for (const fieldPath in change.updatedFields) {
+                                                set(doc, fieldPath, change.updatedFields[fieldPath]);
+                                            }
+                                        }
+                                        if (change.removedFields) {
+                                            for (const fieldPath of change.removedFields) {
+                                                unset(doc, fieldPath);
+                                            }
+                                        }
+                                        change.doc = doc;
+                                    }
+                                    else {
+                                        console.error('[realtime listener] internal non-fatal server error: unexpected update dataType event where no doc is associated.');
+                                    }
+                                    break;
+                                }
+                                case 'enqueue': {
+                                    const err = new CloudSDKError({
+                                        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
+                                        errMsg: `HandleServerEvents: full doc is not provided with dataType="update" and queueType="enqueue" (requestId ${msg.requestId})`
+                                    });
+                                    this.closeWithError(err);
+                                    throw err;
+                                }
+                                default: {
+                                    break;
+                                }
+                            }
+                        }
+                        break;
+                    }
+                    case 'replace': {
+                        if (!change.doc) {
+                            const err = new CloudSDKError({
+                                errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
+                                errMsg: `HandleServerEvents: full doc is not provided with dataType="replace" (requestId ${msg.requestId})`
+                            });
+                            this.closeWithError(err);
+                            throw err;
+                        }
+                        break;
+                    }
+                    case 'remove': {
+                        const doc = docs.find(doc => doc._id === change.docId);
+                        if (doc) {
+                            change.doc = doc;
+                        }
+                        else {
+                            console.error('[realtime listener] internal non-fatal server error: unexpected remove event where no doc is associated.');
+                        }
+                        break;
+                    }
+                    case 'limit': {
+                        if (!change.doc) {
+                            switch (change.queueType) {
+                                case 'dequeue': {
+                                    const doc = docs.find(doc => doc._id === change.docId);
+                                    if (doc) {
+                                        change.doc = doc;
+                                    }
+                                    else {
+                                        console.error('[realtime listener] internal non-fatal server error: unexpected limit dataType event where no doc is associated.');
+                                    }
+                                    break;
+                                }
+                                case 'enqueue': {
+                                    const err = new CloudSDKError({
+                                        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_UNEXPECTED_FATAL_ERROR,
+                                        errMsg: `HandleServerEvents: full doc is not provided with dataType="limit" and queueType="enqueue" (requestId ${msg.requestId})`
+                                    });
+                                    this.closeWithError(err);
+                                    throw err;
+                                }
+                                default: {
+                                    break;
+                                }
+                            }
+                        }
+                        break;
+                    }
+                }
+                switch (change.queueType) {
+                    case 'init': {
+                        if (!initEncountered) {
+                            initEncountered = true;
+                            docs = [change.doc];
+                        }
+                        else {
+                            docs.push(change.doc);
+                        }
+                        break;
+                    }
+                    case 'enqueue': {
+                        docs.push(change.doc);
+                        break;
+                    }
+                    case 'dequeue': {
+                        const ind = docs.findIndex(doc => doc._id === change.docId);
+                        if (ind > -1) {
+                            docs.splice(ind, 1);
+                        }
+                        else {
+                            console.error('[realtime listener] internal non-fatal server error: unexpected dequeue event where no doc is associated.');
+                        }
+                        break;
+                    }
+                    case 'update': {
+                        const ind = docs.findIndex(doc => doc._id === change.docId);
+                        if (ind > -1) {
+                            docs[ind] = change.doc;
+                        }
+                        else {
+                            console.error('[realtime listener] internal non-fatal server error: unexpected queueType update event where no doc is associated.');
+                        }
+                        break;
+                    }
+                }
+                if (i === len - 1 ||
+                    (allChangeEvents[i + 1] && allChangeEvents[i + 1].id !== change.id)) {
+                    const docsSnapshot = [...docs];
+                    const docChanges = allChangeEvents
+                        .slice(0, i + 1)
+                        .filter(c => c.id === change.id);
+                    this.sessionInfo.currentEventId = change.id;
+                    this.sessionInfo.currentDocs = docs;
+                    const snapshot = new Snapshot({
+                        id: change.id,
+                        docChanges,
+                        docs: docsSnapshot,
+                        msgType
+                    });
+                    this.listener.onChange(snapshot);
+                }
+            }
+            else {
+                console.warn(`[realtime listener] event received is out of order, cur ${this.sessionInfo.currentEventId} but got ${change.id}`);
+                await this.rebuildWatch();
+                return;
+            }
+        }
+    }
+    _postHandleServerEventsValidityCheck(msg) {
+        if (!this.sessionInfo) {
+            console.error('[realtime listener] internal non-fatal error: sessionInfo lost after server event handling, this should never occur');
+            return;
+        }
+        if (this.sessionInfo.expectEventId &&
+            this.sessionInfo.currentEventId >= this.sessionInfo.expectEventId) {
+            this.clearWaitExpectedEvent();
+        }
+        if (this.sessionInfo.currentEventId < msg.msgData.currEvent) {
+            console.warn('[realtime listener] internal non-fatal error: client eventId does not match with server event id after server event handling');
+            return;
+        }
+    }
+    clearWaitExpectedEvent() {
+        if (this._waitExpectedTimeoutId) {
+            clearTimeout(this._waitExpectedTimeoutId);
+            this._waitExpectedTimeoutId = undefined;
+        }
+    }
+    onMessage(msg) {
+        switch (this.watchStatus) {
+            case WATCH_STATUS.PAUSED: {
+                if (msg.msgType !== 'ERROR') {
+                    return;
+                }
+                break;
+            }
+            case WATCH_STATUS.LOGGINGIN:
+            case WATCH_STATUS.INITING:
+            case WATCH_STATUS.REBUILDING: {
+                console.warn(`[realtime listener] internal non-fatal error: unexpected message received while ${this.watchStatus}`);
+                return;
+            }
+            case WATCH_STATUS.CLOSED: {
+                console.warn('[realtime listener] internal non-fatal error: unexpected message received when the watch has closed');
+                return;
+            }
+            case WATCH_STATUS.ERRORED: {
+                console.warn('[realtime listener] internal non-fatal error: unexpected message received when the watch has ended with error');
+                return;
+            }
+        }
+        if (!this.sessionInfo) {
+            console.warn('[realtime listener] internal non-fatal error: sessionInfo not found while message is received.');
+            return;
+        }
+        this.scheduleSendACK();
+        switch (msg.msgType) {
+            case 'NEXT_EVENT': {
+                console.warn(`nextevent ${msg.msgData.currEvent} ignored`, msg);
+                this.handleServerEvents(msg);
+                break;
+            }
+            case 'CHECK_EVENT': {
+                if (this.sessionInfo.currentEventId < msg.msgData.currEvent) {
+                    this.sessionInfo.expectEventId = msg.msgData.currEvent;
+                    this.clearWaitExpectedEvent();
+                    this._waitExpectedTimeoutId = setTimeout(() => {
+                        this.rebuildWatch();
+                    }, this.getWaitExpectedTimeoutLength());
+                    console.log(`[realtime] waitExpectedTimeoutLength ${this.getWaitExpectedTimeoutLength()}`);
+                }
+                break;
+            }
+            case 'ERROR': {
+                this.closeWithError(new CloudSDKError({
+                    errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_SERVER_ERROR_MSG,
+                    errMsg: `${msg.msgData.code} - ${msg.msgData.message}`
+                }));
+                break;
+            }
+            default: {
+                console.warn(`[realtime listener] virtual client receive unexpected msg ${msg.msgType}: `, msg);
+                break;
+            }
+        }
+    }
+    closeWithError(error) {
+        this.watchStatus = WATCH_STATUS.ERRORED;
+        this.clearACKSchedule();
+        this.listener.onError(error);
+        this.onWatchClose(this, (this.sessionInfo && this.sessionInfo.queryID) || '');
+        console.log(`[realtime] client closed (${this.collectionName} ${this.query}) (watchId ${this.watchId})`);
+    }
+    pause() {
+        this.watchStatus = WATCH_STATUS.PAUSED;
+        console.log(`[realtime] client paused (${this.collectionName} ${this.query}) (watchId ${this.watchId})`);
+    }
+    async resume() {
+        this.watchStatus = WATCH_STATUS.RESUMING;
+        console.log(`[realtime] client resuming with ${this.sessionInfo ? 'REBUILD_WATCH' : 'INIT_WATCH'} (${this.collectionName} ${this.query}) (${this.watchId})`);
+        try {
+            await (this.sessionInfo ? this.rebuildWatch() : this.initWatch());
+            console.log(`[realtime] client successfully resumed (${this.collectionName} ${this.query}) (${this.watchId})`);
+        }
+        catch (e) {
+            console.error(`[realtime] client resume failed (${this.collectionName} ${this.query}) (${this.watchId})`, e);
+        }
+    }
+}
+function getPublicEvent(event) {
+    const e = {
+        id: event.ID,
+        dataType: event.DataType,
+        queueType: event.QueueType,
+        docId: event.DocID,
+        doc: event.Doc && event.Doc !== '{}' ? JSON.parse(event.Doc) : undefined
+    };
+    if (event.DataType === 'update') {
+        if (event.UpdatedFields) {
+            e.updatedFields = JSON.parse(event.UpdatedFields);
+        }
+        if (event.removedFields || event.RemovedFields) {
+            e.removedFields = JSON.parse(event.removedFields);
+        }
+    }
+    return e;
+}