@webex/common-timers 3.0.0-beta.21 → 3.0.0-beta.210

package/dist/index.js

@@ -1,11 +1,16 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
+exports.Timer = void 0;
 exports.safeSetInterval = safeSetInterval;
 exports.safeSetTimeout = safeSetTimeout;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -15,7 +20,7 @@ exports.safeSetTimeout = safeSetTimeout;
  * wedging the process open unexpectedly.
  * @param {Mixed} args
  * @protected
- * @returns {Timer|Number}
+ * @returns {NodeJS.Timeout|Number}
  */
 function safeSetTimeout() {
   var timer = setTimeout.apply(void 0, arguments);
@@ -26,11 +31,11 @@ function safeSetTimeout() {
 }
 
 /**
- * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
+ * Wrapper around setInterval which (in node) unrefs the returned timer to avoid
  * wedging the process open unexpectedly.
  * @param {Mixed} args
  * @protected
- * @returns {Timer|Number}
+ * @returns {NodeJS.Timeout|Number}
  */
 function safeSetInterval() {
   var interval = setInterval.apply(void 0, arguments);
@@ -39,4 +44,96 @@ function safeSetInterval() {
   }
   return interval;
 }
+
+/**
+ * Create a restartable timer
+ */
+var Timer = /*#__PURE__*/function () {
+  /**
+   * Construct timer
+   * @param {Function} callback Function called when the timer expired
+   * @param {number} timeout duration of the timeout in milliseconds
+   */
+  function Timer(callback, timeout) {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, Timer);
+    (0, _defineProperty2.default)(this, "state", void 0);
+    (0, _defineProperty2.default)(this, "timeout", void 0);
+    (0, _defineProperty2.default)(this, "callback", void 0);
+    (0, _defineProperty2.default)(this, "currentTimer", void 0);
+    this.state = 'init';
+    this.timeout = timeout;
+    this.callback = function () {
+      _this.state = 'done';
+      callback();
+    };
+  }
+
+  /**
+   * Start timer
+   * @returns {void}
+   */
+  (0, _createClass2.default)(Timer, [{
+    key: "start",
+    value: function start() {
+      if (this.state !== 'init') {
+        throw new Error("Can't start the timer when it's in ".concat(this.state, " state"));
+      }
+      this.startTimer();
+      this.state = 'running';
+    }
+
+    /**
+     * Clear the current timer and start a new one
+     * @returns {void}
+     */
+  }, {
+    key: "reset",
+    value: function reset() {
+      if (this.state !== 'running') {
+        throw new Error("Can't reset the timer when it's in ".concat(this.state, " state"));
+      }
+      this.clearTimer();
+      this.startTimer();
+    }
+
+    /**
+     * Clear the timer
+     * @returns {void}
+     */
+  }, {
+    key: "cancel",
+    value: function cancel() {
+      if (this.state !== 'running') {
+        throw new Error("Can't cancel the timer when it's in ".concat(this.state, " state"));
+      }
+      this.clearTimer();
+      this.state = 'done';
+    }
+
+    /**
+     * Create the actual timer
+     * @private
+     * @returns {undefined}
+     */
+  }, {
+    key: "startTimer",
+    value: function startTimer() {
+      this.currentTimer = safeSetTimeout(this.callback, this.timeout);
+    }
+
+    /**
+     * Clear the actual timer
+     * @private
+     * @returns {undefined}
+     */
+  }, {
+    key: "clearTimer",
+    value: function clearTimer() {
+      clearTimeout(this.currentTimer);
+    }
+  }]);
+  return Timer;
+}();
+exports.Timer = Timer;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["safeSetTimeout","timer","setTimeout","unref","safeSetInterval","interval","setInterval"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/**\n * Wrapper around setTimout which (in node) unrefs the returned timer to avoid\n * wedging the process open unexpectedly.\n * @param {Mixed} args\n * @protected\n * @returns {Timer|Number}\n */\nexport function safeSetTimeout(...args) {\n  const timer = setTimeout(...args);\n\n  if (timer.unref) {\n    timer.unref();\n  }\n\n  return timer;\n}\n\n/**\n * Wrapper around setTimout which (in node) unrefs the returned timer to avoid\n * wedging the process open unexpectedly.\n * @param {Mixed} args\n * @protected\n * @returns {Timer|Number}\n */\nexport function safeSetInterval(...args) {\n  const interval = setInterval(...args);\n\n  if (interval.unref) {\n    interval.unref();\n  }\n\n  return interval;\n}\n"],"mappings":";;;;;;;;AAAA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAc,GAAU;EACtC,IAAMC,KAAK,GAAGC,UAAU,yBAAS;EAEjC,IAAID,KAAK,CAACE,KAAK,EAAE;IACfF,KAAK,CAACE,KAAK,EAAE;EACf;EAEA,OAAOF,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,eAAe,GAAU;EACvC,IAAMC,QAAQ,GAAGC,WAAW,yBAAS;EAErC,IAAID,QAAQ,CAACF,KAAK,EAAE;IAClBE,QAAQ,CAACF,KAAK,EAAE;EAClB;EAEA,OAAOE,QAAQ;AACjB"}
+{"version":3,"names":["safeSetTimeout","timer","setTimeout","unref","safeSetInterval","interval","setInterval","Timer","callback","timeout","state","Error","startTimer","clearTimer","currentTimer","clearTimeout"],"sources":["index.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/**\n * Wrapper around setTimout which (in node) unrefs the returned timer to avoid\n * wedging the process open unexpectedly.\n * @param {Mixed} args\n * @protected\n * @returns {NodeJS.Timeout|Number}\n */\nexport function safeSetTimeout(...args: Parameters<typeof setTimeout>): number | NodeJS.Timeout {\n  const timer = setTimeout(...args);\n\n  if (timer.unref) {\n    timer.unref();\n  }\n\n  return timer;\n}\n\n/**\n * Wrapper around setInterval which (in node) unrefs the returned timer to avoid\n * wedging the process open unexpectedly.\n * @param {Mixed} args\n * @protected\n * @returns {NodeJS.Timeout|Number}\n */\nexport function safeSetInterval(...args: Parameters<typeof setInterval>): number | NodeJS.Timeout {\n  const interval = setInterval(...args);\n\n  if (interval.unref) {\n    interval.unref();\n  }\n\n  return interval;\n}\n\n/**\n * Create a restartable timer\n */\nexport class Timer {\n  private state: 'init' | 'running' | 'done';\n  private readonly timeout: number;\n  private readonly callback: () => void;\n  private currentTimer: number | NodeJS.Timeout;\n\n  /**\n   * Construct timer\n   * @param {Function} callback Function called when the timer expired\n   * @param {number} timeout duration of the timeout in milliseconds\n   */\n  constructor(callback: () => void, timeout: number) {\n    this.state = 'init';\n    this.timeout = timeout;\n    this.callback = () => {\n      this.state = 'done';\n      callback();\n    };\n  }\n\n  /**\n   * Start timer\n   * @returns {void}\n   */\n  start() {\n    if (this.state !== 'init') {\n      throw new Error(`Can't start the timer when it's in ${this.state} state`);\n    }\n\n    this.startTimer();\n    this.state = 'running';\n  }\n\n  /**\n   * Clear the current timer and start a new one\n   * @returns {void}\n   */\n  reset() {\n    if (this.state !== 'running') {\n      throw new Error(`Can't reset the timer when it's in ${this.state} state`);\n    }\n    this.clearTimer();\n    this.startTimer();\n  }\n\n  /**\n   * Clear the timer\n   * @returns {void}\n   */\n  cancel() {\n    if (this.state !== 'running') {\n      throw new Error(`Can't cancel the timer when it's in ${this.state} state`);\n    }\n    this.clearTimer();\n    this.state = 'done';\n  }\n\n  /**\n   * Create the actual timer\n   * @private\n   * @returns {undefined}\n   */\n  private startTimer() {\n    this.currentTimer = safeSetTimeout(this.callback, this.timeout);\n  }\n\n  /**\n   * Clear the actual timer\n   * @private\n   * @returns {undefined}\n   */\n  private clearTimer() {\n    clearTimeout(this.currentTimer);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAAA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAc,GAAkE;EAC9F,IAAMC,KAAK,GAAGC,UAAU,yBAAS;EAEjC,IAAID,KAAK,CAACE,KAAK,EAAE;IACfF,KAAK,CAACE,KAAK,EAAE;EACf;EAEA,OAAOF,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,eAAe,GAAmE;EAChG,IAAMC,QAAQ,GAAGC,WAAW,yBAAS;EAErC,IAAID,QAAQ,CAACF,KAAK,EAAE;IAClBE,QAAQ,CAACF,KAAK,EAAE;EAClB;EAEA,OAAOE,QAAQ;AACjB;;AAEA;AACA;AACA;AAFA,IAGaE,KAAK;EAMhB;AACF;AACA;AACA;AACA;EACE,eAAYC,QAAoB,EAAEC,OAAe,EAAE;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IACjD,IAAI,CAACC,KAAK,GAAG,MAAM;IACnB,IAAI,CAACD,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACD,QAAQ,GAAG,YAAM;MACpB,KAAI,CAACE,KAAK,GAAG,MAAM;MACnBF,QAAQ,EAAE;IACZ,CAAC;EACH;;EAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,iBAAQ;MACN,IAAI,IAAI,CAACE,KAAK,KAAK,MAAM,EAAE;QACzB,MAAM,IAAIC,KAAK,8CAAuC,IAAI,CAACD,KAAK,YAAS;MAC3E;MAEA,IAAI,CAACE,UAAU,EAAE;MACjB,IAAI,CAACF,KAAK,GAAG,SAAS;IACxB;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,iBAAQ;MACN,IAAI,IAAI,CAACA,KAAK,KAAK,SAAS,EAAE;QAC5B,MAAM,IAAIC,KAAK,8CAAuC,IAAI,CAACD,KAAK,YAAS;MAC3E;MACA,IAAI,CAACG,UAAU,EAAE;MACjB,IAAI,CAACD,UAAU,EAAE;IACnB;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,kBAAS;MACP,IAAI,IAAI,CAACF,KAAK,KAAK,SAAS,EAAE;QAC5B,MAAM,IAAIC,KAAK,+CAAwC,IAAI,CAACD,KAAK,YAAS;MAC5E;MACA,IAAI,CAACG,UAAU,EAAE;MACjB,IAAI,CAACH,KAAK,GAAG,MAAM;IACrB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,sBAAqB;MACnB,IAAI,CAACI,YAAY,GAAGd,cAAc,CAAC,IAAI,CAACQ,QAAQ,EAAE,IAAI,CAACC,OAAO,CAAC;IACjE;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,sBAAqB;MACnBM,YAAY,CAAC,IAAI,CAACD,YAAY,CAAC;IACjC;EAAC;EAAA;AAAA;AAAA"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@webex/common-timers",
-  "version": "3.0.0-beta.21",
+  "version": "3.0.0-beta.210",
   "description": "Timer wrappers to prevent wedging a process open",
   "license": "MIT",
   "main": "dist/index.js",
-  "devMain": "src/index.js",
+  "devMain": "src/index.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/webex/webex-js-sdk.git",

package/src/index.ts

@@ -0,0 +1,116 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+/**
+ * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
+ * wedging the process open unexpectedly.
+ * @param {Mixed} args
+ * @protected
+ * @returns {NodeJS.Timeout|Number}
+ */
+export function safeSetTimeout(...args: Parameters<typeof setTimeout>): number | NodeJS.Timeout {
+  const timer = setTimeout(...args);
+
+  if (timer.unref) {
+    timer.unref();
+  }
+
+  return timer;
+}
+
+/**
+ * Wrapper around setInterval which (in node) unrefs the returned timer to avoid
+ * wedging the process open unexpectedly.
+ * @param {Mixed} args
+ * @protected
+ * @returns {NodeJS.Timeout|Number}
+ */
+export function safeSetInterval(...args: Parameters<typeof setInterval>): number | NodeJS.Timeout {
+  const interval = setInterval(...args);
+
+  if (interval.unref) {
+    interval.unref();
+  }
+
+  return interval;
+}
+
+/**
+ * Create a restartable timer
+ */
+export class Timer {
+  private state: 'init' | 'running' | 'done';
+  private readonly timeout: number;
+  private readonly callback: () => void;
+  private currentTimer: number | NodeJS.Timeout;
+
+  /**
+   * Construct timer
+   * @param {Function} callback Function called when the timer expired
+   * @param {number} timeout duration of the timeout in milliseconds
+   */
+  constructor(callback: () => void, timeout: number) {
+    this.state = 'init';
+    this.timeout = timeout;
+    this.callback = () => {
+      this.state = 'done';
+      callback();
+    };
+  }
+
+  /**
+   * Start timer
+   * @returns {void}
+   */
+  start() {
+    if (this.state !== 'init') {
+      throw new Error(`Can't start the timer when it's in ${this.state} state`);
+    }
+
+    this.startTimer();
+    this.state = 'running';
+  }
+
+  /**
+   * Clear the current timer and start a new one
+   * @returns {void}
+   */
+  reset() {
+    if (this.state !== 'running') {
+      throw new Error(`Can't reset the timer when it's in ${this.state} state`);
+    }
+    this.clearTimer();
+    this.startTimer();
+  }
+
+  /**
+   * Clear the timer
+   * @returns {void}
+   */
+  cancel() {
+    if (this.state !== 'running') {
+      throw new Error(`Can't cancel the timer when it's in ${this.state} state`);
+    }
+    this.clearTimer();
+    this.state = 'done';
+  }
+
+  /**
+   * Create the actual timer
+   * @private
+   * @returns {undefined}
+   */
+  private startTimer() {
+    this.currentTimer = safeSetTimeout(this.callback, this.timeout);
+  }
+
+  /**
+   * Clear the actual timer
+   * @private
+   * @returns {undefined}
+   */
+  private clearTimer() {
+    clearTimeout(this.currentTimer);
+  }
+}

package/test/unit/spec/index.ts

@@ -0,0 +1,136 @@
+import {assert} from '@webex/test-helper-chai';
+import { Timer, safeSetTimeout, safeSetInterval } from "@webex/common-timers";
+import sinon from 'sinon';
+
+describe("commonn timers", () => {
+  let clock
+
+  beforeEach(() => {
+    clock = sinon.useFakeTimers();
+  })
+  after(() => {
+    clock.restore();
+  })
+
+  describe("safeSetTimeout", () => {
+    it("should call the callback when the timer expired", () => {
+      const callback = sinon.fake();
+      const timer = safeSetTimeout(callback, 1000)
+      clock.runAll()
+      assert.calledOnce(callback)
+
+      clearTimeout(timer)
+    });
+  });
+
+  describe("safeSetInterval", () => {
+    it("should start in an interval", () => {
+      const callback = sinon.fake();
+      const timer = safeSetInterval(callback, 1000)
+      clock.tick(2000)
+      assert.calledTwice(callback)
+
+      clearInterval(timer)
+    });
+  });
+
+  describe("Timer", () => {
+
+    describe("start method", () => {
+      it("should call the callback function when the timer expired", () => {
+        const callback = sinon.fake();
+        const timer = new Timer(callback, 1)
+        timer.start();
+        clock.runAll()
+        assert.calledOnce(callback)
+      });
+
+      it("should throw error when start called more than once", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+
+        assert.throws(() => timer.start(), /Can't start the timer when it's in running state/i);
+        timer.cancel();
+      });
+
+      it("should throw error when start called after reset", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+        timer.reset();
+
+        assert.throws(() => timer.start(), /Can't start the timer when it's in running state/i);
+        timer.cancel();
+      });
+
+      it("should throw error when start called after timer canceled", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+        timer.cancel();
+
+        assert.throws(() => timer.start(), /Can't start the timer when it's in done state/i);
+      });
+
+      it("should throw error when start called after timer finished", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+        clock.runAll()
+
+        assert.throws(() => timer.start(), /Can't start the timer when it's in done state/i);
+      });
+    });
+
+    describe("reset method", () => {
+      it("should reset the timer", () => {
+        const callback = sinon.fake();
+        const timer = new Timer(callback, 1000)
+        timer.start();
+        clock.tick(500)
+        timer.reset();
+        clock.tick(500)
+        assert.notCalled(callback)
+        clock.tick(500)
+        assert.calledOnce(callback)
+      });
+
+      it("should throw error when reset called before start", () => {
+        const timer = new Timer(() => {}, 1000)
+
+        assert.throws(() => timer.reset(), /Can't reset the timer when it's in init state/i);
+      });
+
+      it("should throw error when reset called after cancel", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+        timer.cancel();
+
+        assert.throws(() => timer.reset(), /Can't reset the timer when it's in done state/i);
+      });
+    });
+
+    describe("cancel method", () => {
+      it("should stop the timer", () => {
+        const callback = sinon.fake();
+        const timer = new Timer(callback, 1)
+        timer.start();
+        timer.cancel();
+        clock.runAll()
+        assert.notCalled(callback)
+      });
+
+      it("should throw error when cancel called before start", () => {
+        const timer = new Timer(() => {}, 1000)
+
+        assert.throws(() => timer.cancel(), /Can't cancel the timer when it's in init state/i);
+      });
+
+      it("should throw error when cancel called more than once", () => {
+        const timer = new Timer(() => {}, 1000)
+        timer.start();
+        timer.cancel();
+
+        assert.throws(() => timer.cancel(), /Can't cancel the timer when it's in done state/i);
+      });
+
+    });
+  });
+});

package/src/index.js

@@ -1,37 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-/**
- * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
- * wedging the process open unexpectedly.
- * @param {Mixed} args
- * @protected
- * @returns {Timer|Number}
- */
-export function safeSetTimeout(...args) {
-  const timer = setTimeout(...args);
-
-  if (timer.unref) {
-    timer.unref();
-  }
-
-  return timer;
-}
-
-/**
- * Wrapper around setTimout which (in node) unrefs the returned timer to avoid
- * wedging the process open unexpectedly.
- * @param {Mixed} args
- * @protected
- * @returns {Timer|Number}
- */
-export function safeSetInterval(...args) {
-  const interval = setInterval(...args);
-
-  if (interval.unref) {
-    interval.unref();
-  }
-
-  return interval;
-}