@loaders.gl/loader-utils 4.1.3 → 4.1.4

package/dist/index.cjs

@@ -531,10 +531,15 @@ var STAT_QUEUED_REQUESTS_EVER = "Queued Requests Ever";
 var STAT_ACTIVE_REQUESTS_EVER = "Active Requests Ever";
 var DEFAULT_PROPS = {
   id: "request-scheduler",
-  // Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing
+  /** Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing. */
   throttleRequests: true,
-  // The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.
-  maxRequests: 6
+  /** The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit. */
+  maxRequests: 6,
+  /**
+   * Specifies a debounce time, in milliseconds. All requests are queued, until no new requests have
+   * been added to the queue for this amount of time.
+   */
+  debounceTime: 0
 };
 var RequestScheduler = class {
   constructor(props = {}) {
@@ -542,7 +547,7 @@ var RequestScheduler = class {
     /** Tracks the number of active requests and prioritizes/cancels queued requests. */
     this.requestQueue = [];
     this.requestMap = /* @__PURE__ */ new Map();
-    this.deferredUpdate = null;
+    this.updateTimer = null;
     this.props = { ...DEFAULT_PROPS, ...props };
     this.stats = new import_stats.Stats({ id: this.props.id });
     this.stats.get(STAT_QUEUED_REQUESTS);
@@ -602,13 +607,17 @@ var RequestScheduler = class {
   }
   /** We check requests asynchronously, to prevent multiple updates */
   _issueNewRequests() {
-    if (!this.deferredUpdate) {
-      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
     }
+    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceTime);
   }
   /** Refresh all requests  */
   _issueNewRequestsAsync() {
-    this.deferredUpdate = null;
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
+    }
+    this.updateTimer = null;
     const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);
     if (freeSlots === 0) {
       return;

package/dist/json-loader.js

@@ -1,4 +1,4 @@
-const VERSION = typeof "4.1.3" !== 'undefined' ? "4.1.3" : 'latest';
+const VERSION = typeof "4.1.4" !== 'undefined' ? "4.1.4" : 'latest';
 export const JSONLoader = {
   name: 'JSON',
   id: 'json',

package/dist/lib/request-utils/request-scheduler.d.ts

@@ -10,6 +10,7 @@ export type RequestSchedulerProps = {
     id?: string;
     throttleRequests?: boolean;
     maxRequests?: number;
+    debounceTime?: number;
 };
 /** Tracks one request */
 type Request = {
@@ -29,7 +30,7 @@ export default class RequestScheduler {
     /** Tracks the number of active requests and prioritizes/cancels queued requests. */
     private requestQueue;
     private requestMap;
-    private deferredUpdate;
+    private updateTimer;
     constructor(props?: RequestSchedulerProps);
     /**
      * Called by an application that wants to issue a request, without having it deeply queued by the browser

package/dist/lib/request-utils/request-scheduler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-scheduler.d.ts","sourceRoot":"","sources":["../../../src/lib/request-utils/request-scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,KAAK,MAAM,GAAG,GAAG,CAAC;AAClB,KAAK,YAAY,GAAG,MAAM,GAAG,CAAC;AAC9B,KAAK,mBAAmB,GAAG,MAAM,MAAM,CAAC;AACxC,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,YAAY,CAAC;CACpB,GAAG,IAAI,CAAC;AAET,+BAA+B;AAC/B,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAgBF,yBAAyB;AACzB,KAAK,OAAO,GAAG;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,mBAAmB,CAAC;IACjC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAK;IAE/B,oFAAoF;IACpF,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,UAAU,CAAkD;IACpE,OAAO,CAAC,cAAc,CAAa;gBAEvB,KAAK,GAAE,qBAA0B;IAY7C;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,WAAW,GAAE,mBAA6B,GACzC,OAAO,CAAC,aAAa,CAAC;IA0BzB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAuB7C,oEAAoE;IACpE,iBAAiB,IAAI,IAAI;IAMzB,4BAA4B;IAC5B,sBAAsB;IAwBtB,mGAAmG;IACnG,kBAAkB;IAgBlB,sDAAsD;IACtD,cAAc,CAAC,OAAO,KAAA;CAUvB"}
+{"version":3,"file":"request-scheduler.d.ts","sourceRoot":"","sources":["../../../src/lib/request-utils/request-scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,KAAK,MAAM,GAAG,GAAG,CAAC;AAClB,KAAK,YAAY,GAAG,MAAM,GAAG,CAAC;AAC9B,KAAK,mBAAmB,GAAG,MAAM,MAAM,CAAC;AACxC,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,YAAY,CAAC;CACpB,GAAG,IAAI,CAAC;AAET,+BAA+B;AAC/B,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAqBF,yBAAyB;AACzB,KAAK,OAAO,GAAG;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,mBAAmB,CAAC;IACjC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAK;IAE/B,oFAAoF;IACpF,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,UAAU,CAAkD;IACpE,OAAO,CAAC,WAAW,CAA8C;gBAErD,KAAK,GAAE,qBAA0B;IAY7C;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,WAAW,GAAE,mBAA6B,GACzC,OAAO,CAAC,aAAa,CAAC;IA0BzB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAuB7C,oEAAoE;IACpE,iBAAiB,IAAI,IAAI;IAOzB,4BAA4B;IAC5B,sBAAsB;IA0BtB,mGAAmG;IACnG,kBAAkB;IAgBlB,sDAAsD;IACtD,cAAc,CAAC,OAAO,KAAA;CAUvB"}

package/dist/lib/request-utils/request-scheduler.js

@@ -7,7 +7,8 @@ const STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';
 const DEFAULT_PROPS = {
   id: 'request-scheduler',
   throttleRequests: true,
-  maxRequests: 6
+  maxRequests: 6,
+  debounceTime: 0
 };
 export default class RequestScheduler {
   constructor() {
@@ -17,7 +18,7 @@ export default class RequestScheduler {
     this.activeRequestCount = 0;
     this.requestQueue = [];
     this.requestMap = new Map();
-    this.deferredUpdate = null;
+    this.updateTimer = null;
     this.props = {
       ...DEFAULT_PROPS,
       ...props
@@ -77,12 +78,16 @@ export default class RequestScheduler {
     });
   }
   _issueNewRequests() {
-    if (!this.deferredUpdate) {
-      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
     }
+    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceTime);
   }
   _issueNewRequestsAsync() {
-    this.deferredUpdate = null;
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
+    }
+    this.updateTimer = null;
     const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);
     if (freeSlots === 0) {
       return;

package/dist/lib/request-utils/request-scheduler.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-scheduler.js","names":["Stats","STAT_QUEUED_REQUESTS","STAT_ACTIVE_REQUESTS","STAT_CANCELLED_REQUESTS","STAT_QUEUED_REQUESTS_EVER","STAT_ACTIVE_REQUESTS_EVER","DEFAULT_PROPS","id","throttleRequests","maxRequests","RequestScheduler","constructor","props","arguments","length","undefined","stats","activeRequestCount","requestQueue","requestMap","Map","deferredUpdate","get","scheduleRequest","handle","getPriority","Promise","resolve","done","has","request","priority","promise","push","set","_issueNewRequests","_issueRequest","isDone","delete","setTimeout","_issueNewRequestsAsync","freeSlots","Math","max","_updateAllRequests","i","shift","_updateRequest","splice","sort","a","b"],"sources":["../../../src/lib/request-utils/request-scheduler.ts"],"sourcesContent":["import {Stats} from '@probe.gl/stats';\n\ntype Handle = any;\ntype DoneFunction = () => any;\ntype GetPriorityFunction = () => number;\ntype RequestResult = {\n  done: DoneFunction;\n} | null;\n\n/** RequestScheduler Options */\nexport type RequestSchedulerProps = {\n  id?: string;\n  throttleRequests?: boolean;\n  maxRequests?: number;\n};\n\nconst STAT_QUEUED_REQUESTS = 'Queued Requests';\nconst STAT_ACTIVE_REQUESTS = 'Active Requests';\nconst STAT_CANCELLED_REQUESTS = 'Cancelled Requests';\nconst STAT_QUEUED_REQUESTS_EVER = 'Queued Requests Ever';\nconst STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';\n\nconst DEFAULT_PROPS: Required<RequestSchedulerProps> = {\n  id: 'request-scheduler',\n  // Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing\n  throttleRequests: true,\n  // The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.\n  maxRequests: 6\n};\n\n/** Tracks one request */\ntype Request = {\n  handle: Handle;\n  priority: number;\n  getPriority: GetPriorityFunction;\n  resolve?: (value: any) => any;\n};\n\n/**\n * Used to issue a request, without having them \"deeply queued\" by the browser.\n * @todo - Track requests globally, across multiple servers\n */\nexport default class RequestScheduler {\n  readonly props: Required<RequestSchedulerProps>;\n  readonly stats: Stats;\n  activeRequestCount: number = 0;\n\n  /** Tracks the number of active requests and prioritizes/cancels queued requests. */\n  private requestQueue: Request[] = [];\n  private requestMap: Map<Handle, Promise<RequestResult>> = new Map();\n  private deferredUpdate: any = null;\n\n  constructor(props: RequestSchedulerProps = {}) {\n    this.props = {...DEFAULT_PROPS, ...props};\n\n    // Returns the statistics used by the request scheduler.\n    this.stats = new Stats({id: this.props.id});\n    this.stats.get(STAT_QUEUED_REQUESTS);\n    this.stats.get(STAT_ACTIVE_REQUESTS);\n    this.stats.get(STAT_CANCELLED_REQUESTS);\n    this.stats.get(STAT_QUEUED_REQUESTS_EVER);\n    this.stats.get(STAT_ACTIVE_REQUESTS_EVER);\n  }\n\n  /**\n   * Called by an application that wants to issue a request, without having it deeply queued by the browser\n   *\n   * When the returned promise resolved, it is OK for the application to issue a request.\n   * The promise resolves to an object that contains a `done` method.\n   * When the application's request has completed (or failed), the application must call the `done` function\n   *\n   * @param handle\n   * @param getPriority will be called when request \"slots\" open up,\n   *    allowing the caller to update priority or cancel the request\n   *    Highest priority executes first, priority < 0 cancels the request\n   * @returns a promise\n   *   - resolves to a object (with a `done` field) when the request can be issued without queueing,\n   *   - resolves to `null` if the request has been cancelled (by the callback return < 0).\n   *     In this case the application should not issue the request\n   */\n  scheduleRequest(\n    handle: Handle,\n    getPriority: GetPriorityFunction = () => 0\n  ): Promise<RequestResult> {\n    // Allows throttling to be disabled\n    if (!this.props.throttleRequests) {\n      return Promise.resolve({done: () => {}});\n    }\n\n    // dedupe\n    if (this.requestMap.has(handle)) {\n      return this.requestMap.get(handle) as Promise<any>;\n    }\n\n    const request: Request = {handle, priority: 0, getPriority};\n    const promise = new Promise<RequestResult>((resolve) => {\n      // @ts-ignore\n      request.resolve = resolve;\n      return request;\n    });\n\n    this.requestQueue.push(request);\n    this.requestMap.set(handle, promise);\n    this._issueNewRequests();\n    return promise;\n  }\n\n  // PRIVATE\n\n  _issueRequest(request: Request): Promise<any> {\n    const {handle, resolve} = request;\n    let isDone = false;\n\n    const done = () => {\n      // can only be called once\n      if (!isDone) {\n        isDone = true;\n\n        // Stop tracking a request - it has completed, failed, cancelled etc\n        this.requestMap.delete(handle);\n        this.activeRequestCount--;\n        // A slot just freed up, see if any queued requests are waiting\n        this._issueNewRequests();\n      }\n    };\n\n    // Track this request\n    this.activeRequestCount++;\n\n    return resolve ? resolve({done}) : Promise.resolve({done});\n  }\n\n  /** We check requests asynchronously, to prevent multiple updates */\n  _issueNewRequests(): void {\n    if (!this.deferredUpdate) {\n      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);\n    }\n  }\n\n  /** Refresh all requests  */\n  _issueNewRequestsAsync() {\n    // TODO - shouldn't we clear the timeout?\n    this.deferredUpdate = null;\n\n    const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);\n\n    if (freeSlots === 0) {\n      return;\n    }\n\n    this._updateAllRequests();\n\n    // Resolve pending promises for the top-priority requests\n    for (let i = 0; i < freeSlots; ++i) {\n      const request = this.requestQueue.shift();\n      if (request) {\n        this._issueRequest(request); // eslint-disable-line @typescript-eslint/no-floating-promises\n      }\n    }\n\n    // Uncomment to debug\n    // console.log(`${freeSlots} free slots, ${this.requestQueue.length} queued requests`);\n  }\n\n  /** Ensure all requests have updated priorities, and that no longer valid requests are cancelled */\n  _updateAllRequests() {\n    const requestQueue = this.requestQueue;\n    for (let i = 0; i < requestQueue.length; ++i) {\n      const request = requestQueue[i];\n      if (!this._updateRequest(request)) {\n        // Remove the element and make sure to adjust the counter to account for shortened array\n        requestQueue.splice(i, 1);\n        this.requestMap.delete(request.handle);\n        i--;\n      }\n    }\n\n    // Sort the remaining requests based on priority\n    requestQueue.sort((a, b) => a.priority - b.priority);\n  }\n\n  /** Update a single request by calling the callback */\n  _updateRequest(request) {\n    request.priority = request.getPriority(request.handle); // eslint-disable-line callback-return\n\n    // by returning a negative priority, the callback cancels the request\n    if (request.priority < 0) {\n      request.resolve(null);\n      return false;\n    }\n    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,iBAAiB;AAgBrC,MAAMC,oBAAoB,GAAG,iBAAiB;AAC9C,MAAMC,oBAAoB,GAAG,iBAAiB;AAC9C,MAAMC,uBAAuB,GAAG,oBAAoB;AACpD,MAAMC,yBAAyB,GAAG,sBAAsB;AACxD,MAAMC,yBAAyB,GAAG,sBAAsB;AAExD,MAAMC,aAA8C,GAAG;EACrDC,EAAE,EAAE,mBAAmB;EAEvBC,gBAAgB,EAAE,IAAI;EAEtBC,WAAW,EAAE;AACf,CAAC;AAcD,eAAe,MAAMC,gBAAgB,CAAC;EAUpCC,WAAWA,CAAA,EAAoC;IAAA,IAAnCC,KAA4B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAA,KATpCD,KAAK;IAAA,KACLI,KAAK;IAAA,KACdC,kBAAkB,GAAW,CAAC;IAAA,KAGtBC,YAAY,GAAc,EAAE;IAAA,KAC5BC,UAAU,GAAwC,IAAIC,GAAG,CAAC,CAAC;IAAA,KAC3DC,cAAc,GAAQ,IAAI;IAGhC,IAAI,CAACT,KAAK,GAAG;MAAC,GAAGN,aAAa;MAAE,GAAGM;IAAK,CAAC;IAGzC,IAAI,CAACI,KAAK,GAAG,IAAIhB,KAAK,CAAC;MAACO,EAAE,EAAE,IAAI,CAACK,KAAK,CAACL;IAAE,CAAC,CAAC;IAC3C,IAAI,CAACS,KAAK,CAACM,GAAG,CAACrB,oBAAoB,CAAC;IACpC,IAAI,CAACe,KAAK,CAACM,GAAG,CAACpB,oBAAoB,CAAC;IACpC,IAAI,CAACc,KAAK,CAACM,GAAG,CAACnB,uBAAuB,CAAC;IACvC,IAAI,CAACa,KAAK,CAACM,GAAG,CAAClB,yBAAyB,CAAC;IACzC,IAAI,CAACY,KAAK,CAACM,GAAG,CAACjB,yBAAyB,CAAC;EAC3C;EAkBAkB,eAAeA,CACbC,MAAc,EAEU;IAAA,IADxBC,WAAgC,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,MAAM,CAAC;IAG1C,IAAI,CAAC,IAAI,CAACD,KAAK,CAACJ,gBAAgB,EAAE;MAChC,OAAOkB,OAAO,CAACC,OAAO,CAAC;QAACC,IAAI,EAAEA,CAAA,KAAM,CAAC;MAAC,CAAC,CAAC;IAC1C;IAGA,IAAI,IAAI,CAACT,UAAU,CAACU,GAAG,CAACL,MAAM,CAAC,EAAE;MAC/B,OAAO,IAAI,CAACL,UAAU,CAACG,GAAG,CAACE,MAAM,CAAC;IACpC;IAEA,MAAMM,OAAgB,GAAG;MAACN,MAAM;MAAEO,QAAQ,EAAE,CAAC;MAAEN;IAAW,CAAC;IAC3D,MAAMO,OAAO,GAAG,IAAIN,OAAO,CAAiBC,OAAO,IAAK;MAEtDG,OAAO,CAACH,OAAO,GAAGA,OAAO;MACzB,OAAOG,OAAO;IAChB,CAAC,CAAC;IAEF,IAAI,CAACZ,YAAY,CAACe,IAAI,CAACH,OAAO,CAAC;IAC/B,IAAI,CAACX,UAAU,CAACe,GAAG,CAACV,MAAM,EAAEQ,OAAO,CAAC;IACpC,IAAI,CAACG,iBAAiB,CAAC,CAAC;IACxB,OAAOH,OAAO;EAChB;EAIAI,aAAaA,CAACN,OAAgB,EAAgB;IAC5C,MAAM;MAACN,MAAM;MAAEG;IAAO,CAAC,GAAGG,OAAO;IACjC,IAAIO,MAAM,GAAG,KAAK;IAElB,MAAMT,IAAI,GAAGA,CAAA,KAAM;MAEjB,IAAI,CAACS,MAAM,EAAE;QACXA,MAAM,GAAG,IAAI;QAGb,IAAI,CAAClB,UAAU,CAACmB,MAAM,CAACd,MAAM,CAAC;QAC9B,IAAI,CAACP,kBAAkB,EAAE;QAEzB,IAAI,CAACkB,iBAAiB,CAAC,CAAC;MAC1B;IACF,CAAC;IAGD,IAAI,CAAClB,kBAAkB,EAAE;IAEzB,OAAOU,OAAO,GAAGA,OAAO,CAAC;MAACC;IAAI,CAAC,CAAC,GAAGF,OAAO,CAACC,OAAO,CAAC;MAACC;IAAI,CAAC,CAAC;EAC5D;EAGAO,iBAAiBA,CAAA,EAAS;IACxB,IAAI,CAAC,IAAI,CAACd,cAAc,EAAE;MACxB,IAAI,CAACA,cAAc,GAAGkB,UAAU,CAAC,MAAM,IAAI,CAACC,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1E;EACF;EAGAA,sBAAsBA,CAAA,EAAG;IAEvB,IAAI,CAACnB,cAAc,GAAG,IAAI;IAE1B,MAAMoB,SAAS,GAAGC,IAAI,CAACC,GAAG,CAAC,IAAI,CAAC/B,KAAK,CAACH,WAAW,GAAG,IAAI,CAACQ,kBAAkB,EAAE,CAAC,CAAC;IAE/E,IAAIwB,SAAS,KAAK,CAAC,EAAE;MACnB;IACF;IAEA,IAAI,CAACG,kBAAkB,CAAC,CAAC;IAGzB,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,SAAS,EAAE,EAAEI,CAAC,EAAE;MAClC,MAAMf,OAAO,GAAG,IAAI,CAACZ,YAAY,CAAC4B,KAAK,CAAC,CAAC;MACzC,IAAIhB,OAAO,EAAE;QACX,IAAI,CAACM,aAAa,CAACN,OAAO,CAAC;MAC7B;IACF;EAIF;EAGAc,kBAAkBA,CAAA,EAAG;IACnB,MAAM1B,YAAY,GAAG,IAAI,CAACA,YAAY;IACtC,KAAK,IAAI2B,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG3B,YAAY,CAACJ,MAAM,EAAE,EAAE+B,CAAC,EAAE;MAC5C,MAAMf,OAAO,GAAGZ,YAAY,CAAC2B,CAAC,CAAC;MAC/B,IAAI,CAAC,IAAI,CAACE,cAAc,CAACjB,OAAO,CAAC,EAAE;QAEjCZ,YAAY,CAAC8B,MAAM,CAACH,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC1B,UAAU,CAACmB,MAAM,CAACR,OAAO,CAACN,MAAM,CAAC;QACtCqB,CAAC,EAAE;MACL;IACF;IAGA3B,YAAY,CAAC+B,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKD,CAAC,CAACnB,QAAQ,GAAGoB,CAAC,CAACpB,QAAQ,CAAC;EACtD;EAGAgB,cAAcA,CAACjB,OAAO,EAAE;IACtBA,OAAO,CAACC,QAAQ,GAAGD,OAAO,CAACL,WAAW,CAACK,OAAO,CAACN,MAAM,CAAC;IAGtD,IAAIM,OAAO,CAACC,QAAQ,GAAG,CAAC,EAAE;MACxBD,OAAO,CAACH,OAAO,CAAC,IAAI,CAAC;MACrB,OAAO,KAAK;IACd;IACA,OAAO,IAAI;EACb;AACF"}
+{"version":3,"file":"request-scheduler.js","names":["Stats","STAT_QUEUED_REQUESTS","STAT_ACTIVE_REQUESTS","STAT_CANCELLED_REQUESTS","STAT_QUEUED_REQUESTS_EVER","STAT_ACTIVE_REQUESTS_EVER","DEFAULT_PROPS","id","throttleRequests","maxRequests","debounceTime","RequestScheduler","constructor","props","arguments","length","undefined","stats","activeRequestCount","requestQueue","requestMap","Map","updateTimer","get","scheduleRequest","handle","getPriority","Promise","resolve","done","has","request","priority","promise","push","set","_issueNewRequests","_issueRequest","isDone","delete","clearTimeout","setTimeout","_issueNewRequestsAsync","freeSlots","Math","max","_updateAllRequests","i","shift","_updateRequest","splice","sort","a","b"],"sources":["../../../src/lib/request-utils/request-scheduler.ts"],"sourcesContent":["import {Stats} from '@probe.gl/stats';\n\ntype Handle = any;\ntype DoneFunction = () => any;\ntype GetPriorityFunction = () => number;\ntype RequestResult = {\n  done: DoneFunction;\n} | null;\n\n/** RequestScheduler Options */\nexport type RequestSchedulerProps = {\n  id?: string;\n  throttleRequests?: boolean;\n  maxRequests?: number;\n  debounceTime?: number;\n};\n\nconst STAT_QUEUED_REQUESTS = 'Queued Requests';\nconst STAT_ACTIVE_REQUESTS = 'Active Requests';\nconst STAT_CANCELLED_REQUESTS = 'Cancelled Requests';\nconst STAT_QUEUED_REQUESTS_EVER = 'Queued Requests Ever';\nconst STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';\n\nconst DEFAULT_PROPS: Required<RequestSchedulerProps> = {\n  id: 'request-scheduler',\n  /** Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing. */\n  throttleRequests: true,\n  /** The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit. */\n  maxRequests: 6,\n  /**\n   * Specifies a debounce time, in milliseconds. All requests are queued, until no new requests have\n   * been added to the queue for this amount of time.\n   */\n  debounceTime: 0\n};\n\n/** Tracks one request */\ntype Request = {\n  handle: Handle;\n  priority: number;\n  getPriority: GetPriorityFunction;\n  resolve?: (value: any) => any;\n};\n\n/**\n * Used to issue a request, without having them \"deeply queued\" by the browser.\n * @todo - Track requests globally, across multiple servers\n */\nexport default class RequestScheduler {\n  readonly props: Required<RequestSchedulerProps>;\n  readonly stats: Stats;\n  activeRequestCount: number = 0;\n\n  /** Tracks the number of active requests and prioritizes/cancels queued requests. */\n  private requestQueue: Request[] = [];\n  private requestMap: Map<Handle, Promise<RequestResult>> = new Map();\n  private updateTimer: ReturnType<typeof setTimeout> | null = null;\n\n  constructor(props: RequestSchedulerProps = {}) {\n    this.props = {...DEFAULT_PROPS, ...props};\n\n    // Returns the statistics used by the request scheduler.\n    this.stats = new Stats({id: this.props.id});\n    this.stats.get(STAT_QUEUED_REQUESTS);\n    this.stats.get(STAT_ACTIVE_REQUESTS);\n    this.stats.get(STAT_CANCELLED_REQUESTS);\n    this.stats.get(STAT_QUEUED_REQUESTS_EVER);\n    this.stats.get(STAT_ACTIVE_REQUESTS_EVER);\n  }\n\n  /**\n   * Called by an application that wants to issue a request, without having it deeply queued by the browser\n   *\n   * When the returned promise resolved, it is OK for the application to issue a request.\n   * The promise resolves to an object that contains a `done` method.\n   * When the application's request has completed (or failed), the application must call the `done` function\n   *\n   * @param handle\n   * @param getPriority will be called when request \"slots\" open up,\n   *    allowing the caller to update priority or cancel the request\n   *    Highest priority executes first, priority < 0 cancels the request\n   * @returns a promise\n   *   - resolves to a object (with a `done` field) when the request can be issued without queueing,\n   *   - resolves to `null` if the request has been cancelled (by the callback return < 0).\n   *     In this case the application should not issue the request\n   */\n  scheduleRequest(\n    handle: Handle,\n    getPriority: GetPriorityFunction = () => 0\n  ): Promise<RequestResult> {\n    // Allows throttling to be disabled\n    if (!this.props.throttleRequests) {\n      return Promise.resolve({done: () => {}});\n    }\n\n    // dedupe\n    if (this.requestMap.has(handle)) {\n      return this.requestMap.get(handle) as Promise<any>;\n    }\n\n    const request: Request = {handle, priority: 0, getPriority};\n    const promise = new Promise<RequestResult>((resolve) => {\n      // @ts-ignore\n      request.resolve = resolve;\n      return request;\n    });\n\n    this.requestQueue.push(request);\n    this.requestMap.set(handle, promise);\n    this._issueNewRequests();\n    return promise;\n  }\n\n  // PRIVATE\n\n  _issueRequest(request: Request): Promise<any> {\n    const {handle, resolve} = request;\n    let isDone = false;\n\n    const done = () => {\n      // can only be called once\n      if (!isDone) {\n        isDone = true;\n\n        // Stop tracking a request - it has completed, failed, cancelled etc\n        this.requestMap.delete(handle);\n        this.activeRequestCount--;\n        // A slot just freed up, see if any queued requests are waiting\n        this._issueNewRequests();\n      }\n    };\n\n    // Track this request\n    this.activeRequestCount++;\n\n    return resolve ? resolve({done}) : Promise.resolve({done});\n  }\n\n  /** We check requests asynchronously, to prevent multiple updates */\n  _issueNewRequests(): void {\n    if (this.updateTimer !== null) {\n      clearTimeout(this.updateTimer);\n    }\n    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceTime);\n  }\n\n  /** Refresh all requests  */\n  _issueNewRequestsAsync() {\n    if (this.updateTimer !== null) {\n      clearTimeout(this.updateTimer);\n    }\n    this.updateTimer = null;\n\n    const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);\n\n    if (freeSlots === 0) {\n      return;\n    }\n\n    this._updateAllRequests();\n\n    // Resolve pending promises for the top-priority requests\n    for (let i = 0; i < freeSlots; ++i) {\n      const request = this.requestQueue.shift();\n      if (request) {\n        this._issueRequest(request); // eslint-disable-line @typescript-eslint/no-floating-promises\n      }\n    }\n\n    // Uncomment to debug\n    // console.log(`${freeSlots} free slots, ${this.requestQueue.length} queued requests`);\n  }\n\n  /** Ensure all requests have updated priorities, and that no longer valid requests are cancelled */\n  _updateAllRequests() {\n    const requestQueue = this.requestQueue;\n    for (let i = 0; i < requestQueue.length; ++i) {\n      const request = requestQueue[i];\n      if (!this._updateRequest(request)) {\n        // Remove the element and make sure to adjust the counter to account for shortened array\n        requestQueue.splice(i, 1);\n        this.requestMap.delete(request.handle);\n        i--;\n      }\n    }\n\n    // Sort the remaining requests based on priority\n    requestQueue.sort((a, b) => a.priority - b.priority);\n  }\n\n  /** Update a single request by calling the callback */\n  _updateRequest(request) {\n    request.priority = request.getPriority(request.handle); // eslint-disable-line callback-return\n\n    // by returning a negative priority, the callback cancels the request\n    if (request.priority < 0) {\n      request.resolve(null);\n      return false;\n    }\n    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,iBAAiB;AAiBrC,MAAMC,oBAAoB,GAAG,iBAAiB;AAC9C,MAAMC,oBAAoB,GAAG,iBAAiB;AAC9C,MAAMC,uBAAuB,GAAG,oBAAoB;AACpD,MAAMC,yBAAyB,GAAG,sBAAsB;AACxD,MAAMC,yBAAyB,GAAG,sBAAsB;AAExD,MAAMC,aAA8C,GAAG;EACrDC,EAAE,EAAE,mBAAmB;EAEvBC,gBAAgB,EAAE,IAAI;EAEtBC,WAAW,EAAE,CAAC;EAKdC,YAAY,EAAE;AAChB,CAAC;AAcD,eAAe,MAAMC,gBAAgB,CAAC;EAUpCC,WAAWA,CAAA,EAAoC;IAAA,IAAnCC,KAA4B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAA,KATpCD,KAAK;IAAA,KACLI,KAAK;IAAA,KACdC,kBAAkB,GAAW,CAAC;IAAA,KAGtBC,YAAY,GAAc,EAAE;IAAA,KAC5BC,UAAU,GAAwC,IAAIC,GAAG,CAAC,CAAC;IAAA,KAC3DC,WAAW,GAAyC,IAAI;IAG9D,IAAI,CAACT,KAAK,GAAG;MAAC,GAAGP,aAAa;MAAE,GAAGO;IAAK,CAAC;IAGzC,IAAI,CAACI,KAAK,GAAG,IAAIjB,KAAK,CAAC;MAACO,EAAE,EAAE,IAAI,CAACM,KAAK,CAACN;IAAE,CAAC,CAAC;IAC3C,IAAI,CAACU,KAAK,CAACM,GAAG,CAACtB,oBAAoB,CAAC;IACpC,IAAI,CAACgB,KAAK,CAACM,GAAG,CAACrB,oBAAoB,CAAC;IACpC,IAAI,CAACe,KAAK,CAACM,GAAG,CAACpB,uBAAuB,CAAC;IACvC,IAAI,CAACc,KAAK,CAACM,GAAG,CAACnB,yBAAyB,CAAC;IACzC,IAAI,CAACa,KAAK,CAACM,GAAG,CAAClB,yBAAyB,CAAC;EAC3C;EAkBAmB,eAAeA,CACbC,MAAc,EAEU;IAAA,IADxBC,WAAgC,GAAAZ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,MAAM,CAAC;IAG1C,IAAI,CAAC,IAAI,CAACD,KAAK,CAACL,gBAAgB,EAAE;MAChC,OAAOmB,OAAO,CAACC,OAAO,CAAC;QAACC,IAAI,EAAEA,CAAA,KAAM,CAAC;MAAC,CAAC,CAAC;IAC1C;IAGA,IAAI,IAAI,CAACT,UAAU,CAACU,GAAG,CAACL,MAAM,CAAC,EAAE;MAC/B,OAAO,IAAI,CAACL,UAAU,CAACG,GAAG,CAACE,MAAM,CAAC;IACpC;IAEA,MAAMM,OAAgB,GAAG;MAACN,MAAM;MAAEO,QAAQ,EAAE,CAAC;MAAEN;IAAW,CAAC;IAC3D,MAAMO,OAAO,GAAG,IAAIN,OAAO,CAAiBC,OAAO,IAAK;MAEtDG,OAAO,CAACH,OAAO,GAAGA,OAAO;MACzB,OAAOG,OAAO;IAChB,CAAC,CAAC;IAEF,IAAI,CAACZ,YAAY,CAACe,IAAI,CAACH,OAAO,CAAC;IAC/B,IAAI,CAACX,UAAU,CAACe,GAAG,CAACV,MAAM,EAAEQ,OAAO,CAAC;IACpC,IAAI,CAACG,iBAAiB,CAAC,CAAC;IACxB,OAAOH,OAAO;EAChB;EAIAI,aAAaA,CAACN,OAAgB,EAAgB;IAC5C,MAAM;MAACN,MAAM;MAAEG;IAAO,CAAC,GAAGG,OAAO;IACjC,IAAIO,MAAM,GAAG,KAAK;IAElB,MAAMT,IAAI,GAAGA,CAAA,KAAM;MAEjB,IAAI,CAACS,MAAM,EAAE;QACXA,MAAM,GAAG,IAAI;QAGb,IAAI,CAAClB,UAAU,CAACmB,MAAM,CAACd,MAAM,CAAC;QAC9B,IAAI,CAACP,kBAAkB,EAAE;QAEzB,IAAI,CAACkB,iBAAiB,CAAC,CAAC;MAC1B;IACF,CAAC;IAGD,IAAI,CAAClB,kBAAkB,EAAE;IAEzB,OAAOU,OAAO,GAAGA,OAAO,CAAC;MAACC;IAAI,CAAC,CAAC,GAAGF,OAAO,CAACC,OAAO,CAAC;MAACC;IAAI,CAAC,CAAC;EAC5D;EAGAO,iBAAiBA,CAAA,EAAS;IACxB,IAAI,IAAI,CAACd,WAAW,KAAK,IAAI,EAAE;MAC7BkB,YAAY,CAAC,IAAI,CAAClB,WAAW,CAAC;IAChC;IACA,IAAI,CAACA,WAAW,GAAGmB,UAAU,CAAC,MAAM,IAAI,CAACC,sBAAsB,CAAC,CAAC,EAAE,IAAI,CAAC7B,KAAK,CAACH,YAAY,CAAC;EAC7F;EAGAgC,sBAAsBA,CAAA,EAAG;IACvB,IAAI,IAAI,CAACpB,WAAW,KAAK,IAAI,EAAE;MAC7BkB,YAAY,CAAC,IAAI,CAAClB,WAAW,CAAC;IAChC;IACA,IAAI,CAACA,WAAW,GAAG,IAAI;IAEvB,MAAMqB,SAAS,GAAGC,IAAI,CAACC,GAAG,CAAC,IAAI,CAAChC,KAAK,CAACJ,WAAW,GAAG,IAAI,CAACS,kBAAkB,EAAE,CAAC,CAAC;IAE/E,IAAIyB,SAAS,KAAK,CAAC,EAAE;MACnB;IACF;IAEA,IAAI,CAACG,kBAAkB,CAAC,CAAC;IAGzB,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,SAAS,EAAE,EAAEI,CAAC,EAAE;MAClC,MAAMhB,OAAO,GAAG,IAAI,CAACZ,YAAY,CAAC6B,KAAK,CAAC,CAAC;MACzC,IAAIjB,OAAO,EAAE;QACX,IAAI,CAACM,aAAa,CAACN,OAAO,CAAC;MAC7B;IACF;EAIF;EAGAe,kBAAkBA,CAAA,EAAG;IACnB,MAAM3B,YAAY,GAAG,IAAI,CAACA,YAAY;IACtC,KAAK,IAAI4B,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG5B,YAAY,CAACJ,MAAM,EAAE,EAAEgC,CAAC,EAAE;MAC5C,MAAMhB,OAAO,GAAGZ,YAAY,CAAC4B,CAAC,CAAC;MAC/B,IAAI,CAAC,IAAI,CAACE,cAAc,CAAClB,OAAO,CAAC,EAAE;QAEjCZ,YAAY,CAAC+B,MAAM,CAACH,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC3B,UAAU,CAACmB,MAAM,CAACR,OAAO,CAACN,MAAM,CAAC;QACtCsB,CAAC,EAAE;MACL;IACF;IAGA5B,YAAY,CAACgC,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKD,CAAC,CAACpB,QAAQ,GAAGqB,CAAC,CAACrB,QAAQ,CAAC;EACtD;EAGAiB,cAAcA,CAAClB,OAAO,EAAE;IACtBA,OAAO,CAACC,QAAQ,GAAGD,OAAO,CAACL,WAAW,CAACK,OAAO,CAACN,MAAM,CAAC;IAGtD,IAAIM,OAAO,CAACC,QAAQ,GAAG,CAAC,EAAE;MACxBD,OAAO,CAACH,OAAO,CAAC,IAAI,CAAC;MACrB,OAAO,KAAK;IACd;IACA,OAAO,IAAI;EACb;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/loader-utils",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "Framework-independent loaders for 3D graphics formats",
   "license": "MIT",
   "type": "module",
@@ -47,8 +47,8 @@
   "scripts": {},
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/worker-utils": "4.1.3",
+    "@loaders.gl/worker-utils": "4.1.4",
     "@probe.gl/stats": "^4.0.2"
   },
-  "gitHead": "4313c1f68c25723ab3e906db5a6ac65c2e8ac7b6"
+  "gitHead": "e5b4fe1845c1483addfc4c3d630f1617595efbae"
 }

package/src/lib/request-utils/request-scheduler.ts

@@ -12,6 +12,7 @@ export type RequestSchedulerProps = {
   id?: string;
   throttleRequests?: boolean;
   maxRequests?: number;
+  debounceTime?: number;
 };
 
 const STAT_QUEUED_REQUESTS = 'Queued Requests';
@@ -22,10 +23,15 @@ const STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';
 
 const DEFAULT_PROPS: Required<RequestSchedulerProps> = {
   id: 'request-scheduler',
-  // Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing
+  /** Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing. */
   throttleRequests: true,
-  // The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.
-  maxRequests: 6
+  /** The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit. */
+  maxRequests: 6,
+  /**
+   * Specifies a debounce time, in milliseconds. All requests are queued, until no new requests have
+   * been added to the queue for this amount of time.
+   */
+  debounceTime: 0
 };
 
 /** Tracks one request */
@@ -48,7 +54,7 @@ export default class RequestScheduler {
   /** Tracks the number of active requests and prioritizes/cancels queued requests. */
   private requestQueue: Request[] = [];
   private requestMap: Map<Handle, Promise<RequestResult>> = new Map();
-  private deferredUpdate: any = null;
+  private updateTimer: ReturnType<typeof setTimeout> | null = null;
 
   constructor(props: RequestSchedulerProps = {}) {
     this.props = {...DEFAULT_PROPS, ...props};
@@ -132,15 +138,18 @@ export default class RequestScheduler {
 
   /** We check requests asynchronously, to prevent multiple updates */
   _issueNewRequests(): void {
-    if (!this.deferredUpdate) {
-      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
     }
+    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceTime);
   }
 
   /** Refresh all requests  */
   _issueNewRequestsAsync() {
-    // TODO - shouldn't we clear the timeout?
-    this.deferredUpdate = null;
+    if (this.updateTimer !== null) {
+      clearTimeout(this.updateTimer);
+    }
+    this.updateTimer = null;
 
     const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);