@shushed/helpers 0.0.99 → 0.0.100

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import * as _google_cloud_scheduler_build_protos_protos from '@google-cloud/sche
 import { CloudSchedulerClient } from '@google-cloud/scheduler';
 import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
 import { BigQuery } from '@google-cloud/bigquery';
+import { RedisClientType } from 'redis';
 
 declare const schema$r: {
     readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -33120,6 +33121,23 @@ declare class BigQueryHelper extends Runtime {
     }): Promise<string>;
 }
 
+interface RateLimitLockInfo {
+    id: string;
+    workflowId: string;
+    triggerId: string;
+    url: string;
+    envName: string;
+    creation_time: number;
+    expiration_time: number;
+}
+declare class RateLimit extends Runtime {
+    private redisInstance;
+    constructor(opts: Opts, redisInstance: RedisClientType);
+    acquireLock(id: string, maxConcurrentExecutions: number, expirationInSeconds?: number): Promise<boolean>;
+    releaseLock(id: string): Promise<void>;
+    viewLocks(id: string): Promise<RateLimitLockInfo[]>;
+}
+
 type TriggerOnExecuteOptions = {
     req: {
         status?: number;
@@ -33366,6 +33384,8 @@ type index_Message = Message;
 type index_NodeOptions = NodeOptions;
 type index_PubSubHelper = PubSubHelper;
 declare const index_PubSubHelper: typeof PubSubHelper;
+type index_RateLimit = RateLimit;
+declare const index_RateLimit: typeof RateLimit;
 type index_Runtime = Runtime;
 declare const index_Runtime: typeof Runtime;
 type index_SchedulerHelper = SchedulerHelper;
@@ -33385,7 +33405,7 @@ declare const index_shortHash: typeof shortHash;
 declare const index_validate: typeof validate;
 declare const index_validateGoogleAuth: typeof validateGoogleAuth;
 declare namespace index {
-  export { index_BigQueryHelper as BigQueryHelper, index_CloudTasksHelper as CloudTasksHelper, index_EnvEngine as EnvEngine, type index_ILogging as ILogging, index_JWKSHelper as JWKSHelper, index_Logging as Logging, type index_Message as Message, type index_NodeOptions as NodeOptions, index_PubSubHelper as PubSubHelper, index_Runtime as Runtime, index_SchedulerHelper as SchedulerHelper, index_Secrets as Secrets, type index_TriggerOnCreateOptions as TriggerOnCreateOptions, type index_TriggerOnExecuteOptions as TriggerOnExecuteOptions, index_getEventTime as getEventTime, index_isCloudTask as isCloudTask, index_isCronMessage as isCronMessage, index_isPubSubRequest as isPubSubRequest, index_parseDateOrDefault as parseDateOrDefault, index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_shortHash as shortHash, index_validate as validate, index_validateGoogleAuth as validateGoogleAuth };
+  export { index_BigQueryHelper as BigQueryHelper, index_CloudTasksHelper as CloudTasksHelper, index_EnvEngine as EnvEngine, type index_ILogging as ILogging, index_JWKSHelper as JWKSHelper, index_Logging as Logging, type index_Message as Message, type index_NodeOptions as NodeOptions, index_PubSubHelper as PubSubHelper, index_RateLimit as RateLimit, index_Runtime as Runtime, index_SchedulerHelper as SchedulerHelper, index_Secrets as Secrets, type index_TriggerOnCreateOptions as TriggerOnCreateOptions, type index_TriggerOnExecuteOptions as TriggerOnExecuteOptions, index_getEventTime as getEventTime, index_isCloudTask as isCloudTask, index_isCronMessage as isCronMessage, index_isPubSubRequest as isPubSubRequest, index_parseDateOrDefault as parseDateOrDefault, index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_shortHash as shortHash, index_validate as validate, index_validateGoogleAuth as validateGoogleAuth };
 }
 
 export { index as lib, index$9 as schema, index$1 as types };

package/dist/index.js

@@ -316,6 +316,7 @@ __export(src_public_exports, {
   JWKSHelper: () => jwks_default,
   Logging: () => Logging,
   PubSubHelper: () => pubsub_default,
+  RateLimit: () => RateLimit,
   Runtime: () => Runtime,
   SchedulerHelper: () => scheduler_default,
   Secrets: () => secret_default,
@@ -1880,6 +1881,87 @@ var BigQueryHelper = class extends Runtime {
   }
 };
 var bigquery_default = BigQueryHelper;
+
+// src-public/rateLimit.ts
+function normalizeId(id) {
+  return encodeURIComponent(id);
+}
+var RateLimit = class extends Runtime {
+  redisInstance;
+  constructor(opts, redisInstance) {
+    super(opts);
+    this.redisInstance = redisInstance;
+  }
+  async acquireLock(id, maxConcurrentExecutions, expirationInSeconds = 60 * 5) {
+    const key = `ratelimit:${normalizeId(id)}`;
+    const now = Date.now();
+    const lockInfo = {
+      id,
+      workflowId: this.workflowId,
+      triggerId: this.triggerId,
+      url: this.runtimeUrl,
+      envName: this.envName,
+      creation_time: now,
+      expiration_time: now + expirationInSeconds * 1e3
+    };
+    try {
+      const timeout = 300;
+      const redis = this.redisInstance;
+      await Promise.race([
+        redis.zRemRangeByScore(key, "-inf", now),
+        new Promise((_, reject) => setTimeout(() => reject(new Error("Redis timeout")), timeout))
+      ]);
+      const count = await Promise.race([
+        redis.zCard(key),
+        new Promise((_, reject) => setTimeout(() => reject(new Error("Redis timeout")), timeout))
+      ]);
+      if (count >= maxConcurrentExecutions) {
+        return false;
+      }
+      await Promise.race([
+        redis.zAdd(key, { score: lockInfo.expiration_time, value: JSON.stringify(lockInfo) }),
+        new Promise((_, reject) => setTimeout(() => reject(new Error("Redis timeout")), timeout))
+      ]);
+      await Promise.race([
+        redis.expire(key, expirationInSeconds),
+        new Promise((_, reject) => setTimeout(() => reject(new Error("Redis timeout")), timeout))
+      ]);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async releaseLock(id) {
+    const key = `ratelimit:${normalizeId(id)}`;
+    const redis = this.redisInstance;
+    const locks = await redis.zRange(key, 0, -1);
+    const filtered = locks.filter((lockStr) => {
+      try {
+        const lock = JSON.parse(lockStr);
+        return lock.workflowId === this.workflowId && lock.triggerId === this.triggerId && lock.envName === this.envName && lock.url === this.runtimeUrl;
+      } catch {
+        return false;
+      }
+    });
+    for (const lockStr of filtered) {
+      await redis.zRem(key, lockStr);
+    }
+  }
+  async viewLocks(id) {
+    const key = `ratelimit:${normalizeId(id)}`;
+    const redis = this.redisInstance;
+    const now = Date.now();
+    await redis.zRemRangeByScore(key, "-inf", now);
+    const locks = await redis.zRange(key, 0, -1);
+    return locks.reduce((acc, lockStr) => {
+      try {
+        acc.push(JSON.parse(lockStr));
+      } catch {
+      }
+      return acc;
+    }, []);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   lib,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shushed/helpers",
-  "version": "0.0.99",
+  "version": "0.0.100",
   "author": "",
   "license": "UNLICENSED",
   "description": "",