@wildix/xbees-conversations-utils 4.0.1 → 4.0.2

package/dist-cjs/rateLimits/generatedMethodNames.js

@@ -0,0 +1,320 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES = exports.CHANNEL_SYNC_METHOD_NAMES = exports.CHANNEL_METHOD_NAMES = exports.STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES = exports.STREAM_CHANNEL_RESULT_METHOD_NAMES = exports.STREAM_SYNC_METHOD_NAMES = exports.STREAM_METHOD_NAMES = void 0;
+exports.STREAM_METHOD_NAMES = [
+    '_addChannelConfig',
+    '_buildWSPayload',
+    '_callClientListeners',
+    '_createImport',
+    '_createImportURL',
+    '_deleteUserMessageReference',
+    '_enrichAxiosOptions',
+    '_getConnectionID',
+    '_getImport',
+    '_getToken',
+    '_handleClientEvent',
+    '_handleUserEvent',
+    '_hasConnectionID',
+    '_isUsingServerAuth',
+    '_listImports',
+    '_logApiError',
+    '_logApiRequest',
+    '_logApiResponse',
+    '_muteStatus',
+    '_normalizeDate',
+    '_normalizeExpiration',
+    '_queryFlagReports',
+    '_queryFlags',
+    '_reviewFlagReport',
+    '_sayHi',
+    '_setToken',
+    '_setupConnection',
+    '_setUser',
+    '_startCleaning',
+    '_unblockMessage',
+    '_updateMemberWatcherReferences',
+    '_updateUserMessageReferences',
+    '_updateUserReferences',
+    '_validateAndGetMessageId',
+    'addDevice',
+    'banUser',
+    'channel',
+    'closeConnection',
+    'commitMessage',
+    'connect',
+    'connectAnonymousUser',
+    'connectUser',
+    'createAbortControllerForNextRequest',
+    'createBlockList',
+    'createCampaign',
+    'createChannelType',
+    'createCommand',
+    'createPermission',
+    'createRole',
+    'createSegment',
+    'createToken',
+    'deactivateUser',
+    'deactivateUsers',
+    'delete',
+    'deleteBlockList',
+    'deleteCampaign',
+    'deleteChannels',
+    'deleteChannelType',
+    'deleteCommand',
+    'deleteMessage',
+    'deletePermission',
+    'deletePushProvider',
+    'deleteRole',
+    'deleteSegment',
+    'deleteUser',
+    'deleteUsers',
+    'devToken',
+    'disconnect',
+    'disconnectUser',
+    'dispatchEvent',
+    'doAxiosRequest',
+    'enrichURL',
+    'errorFromResponse',
+    'exportChannel',
+    'exportChannels',
+    'exportUser',
+    'exportUsers',
+    'flagMessage',
+    'flagUser',
+    'get',
+    'getAppSettings',
+    'getAuthType',
+    'getBlockList',
+    'getCallToken',
+    'getChannelById',
+    'getChannelByMembers',
+    'getChannelType',
+    'getCommand',
+    'getDevices',
+    'getExportChannelStatus',
+    'getMessage',
+    'getPermission',
+    'getRateLimits',
+    'getTask',
+    'getUnreadCount',
+    'getUserAgent',
+    'handleEvent',
+    'handleResponse',
+    'hydrateActiveChannels',
+    'listBlockLists',
+    'listChannelTypes',
+    'listCommands',
+    'listPermissions',
+    'listPushProviders',
+    'listRoles',
+    'markAllRead',
+    'markChannelsRead',
+    'muteUser',
+    'off',
+    'on',
+    'openConnection',
+    'partialUpdateMessage',
+    'partialUpdateUser',
+    'partialUpdateUsers',
+    'patch',
+    'pinMessage',
+    'post',
+    'put',
+    'queryBannedUsers',
+    'queryCampaigns',
+    'queryChannels',
+    'queryMessageFlags',
+    'queryRecipients',
+    'querySegments',
+    'queryUsers',
+    'reactivateUser',
+    'reactivateUsers',
+    'recoverState',
+    'removeDevice',
+    'removeShadowBan',
+    'restoreUsers',
+    'resumeCampaign',
+    'revokeTokens',
+    'revokeUsersToken',
+    'revokeUserToken',
+    'scheduleCampaign',
+    'search',
+    'sendFile',
+    'sendUserCustomEvent',
+    'setAnonymousUser',
+    'setBaseURL',
+    'setGuestUser',
+    'setLocalDevice',
+    'setUser',
+    'setUserAgent',
+    'shadowBan',
+    'stopCampaign',
+    'sync',
+    'testCampaign',
+    'testPushSettings',
+    'testSQSSettings',
+    'translateMessage',
+    'unbanUser',
+    'unblockMessage',
+    'unflagMessage',
+    'unflagUser',
+    'unmuteUser',
+    'unpinMessage',
+    'updateAppSettings',
+    'updateBlockList',
+    'updateCampaign',
+    'updateChannelType',
+    'updateCommand',
+    'updateMessage',
+    'updatePermission',
+    'updateSegment',
+    'updateUser',
+    'updateUsers',
+    'upsertPushProvider',
+    'upsertUser',
+    'upsertUsers',
+    'userMuteStatus',
+    'verifyWebhook',
+];
+exports.STREAM_SYNC_METHOD_NAMES = [
+    '_addChannelConfig',
+    '_buildWSPayload',
+    '_callClientListeners',
+    '_deleteUserMessageReference',
+    '_enrichAxiosOptions',
+    '_getConnectionID',
+    '_getToken',
+    '_handleClientEvent',
+    '_handleUserEvent',
+    '_hasConnectionID',
+    '_isUsingServerAuth',
+    '_logApiError',
+    '_logApiRequest',
+    '_logApiResponse',
+    '_muteStatus',
+    '_normalizeDate',
+    '_normalizeExpiration',
+    '_sayHi',
+    '_setUser',
+    '_startCleaning',
+    '_updateMemberWatcherReferences',
+    '_updateUserMessageReferences',
+    '_updateUserReferences',
+    '_validateAndGetMessageId',
+    'createAbortControllerForNextRequest',
+    'createToken',
+    'devToken',
+    'dispatchEvent',
+    'errorFromResponse',
+    'getAuthType',
+    'getUserAgent',
+    'handleEvent',
+    'handleResponse',
+    'off',
+    'on',
+    'setBaseURL',
+    'setLocalDevice',
+    'setUserAgent',
+    'userMuteStatus',
+    'verifyWebhook',
+];
+exports.STREAM_CHANNEL_RESULT_METHOD_NAMES = [
+    'channel',
+    'getChannelById',
+    'getChannelByMembers',
+    'hydrateActiveChannels',
+    'queryChannels',
+];
+exports.STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES = [
+    'channel',
+    'getChannelById',
+    'getChannelByMembers',
+    'hydrateActiveChannels',
+];
+exports.CHANNEL_METHOD_NAMES = [
+    '_callChannelListeners',
+    '_channelURL',
+    '_checkInitialized',
+    '_countMessageAsUnread',
+    '_disconnect',
+    '_extendEventWithOwnReactions',
+    '_handleChannelEvent',
+    '_initializeState',
+    '_update',
+    'acceptInvite',
+    'addMembers',
+    'addModerators',
+    'assignRoles',
+    'banUser',
+    'clean',
+    'countUnread',
+    'countUnreadMentions',
+    'create',
+    'createCall',
+    'delete',
+    'deleteFile',
+    'deleteImage',
+    'deleteReaction',
+    'demoteModerators',
+    'disableSlowMode',
+    'enableSlowMode',
+    'getClient',
+    'getConfig',
+    'getMessagesById',
+    'getPinnedMessages',
+    'getReactions',
+    'getReplies',
+    'hide',
+    'inviteMembers',
+    'keystroke',
+    'lastMessage',
+    'lastRead',
+    'markRead',
+    'markUnread',
+    'mute',
+    'muteStatus',
+    'off',
+    'on',
+    'query',
+    'queryMembers',
+    'rejectInvite',
+    'removeMembers',
+    'removeShadowBan',
+    'search',
+    'sendAction',
+    'sendEvent',
+    'sendFile',
+    'sendImage',
+    'sendMessage',
+    'sendReaction',
+    'shadowBan',
+    'show',
+    'stopTyping',
+    'stopWatching',
+    'truncate',
+    'unbanUser',
+    'unmute',
+    'update',
+    'updatePartial',
+    'watch',
+];
+exports.CHANNEL_SYNC_METHOD_NAMES = [
+    '_callChannelListeners',
+    '_channelURL',
+    '_checkInitialized',
+    '_countMessageAsUnread',
+    '_disconnect',
+    '_extendEventWithOwnReactions',
+    '_handleChannelEvent',
+    '_initializeState',
+    'clean',
+    'countUnread',
+    'countUnreadMentions',
+    'getConfig',
+    'lastMessage',
+    'lastRead',
+    'muteStatus',
+    'off',
+    'on',
+];
+exports.CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES = ['getClient'];

