import { Cluster } from 'ioredis'; // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore import { CONNECTION_CLOSED_ERROR_MSG } from 'ioredis/built/utils'; import * as semver from 'semver'; import { SpanKind, TelemetryAttributes } from '../enums'; export const errorObject = { value: null }; export function tryCatch(fn, ctx, args) { try { return fn.apply(ctx, args); } catch (e) { errorObject.value = e; return errorObject; } } /** * Checks the size of string for ascii/non-ascii characters * @see https://stackoverflow.com/a/23318053/1347170 * @param str - */ export function lengthInUtf8Bytes(str) { return Buffer.byteLength(str, 'utf8'); } export function isEmpty(obj) { for (const key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { return false; } } return true; } export function array2obj(arr) { const obj = {}; for (let i = 0; i < arr.length; i += 2) { obj[arr[i]] = arr[i + 1]; } return obj; } export function objectToFlatArray(obj) { const arr = []; for (const key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key) && obj[key] !== undefined) { arr[arr.length] = key; arr[arr.length] = obj[key]; } } return arr; } export function delay(ms, abortController) { return new Promise(resolve => { // eslint-disable-next-line prefer-const let timeout; const callback = () => { abortController === null || abortController === void 0 ? void 0 : abortController.signal.removeEventListener('abort', callback); clearTimeout(timeout); resolve(); }; timeout = setTimeout(callback, ms); abortController === null || abortController === void 0 ? void 0 : abortController.signal.addEventListener('abort', callback); }); } export function increaseMaxListeners(emitter, count) { const maxListeners = emitter.getMaxListeners(); emitter.setMaxListeners(maxListeners + count); } export function invertObject(obj) { return Object.entries(obj).reduce((result, [key, value]) => { result[value] = key; return result; }, {}); } export const optsDecodeMap = { de: 'deduplication', fpof: 'failParentOnFailure', cpof: 'continueParentOnFailure', idof: 'ignoreDependencyOnFailure', kl: 'keepLogs', rdof: 'removeDependencyOnFailure', }; export const optsEncodeMap = Object.assign(Object.assign({}, invertObject(optsDecodeMap)), { /*/ Legacy for backwards compatibility */ debounce: 'de' }); export function isRedisInstance(obj) { if (!obj) { return false; } const redisApi = ['connect', 'disconnect', 'duplicate']; return redisApi.every(name => typeof obj[name] === 'function'); } export function isRedisCluster(obj) { return isRedisInstance(obj) && obj.isCluster; } export function decreaseMaxListeners(emitter, count) { increaseMaxListeners(emitter, -count); } export async function removeAllQueueData(client, queueName, prefix = process.env.BULLMQ_TEST_PREFIX || 'bull') { if (client instanceof Cluster) { // todo compat with cluster ? // @see https://github.com/luin/ioredis/issues/175 return Promise.resolve(false); } const pattern = `${prefix}:${queueName}:*`; const removing = await new Promise((resolve, reject) => { const stream = client.scanStream({ match: pattern, }); stream.on('data', (keys) => { if (keys.length) { const pipeline = client.pipeline(); keys.forEach(key => { pipeline.del(key); }); pipeline.exec().catch(error => { reject(error); }); } }); stream.on('end', () => resolve()); stream.on('error', error => reject(error)); }); await removing; await client.quit(); } export function getParentKey(opts) { if (opts) { return `${opts.queue}:${opts.id}`; } } export const clientCommandMessageReg = /ERR unknown command ['`]\s*client\s*['`]/; export const DELAY_TIME_5 = 5000; export const DELAY_TIME_1 = 100; export function isNotConnectionError(error) { const { code, message: errorMessage } = error; return (errorMessage !== CONNECTION_CLOSED_ERROR_MSG && !errorMessage.includes('ECONNREFUSED') && code !== 'ECONNREFUSED'); } export const asyncSend = (proc, msg) => { return new Promise((resolve, reject) => { if (typeof proc.send === 'function') { proc.send(msg, (err) => { if (err) { reject(err); } else { resolve(); } }); } else if (typeof proc.postMessage === 'function') { resolve(proc.postMessage(msg)); } else { resolve(); } }); }; export const childSend = (proc, msg) => asyncSend(proc, msg); export const isRedisVersionLowerThan = (currentVersion, minimumVersion) => { const version = semver.valid(semver.coerce(currentVersion)); return semver.lt(version, minimumVersion); }; export const parseObjectValues = (obj) => { const accumulator = {}; for (const value of Object.entries(obj)) { accumulator[value[0]] = JSON.parse(value[1]); } return accumulator; }; const getCircularReplacer = (rootReference) => { const references = new WeakSet(); references.add(rootReference); return (_, value) => { if (typeof value === 'object' && value !== null) { if (references.has(value)) { return '[Circular]'; } references.add(value); } return value; }; }; export const errorToJSON = (value) => { const error = {}; Object.getOwnPropertyNames(value).forEach(function (propName) { error[propName] = value[propName]; }); return JSON.parse(JSON.stringify(error, getCircularReplacer(value))); }; const INFINITY = 1 / 0; export const toString = (value) => { if (value == null) { return ''; } // Exit early for strings to avoid a performance hit in some environments. if (typeof value === 'string') { return value; } if (Array.isArray(value)) { // Recursively convert values (susceptible to call stack limits). return `${value.map(other => (other == null ? other : toString(other)))}`; } if (typeof value == 'symbol' || Object.prototype.toString.call(value) == '[object Symbol]') { return value.toString(); } const result = `${value}`; return result === '0' && 1 / value === -INFINITY ? '-0' : result; }; export const QUEUE_EVENT_SUFFIX = ':qe'; export function removeUndefinedFields(obj) { const newObj = {}; for (const key in obj) { if (obj[key] !== undefined) { newObj[key] = obj[key]; } } return newObj; } /** * Wraps the code with telemetry and provides a span for configuration. * * @param telemetry - telemetry configuration. If undefined, the callback will be executed without telemetry. * @param spanKind - kind of the span: Producer, Consumer, Internal * @param queueName - queue name * @param operation - operation name (such as add, process, etc) * @param destination - destination name (normally the queue name) * @param callback - code to wrap with telemetry * @param srcPropagationMedatada - * @returns */ export async function trace(telemetry, spanKind, queueName, operation, destination, callback, srcPropagationMetadata) { if (!telemetry) { return callback(); } else { const { tracer, contextManager } = telemetry; const currentContext = contextManager.active(); let parentContext; if (srcPropagationMetadata) { parentContext = contextManager.fromMetadata(currentContext, srcPropagationMetadata); } const spanName = destination ? `${operation} ${destination}` : operation; const span = tracer.startSpan(spanName, { kind: spanKind, }, parentContext); try { span.setAttributes({ [TelemetryAttributes.QueueName]: queueName, [TelemetryAttributes.QueueOperation]: operation, }); let messageContext; let dstPropagationMetadata; if (spanKind === SpanKind.CONSUMER && parentContext) { messageContext = span.setSpanOnContext(parentContext); } else { messageContext = span.setSpanOnContext(currentContext); } if (callback.length == 2) { dstPropagationMetadata = contextManager.getMetadata(messageContext); } return await contextManager.with(messageContext, () => callback(span, dstPropagationMetadata)); } catch (err) { span.recordException(err); throw err; } finally { span.end(); } } } //# sourceMappingURL=index.js.map