@cubejs-backend/query-orchestrator 0.24.0 → 0.24.2

package/orchestrator/QueryQueue.js

@@ -1,381 +1,8 @@
-const R = require('ramda');
-const TimeoutError = require('./TimeoutError');
-const ContinueWaitError = require('./ContinueWaitError');
-const RedisQueueDriver = require('./RedisQueueDriver');
-const LocalQueueDriver = require('./LocalQueueDriver');
+const { QueryQueue } = require('../dist/src/orchestrator/QueryQueue');
 
-class QueryQueue {
-  constructor(redisQueuePrefix, options) {
-    this.redisQueuePrefix = redisQueuePrefix;
-    this.concurrency = options.concurrency || 2;
-    this.continueWaitTimeout = options.continueWaitTimeout || 5;
-    this.executionTimeout = options.executionTimeout || 600;
-    this.orphanedTimeout = options.orphanedTimeout || 120;
-    this.heartBeatInterval = options.heartBeatInterval || 30;
-    this.sendProcessMessageFn = options.sendProcessMessageFn || ((queryKey) => { this.processQuery(queryKey); });
-    this.sendCancelMessageFn = options.sendCancelMessageFn || ((query) => { this.processCancel(query); });
-    this.queryHandlers = options.queryHandlers;
-    this.cancelHandlers = options.cancelHandlers;
-    this.logger = options.logger || ((message, event) => console.log(`${message} ${JSON.stringify(event)}`));
-    const queueDriverOptions = {
-      redisQueuePrefix: this.redisQueuePrefix,
-      concurrency: this.concurrency,
-      continueWaitTimeout: this.continueWaitTimeout,
-      orphanedTimeout: this.orphanedTimeout,
-      heartBeatTimeout: this.heartBeatInterval * 4,
-      redisPool: options.redisPool
-    };
-    this.queueDriver = options.cacheAndQueueDriver === 'redis' ?
-      new RedisQueueDriver(queueDriverOptions) :
-      new LocalQueueDriver(queueDriverOptions);
-  }
-
-  async executeInQueue(queryHandler, queryKey, query, priority, options) {
-    options = options || {};
-    const redisClient = await this.queueDriver.createConnection();
-    try {
-      if (priority == null) {
-        priority = 0;
-      }
-      if (!(priority >= -10000 && priority <= 10000)) {
-        throw new Error('Priority should be between -10000 and 10000');
-      }
-      let result = await redisClient.getResult(queryKey);
-      if (result) {
-        return this.parseResult(result);
-      }
-      const time = new Date().getTime();
-      const keyScore = time + (10000 - priority) * 1E14;
-
-      // eslint-disable-next-line no-unused-vars
-      const [added, b, c, queueSize] = await redisClient.addToQueue(
-        keyScore, queryKey, time, queryHandler, query, priority, options
-      );
-
-      if (added > 0) {
-        this.logger('Added to queue', {
-          priority,
-          queueSize,
-          queryKey,
-          queuePrefix: this.redisQueuePrefix,
-          requestId: options.requestId,
-        });
-      }
-
-      await this.reconcileQueue();
-
-      const queryDef = await redisClient.getQueryDef(queryKey);
-      const [active, toProcess] = await redisClient.getQueryStageState(true);
-
-      if (queryDef) {
-        this.logger('Waiting for query', {
-          queueSize,
-          queryKey: queryDef.queryKey,
-          queuePrefix: this.redisQueuePrefix,
-          requestId: options.requestId,
-          activeQueryKeys: active,
-          toProcessQueryKeys: toProcess,
-          active: active.indexOf(redisClient.redisHash(queryKey)) !== -1,
-          queueIndex: toProcess.indexOf(redisClient.redisHash(queryKey)),
-          waitingForRequestId: queryDef.requestId
-        });
-      }
-
-      result = await redisClient.getResultBlocking(queryKey);
-      if (!result) {
-        throw new ContinueWaitError();
-      }
-      return this.parseResult(result);
-    } finally {
-      this.queueDriver.release(redisClient);
-    }
-  }
-
-  parseResult(result) {
-    if (!result) {
-      return;
-    }
-    if (result.error) {
-      throw new Error(result.error); // TODO
-    } else {
-      // eslint-disable-next-line consistent-return
-      return result.result;
-    }
-  }
-
-  async reconcileQueue() {
-    if (!this.reconcilePromise) {
-      this.reconcileAgain = false;
-      this.reconcilePromise = this.reconcileQueueImpl().then(() => {
-        this.reconcilePromise = null;
-        if (this.reconcileAgain) {
-          return this.reconcileQueue();
-        }
-        return null;
-      });
-    } else {
-      this.reconcileAgain = true;
-    }
-    return this.reconcilePromise;
-  }
-
-  async reconcileQueueImpl() {
-    const redisClient = await this.queueDriver.createConnection();
-    try {
-      const toCancel = (
-        await redisClient.getStalledQueries()
-      ).concat(
-        await redisClient.getOrphanedQueries()
-      );
-
-      await Promise.all(toCancel.map(async queryKey => {
-        const [query] = await redisClient.getQueryAndRemove(queryKey);
-        if (query) {
-          this.logger('Removing orphaned query', {
-            queryKey: query.queryKey,
-            queuePrefix: this.redisQueuePrefix,
-            requestId: query.requestId
-          });
-          await this.sendCancelMessageFn(query);
-        }
-      }));
-
-      const active = await redisClient.getActiveQueries();
-      const toProcess = await redisClient.getToProcessQueries();
-      await Promise.all(
-        R.pipe(
-          R.filter(p => active.indexOf(p) === -1),
-          R.take(this.concurrency),
-          R.map(this.sendProcessMessageFn)
-        )(toProcess)
-      );
-    } finally {
-      this.queueDriver.release(redisClient);
-    }
-  }
-
-  queryTimeout(promise) {
-    let timeout;
-    const { executionTimeout } = this;
-
-    return Promise.race([
-      promise,
-      new Promise((resolve, reject) => {
-        timeout = setTimeout(() => {
-          reject(new TimeoutError(`Query execution timeout after ${executionTimeout / 60} min of waiting`));
-        }, executionTimeout * 1000);
-      }),
-    ]).then((v) => {
-      clearTimeout(timeout);
-      return v;
-    }, (err) => {
-      clearTimeout(timeout);
-      throw err;
-    });
-  }
-
-  async fetchQueryStageState() {
-    const redisClient = await this.queueDriver.createConnection();
-    try {
-      return redisClient.getQueryStageState();
-    } finally {
-      this.queueDriver.release(redisClient);
-    }
-  }
-
-  async getQueryStage(stageQueryKey, priorityFilter, queryStageState) {
-    const [active, toProcess, allQueryDefs] = queryStageState || await this.fetchQueryStageState();
-
-    const queryDefs = toProcess.map(k => allQueryDefs[k]).filter(q => !!q);
-    const queryInQueue = queryDefs.find(q => this.redisHash(q.stageQueryKey) === this.redisHash(stageQueryKey) &&
-      (priorityFilter != null ? q.priority === priorityFilter : true));
-
-    if (queryInQueue) {
-      if (active.indexOf(this.redisHash(queryInQueue.queryKey)) !== -1) {
-        return {
-          stage: 'Executing query',
-          timeElapsed: queryInQueue.startQueryTime ? new Date().getTime() - queryInQueue.startQueryTime : undefined
-        };
-      }
-      const index = queryDefs.filter(q => active.indexOf(this.redisHash(q.queryKey)) === -1).indexOf(queryInQueue);
-      if (index !== -1) {
-        return index !== -1 ? { stage: `#${index + 1} in queue` } : undefined;
-      }
-    }
-
-    return undefined;
-  }
-
-  async processQuery(queryKey) {
-    const redisClient = await this.queueDriver.createConnection();
-    let insertedCount;
-    // eslint-disable-next-line no-unused-vars
-    let removedCount;
-    let activeKeys;
-    let queueSize;
-    let query;
-    let processingLockAcquired;
-    try {
-      const processingId = await redisClient.getNextProcessingId();
-      const retrieveResult = await redisClient.retrieveForProcessing(queryKey, processingId);
-      if (retrieveResult) {
-        [insertedCount, removedCount, activeKeys, queueSize, query, processingLockAcquired] = retrieveResult;
-      }
-      const activated = activeKeys && activeKeys.indexOf(this.redisHash(queryKey)) !== -1;
-      if (!query) {
-        query = await redisClient.getQueryDef(this.redisHash(queryKey));
-      }
-      if (query && insertedCount && activated && processingLockAcquired) {
-        let executionResult;
-        const startQueryTime = (new Date()).getTime();
-        const timeInQueue = (new Date()).getTime() - query.addedToQueueTime;
-        this.logger('Performing query', {
-          processingId,
-          queueSize,
-          queryKey: query.queryKey,
-          queuePrefix: this.redisQueuePrefix,
-          requestId: query.requestId,
-          timeInQueue
-        });
-        await redisClient.optimisticQueryUpdate(queryKey, { startQueryTime }, processingId);
-
-        const heartBeatTimer = setInterval(
-          () => redisClient.updateHeartBeat(queryKey),
-          this.heartBeatInterval * 1000
-        );
-        try {
-          executionResult = {
-            result: await this.queryTimeout(
-              this.queryHandlers[query.queryHandler](
-                query.query,
-                async (cancelHandler) => {
-                  try {
-                    return redisClient.optimisticQueryUpdate(queryKey, { cancelHandler }, processingId);
-                  } catch (e) {
-                    this.logger('Error while query update', {
-                      queryKey: query.queryKey,
-                      error: e.stack || e,
-                      queuePrefix: this.redisQueuePrefix,
-                      requestId: query.requestId
-                    });
-                  }
-                  return null;
-                }
-              )
-            )
-          };
-          this.logger('Performing query completed', {
-            processingId,
-            queueSize,
-            duration: ((new Date()).getTime() - startQueryTime),
-            queryKey: query.queryKey,
-            queuePrefix: this.redisQueuePrefix,
-            requestId: query.requestId,
-            timeInQueue
-          });
-        } catch (e) {
-          executionResult = {
-            error: (e.message || e).toString() // TODO error handling
-          };
-          this.logger('Error while querying', {
-            processingId,
-            queueSize,
-            duration: ((new Date()).getTime() - startQueryTime),
-            queryKey: query.queryKey,
-            queuePrefix: this.redisQueuePrefix,
-            requestId: query.requestId,
-            timeInQueue,
-            error: (e.stack || e).toString()
-          });
-          if (e instanceof TimeoutError) {
-            const queryWithCancelHandle = await redisClient.getQueryDef(queryKey);
-            if (queryWithCancelHandle) {
-              this.logger('Cancelling query due to timeout', {
-                processingId,
-                queryKey: queryWithCancelHandle.queryKey,
-                queuePrefix: this.redisQueuePrefix,
-                requestId: queryWithCancelHandle.requestId
-              });
-              await this.sendCancelMessageFn(queryWithCancelHandle);
-            }
-          }
-        }
-
-        clearInterval(heartBeatTimer);
-
-        if (!(await redisClient.setResultAndRemoveQuery(queryKey, executionResult, processingId))) {
-          this.logger('Orphaned execution result', {
-            processingId,
-            warn: 'Result for query was not set due to processing lock wasn\'t acquired',
-            queryKey: query.queryKey,
-            queuePrefix: this.redisQueuePrefix,
-            requestId: query.requestId
-          });
-        }
-
-        await this.reconcileQueue();
-      } else {
-        this.logger('Skip processing', {
-          processingId,
-          queryKey: query && query.queryKey || queryKey,
-          requestId: query && query.requestId,
-          queuePrefix: this.redisQueuePrefix,
-          processingLockAcquired,
-          query,
-          insertedCount,
-          activeKeys,
-          activated,
-          queryExists: !!query
-        });
-        const currentProcessingId = await redisClient.freeProcessingLock(queryKey, processingId, activated);
-        if (currentProcessingId) {
-          this.logger('Skipping free processing lock', {
-            processingId,
-            currentProcessingId,
-            queryKey: query && query.queryKey || queryKey,
-            requestId: query && query.requestId,
-            queuePrefix: this.redisQueuePrefix,
-            processingLockAcquired,
-            query,
-            insertedCount,
-            activeKeys,
-            activated,
-            queryExists: !!query
-          });
-        }
-      }
-    } catch (e) {
-      this.logger('Queue storage error', {
-        queryKey: query && query.queryKey || queryKey,
-        requestId: query && query.requestId,
-        error: (e.stack || e).toString(),
-        queuePrefix: this.redisQueuePrefix
-      });
-    } finally {
-      this.queueDriver.release(redisClient);
-    }
-  }
-
-  async processCancel(query) {
-    const { queryHandler } = query;
-    try {
-      if (!this.cancelHandlers[queryHandler]) {
-        throw new Error(`No cancel handler for ${queryHandler}`);
-      }
-      await this.cancelHandlers[queryHandler](query);
-    } catch (e) {
-      this.logger('Error while cancel', {
-        queryKey: query.queryKey,
-        error: e.stack || e,
-        queuePrefix: this.redisQueuePrefix,
-        requestId: query.requestId
-      });
-    }
-  }
-
-  redisHash(queryKey) {
-    return this.queueDriver.redisHash(queryKey);
-  }
-}
+process.emitWarning(
+  'Using absolute import with @cubejs-backend/query-orchestrator is deprecated',
+  'DeprecationWarning'
+);
 
 module.exports = QueryQueue;