package/dist-cjs/rateLimits/helpers/RedisCooldown.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCooldown = void 0;
+const constants_1 = require("../constants");
+class RedisCooldown {
+    static resolveRedisKey(cooldownKey, options) {
+        const keyPrefix = options?.keyPrefix ?? constants_1.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX;
+        return `${keyPrefix}${cooldownKey}`;
+    }
+    static async getRemainingMs(cooldownKey, context, options) {
+        const { redis, logger } = context;
+        try {
+            const ttlMs = await redis.pttl(RedisCooldown.resolveRedisKey(cooldownKey, options));
+            if (ttlMs > 0) {
+                return ttlMs;
+            }
+        }
+        catch (error) {
+            logger.warn('Failed to read stream rate-limit cooldown from Redis', {
+                cooldownKey,
+                error,
+            });
+        }
+        return 0;
+    }
+    static async setRemainingMs(cooldownKey, cooldownMs, context, options) {
+        if (cooldownMs <= 0) {
+            return;
+        }
+        const { redis, logger } = context;
+        const redisKey = RedisCooldown.resolveRedisKey(cooldownKey, options);
+        try {
+            await redis.eval(`
+        local key = KEYS[1]
+        local new_ttl = tonumber(ARGV[1])
+        local current_ttl = redis.call('PTTL', key)
+
+        if current_ttl == -2 then
+          redis.call('SET', key, '1', 'PX', new_ttl)
+          return 1
+        end
+
+        if current_ttl == -1 or current_ttl < new_ttl then
+          redis.call('PEXPIRE', key, new_ttl)
+          return 2
+        end
+
+        return 0
+      `, 1, redisKey, cooldownMs.toString());
+        }
+        catch (error) {
+            logger.warn('Failed to write stream rate-limit cooldown to Redis', {
+                cooldownKey,
+                cooldownMs,
+                error,
+            });
+        }
+    }
+    static async setRemainingMsExact(cooldownKey, cooldownMs, context, options) {
+        if (cooldownMs <= 0) {
+            return;
+        }
+        const { redis, logger } = context;
+        try {
+            await redis.set(RedisCooldown.resolveRedisKey(cooldownKey, options), '1', 'PX', cooldownMs);
+        }
+        catch (error) {
+            logger.warn('Failed to write exact stream rate-limit cooldown to Redis', {
+                cooldownKey,
+                cooldownMs,
+                error,
+            });
+        }
+    }
+    static async getValue(cooldownKey, context, options) {
+        const { redis, logger } = context;
+        try {
+            const value = await redis.get(RedisCooldown.resolveRedisKey(cooldownKey, options));
+            if (typeof value === 'string' && value.length > 0) {
+                return value;
+            }
+        }
+        catch (error) {
+            logger.warn('Failed to read stream rate-limit metadata from Redis', {
+                cooldownKey,
+                error,
+            });
+        }
+    }
+    static async setValueWithRemainingMs(cooldownKey, value, cooldownMs, context, options) {
+        if (value.length === 0 || cooldownMs <= 0) {
+            return;
+        }
+        const { redis, logger } = context;
+        try {
+            await redis.eval(`
+        local key = KEYS[1]
+        local value = ARGV[1]
+        local new_ttl = tonumber(ARGV[2])
+        local current_ttl = redis.call('PTTL', key)
+
+        if current_ttl == -2 then
+          redis.call('SET', key, value, 'PX', new_ttl)
+          return 1
+        end
+
+        if current_ttl == -1 or current_ttl < new_ttl then
+          redis.call('SET', key, value, 'PX', new_ttl)
+          return 2
+        end
+
+        redis.call('SET', key, value, 'KEEPTTL')
+        return 0
+      `, 1, RedisCooldown.resolveRedisKey(cooldownKey, options), value, cooldownMs.toString());
+        }
+        catch (error) {
+            logger.warn('Failed to write stream rate-limit metadata to Redis', {
+                cooldownKey,
+                cooldownMs,
+                error,
+            });
+        }
+    }
+    static async setRemainingMsWithValue(cooldownKey, valueKey, value, cooldownMs, context, options) {
+        if (value.length === 0 || cooldownMs <= 0) {
+            return;
+        }
+        const { redis, logger } = context;
+        const cooldownRedisKey = RedisCooldown.resolveRedisKey(cooldownKey, options);
+        const valueRedisKey = RedisCooldown.resolveRedisKey(valueKey, options);
+        try {
+            await redis.eval(`
+        local cooldown_key = KEYS[1]
+        local value_key = KEYS[2]
+        local value = ARGV[1]
+        local new_ttl = tonumber(ARGV[2])
+        local current_ttl = redis.call('PTTL', cooldown_key)
+        local final_ttl = new_ttl
+
+        if current_ttl == -2 then
+          redis.call('SET', cooldown_key, '1', 'PX', new_ttl)
+        elseif current_ttl == -1 or current_ttl < new_ttl then
+          redis.call('PEXPIRE', cooldown_key, new_ttl)
+        else
+          final_ttl = current_ttl
+        end
+
+        redis.call('SET', value_key, value, 'PX', final_ttl)
+        return final_ttl
+      `, 2, cooldownRedisKey, valueRedisKey, value, cooldownMs.toString());
+        }
+        catch (error) {
+            logger.warn('Failed to write stream rate-limit cooldown and metadata to Redis', {
+                cooldownKey,
+                valueKey,
+                cooldownMs,
+                error,
+            });
+        }
+    }
+    static async clear(cooldownKey, context, options) {
+        const { redis, logger } = context;
+        try {
+            await redis.del(RedisCooldown.resolveRedisKey(cooldownKey, options));
+        }
+        catch (error) {
+            logger.warn('Failed to clear stream rate-limit cooldown from Redis', {
+                cooldownKey,
+                error,
+            });
+        }
+    }
+}
+exports.RedisCooldown = RedisCooldown;

