@wildix/xbees-conversations-utils 1.2.1 → 1.2.3

package/dist-es/rateLimits/createRateLimitedStreamProxy.js

@@ -0,0 +1,88 @@
+import { CHANNEL_SYNC_METHOD_NAMES, CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES, DEFAULT_OPTIONS, STREAM_CHANNEL_RESULT_METHOD_NAMES, STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES, STREAM_SYNC_METHOD_NAMES, } from './constants';
+import { executeWithRateLimitHandling } from './helpers/executeWithRateLimitHandling';
+import { isStreamChannelLike } from './helpers/isStreamChannelLike';
+import { registerStreamInterceptors } from './helpers/registerStreamInterceptors';
+import { splitCallArgsAndOptions } from './helpers/splitCallArgsAndOptions';
+const STREAM_SYNC_METHODS = new Set(STREAM_SYNC_METHOD_NAMES);
+const STREAM_CHANNEL_RESULT_METHODS = new Set(STREAM_CHANNEL_RESULT_METHOD_NAMES);
+const STREAM_SYNC_CHANNEL_RESULT_METHODS = new Set(STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES);
+const CHANNEL_SYNC_METHODS = new Set(CHANNEL_SYNC_METHOD_NAMES);
+const CHANNEL_SYNC_PROXY_RESULT_METHODS = new Set(CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES);
+function wrapKnownChannelResult(result, dependencies) {
+    if (Array.isArray(result)) {
+        return result.map((item) => wrapKnownChannelResult(item, dependencies));
+    }
+    if (typeof result !== 'object' || result === null) {
+        return result;
+    }
+    return wrapTarget(result, dependencies);
+}
+function normalizeStreamCallResult(result, dependencies, wrapAsChannelResult = false) {
+    if (wrapAsChannelResult) {
+        return wrapKnownChannelResult(result, dependencies);
+    }
+    if (Array.isArray(result)) {
+        return result.map((item) => normalizeStreamCallResult(item, dependencies));
+    }
+    if (!isStreamChannelLike(result)) {
+        return result;
+    }
+    return wrapTarget(result, dependencies);
+}
+function createRateLimitedMethodWrapper(target, value, operation, dependencies, wrapAsChannelResult) {
+    return async (...args) => {
+        const { callArgs, callOptions } = splitCallArgsAndOptions(args);
+        const result = await executeWithRateLimitHandling(() => Reflect.apply(value, target, callArgs), operation, dependencies.context, {
+            ...DEFAULT_OPTIONS,
+            ...callOptions,
+        });
+        return normalizeStreamCallResult(result, dependencies, wrapAsChannelResult);
+    };
+}
+function wrapTarget(target, dependencies) {
+    const cachedObject = dependencies.cache.get(target);
+    if (cachedObject) {
+        return cachedObject;
+    }
+    const proxy = new Proxy(target, {
+        get: (originalTarget, property, receiver) => {
+            const value = Reflect.get(originalTarget, property, receiver);
+            if (typeof property !== 'string' || typeof value !== 'function') {
+                return value;
+            }
+            if (STREAM_SYNC_CHANNEL_RESULT_METHODS.has(property)) {
+                return (...args) => {
+                    const { callArgs } = splitCallArgsAndOptions(args);
+                    const result = Reflect.apply(value, originalTarget, callArgs);
+                    return normalizeStreamCallResult(result, dependencies, true);
+                };
+            }
+            if (CHANNEL_SYNC_PROXY_RESULT_METHODS.has(property)) {
+                return (...args) => {
+                    const { callArgs } = splitCallArgsAndOptions(args);
+                    const result = Reflect.apply(value, originalTarget, callArgs);
+                    if (typeof result === 'object' && result !== null) {
+                        return wrapTarget(result, dependencies);
+                    }
+                    return result;
+                };
+            }
+            if (STREAM_SYNC_METHODS.has(property) || CHANNEL_SYNC_METHODS.has(property)) {
+                return (...args) => {
+                    const { callArgs } = splitCallArgsAndOptions(args);
+                    return Reflect.apply(value, originalTarget, callArgs);
+                };
+            }
+            return createRateLimitedMethodWrapper(originalTarget, value, property, dependencies, STREAM_CHANNEL_RESULT_METHODS.has(property));
+        },
+    });
+    dependencies.cache.set(target, proxy);
+    return proxy;
+}
+export function createRateLimitedStreamProxy(stream, context) {
+    registerStreamInterceptors(stream, context);
+    return wrapTarget(stream, {
+        context,
+        cache: new WeakMap(),
+    });
+}

