feat: add core event engine state machine (pubnub#265)

* chore: remove flow types

* chore: clean the repository

* chore: add eslint and prettier configs

* chore: fix eslint rules

* build: add node and web builds

* test: fix tests and ci

* chore: update CODEOWNERS

* feat: add core event engine state machine

* feat: bind EventEngine to PubNub instance

* feat: initial reconnection state description

* feat: added stopped states

* chore: run build

* fix: fix tests and ignore aborts in subscription manager

* PubNub SDK v6.0.0 release.

Co-authored-by: Client Engineering Bot <60980775+Client Engineering [email protected]>

Author: are

.mocharc.yml

@@ -1,4 +1,4 @@
-spec: test/**/*.test.js
+spec: test/**/*.test.{ts,js}
 require: test/setup.js
 exclude:
   - test/dist/*.js

.pubnub.yml

@@ -1,5 +1,12 @@
 ---
 changelog:
+  - date: 2022-04-14
+    version: v6.0.0
+    changes:
+      - type: feature
+        text: "Added a TypeScript build chain and moved from webpack to rollup."
+      - type: feature
+        text: "Added an initial implementation of Event Engine."
   - date: 2022-03-02
     version: v5.0.1
     changes:
@@ -1101,7 +1108,7 @@ supported-platforms:
       - "Ubuntu 14.04 and up"
       - "Windows 7 and up"
     version: "Pubnub Javascript for Node"
-version: "5.0.1"
+version: "6.0.0"
 sdks:
   -
     full-name: PubNub Javascript SDK
@@ -1120,7 +1127,7 @@ sdks:
             distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v5.0.1.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v6.0.0.zip
             requires:
               -
                 name: "agentkeepalive"
@@ -1884,7 +1891,7 @@ sdks:
             distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v5.0.1/pubnub.5.0.1.js
+            location: https://github.com/pubnub/javascript/releases/download/v6.0.0/pubnub.6.0.0.js
             requires:
               -
                 name: "agentkeepalive"

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v6.0.0
+April 14 2022
+
+#### Added
+- Added a TypeScript build chain and moved from webpack to rollup.
+- Added an initial implementation of Event Engine.
+
 ## v5.0.1
 March 02 2022
 

README.md

@@ -22,8 +22,8 @@ You will need the publish and subscribe keys to authenticate your app. Get your
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.5.0.1.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.5.0.1.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.6.0.0.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.6.0.0.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -0,0 +1,57 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbortSignal = exports.AbortError = void 0;
+var subject_1 = require("./subject");
+var AbortError = /** @class */ (function (_super) {
+    __extends(AbortError, _super);
+    function AbortError() {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, 'The operation was aborted.') || this;
+        _this.name = 'AbortError';
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return AbortError;
+}(Error));
+exports.AbortError = AbortError;
+var AbortSignal = /** @class */ (function (_super) {
+    __extends(AbortSignal, _super);
+    function AbortSignal() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this._aborted = false;
+        return _this;
+    }
+    Object.defineProperty(AbortSignal.prototype, "aborted", {
+        get: function () {
+            return this._aborted;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    AbortSignal.prototype.throwIfAborted = function () {
+        if (this._aborted) {
+            throw new AbortError();
+        }
+    };
+    AbortSignal.prototype.abort = function () {
+        this._aborted = true;
+        this.notify(new AbortError());
+    };
+    return AbortSignal;
+}(subject_1.Subject));
+exports.AbortSignal = AbortSignal;

dist/web/pubnub.min.js

@@ -9,7 +9,7 @@ var makeDefaultOrigins = function () { return Array.from({ length: 20 }, functio
 var default_1 = /** @class */ (function () {
     function default_1(_a) {
         var setup = _a.setup;
-        var _b, _c;
+        var _b, _c, _d;
         this._PNSDKSuffix = {};
         this.instanceId = "pn-".concat(uuid_1.default.createUUID());
         this.secretKey = setup.secretKey || setup.secret_key;
@@ -37,6 +37,8 @@ var default_1 = /** @class */ (function () {
         this.customDecrypt = setup.customDecrypt;
         this.fileUploadPublishRetryLimit = (_b = setup.fileUploadPublishRetryLimit) !== null && _b !== void 0 ? _b : 5;
         this.useRandomIVs = (_c = setup.useRandomIVs) !== null && _c !== void 0 ? _c : true;
+        // flag for beta subscribe feature enablement
+        this.enableSubscribeBeta = (_d = setup.enableSubscribeBeta) !== null && _d !== void 0 ? _d : false;
         // if location config exist and we are in https, force secure to true.
         if (typeof location !== 'undefined' && location.protocol === 'https:') {
             this.secure = true;
@@ -143,7 +145,7 @@ var default_1 = /** @class */ (function () {
         return this;
     };
     default_1.prototype.getVersion = function () {
-        return '5.0.0';
+        return '6.0.0';
     };
     default_1.prototype._addPnsdkSuffix = function (name, suffix) {
         this._PNSDKSuffix[name] = suffix;

lib/core/components/abort_signal.js

@@ -34,10 +34,12 @@ var categories_1 = require("../constants/categories");
 var PubNubError = /** @class */ (function (_super) {
     __extends(PubNubError, _super);
     function PubNubError(message, status) {
+        var _newTarget = this.constructor;
         var _this = _super.call(this, message) || this;
         _this.name = _this.constructor.name;
         _this.status = status;
         _this.message = message;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
         return _this;
     }
     return PubNubError;
@@ -177,6 +179,7 @@ function default_1(modules, endpoint) {
         headers: endpoint.getRequestHeaders ? endpoint.getRequestHeaders() : {},
         ignoreBody: typeof endpoint.ignoreBody === 'function' ? endpoint.ignoreBody(modules) : false,
         forceBuffered: typeof endpoint.forceBuffered === 'function' ? endpoint.forceBuffered(modules, incomingParams) : null,
+        abortSignal: typeof endpoint.getAbortSignal === 'function' ? endpoint.getAbortSignal(modules, incomingParams) : null,
     };
     outgoingParams.uuid = config.UUID;
     outgoingParams.pnsdk = generatePNSDK(config);

lib/core/components/config.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subject = void 0;
+var Subject = /** @class */ (function () {
+    function Subject(sync) {
+        if (sync === void 0) { sync = false; }
+        this.sync = sync;
+        this.listeners = new Set();
+    }
+    Subject.prototype.subscribe = function (listener) {
+        var _this = this;
+        this.listeners.add(listener);
+        return function () {
+            _this.listeners.delete(listener);
+        };
+    };
+    Subject.prototype.notify = function (event) {
+        var _this = this;
+        var wrapper = function () {
+            _this.listeners.forEach(function (listener) {
+                listener(event);
+            });
+        };
+        if (this.sync) {
+            wrapper();
+        }
+        else {
+            setTimeout(wrapper, 0);
+        }
+    };
+    return Subject;
+}());
+exports.Subject = Subject;

lib/core/components/endpoint.js

@@ -144,7 +144,7 @@ var default_1 = /** @class */ (function () {
                 }
             }
             if (channelGroup in _this._presenceChannelGroups) {
-                delete _this._channelGroups[channelGroup];
+                delete _this._presenceChannelGroups[channelGroup];
                 actualChannelGroups.push(channelGroup);
             }
         });
@@ -300,6 +300,10 @@ var default_1 = /** @class */ (function () {
     default_1.prototype._processSubscribeResponse = function (status, payload) {
         var _this = this;
         if (status.error) {
+            // if error comes from request abort, ignore
+            if (status.errorData && status.errorData.message === 'Aborted') {
+                return;
+            }
             // if we timeout from server, restart the loop.
             if (status.category === categories_1.default.PNTimeoutCategory) {
                 this._startSubscribeLoop();

lib/core/components/requestController.js

@@ -77,4 +77,7 @@ exports.default = {
     PNAccessManagerAudit: 'PNAccessManagerAudit',
     PNAccessManagerRevokeToken: 'PNAccessManagerRevokeToken',
     //
+    // subscription utilities
+    PNHandshakeOperation: 'PNHandshakeOperation',
+    PNReceiveMessagesOperation: 'PNReceiveMessagesOperation',
 };

lib/core/components/requestController.js.map

@@ -1,5 +1,21 @@
 "use strict";
 /*       */
+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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleResponse = exports.prepareParams = exports.isAuthSupported = exports.getRequestTimeout = exports.getURL = exports.validateParams = exports.getOperation = void 0;
 var operations_1 = require("../../constants/operations");
@@ -42,7 +58,7 @@ function prepareParams(modules, incomingParams) {
     var timetoken = incomingParams.timetoken, channelTimetokens = incomingParams.channelTimetokens;
     var outgoingParams = {};
     if (channelTimetokens && channelTimetokens.length === 1) {
-        var tt = channelTimetokens[0];
+        var _a = __read(channelTimetokens, 1), tt = _a[0];
         outgoingParams.timetoken = tt;
     }
     else if (channelTimetokens) {

lib/core/components/subject.js

@@ -1,5 +1,21 @@
 "use strict";
 /**       */
+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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var operations_1 = require("../../../constants/operations");
 var endpoint = {
@@ -37,7 +53,7 @@ var endpoint = {
         queryParams.limit = (_h = params === null || params === void 0 ? void 0 : params.limit) !== null && _h !== void 0 ? _h : 100;
         if (params === null || params === void 0 ? void 0 : params.sort) {
             queryParams.sort = Object.entries((_j = params.sort) !== null && _j !== void 0 ? _j : {}).map(function (_a) {
-                var key = _a[0], value = _a[1];
+                var _b = __read(_a, 2), key = _b[0], value = _b[1];
                 if (value === 'asc' || value === 'desc') {
                     return "".concat(key, ":").concat(value);
                 }

lib/core/components/subscription_manager.js

@@ -1,5 +1,21 @@
 "use strict";
 /**       */
+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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var operations_1 = require("../../../constants/operations");
 var utils_1 = require("../../../utils");
@@ -50,7 +66,7 @@ var endpoint = {
         queryParams.limit = (_l = params === null || params === void 0 ? void 0 : params.limit) !== null && _l !== void 0 ? _l : 100;
         if (params === null || params === void 0 ? void 0 : params.sort) {
             queryParams.sort = Object.entries((_m = params.sort) !== null && _m !== void 0 ? _m : {}).map(function (_a) {
-                var key = _a[0], value = _a[1];
+                var _b = __read(_a, 2), key = _b[0], value = _b[1];
                 if (value === 'asc' || value === 'desc') {
                     return "".concat(key, ":").concat(value);
                 }