package/dist-cjs/rateLimits/helpers/createRateLimitExceededException.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRateLimitExceededException = void 0;
+const xbees_conversations_client_1 = require("@wildix/xbees-conversations-client");
+const constants_1 = require("../constants");
+const RETRY_AFTER_HEADER_PADDING_MS = 3000;
+function toPositiveMilliseconds(milliseconds) {
+    return Math.max(0, Math.ceil(milliseconds));
+}
+function toEpochSecondsFromNow(delayMs) {
+    return Math.ceil((Date.now() + toPositiveMilliseconds(delayMs)) / 1000);
+}
+function createRateLimitExceededException(options = {}) {
+    const { rateLimit, message, operation, retryAfterMs = constants_1.DEFAULT_RETRY_AFTER_MS } = options;
+    const defaultMessage = operation ? `Rate limit exceeded for ${operation}` : 'Rate limit exceeded';
+    const retryAfterFromResetMs = rateLimit?.reset ? rateLimit.reset - Date.now() : undefined;
+    const effectiveRetryAfterMs = retryAfterFromResetMs ?? retryAfterMs;
+    const retryAfterMilliseconds = toPositiveMilliseconds(effectiveRetryAfterMs);
+    const rateLimitResetMilliseconds = rateLimit?.reset
+        ? toPositiveMilliseconds(retryAfterFromResetMs ?? 0)
+        : retryAfterMilliseconds;
+    const retryAfterEpochSeconds = toEpochSecondsFromNow(effectiveRetryAfterMs + RETRY_AFTER_HEADER_PADDING_MS);
+    return new xbees_conversations_client_1.RateLimitExceededException({
+        $metadata: {},
+        message: message || defaultMessage,
+        rateLimitRemaining: rateLimit?.remaining || 0,
+        retryAfter: retryAfterEpochSeconds,
+        rateLimit: rateLimit?.limit?.toString() || 'unknown',
+        rateLimitReset: rateLimitResetMilliseconds,
+    });
+}
+exports.createRateLimitExceededException = createRateLimitExceededException;