package/dist-es/rateLimits/exception/createRateLimitExceededException.js

@@ -0,0 +1,17 @@
+import {RateLimitExceededException} from '@wildix/xbees-conversations-client';
+
+import {DEFAULT_RETRY_AFTER_MS} from '../constants';
+
+export function createRateLimitExceededException(options = {}) {
+  const {rateLimit, message, operation, retryAfterMs = DEFAULT_RETRY_AFTER_MS} = options;
+  const defaultMessage = operation ? `Rate limit exceeded for ${operation}` : 'Rate limit exceeded';
+
+  return new RateLimitExceededException({
+    $metadata: {},
+    message: message || defaultMessage,
+    rateLimitRemaining: rateLimit?.remaining || 0,
+    retryAfter: rateLimit?.reset ? rateLimit.reset - Date.now() : retryAfterMs,
+    rateLimit: rateLimit?.limit?.toString() || 'unknown',
+    rateLimitReset: rateLimit?.reset || Date.now() + retryAfterMs,
+  });
+}

package/dist-es/rateLimits/exception/processStreamRateLimitException.js

@@ -0,0 +1,37 @@
+import {createRateLimitExceededException} from './createRateLimitExceededException';
+
+function isStreamException(error) {
+  return (
+    typeof error === 'object' &&
+    error !== null &&
+    'metadata' in error &&
+    typeof error.metadata === 'object' &&
+    error.metadata !== null &&
+    'responseCode' in error.metadata
+  );
+}
+
+function isStreamAPIException(error) {
+  return typeof error === 'object' && !!error.code;
+}
+
+export function processStreamRateLimitException(error) {
+  if (isStreamException(error) && error.metadata?.responseCode === 429) {
+    const rateLimit = error.metadata?.rateLimit;
+    console.warn('Stream rate limit exceeded [StreamException]', {rateLimit});
+
+    return createRateLimitExceededException({rateLimit, message: error.message || 'Rate limit exceeded'});
+  }
+
+  if (isStreamAPIException(error) && (error.code === 429 || error.StatusCode === 429)) {
+    console.warn('Stream rate limit exceeded [StreamAPIException]', {code: error.code, StatusCode: error.StatusCode});
+
+    return createRateLimitExceededException({message: error.message || 'Rate limit exceeded'});
+  }
+
+  if (typeof error === 'object' && error !== null && 'status' in error && error.status === 429) {
+    console.warn('Stream rate limit exceeded [error.status === 429]');
+
+    return createRateLimitExceededException({message: 'Rate limit exceeded'});
+  }
+}

package/dist-es/rateLimits/executeStreamRequestWithRateLimitHandling.js

