fix(sqs): Support both standard and FIFO SQS queues (#490)

Currently, sending an SQS message to a standard (non-FIFO) queue will
fail if the `messageGroupId` param is provided to the `sendMessage`
function. The function should only include this param when it is sending
a message to a FIFO queue.

## Related Issues

- #489

Author: blefebvre

package-lock.json

@@ -25,6 +25,15 @@ class SQS {
     this.log = log;
   }
 
+  /**
+   * Check if the queue is a FIFO queue by examining its URL.
+   * @param {string} queueUrl - the URL of the SQS queue
+   * @returns {boolean} true if the queue is a FIFO queue, false otherwise
+   */
+  static #isFifoQueue(queueUrl) {
+    return hasText(queueUrl) && queueUrl.toLowerCase().endsWith('.fifo');
+  }
+
   /**
    * Send a message to an SQS queue. For FIFO queues, messageGroupId is required.
    * @param {string} queueUrl - The URL of the SQS queue.
@@ -43,8 +52,8 @@ class SQS {
       QueueUrl: queueUrl,
     };
 
-    if (hasText(messageGroupId)) {
-      // MessageGroupId is required for FIFO queues
+    // Only include MessageGroupId if the queue is a FIFO queue
+    if (SQS.#isFifoQueue(queueUrl) && hasText(messageGroupId)) {
       params.MessageGroupId = messageGroupId;
     }
 

packages/spacecat-shared-utils/src/sqs.js

@@ -189,9 +189,9 @@ describe('SQS', () => {
       ]);
     });
 
-    it('should include a MessageGroupId when provided', async () => {
+    it('should include a MessageGroupId when the queue is a FIFO queue', async () => {
       const action = wrap(async (req, ctx) => {
-        await ctx.sqs.sendMessage('queue-url', { key: 'value' }, 'job-id');
+        await ctx.sqs.sendMessage('https://sqs.us-east-1.amazonaws.com/123456789012/fifo-queue.fifo', { key: 'value' }, 'job-id');
       }).with(sqsWrapper);
 
       await action({}, context);
@@ -204,5 +204,37 @@ describe('SQS', () => {
       ]);
       expect(firstSendArg.input.MessageGroupId).to.equal('job-id');
     });
+
+    it('should not include a MessageGroupId when the queue is standard queue', async () => {
+      const action = wrap(async (req, ctx) => {
+        // Note: no .fifo suffix
+        await ctx.sqs.sendMessage('https://sqs.us-east-1.amazonaws.com/123456789012/standard-queue', { key: 'value' }, 'job-id');
+      }).with(sqsWrapper);
+
+      await action({}, context);
+
+      const firstSendArg = sendStub.getCall(0).args[0];
+      expect(Object.keys(firstSendArg.input)).to.deep.equal([
+        'MessageBody',
+        'QueueUrl',
+      ]);
+      expect(firstSendArg.input.MessageGroupId).to.be.undefined;
+    });
+
+    it('should not include a MessageGroupId when the queue URL is undefined', async () => {
+      const action = wrap(async (req, ctx) => {
+        // Edge case: no queue URL
+        await ctx.sqs.sendMessage(undefined, { key: 'value' }, 'job-id');
+      }).with(sqsWrapper);
+
+      await action({}, context);
+
+      const firstSendArg = sendStub.getCall(0).args[0];
+      expect(Object.keys(firstSendArg.input)).to.deep.equal([
+        'MessageBody',
+        'QueueUrl',
+      ]);
+      expect(firstSendArg.input.MessageGroupId).to.be.undefined;
+    });
   });
 });