utils.js

Filename	Percent	Threshold	Total	Covered	Uncovered
test/utils/utils.js	83.54%	80%	158	132	26

// @ts-check
// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: 2024 CERN (home.cern)

import { isNil, makeDeferred, timeout } from "@cern/nodash";
import { expect } from "chai";
import d from "debug";

const debug = d("test:utils");


/**
 * @param  {() => boolean|any} cb
 * @param {string} [msg]
 * @param  {number} [timeout=1000]
 * @return {Promise<any>}
 */
export function waitFor(cb, msg = undefined, timeout = 1000) {
  var def = makeDeferred();
  var resolved = false;
  var err = new Error(msg || "timeout"); /* create this early to have stacktrace */
  /** @type {NodeJS.Timeout|null} */
  var nextTimer = null;
  var timer = setTimeout(() => {
    resolved = true;
    // @ts-ignore
    clearTimeout(nextTimer);
    def.reject(err);
  }, timeout ?? 1000);


  function next() {
    if (resolved) { return; }
    try {
      var ret = cb(); /* eslint-disable-line callback-return */
      if (ret) {
        clearTimeout(timer);
        resolved = true;
        def.resolve(ret);
      }
      else {
        nextTimer = /** @type {any} */(setTimeout(next, 200));
      }
    }
    catch (e) {
      clearTimeout(timer);
      resolved = true;
      def.reject(!isNil(e?.message) ? e : new Error(e));
    }
  }

  next();
  return def.promise;
}

/**
 * @param  {Function} fun
 */
function throws(fun) {
  try {
    fun();
    return null;
  }
  catch (e) {
    return e.message;
  }
}

/**
 * @template T=any
 * @param  {() => T} test
 * @param  {any} value
 * @param  {string} [msg]
 * @param  {number} [timeout]
 * @return {Promise<T>}
 */
export function waitForValue(test, value,
                             msg = undefined, timeout = undefined) {
  /** @type {any} */
  var _val;
  return waitFor(() => {
    _val = test();
    return throws(() => expect(_val).to.deep.equal(value)) === null;
  }, msg, timeout)
  .catch((err) => {
    const assertMsg = throws(() => expect(_val).to.deep.equal(value)) ||
      ("Invalid result value: " + (_val?.toString?.() ?? _val) + " != " + value);
    if (err instanceof Error) {
      err.message = msg ? `${assertMsg}: (${msg})` : assertMsg;
      throw err;
    }
    throw new Error(msg);
  });
}

/**
 * @param {any} obj
 * @param {string} evt
 * @param {number} [count]
 * @param {number} [ms]
 * @returns {Promise<any>}
 */
export function waitForEvent(obj, evt, count, ms) {
  var def = makeDeferred();
  const stack = (new Error()).stack;
  var ret = [];
  var received = 0;
  count = count ?? 1;

  var cb = function(e) {
    ret.push(e);
    debug(`waitForEvent: received:${evt}`);

    if (++received >= count) {
      def.resolve((count === 1) ? ret[0] : ret);
    }
  };
  obj.on(evt, cb);

  return timeout(def.promise, ms ?? 1000)
  .catch((err) => {
    err.stack = stack;
    throw err;
  })
  .finally(function() {
    if (def.isPending) { def.reject(); }
    obj.removeListener(evt, cb);
  });
}

[{"file":"test/utils/utils.js","line":34,"character":10,"text":"ret","kind":1},{"file":"test/utils/utils.js","line":35,"character":10,"text":"ret","kind":1},{"file":"test/utils/utils.js","line":38,"character":20,"text":"ret","kind":1},{"file":"test/utils/utils.js","line":76,"character":35,"text":"value","kind":1},{"file":"test/utils/utils.js","line":79,"character":6,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":81,"character":4,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":82,"character":31,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":82,"character":51,"text":"value","kind":1},{"file":"test/utils/utils.js","line":84,"character":10,"text":"err","kind":1},{"file":"test/utils/utils.js","line":85,"character":42,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":85,"character":62,"text":"value","kind":1},{"file":"test/utils/utils.js","line":86,"character":35,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":86,"character":57,"text":"_val","kind":1},{"file":"test/utils/utils.js","line":86,"character":74,"text":"value","kind":1},{"file":"test/utils/utils.js","line":87,"character":8,"text":"err","kind":1},{"file":"test/utils/utils.js","line":102,"character":29,"text":"obj","kind":1},{"file":"test/utils/utils.js","line":109,"character":20,"text":"e","kind":1},{"file":"test/utils/utils.js","line":110,"character":13,"text":"e","kind":1},{"file":"test/utils/utils.js","line":117,"character":2,"text":"obj","kind":1},{"file":"test/utils/utils.js","line":117,"character":6,"text":"on","kind":1},{"file":"test/utils/utils.js","line":120,"character":10,"text":"err","kind":1},{"file":"test/utils/utils.js","line":121,"character":4,"text":"err","kind":1},{"file":"test/utils/utils.js","line":121,"character":8,"text":"stack","kind":1},{"file":"test/utils/utils.js","line":122,"character":10,"text":"err","kind":1},{"file":"test/utils/utils.js","line":126,"character":4,"text":"obj","kind":1},{"file":"test/utils/utils.js","line":126,"character":8,"text":"removeListener","kind":1}]

TypeScript coverage report