@@ -0,0 +1,93 @@
+import {setTimeout as sleep} from 'node:timers/promises';
+
+import {
+  DEFAULT_FIXED_RATE_LIMIT_DELAY_MS,
+  DEFAULT_JITTER_MS,
+  DEFAULT_OPTS_1_ATTEMPT_NO_COOLDOWN,
+  DEFAULT_RETRY_AFTER_MS,
+  RETRY_AFTER_BUFFER_MS,
+} from './constants';
+import {createRateLimitExceededException} from './exception/createRateLimitExceededException';
+import {processStreamRateLimitException} from './exception/processStreamRateLimitException';
+import {RedisCooldown} from './RedisCooldown';
+
+/** Computes actual backoff delay from rate-limit error and configured caps. */
+function calculateRateLimitDelayMs(error, maxDelayMs) {
+  const retryAfterMs =
+    typeof error.retryAfter === 'number' ? error.retryAfter + RETRY_AFTER_BUFFER_MS : DEFAULT_RETRY_AFTER_MS;
+
+  if (retryAfterMs > 0) {
+    const jitterMs = Math.floor(Math.random() * DEFAULT_JITTER_MS);
+
+    return Math.min(maxDelayMs, retryAfterMs + jitterMs);
+  }
+
+  return Math.min(maxDelayMs, DEFAULT_FIXED_RATE_LIMIT_DELAY_MS);
+}
+
+/** Executes Stream request with cooldown check, retry policy and rate-limit normalization. */
+export async function executeStreamRequestWithRateLimitHandling(execute, operation, context, options = {}) {
+  const {redis} = context;
+  const {enableCooldown, maxAttempts, maxDelayMs, maxRetryableDelayMs} = {
+    ...DEFAULT_OPTS_1_ATTEMPT_NO_COOLDOWN,
+    ...options,
+  };
+  let attempt = 1;
+
+  if (enableCooldown) {
+    const cooldownMs = await RedisCooldown.getRemainingMs(operation, {redis});
+
+    if (cooldownMs > 0) {
+      console.warn('Skipping stream request due to active rate-limit cooldown', {
+        operation,
+        cooldown: cooldownMs,
+      });
+      throw createRateLimitExceededException({operation, retryAfterMs: cooldownMs});
+    }
+  }
+
+  for (;;) {
+    try {
+      return await execute();
+    } catch (error) {
+      const rateLimitError = processStreamRateLimitException(error);
+
+      if (!rateLimitError) {
+        throw error;
+      }
+
+      const retryAfterMs = calculateRateLimitDelayMs(rateLimitError, maxDelayMs);
+
+      if (enableCooldown) {
+        await RedisCooldown.setRemainingMs(operation, retryAfterMs, {redis});
+      }
+
+      if (attempt < maxAttempts && retryAfterMs <= maxRetryableDelayMs) {
+        console.warn('Retrying stream request after rate limit', {
+          operation,
+          attempt,
+          maxAttempts,
+          retryAfterMs,
+          rateLimit: rateLimitError.rateLimit,
+          rateLimitRemaining: rateLimitError.rateLimitRemaining,
+          rateLimitReset: rateLimitError.rateLimitReset,
+        });
+        await sleep(retryAfterMs);
+        attempt++;
+        continue;
+      }
+
+      console.warn('Propagating stream rate limit w/o retry', {
+        operation,
+        attempt,
+        maxAttempts,
+        retryAfterMs,
+        maxRetryableDelayMs,
+        rateLimit: rateLimitError.rateLimit,
+        rateLimitRemaining: rateLimitError.rateLimitRemaining,
+        rateLimitReset: rateLimitError.rateLimitReset,
+      });
+      throw rateLimitError;
+    }
+  }
+}

package/dist-es/rateLimits/generatedMethodNames.js

@@ -0,0 +1,317 @@
+export const 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',
+];
+export const 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',
+];
+export const STREAM_CHANNEL_RESULT_METHOD_NAMES = [
+    'channel',
+    'getChannelById',
+    'getChannelByMembers',
+    'hydrateActiveChannels',
+    'queryChannels',
+];
+export const STREAM_SYNC_CHANNEL_RESULT_METHOD_NAMES = [
+    'channel',
+    'getChannelById',
+    'getChannelByMembers',
+    'hydrateActiveChannels',
+];
+export const 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',
+];
+export const CHANNEL_SYNC_METHOD_NAMES = [
+    '_callChannelListeners',
+    '_channelURL',
+    '_checkInitialized',
+    '_countMessageAsUnread',
+    '_disconnect',
+    '_extendEventWithOwnReactions',
+    '_handleChannelEvent',
+    '_initializeState',
+    'clean',
+    'countUnread',
+    'countUnreadMentions',
+    'getConfig',
+    'lastMessage',
+    'lastRead',
+    'muteStatus',
+    'off',
+    'on',
+];
+export const CHANNEL_SYNC_PROXY_RESULT_METHOD_NAMES = ['getClient'];