package/orchestrator/README.md

@@ -0,0 +1,3 @@
+
+This directory will be removed in next major version after full deprecation
+of absolute imports for @cubejs-backend/query-orchestrator

package/orchestrator/RedisCacheDriver.js

@@ -1,48 +1,8 @@
-class RedisCacheDriver {
-  constructor({ pool }) {
-    this.redisPool = pool;
-  }
+const { RedisCacheDriver } = require('../dist/src/orchestrator/RedisCacheDriver');
 
-  async getClient() {
-    return this.redisPool.getClient();
-  }
-
-  async get(key) {
-    const client = await this.getClient();
-    try {
-      const res = await client.getAsync(key);
-      return res && JSON.parse(res);
-    } finally {
-      this.redisPool.release(client);
-    }
-  }
-
-  async set(key, value, expiration) {
-    const client = await this.getClient();
-    try {
-      return await client.setAsync(key, JSON.stringify(value), 'EX', expiration);
-    } finally {
-      this.redisPool.release(client);
-    }
-  }
-
-  async remove(key) {
-    const client = await this.getClient();
-    try {
-      return await client.delAsync(key);
-    } finally {
-      this.redisPool.release(client);
-    }
-  }
-
-  async keysStartingWith(prefix) {
-    const client = await this.getClient();
-    try {
-      return await client.keysAsync(`${prefix}*`);
-    } finally {
-      this.redisPool.release(client);
-    }
-  }
-}
+process.emitWarning(
+  'Using absolute import with @cubejs-backend/query-orchestrator is deprecated',
+  'DeprecationWarning'
+);
 
 module.exports = RedisCacheDriver;

