@friggframework/core 2.0.0--canary.658.93c8e07.0 → 2.0.0--canary.656.4fb07b4.0

package/types/module-plugin/index.d.ts

@@ -1,6 +1,6 @@
 declare module "@friggframework/module-plugin" {
   import { Delegate, IFriggDelegate } from "@friggframework/core";
-  import type { RateLimitError, RateLimitHint } from "@friggframework/errors";
+  import type { RateLimitHint } from "@friggframework/errors";
 
   export interface Credential {
     id?: string;
@@ -44,21 +44,12 @@ declare module "@friggframework/module-plugin" {
   };
 
   export type RateLimitPolicy = {
-    /** The key a limit counts against. Default `entity`. */
     scope?: RateLimitScope;
     windows?: RateLimitWindow[];
     maxConcurrency?: number;
-    /** A wait never shorter than this, for every throttled response. */
     minRetryAfterMs?: number;
-    /** The most a request sleeps in process, in total. Default 300000. */
     maxInProcessWaitMs?: number;
-    /** Header parsers, in order. Default all three. */
     parsers?: Array<"retryAfter" | "resetHeaders" | "ietf">;
-    /**
-     * Recognises a limit that is not a plain 429, or names its reason. Returns
-     * null when the response is not a limit. A hint with no time takes its
-     * time from the parsers or the policy.
-     */
     classify?(
       signal: RateLimitSignal
     ): Partial<Omit<RateLimitHint, "source">> & {
@@ -75,8 +66,6 @@ declare module "@friggframework/module-plugin" {
     static requestTimeoutMs?: number;
 
     DLGT_INVALID_AUTH: string;
-    /** Notified with the `RateLimitError` right before a wait that is too long throws. */
-    DLGT_RATE_LIMITED: string;
     requestTimeoutMs: number;
     backOff: number[];
     fetch: any;
@@ -96,12 +85,6 @@ declare module "@friggframework/module-plugin" {
     parseBody(response: any): Promise<any>;
     refreshAuth(): Promise<any>;
     _adoptNewerCredential(): Promise<boolean>;
-    /**
-     * Tells the integration about a `RateLimitError` the module throws itself.
-     * The Requester calls it for its own errors; a module built on a vendor SDK
-     * calls it before its own throw.
-     */
-    _notifyRateLimited(rateLimitError: RateLimitError): Promise<void>;
 
     delegate: any;
     delegateTypes: any[];
@@ -119,7 +102,6 @@ declare module "@friggframework/module-plugin" {
     isRefreshable: boolean;
     refreshCount: number;
     DLGT_INVALID_AUTH: string;
-    DLGT_RATE_LIMITED: string;
     fetch: any;
 
     parseBody(response: any): Promise<any>;
@@ -135,7 +117,6 @@ declare module "@friggframework/module-plugin" {
     _delete(options: RequestOptions): Promise<any>;
     refreshAuth(): Promise<any>;
     _adoptNewerCredential(): Promise<boolean>;
-    _notifyRateLimited(rateLimitError: RateLimitError): Promise<void>;
   }
 
   type RequestOptions = {
@@ -149,6 +130,7 @@ declare module "@friggframework/module-plugin" {
   type RequesterConstructor = {
     backOff?: number[];
     fetch?: any;
+    random?: () => number;
   };
 
   export class ApiKeyRequester

package/integrations/repositories/message-item-shared.js

@@ -1,24 +0,0 @@
-const isItem = (value) =>
-    value !== null && typeof value === 'object' && !Array.isArray(value);
-
-/**
- * The stored shape of a message, for IntegrationRepository
- * .updateIntegrationMessages(). The method takes the positional form (title,
- * body, timestamp) or one item object. The keys of an item object are stored
- * as they are, so a caller can attach what a client acts on, like a code or
- * a list of actions.
- * @param {string|Object} titleOrItem - The title, or the whole item.
- * @param {string} [messageBody] - Ignored when an item is given.
- * @param {number|Date} [messageTimestamp] - Ignored when an item is given.
- * @returns {Object} A new object; the given item is never returned itself.
- */
-function toMessageItem(titleOrItem, messageBody, messageTimestamp) {
-    if (isItem(titleOrItem)) return { ...titleOrItem };
-    return {
-        title: titleOrItem,
-        message: messageBody,
-        timestamp: messageTimestamp,
-    };
-}
-
-module.exports = { toMessageItem };

package/integrations/use-cases/record-rate-limit-message.js

@@ -1,85 +0,0 @@
-const RATE_LIMITED = 'RATE_LIMITED';
-const SAME_LIMIT_WINDOW_MS = 60_000;
-const MINUTE_MS = 60_000;
-
-const isLink = (link) =>
-    typeof link?.label === 'string' && typeof link?.url === 'string';
-
-const linkActions = (links) =>
-    (Array.isArray(links) ? links : [])
-        .filter(isLink)
-        .map(({ label, url }) => ({ type: 'LINK', label, url }));
-
-function utcMinuteAfter(date) {
-    const minute = new Date(Math.ceil(date.getTime() / MINUTE_MS) * MINUTE_MS);
-    return `${minute.toISOString().slice(0, 16).replace('T', ' ')} UTC`;
-}
-
-/**
- * Use case that records one user-facing warning when a module reports a rate
- * limit that is too long to wait for. The text is fixed and the payload's
- * message, url, body and headers are never read, because the message reaches
- * end users. It changes no integration status: a rate limit is not an error.
- * @class RecordRateLimitMessage
- */
-class RecordRateLimitMessage {
-    /**
-     * @param {Object} params - Configuration parameters.
-     * @param {import('../repositories/integration-repository-interface').IntegrationRepositoryInterface} params.integrationRepository - Repository for integration data operations.
-     */
-    constructor({ integrationRepository }) {
-        this.integrationRepository = integrationRepository;
-    }
-
-    /**
-     * Writes the warning, unless the stored warnings already hold one for the
-     * same module whose reset time is within a minute of this one. Many workers
-     * hit one limit together and each reports it, so the check reads the
-     * stored warnings and not the messages of this instance.
-     * @async
-     * @param {string} integrationId - ID of the integration to warn on.
-     * @param {Object} payload - The RATE_LIMITED payload of the Module.
-     * @param {string} payload.moduleName
-     * @param {string} payload.reason
-     * @param {Date|string|number} payload.retryAt
-     * @param {Array<{label: string, url: string}>} [payload.links]
-     * @returns {Promise<boolean>} True when it wrote a warning.
-     * @throws When the read or the write fails; the caller decides what a
-     *   failed warning is worth.
-     */
-    async execute(integrationId, { moduleName, reason, retryAt, links }) {
-        const resetAt = new Date(retryAt);
-        const warnings =
-            await this.integrationRepository.findIntegrationMessages(
-                integrationId,
-                'warnings'
-            );
-        const alreadyRecorded = warnings.some(
-            (warning) =>
-                warning?.code === RATE_LIMITED &&
-                warning.module === moduleName &&
-                Math.abs(Date.parse(warning.retryAt) - resetAt.getTime()) <=
-                    SAME_LIMIT_WINDOW_MS
-        );
-        if (alreadyRecorded) return false;
-
-        const resetsAt = utcMinuteAfter(resetAt);
-        await this.integrationRepository.updateIntegrationMessages(
-            integrationId,
-            'warnings',
-            {
-                title: 'Rate limit reached',
-                message: `The ${moduleName} API rate limit was reached and resets at ${resetsAt}.`,
-                timestamp: Date.now(),
-                code: RATE_LIMITED,
-                module: moduleName,
-                reason,
-                retryAt: resetAt.toISOString(),
-                actions: [{ type: 'RETRY_WHEN_READY' }, ...linkActions(links)],
-            }
-        );
-        return true;
-    }
-}
-
-module.exports = { RecordRateLimitMessage };