@dbos-inc/sqs-receive 3.0.10-preview

package/README.md

@@ -0,0 +1,178 @@
+# DBOS AWS Simple Queue Service (SQS) Receiver
+
+Message queues are a common building block for distributed systems. Message queues allow processing to occur at a different place or time, perhaps in another programming environment. Due to its flexibility, robustness, integration, and low cost, [Amazon Simple Queue Service](https://aws.amazon.com/sqs/) is the most popular message queuing service underpinning distributed systems in AWS.
+
+This package includes a [DBOS](https://docs.dbos.dev/) receiver for SQS messages, which invokes a workflow for each message received.
+
+The test in this package also shows wrapping SQS send in a [DBOS step](https://docs.dbos.dev/typescript/tutorials/step-tutorial).
+
+## Getting Started
+
+In order to send and receive messages with SQS, it is necessary to register with AWS, create a queue, and create access keys for the queue. (See [Send Messages Between Distributed Applications](https://aws.amazon.com/getting-started/hands-on/send-messages-distributed-applications/) in AWS documentation.)
+
+## Configuring a DBOS Application with AWS SQS
+
+First, ensure that the DBOS SQS package is installed into the application:
+
+```
+npm install @dbos-inc/sqs-receive
+```
+
+## Receiving Messages
+
+The DBOS SQS receiver provides the capability of running DBOS workflows exactly once per SQS message, even on standard "at-least-once" SQS queues.
+
+The package uses decorators to configure message receipt and identify the functions that will be invoked during message dispatch.
+
+### Imports
+
+First, ensure that the SQS receiver class is imported:
+
+```typescript
+import { SQSReceiver } from '@dbos-inc/dbos-sqs';
+```
+
+### Receiver Configuration
+
+Receiving messages requires:
+
+- Creating an `SQSReceiver` object
+- Providing configuration, so that the receiver can connect to AWS and locate the SQS queues
+- Associating your workflow code with SQS message queues
+- Registering your receiver with DBOS
+
+The SQS Receiver can be configured in 3 ways:
+
+- When constructing the `SQSReceiver` object
+- At the class level, with `@<receiver>.configuration`
+- At the method level, with `@<receiver>.messageConsumer`
+
+```typescript
+// Note the configuration interface is:
+interface SQSConfig {
+  client?: SQSClient | (()=>SQSClient);
+  queueUrl?: string;
+  getWorkflowKey?: (m: Message) => string;
+  workflowQueueName?: string;
+}
+
+// Create a receiver (can configure now, or later...)
+const sqsReceiver = new SQSReceiver();
+
+// Optionally, configure the receiver at the class level
+@sqsReceiver.configure({client: .../*client or function to retrieve client goes here*/})
+class SQSEventProcessor {
+  ...
+}
+```
+
+Then, within the class, one or more `static` workflow methods should be decorated with `@sqsReceiver.messageConsumer` to handle SQS messages:
+
+```typescript
+@sqsReceiver.configure(...)
+class SQSEventProcessor {
+  @sqsReceiver.messageConsumer({ queueUrl: process.env['SQS_QUEUE_URL'] })
+  @DBOS.workflow()
+  static async recvMessage(msg: Message) {
+    // Workflow code goes here...
+  }
+}
+```
+
+Finally, register your SQS receiver, and launch DBOS:
+
+```typescript
+DBOS.registerLifecycleCallback(sqsReceiver);
+await DBOS.launch();
+```
+
+_NOTE:_ The DBOS `@messageConsumer` decorator should be applied to a method decorated with `@DBOS.workflow`.
+
+### Concurrency and Rate Limiting
+
+By default, `@messageConsumer` workflows are started immediately after message receipt. If `workflowQueueName` is specified in the `SQSConfig` at either the method, class, or receiver level, then the workflow will be enqueued in a [workflow queue](https://docs.dbos.dev/typescript/reference/transactapi/workflow-queues).
+
+### Once-And-Only-Once (OAOO) Semantics
+
+Typical application processing for standard SQS queues implements "at least once" processing of the message:
+
+- Receive the message from the SQS queue
+- If necessary, extend the visibility timeout of the message during the course of processing
+- After all processing is complete, delete the message from the queue. If there are any failures,
+  the message will remain in the queue and be redelivered to another consumer.
+
+The DBOS receiver proceeds differently:
+
+- Receive the message from the SQS queue
+- Start a workflow (using an OAOO key computed from the message)
+- Quickly delete the message
+
+This means that, instead of the SQS service redelivering the message in the case of a transient failure, it is up to DBOS to restart any interrupted workflows. Also, since DBOS workflows execute to completion exactly once, it is not necessary to use a SQS FIFO queue for exactly-once processing.
+
+## Simple Testing
+
+The `sqs.test.ts` file included in the source repository demonstrates sending and processing SQS messages. Before running, set the following environment variables:
+
+- `SQS_QUEUE_URL`: SQS queue URL with access for sending and receiving messages
+- `AWS_ENDPOINT_URL_SQS`: SQS endpoint URL
+- `AWS_REGION`: AWS region to use
+- `AWS_ACCESS_KEY_ID`: The access key with permission to use the SQS service
+- `AWS_SECRET_ACCESS_KEY`: The secret access key corresponding to `AWS_ACCESS_KEY_ID`
+
+## Sending Messages
+
+Sending messages in DBOS is done using the AWS libraries directly, with the send call wrapped in a DBOS step to make execution durable.
+
+### Imports
+
+First, ensure that the AWS libraries are imported:
+
+```typescript
+import { Message, SendMessageCommand, SendMessageCommandInput, SQSClient } from '@aws-sdk/client-sqs';
+```
+
+### Sending Code
+
+The code below is just an example. You may choose to create your SQS client and message sending code differently; the key here is that it is registered with DBOS:
+
+```typescript
+// Your preferred method for connecting to SQS
+function createSQS() {
+  return new SQSClient({
+    region: process.env['AWS_REGION'] ?? '',
+    endpoint: process.env['AWS_ENDPOINT_URL_SQS'],
+    credentials: {
+      accessKeyId: process.env['AWS_ACCESS_KEY_ID'] ?? '',
+      secretAccessKey: process.env['AWS_SECRET_ACCESS_KEY'] ?? '',
+    },
+    //logger: console,
+  });
+}
+
+// Maybe you have the URL in each message, or maybe set globally...
+// Create a new type that omits the QueueUrl property
+type MessageWithoutQueueUrl = Omit<SendMessageCommandInput, 'QueueUrl'>;
+
+// Create a new type that allows QueueUrl to be added later
+type MessageWithOptionalQueueUrl = MessageWithoutQueueUrl & { QueueUrl?: string };
+
+// This is the send code, not to be called directly...
+async function sendMessageInternal(msg: MessageWithOptionalQueueUrl) {
+  try {
+    const smsg = { ...msg, QueueUrl: msg.QueueUrl || process.env['SQS_QUEUE_URL']! };
+    return await createSQS().send(new SendMessageCommand(smsg));
+  } catch (e) {
+    DBOS.logger.error(e);
+    throw e;
+  }
+}
+
+// `sendMessageStep(msg)` will be what your workflows actually call.
+const sendMessageStep = DBOS.registerStep(sendMessageInternal, { name: 'Send SQS Message' });
+```
+
+## Next Steps
+
+- To start a DBOS app from a template, visit our [quickstart](https://docs.dbos.dev/quickstart).
+- For DBOS programming tutorials, check out our [programming guide](https://docs.dbos.dev/typescript/programming-guide).
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc/dbos-transact-ts).

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { DBOSLifecycleCallback } from '@dbos-inc/dbos-sdk';
+import { Message, ReceiveMessageCommand, ReceiveMessageCommandOutput, SQSClient } from '@aws-sdk/client-sqs';
+interface SQSConfig {
+    client?: SQSClient | (() => SQSClient);
+    queueUrl?: string;
+    getWorkflowKey?: (m: Message) => string;
+    workflowQueueName?: string;
+}
+declare class SQSReceiver extends DBOSLifecycleCallback {
+    config?: SQSConfig;
+    constructor(config?: SQSConfig);
+    listeners: Promise<void>[];
+    isShuttingDown: boolean;
+    destroy(): Promise<void>;
+    static sendReceiveMessageCommandSafe(sqs: SQSClient, params: ReceiveMessageCommand): Promise<ReceiveMessageCommandOutput>;
+    static validateConnection(client: SQSClient, url: string): Promise<void>;
+    initialize(): Promise<void>;
+    logRegisteredEndpoints(): void;
+    configuration(config: SQSConfig): <T extends new (...args: unknown[]) => object>(ctor: T) => void;
+    messageConsumer(config?: SQSConfig): <This, Args extends [Message], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>;
+}
+export { SQSConfig, SQSReceiver };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAErF,OAAO,EAIL,OAAO,EACP,qBAAqB,EACrB,2BAA2B,EAC3B,SAAS,EACV,MAAM,qBAAqB,CAAC;AAE7B,UAAU,SAAS;IACjB,MAAM,CAAC,EAAE,SAAS,GAAG,CAAC,MAAM,SAAS,CAAC,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IACxC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAUD,cAAM,WAAY,SAAQ,qBAAqB;IAC7C,MAAM,CAAC,EAAE,SAAS,CAAC;gBAEP,MAAM,CAAC,EAAE,SAAS;IAK9B,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAM;IAChC,cAAc,UAAS;IAER,OAAO;WAWT,6BAA6B,CACxC,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,2BAA2B,CAAC;WAS1B,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM;IAS/C,UAAU;IAoGhB,sBAAsB;IAqB/B,aAAa,CAAC,MAAM,EAAE,SAAS,4BAIa,OAAO,EAAE,KAAG,MAAM,QAAU,CAAC;IAQzE,eAAe,CAAC,MAAM,CAAC,EAAE,SAAS,kDAItB,MAAM,eACD,MAAM,gBACL,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,QAAQ,MAAM,CAAC,CAAC,oCAAxC,IAAI,WAAW,IAAI,KAAK,QAAQ,MAAM,CAAC;CAczF;AAED,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQSReceiver = void 0;
+const dbos_sdk_1 = require("@dbos-inc/dbos-sdk");
+const client_sqs_1 = require("@aws-sdk/client-sqs");
+class SQSReceiver extends dbos_sdk_1.DBOSLifecycleCallback {
+    config;
+    constructor(config) {
+        super();
+        this.config = config;
+    }
+    listeners = [];
+    isShuttingDown = false;
+    async destroy() {
+        this.isShuttingDown = true;
+        try {
+            await Promise.allSettled(this.listeners);
+        }
+        catch (e) {
+            // yawn
+        }
+        this.listeners = [];
+    }
+    // async function that uses .then/.catch to handle potentially unreliable library calls
+    static async sendReceiveMessageCommandSafe(sqs, params) {
+        return new Promise((resolve, reject) => {
+            sqs
+                .send(params)
+                .then((response) => resolve(response))
+                .catch((error) => reject(error));
+        });
+    }
+    static async validateConnection(client, url) {
+        const params = {
+            QueueUrl: url,
+            AttributeNames: ['All'],
+        };
+        const _validateSQSConfiguration = await client.send(new client_sqs_1.GetQueueAttributesCommand(params));
+    }
+    async initialize() {
+        const regops = dbos_sdk_1.DBOS.getAssociatedInfo(this);
+        for (const regop of regops) {
+            const { methodConfig, classConfig, methodReg } = regop;
+            const sqsclass = classConfig;
+            const sqsmethod = methodConfig;
+            if (!sqsmethod)
+                continue;
+            const url = sqsclass.config?.queueUrl ?? sqsmethod.config?.queueUrl ?? this.config?.queueUrl;
+            if (!url)
+                continue;
+            const cname = methodReg.className;
+            const mname = methodReg.name;
+            if (!methodReg.workflowConfig) {
+                throw new dbos_sdk_1.Error.DBOSError(`Error registering method ${cname}.${mname}: An SQS decorator can only be assigned to a workflow!`);
+            }
+            let sqs = undefined;
+            if (sqsmethod.config?.client) {
+                sqs = typeof sqsmethod.config.client === 'function' ? sqsmethod.config.client() : sqsmethod.config.client;
+            }
+            else if (sqsclass.config?.client) {
+                sqs = typeof sqsclass.config.client === 'function' ? sqsclass.config.client() : sqsclass.config.client;
+            }
+            else if (this.config?.client) {
+                sqs = typeof this.config.client === 'function' ? this.config.client() : this.config.client;
+            }
+            if (!sqs) {
+                throw new dbos_sdk_1.Error.DBOSError(`Error initializing SQS method ${cname}.${mname}: No SQSClient provided`);
+            }
+            try {
+                await SQSReceiver.validateConnection(sqs, url);
+                dbos_sdk_1.DBOS.logger.info(`Successfully connected to SQS queue ${url} for ${cname}.${mname}`);
+            }
+            catch (e) {
+                const err = e;
+                dbos_sdk_1.DBOS.logger.error(err);
+                throw new dbos_sdk_1.Error.DBOSError(`SQS Receiver for ${cname}.${mname} was unable to connect to ${url}: ${err.message}`);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-this-alias
+            const sqsr = this;
+            this.listeners.push((async (client, url) => {
+                while (!this.isShuttingDown) {
+                    // Get message
+                    try {
+                        const response = await SQSReceiver.sendReceiveMessageCommandSafe(client, new client_sqs_1.ReceiveMessageCommand({
+                            QueueUrl: url,
+                            MaxNumberOfMessages: 1,
+                            WaitTimeSeconds: 5,
+                        }));
+                        if (!response.Messages || response.Messages.length === 0) {
+                            dbos_sdk_1.DBOS.logger.debug(`No messages for ${url} - `);
+                            continue;
+                        }
+                        const message = response.Messages[0];
+                        // Start workflow
+                        let wfid = sqsmethod.config?.getWorkflowKey ? sqsmethod.config.getWorkflowKey(message) : undefined;
+                        if (!wfid) {
+                            wfid = sqsclass.config?.getWorkflowKey ? sqsclass.config.getWorkflowKey(message) : undefined;
+                        }
+                        if (!wfid) {
+                            wfid = sqsr.config?.getWorkflowKey ? sqsr.config.getWorkflowKey(message) : undefined;
+                        }
+                        if (!wfid)
+                            wfid = message.MessageId;
+                        await dbos_sdk_1.DBOS.startWorkflow(methodReg.registeredFunction, {
+                            workflowID: wfid,
+                            queueName: sqsmethod.config?.workflowQueueName ??
+                                sqsclass.config?.workflowQueueName ??
+                                sqsr.config?.workflowQueueName,
+                        })(message);
+                        // Delete the message from the queue after starting workflow (which will take over retries)
+                        await client.send(new client_sqs_1.DeleteMessageCommand({
+                            QueueUrl: url,
+                            ReceiptHandle: message.ReceiptHandle,
+                        }));
+                    }
+                    catch (e) {
+                        dbos_sdk_1.DBOS.logger.error(e);
+                    }
+                }
+            })(sqs, url));
+        }
+    }
+    logRegisteredEndpoints() {
+        dbos_sdk_1.DBOS.logger.info('SQS receiver endpoints:');
+        const eps = dbos_sdk_1.DBOS.getAssociatedInfo(this);
+        for (const e of eps) {
+            const { methodConfig, classConfig, methodReg } = e;
+            const sqsclass = classConfig;
+            const sqsmethod = methodConfig;
+            if (sqsmethod) {
+                const url = sqsclass.config?.queueUrl ?? sqsmethod.config?.queueUrl ?? this.config?.queueUrl;
+                if (url) {
+                    const cname = methodReg.className;
+                    const mname = methodReg.name;
+                    dbos_sdk_1.DBOS.logger.info(`    ${url} -> ${cname}.${mname}`);
+                }
+            }
+        }
+    }
+    // Decorator - class
+    configuration(config) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const er = this;
+        function clsdec(ctor) {
+            const erInfo = dbos_sdk_1.DBOS.associateClassWithInfo(er, ctor);
+            erInfo.config = config;
+        }
+        return clsdec;
+    }
+    // Decorators - method
+    messageConsumer(config) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const er = this;
+        function mtddec(target, propertyKey, inDescriptor) {
+            const { regInfo: receiverInfo } = dbos_sdk_1.DBOS.associateFunctionWithInfo(er, inDescriptor.value, {
+                classOrInst: target,
+                name: propertyKey,
+            });
+            const mRegistration = receiverInfo;
+            mRegistration.config = config;
+            return inDescriptor;
+        }
+        return mtddec;
+    }
+}
+exports.SQSReceiver = SQSReceiver;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,iDAAqF;AAErF,oDAQ6B;AAiB7B,MAAM,WAAY,SAAQ,gCAAqB;IAC7C,MAAM,CAAa;IAEnB,YAAY,MAAkB;QAC5B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,SAAS,GAAoB,EAAE,CAAC;IAChC,cAAc,GAAG,KAAK,CAAC;IAEd,KAAK,CAAC,OAAO;QACpB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,uFAAuF;IACvF,MAAM,CAAC,KAAK,CAAC,6BAA6B,CACxC,GAAc,EACd,MAA6B;QAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,GAAG;iBACA,IAAI,CAAC,MAAM,CAAC;iBACZ,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBACrC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAc,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAiB,EAAE,GAAW;QAC5D,MAAM,MAAM,GAAmC;YAC7C,QAAQ,EAAE,GAAG;YACb,cAAc,EAAE,CAAC,KAAK,CAAC;SACxB,CAAC;QAEF,MAAM,yBAAyB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,sCAAyB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7F,CAAC;IAEQ,KAAK,CAAC,UAAU;QACvB,MAAM,MAAM,GAAG,eAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE5C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;YACvD,MAAM,QAAQ,GAAG,WAAiC,CAAC;YACnD,MAAM,SAAS,GAAG,YAAmC,CAAC;YACtD,IAAI,CAAC,SAAS;gBAAE,SAAS;YAEzB,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,QAAQ,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC;YAC7F,IAAI,CAAC,GAAG;gBAAE,SAAS;YAEnB,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC;YAClC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC;YAE7B,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;gBAC9B,MAAM,IAAI,gBAAS,CAAC,SAAS,CAC3B,4BAA4B,KAAK,IAAI,KAAK,wDAAwD,CACnG,CAAC;YACJ,CAAC;YAED,IAAI,GAAG,GAA0B,SAAS,CAAC;YAC3C,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBAC7B,GAAG,GAAG,OAAO,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC;YAC5G,CAAC;iBAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBACnC,GAAG,GAAG,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;YACzG,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBAC/B,GAAG,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAC7F,CAAC;YAED,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,gBAAS,CAAC,SAAS,CAAC,iCAAiC,KAAK,IAAI,KAAK,yBAAyB,CAAC,CAAC;YAC1G,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,WAAW,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC/C,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uCAAuC,GAAG,QAAQ,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC;YACvF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,GAAG,GAAG,CAAU,CAAC;gBACvB,eAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,IAAI,gBAAS,CAAC,SAAS,CAC3B,oBAAoB,KAAK,IAAI,KAAK,6BAA6B,GAAG,KAAK,GAAG,CAAC,OAAO,EAAE,CACrF,CAAC;YACJ,CAAC;YAED,4DAA4D;YAC5D,MAAM,IAAI,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,SAAS,CAAC,IAAI,CACjB,CAAC,KAAK,EAAE,MAAiB,EAAE,GAAW,EAAE,EAAE;gBACxC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;oBAC5B,cAAc;oBACd,IAAI,CAAC;wBACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,6BAA6B,CAC9D,MAAM,EACN,IAAI,kCAAqB,CAAC;4BACxB,QAAQ,EAAE,GAAG;4BACb,mBAAmB,EAAE,CAAC;4BACtB,eAAe,EAAE,CAAC;yBACnB,CAAC,CACH,CAAC;wBAEF,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BACzD,eAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,CAAC;4BAC/C,SAAS;wBACX,CAAC;wBAED,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;wBAErC,iBAAiB;wBACjB,IAAI,IAAI,GAAG,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;wBACnG,IAAI,CAAC,IAAI,EAAE,CAAC;4BACV,IAAI,GAAG,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;wBAC/F,CAAC;wBACD,IAAI,CAAC,IAAI,EAAE,CAAC;4BACV,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;wBACvF,CAAC;wBACD,IAAI,CAAC,IAAI;4BAAE,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;wBACpC,MAAM,eAAI,CAAC,aAAa,CAAC,SAAS,CAAC,kBAA8D,EAAE;4BACjG,UAAU,EAAE,IAAI;4BAChB,SAAS,EACP,SAAS,CAAC,MAAM,EAAE,iBAAiB;gCACnC,QAAQ,CAAC,MAAM,EAAE,iBAAiB;gCAClC,IAAI,CAAC,MAAM,EAAE,iBAAiB;yBACjC,CAAC,CAAC,OAAO,CAAC,CAAC;wBAEZ,2FAA2F;wBAC3F,MAAM,MAAM,CAAC,IAAI,CACf,IAAI,iCAAoB,CAAC;4BACvB,QAAQ,EAAE,GAAG;4BACb,aAAa,EAAE,OAAO,CAAC,aAAa;yBACrC,CAAC,CACH,CAAC;oBACJ,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,eAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CACb,CAAC;QACJ,CAAC;IACH,CAAC;IAEQ,sBAAsB;QAC7B,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAE5C,MAAM,GAAG,GAAG,eAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAEzC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,WAAiC,CAAC;YACnD,MAAM,SAAS,GAAG,YAAmC,CAAC;YACtD,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,QAAQ,IAAI,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC;gBAC7F,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC;oBAClC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC;oBAC7B,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,aAAa,CAAC,MAAiB;QAC7B,4DAA4D;QAC5D,MAAM,EAAE,GAAG,IAAI,CAAC;QAEhB,SAAS,MAAM,CAAiD,IAAO;YACrE,MAAM,MAAM,GAAG,eAAI,CAAC,sBAAsB,CAAC,EAAE,EAAE,IAAI,CAAuB,CAAC;YAC3E,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,sBAAsB;IACtB,eAAe,CAAC,MAAkB;QAChC,4DAA4D;QAC5D,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,SAAS,MAAM,CACb,MAAc,EACd,WAAmB,EACnB,YAAqF;YAErF,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,eAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,YAAY,CAAC,KAAM,EAAE;gBACxF,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;YAEH,MAAM,aAAa,GAAG,YAAmC,CAAC;YAC1D,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;YAE9B,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAEmB,kCAAW"}

package/dist/sqs.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sqs.test.d.ts.map

package/dist/sqs.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqs.test.d.ts","sourceRoot":"","sources":["../sqs.test.ts"],"names":[],"mappings":""}

package/dist/sqs.test.js

@@ -0,0 +1,108 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_sqs_1 = require("@aws-sdk/client-sqs");
+const index_1 = require("./index");
+const dbos_sdk_1 = require("@dbos-inc/dbos-sdk");
+const sleepms = (ms) => new Promise((r) => setTimeout(r, ms));
+function createSQS() {
+    return new client_sqs_1.SQSClient({
+        region: process.env['AWS_REGION'] ?? '',
+        endpoint: process.env['AWS_ENDPOINT_URL_SQS'],
+        credentials: {
+            accessKeyId: process.env['AWS_ACCESS_KEY_ID'] ?? '',
+            secretAccessKey: process.env['AWS_SECRET_ACCESS_KEY'] ?? '',
+        },
+        //logger: console,
+    });
+}
+async function sendMessageInternal(msg) {
+    try {
+        const smsg = { ...msg, QueueUrl: msg.QueueUrl || process.env['SQS_QUEUE_URL'] };
+        return await createSQS().send(new client_sqs_1.SendMessageCommand(smsg));
+    }
+    catch (e) {
+        dbos_sdk_1.DBOS.logger.error(e);
+        throw e;
+    }
+}
+const sendMessageStep = dbos_sdk_1.DBOS.registerStep(sendMessageInternal, { name: 'Send SQS Message' });
+const sqsReceiver = new index_1.SQSReceiver({
+    client: createSQS,
+});
+class SQSRcv {
+    static msgRcvCount = 0;
+    static msgValueSum = 0;
+    static async recvMessage(msg) {
+        const ms = msg.Body;
+        const res = JSON.parse(ms);
+        SQSRcv.msgRcvCount++;
+        SQSRcv.msgValueSum += res.val;
+        return Promise.resolve();
+    }
+}
+__decorate([
+    sqsReceiver.messageConsumer({ queueUrl: process.env['SQS_QUEUE_URL'] }),
+    dbos_sdk_1.DBOS.workflow(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], SQSRcv, "recvMessage", null);
+describe('sqs-tests', () => {
+    let sqsIsAvailable = true;
+    beforeAll(() => {
+        // Check if SES is available and update app config, skip the test if it's not
+        if (!process.env['AWS_REGION'] || !process.env['SQS_QUEUE_URL']) {
+            sqsIsAvailable = false;
+        }
+        else {
+            // This would normally be a global or static or something
+            dbos_sdk_1.DBOS.setConfig({ name: 'dbossqstest' });
+        }
+    });
+    beforeEach(async () => {
+        if (sqsIsAvailable) {
+            dbos_sdk_1.DBOS.registerLifecycleCallback(sqsReceiver);
+            await dbos_sdk_1.DBOS.launch();
+        }
+        else {
+            console.log('SQS Test is not configured.  To run, set AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and SQS_QUEUE_URL');
+        }
+    });
+    afterEach(async () => {
+        if (sqsIsAvailable) {
+            await dbos_sdk_1.DBOS.shutdown();
+        }
+    }, 10000);
+    // This tests receive also; which is already wired up
+    test('sqs-send', async () => {
+        if (!sqsIsAvailable) {
+            console.log('SQS unavailable, skipping SQS tests');
+            return;
+        }
+        const sv = {
+            val: 10,
+        };
+        const ser = await sendMessageStep({
+            MessageBody: JSON.stringify(sv),
+        });
+        expect(ser.MessageId).toBeDefined();
+        // Wait for receipt
+        for (let i = 0; i < 100; ++i) {
+            if (SQSRcv.msgRcvCount === 1)
+                break;
+            await sleepms(100);
+        }
+        expect(SQSRcv.msgRcvCount).toBe(1);
+        expect(SQSRcv.msgValueSum).toBe(10);
+    });
+});
+//# sourceMappingURL=sqs.test.js.map

package/dist/sqs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqs.test.js","sourceRoot":"","sources":["../sqs.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,oDAAsG;AACtG,mCAAsC;AACtC,iDAA0C;AAE1C,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAMtE,SAAS,SAAS;IAChB,OAAO,IAAI,sBAAS,CAAC;QACnB,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE;QACvC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;QAC7C,WAAW,EAAE;YACX,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,EAAE;YACnD,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE;SAC5D;QACD,kBAAkB;KACnB,CAAC,CAAC;AACL,CAAC;AAQD,KAAK,UAAU,mBAAmB,CAAC,GAAgC;IACjE,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,CAAE,EAAE,CAAC;QACjF,OAAO,MAAM,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,+BAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,eAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,MAAM,eAAe,GAAG,eAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;AAE7F,MAAM,WAAW,GAAG,IAAI,mBAAW,CAAC;IAClC,MAAM,EAAE,SAAS;CAClB,CAAC,CAAC;AAEH,MAAM,MAAM;IACV,MAAM,CAAC,WAAW,GAAW,CAAC,CAAC;IAC/B,MAAM,CAAC,WAAW,GAAW,CAAC,CAAC;IAGlB,AAAb,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAY;QACnC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAK,CAAC;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAa,CAAC;QACvC,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,CAAC;QAC9B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;;AANY;IAFZ,WAAW,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;IACvE,eAAI,CAAC,QAAQ,EAAE;;;;+BAOf;AAGH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAI,cAAc,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,GAAG,EAAE;QACb,6EAA6E;QAC7E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAChE,cAAc,GAAG,KAAK,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,yDAAyD;YACzD,eAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,IAAI,cAAc,EAAE,CAAC;YACnB,eAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;YAC5C,MAAM,eAAI,CAAC,MAAM,EAAE,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CACT,kHAAkH,CACnH,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,eAAI,CAAC,QAAQ,EAAE,CAAC;QACxB,CAAC;IACH,CAAC,EAAE,KAAK,CAAC,CAAC;IAEV,qDAAqD;IACrD,IAAI,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;QAC1B,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;YACnD,OAAO;QACT,CAAC;QACD,MAAM,EAAE,GAAa;YACnB,GAAG,EAAE,EAAE;SACR,CAAC;QACF,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC;YAChC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;SAChC,CAAC,CAAC;QACH,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAEpC,mBAAmB;QACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,WAAW,KAAK,CAAC;gBAAE,MAAM;YACpC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}