package/orchestrator/RedisFactory.js

@@ -1,48 +1,8 @@
-const redis = require('redis');
-const { promisify } = require('util');
+const { createRedisClient } = require('../dist/src/orchestrator/RedisFactory');
 
-module.exports = function createRedisClient(url) {
-  redis.Multi.prototype.execAsync = function execAsync() {
-    return new Promise((resolve, reject) => this.exec((err, res) => (
-      err ? reject(err) : resolve(res)
-    )));
-  };
+process.emitWarning(
+  'Using absolute import with @cubejs-backend/query-orchestrator is deprecated',
+  'DeprecationWarning'
+);
 
-  const options = {
-    url,
-  };
-
-  if (process.env.REDIS_TLS === 'true') {
-    options.tls = {};
-  }
-
-  if (process.env.REDIS_PASSWORD) {
-    options.password = process.env.REDIS_PASSWORD;
-  }
-
-  const client = redis.createClient(options);
-
-  [
-    'brpop',
-    'del',
-    'get',
-    'hget',
-    'rpop',
-    'set',
-    'zadd',
-    'zrange',
-    'zrangebyscore',
-    'keys',
-    'watch',
-    'unwatch',
-    'incr',
-    'decr',
-    'lpush'
-  ].forEach(
-    k => {
-      client[`${k}Async`] = promisify(client[k]);
-    }
-  );
-
-  return client;
-};
+module.exports = createRedisClient;