package/dist-cjs/rateLimits/helpers/executeWithRateLimitHandling.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeWithRateLimitHandling = void 0;
+const promises_1 = require("node:timers/promises");
+const constants_1 = require("../constants");
+const createRateLimitExceededException_1 = require("./createRateLimitExceededException");
+const processStreamRateLimitException_1 = require("./processStreamRateLimitException");
+const rateLimitSnapshot_1 = require("./rateLimitSnapshot");
+const RedisCooldown_1 = require("./RedisCooldown");
+function calculateRateLimitDelayMs(error, maxDelayMs) {
+    const retryAfterMs = typeof error.rateLimitReset === 'number' && error.rateLimitReset > 0 ? error.rateLimitReset : 0;
+    const hasServerRetryAfter = retryAfterMs > 0;
+    const baseDelayMs = hasServerRetryAfter ? retryAfterMs + constants_1.RETRY_AFTER_BUFFER_MS : constants_1.DEFAULT_RETRY_AFTER_MS;
+    if (baseDelayMs > 0) {
+        const jitterMs = Math.floor(Math.random() * constants_1.DEFAULT_JITTER_MS);
+        const computedDelayMs = baseDelayMs + jitterMs;
+        if (hasServerRetryAfter) {
+            return computedDelayMs;
+        }
+        return Math.min(maxDelayMs, computedDelayMs);
+    }
+    return Math.min(maxDelayMs, constants_1.DEFAULT_MAX_DELAY_MS);
+}
+function getRateLimitMetadataKey(operation) {
+    return `${operation}${constants_1.STREAM_RATE_LIMIT_METADATA_KEY_SUFFIX}`;
+}
+function toCooldownRateLimit(snapshot, cooldownMs) {
+    return {
+        limit: snapshot.limit,
+        remaining: snapshot.remaining,
+        reset: Math.max(snapshot.reset, Date.now() + cooldownMs),
+    };
+}
+function toRateLimitSnapshot(error) {
+    const limit = Number(error.rateLimit);
+    const remaining = error.rateLimitRemaining;
+    const resetMs = error.rateLimitReset;
+    if (!Number.isFinite(limit) ||
+        typeof remaining !== 'number' ||
+        !Number.isFinite(remaining) ||
+        typeof resetMs !== 'number' ||
+        !Number.isFinite(resetMs) ||
+        resetMs <= 0) {
+        return;
+    }
+    return {
+        limit,
+        remaining,
+        reset: Date.now() + resetMs,
+    };
+}
+async function executeWithRateLimitHandling(execute, operation, context, options) {
+    const { logger, redis } = context;
+    const { enableCooldown, maxAttempts, maxDelayMs, maxRetryableDelayMs } = options;
+    let attempt = 1;
+    if (enableCooldown) {
+        const cooldownMs = await RedisCooldown_1.RedisCooldown.getRemainingMs(operation, { redis, logger });
+        if (cooldownMs > 0) {
+            const rateLimitSnapshot = (0, rateLimitSnapshot_1.parseRateLimitSnapshot)(await RedisCooldown_1.RedisCooldown.getValue(getRateLimitMetadataKey(operation), { redis, logger }));
+            logger.warn('Skipping stream request due to active rate-limit cooldown', {
+                operation,
+                cooldown: cooldownMs,
+                rateLimitSnapshot,
+            });
+            throw (0, createRateLimitExceededException_1.createRateLimitExceededException)({
+                operation,
+                retryAfterMs: cooldownMs,
+                rateLimit: rateLimitSnapshot ? toCooldownRateLimit(rateLimitSnapshot, cooldownMs) : undefined,
+            });
+        }
+        const softCooldownMs = await RedisCooldown_1.RedisCooldown.getRemainingMs(constants_1.STREAM_RATE_LIMIT_SOFT_COOLDOWN_KEY, { redis, logger }, { keyPrefix: constants_1.STREAM_RATE_LIMIT_COOLDOWN_KEY_PREFIX });
+        if (softCooldownMs > 0) {
+            logger.debug('Delaying stream request due to active soft rate-limit cooldown', {
+                operation,
+                cooldown: softCooldownMs,
+            });
+            await (0, promises_1.setTimeout)(softCooldownMs);
+        }
+        const budgetCooldownMs = await RedisCooldown_1.RedisCooldown.getRemainingMs(constants_1.STREAM_BUDGET_COOLDOWN_KEY, { redis, logger }, { keyPrefix: constants_1.STREAM_BUDGET_COOLDOWN_KEY_PREFIX });
+        if (budgetCooldownMs > 0) {
+            logger.warn('Delaying stream request due to active budget cooldown', {
+                operation,
+                cooldown: budgetCooldownMs,
+            });
+            let totalBudgetWaitMs = 0;
+            for (;;) {
+                const waitMs = await RedisCooldown_1.RedisCooldown.getRemainingMs(constants_1.STREAM_BUDGET_COOLDOWN_KEY, { redis, logger }, { keyPrefix: constants_1.STREAM_BUDGET_COOLDOWN_KEY_PREFIX });
+                if (waitMs <= 0 || totalBudgetWaitMs >= constants_1.BUDGET_DELAY_MAX_MS) {
+                    break;
+                }
+                const chunkMs = Math.min(waitMs, constants_1.BUDGET_COOLDOWN_SLEEP_CHUNK_MS);
+                await (0, promises_1.setTimeout)(chunkMs);
+                totalBudgetWaitMs += chunkMs;
+            }
+        }
+    }
+    for (;;) {
+        try {
+            return await execute();
+        }
+        catch (error) {
+            const rateLimitError = (0, processStreamRateLimitException_1.processStreamRateLimitException)(error, logger);
+            if (!rateLimitError) {
+                throw error;
+            }
+            const retryAfterMs = calculateRateLimitDelayMs(rateLimitError, maxDelayMs);
+            if (enableCooldown) {
+                const rateLimitSnapshot = toRateLimitSnapshot(rateLimitError);
+                if (rateLimitSnapshot) {
+                    await RedisCooldown_1.RedisCooldown.setRemainingMsWithValue(operation, getRateLimitMetadataKey(operation), (0, rateLimitSnapshot_1.serializeRateLimitSnapshot)(rateLimitSnapshot), retryAfterMs, { redis, logger });
+                }
+                else {
+                    await RedisCooldown_1.RedisCooldown.setRemainingMs(operation, retryAfterMs, { redis, logger });
+                }
+            }
+            if (attempt < maxAttempts && retryAfterMs <= maxRetryableDelayMs) {
+                logger.warn('Retrying stream request after rate limit', {
+                    operation,
+                    attempt,
+                    maxAttempts,
+                    retryAfterMs,
+                    rateLimit: rateLimitError.rateLimit,
+                    rateLimitRemaining: rateLimitError.rateLimitRemaining,
+                    rateLimitReset: rateLimitError.rateLimitReset,
+                });
+                await (0, promises_1.setTimeout)(retryAfterMs);
+                attempt++;
+                continue;
+            }
+            logger.warn('Propagating stream rate limit w/o retry', {
+                operation,
+                attempt,
+                maxAttempts,
+                retryAfterMs,
+                maxRetryableDelayMs,
+                rateLimit: rateLimitError.rateLimit,
+                rateLimitRemaining: rateLimitError.rateLimitRemaining,
+                rateLimitReset: rateLimitError.rateLimitReset,
+            });
+            throw rateLimitError;
+        }
+    }
+}
+exports.executeWithRateLimitHandling = executeWithRateLimitHandling;