174 lines
5.4 KiB
JavaScript
174 lines
5.4 KiB
JavaScript
|
"use strict";
|
||
|
/*
|
||
|
* Copyright 2019 gRPC authors.
|
||
|
*
|
||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
* you may not use this file except in compliance with the License.
|
||
|
* You may obtain a copy of the License at
|
||
|
*
|
||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
*
|
||
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
* See the License for the specific language governing permissions and
|
||
|
* limitations under the License.
|
||
|
*
|
||
|
*/
|
||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||
|
exports.BackoffTimeout = void 0;
|
||
|
const INITIAL_BACKOFF_MS = 1000;
|
||
|
const BACKOFF_MULTIPLIER = 1.6;
|
||
|
const MAX_BACKOFF_MS = 120000;
|
||
|
const BACKOFF_JITTER = 0.2;
|
||
|
/**
|
||
|
* Get a number uniformly at random in the range [min, max)
|
||
|
* @param min
|
||
|
* @param max
|
||
|
*/
|
||
|
function uniformRandom(min, max) {
|
||
|
return Math.random() * (max - min) + min;
|
||
|
}
|
||
|
class BackoffTimeout {
|
||
|
constructor(callback, options) {
|
||
|
this.callback = callback;
|
||
|
/**
|
||
|
* The delay time at the start, and after each reset.
|
||
|
*/
|
||
|
this.initialDelay = INITIAL_BACKOFF_MS;
|
||
|
/**
|
||
|
* The exponential backoff multiplier.
|
||
|
*/
|
||
|
this.multiplier = BACKOFF_MULTIPLIER;
|
||
|
/**
|
||
|
* The maximum delay time
|
||
|
*/
|
||
|
this.maxDelay = MAX_BACKOFF_MS;
|
||
|
/**
|
||
|
* The maximum fraction by which the delay time can randomly vary after
|
||
|
* applying the multiplier.
|
||
|
*/
|
||
|
this.jitter = BACKOFF_JITTER;
|
||
|
/**
|
||
|
* Indicates whether the timer is currently running.
|
||
|
*/
|
||
|
this.running = false;
|
||
|
/**
|
||
|
* Indicates whether the timer should keep the Node process running if no
|
||
|
* other async operation is doing so.
|
||
|
*/
|
||
|
this.hasRef = true;
|
||
|
/**
|
||
|
* The time that the currently running timer was started. Only valid if
|
||
|
* running is true.
|
||
|
*/
|
||
|
this.startTime = new Date();
|
||
|
/**
|
||
|
* The approximate time that the currently running timer will end. Only valid
|
||
|
* if running is true.
|
||
|
*/
|
||
|
this.endTime = new Date();
|
||
|
if (options) {
|
||
|
if (options.initialDelay) {
|
||
|
this.initialDelay = options.initialDelay;
|
||
|
}
|
||
|
if (options.multiplier) {
|
||
|
this.multiplier = options.multiplier;
|
||
|
}
|
||
|
if (options.jitter) {
|
||
|
this.jitter = options.jitter;
|
||
|
}
|
||
|
if (options.maxDelay) {
|
||
|
this.maxDelay = options.maxDelay;
|
||
|
}
|
||
|
}
|
||
|
this.nextDelay = this.initialDelay;
|
||
|
this.timerId = setTimeout(() => { }, 0);
|
||
|
clearTimeout(this.timerId);
|
||
|
}
|
||
|
runTimer(delay) {
|
||
|
var _a, _b;
|
||
|
this.endTime = this.startTime;
|
||
|
this.endTime.setMilliseconds(this.endTime.getMilliseconds() + this.nextDelay);
|
||
|
clearTimeout(this.timerId);
|
||
|
this.timerId = setTimeout(() => {
|
||
|
this.callback();
|
||
|
this.running = false;
|
||
|
}, delay);
|
||
|
if (!this.hasRef) {
|
||
|
(_b = (_a = this.timerId).unref) === null || _b === void 0 ? void 0 : _b.call(_a);
|
||
|
}
|
||
|
}
|
||
|
/**
|
||
|
* Call the callback after the current amount of delay time
|
||
|
*/
|
||
|
runOnce() {
|
||
|
this.running = true;
|
||
|
this.startTime = new Date();
|
||
|
this.runTimer(this.nextDelay);
|
||
|
const nextBackoff = Math.min(this.nextDelay * this.multiplier, this.maxDelay);
|
||
|
const jitterMagnitude = nextBackoff * this.jitter;
|
||
|
this.nextDelay =
|
||
|
nextBackoff + uniformRandom(-jitterMagnitude, jitterMagnitude);
|
||
|
}
|
||
|
/**
|
||
|
* Stop the timer. The callback will not be called until `runOnce` is called
|
||
|
* again.
|
||
|
*/
|
||
|
stop() {
|
||
|
clearTimeout(this.timerId);
|
||
|
this.running = false;
|
||
|
}
|
||
|
/**
|
||
|
* Reset the delay time to its initial value. If the timer is still running,
|
||
|
* retroactively apply that reset to the current timer.
|
||
|
*/
|
||
|
reset() {
|
||
|
this.nextDelay = this.initialDelay;
|
||
|
if (this.running) {
|
||
|
const now = new Date();
|
||
|
const newEndTime = this.startTime;
|
||
|
newEndTime.setMilliseconds(newEndTime.getMilliseconds() + this.nextDelay);
|
||
|
clearTimeout(this.timerId);
|
||
|
if (now < newEndTime) {
|
||
|
this.runTimer(newEndTime.getTime() - now.getTime());
|
||
|
}
|
||
|
else {
|
||
|
this.running = false;
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
/**
|
||
|
* Check whether the timer is currently running.
|
||
|
*/
|
||
|
isRunning() {
|
||
|
return this.running;
|
||
|
}
|
||
|
/**
|
||
|
* Set that while the timer is running, it should keep the Node process
|
||
|
* running.
|
||
|
*/
|
||
|
ref() {
|
||
|
var _a, _b;
|
||
|
this.hasRef = true;
|
||
|
(_b = (_a = this.timerId).ref) === null || _b === void 0 ? void 0 : _b.call(_a);
|
||
|
}
|
||
|
/**
|
||
|
* Set that while the timer is running, it should not keep the Node process
|
||
|
* running.
|
||
|
*/
|
||
|
unref() {
|
||
|
var _a, _b;
|
||
|
this.hasRef = false;
|
||
|
(_b = (_a = this.timerId).unref) === null || _b === void 0 ? void 0 : _b.call(_a);
|
||
|
}
|
||
|
/**
|
||
|
* Get the approximate timestamp of when the timer will fire. Only valid if
|
||
|
* this.isRunning() is true.
|
||
|
*/
|
||
|
getEndTime() {
|
||
|
return this.endTime;
|
||
|
}
|
||
|
}
|
||
|
exports.BackoffTimeout = BackoffTimeout;
|
||
|
//# sourceMappingURL=backoff-timeout.js.map
|