package/orchestrator/RedisPool.js

@@ -1,52 +1,8 @@
-const genericPool = require('generic-pool');
-const createRedisClient = require('./RedisFactory');
+const { RedisPool } = require('../dist/src/orchestrator/RedisPool');
 
-class RedisPool {
-  constructor(options) {
-    options = options || {};
-    const defaultMin = process.env.CUBEJS_REDIS_POOL_MIN ? parseInt(process.env.CUBEJS_REDIS_POOL_MIN, 10) : 2;
-    const defaultMax = process.env.CUBEJS_REDIS_POOL_MAX ? parseInt(process.env.CUBEJS_REDIS_POOL_MAX, 10) : 1000;
-    const min = (typeof options.poolMin !== 'undefined') ? options.poolMin : defaultMin;
-    const max = (typeof options.poolMax !== 'undefined') ? options.poolMax : defaultMax;
-    const create = options.createClient || (() => createRedisClient(process.env.REDIS_URL));
-    const destroy = options.destroyClient || (client => client.end(true));
-    const opts = {
-      min,
-      max,
-      acquireTimeoutMillis: 5000,
-      idleTimeoutMillis: 5000,
-      evictionRunIntervalMillis: 5000
-    };
-    if (max > 0) {
-      this.pool = genericPool.createPool({ create, destroy }, opts);
-    } else {
-      // fallback to un-pooled behavior if pool max is 0
-      this.create = create;
-    }
-  }
-
-  async getClient() {
-    if (this.pool) {
-      return this.pool.acquire();
-    } else {
-      return this.create();
-    }
-  }
-
-  release(client) {
-    if (this.pool) {
-      this.pool.release(client);
-    } else if (client) {
-      client.quit();
-    }
-  }
-
-  async cleanup() {
-    if (this.pool) {
-      await this.pool.drain();
-      this.pool.clear();
-    }
-  }
-}
+process.emitWarning(
+  'Using absolute import with @cubejs-backend/query-orchestrator is deprecated',
+  'DeprecationWarning'
+);
 
 module.exports = RedisPool;