Leaking Timeout In LocalQueueDriver · cube-js/cube#4198

(2 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import

good first issuehelp wanted

Description

Describe the bug The LocalQueueDriver leaks setTimeout in a Promise.race.

To Reproduce Steps to reproduce the behavior:

Set continueWaitTimeout to a high number, 20+ seconds or so.
Make a load request to Cubejs
Call shutdown on the server.
Process runs until timeout ends.

Expected behavior Timeout should be canceled if nothing is awaiting it.

In LocalQueueDriver.js,

 async getResultBlocking(queryKey) {
    const resultListKey = this.resultListKey(queryKey);
    if (!this.queryDef[this.redisHash(queryKey)] && !this.resultPromises[resultListKey]) {
      return null;
    }

    const timeoutPromise = (timeout) => new Promise((resolve) => setTimeout(() => resolve(null), timeout));

    const res = await Promise.race([
      this.getResultPromise(resultListKey),

      // LEAKING TIMEOUT HERE

      timeoutPromise(this.continueWaitTimeout * 1000),
    ]);

    if (res) {
      delete this.resultPromises[resultListKey];
    }
    return res;

** Example Config **

    orchestratorOptions: {
      queryCacheOptions: {
        queueOptions: {
          continueWaitTimeout: 30,
        },
      },
    },

Contributor guide

Tech stack: javascriptnodejs
Domain: backend
Issue type: bug
Difficulty: 3
Estimated time: under 1 hour
Activity status: fresh
Clarity: clear
Prerequisites: JavaScript async/awaitPromise.raceclearTimeout
Newbie friendliness: 80
Research direction: The issue is in `LocalQueueDriver.js` in the `getResultBlocking` method. The `timeoutPromise` creates a timeout that is never cleared when the race is won by another promise. To fix, replace the simple timeout with a cancellable promise that calls `clearTimeout` when the race completes. Look at existing patterns in the codebase for cancellable promises or use a wrapper that exposes a resolve function to cancel.