qdone 2.2.0 → 2.2.2

package/commonjs/src/defaults.js

@@ -94,8 +94,10 @@ function getOptionsWithDefaults(options) {
     // For API invocations don't force caller to supply default options
     if (!options)
         options = {};
-    // Activate DLQ if any option is set
-    const dlq = options.dlq || !!(options['dlq-suffix'] || options['dlq-after'] || options['dlq-name'] || options.dlqSuffix || options.dlqAfter || options.dlqName);
+    // Activate DLQ if any sub-option is set. Use ?? so that undefined (not
+    // passed) falls through to the default, while explicit false is preserved.
+    const hasDlqSubOption = !!(options['dlq-suffix'] || options['dlq-after'] || options['dlq-name'] || options.dlqSuffix || options.dlqAfter || options.dlqName);
+    const dlq = options.dlq ?? (hasDlqSubOption || undefined);
     const opt = {
         // Shared
         prefix: options.prefix === '' ? options.prefix : (options.prefix || process.env.QDONE_PREFIX || exports.defaults.prefix),
@@ -124,7 +126,7 @@ function getOptionsWithDefaults(options) {
         delay: options.delay || process.env.QDONE_DELAY || exports.defaults.delay,
         sendRetries: options.sendRetries || options['send-retries'] || process.env.QDONE_SEND_RETRIES || exports.defaults.sendRetries,
         failDelay: options.failDelay || options['fail-delay'] || process.env.QDONE_FAIL_DELAY || exports.defaults.failDelay,
-        dlq: dlq === false ? false : exports.defaults.dlq,
+        dlq: dlq ?? exports.defaults.dlq,
         dlqSuffix: options.dlqSuffix || options['dlq-suffix'] || process.env.QDONE_DLQ_SUFFIX || exports.defaults.dlqSuffix,
         dlqAfter: options.dlqAfter || options['dlq-after'] || process.env.QDONE_DLQ_AFTER || exports.defaults.dlqAfter,
         tags: options.tags || undefined,

package/commonjs/src/monitor.js

@@ -8,9 +8,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.monitor = monitor;
 exports.interpretWildcard = interpretWildcard;
+exports.getQueueAge = getQueueAge;
 exports.getAggregateData = getAggregateData;
 const sqs_js_1 = require("./sqs.js");
 const cloudWatch_js_1 = require("./cloudWatch.js");
+const client_cloudwatch_1 = require("@aws-sdk/client-cloudwatch");
 const defaults_js_1 = require("./defaults.js");
 const qrlCache_js_1 = require("./qrlCache.js");
 const debug_1 = __importDefault(require("debug"));
@@ -45,16 +47,45 @@ function interpretWildcard(queueName) {
     // debug({ prefix, suffix, safeSuffix, suffixRegex })
     return { prefix, suffix, safeSuffix, suffixRegex };
 }
+/**
+ * Gets ApproximateAgeOfOldestMessage for a single queue from CloudWatch.
+ * This metric is not available via the SQS GetQueueAttributes API.
+ */
+async function getQueueAge(queueName) {
+    const now = new Date();
+    const params = {
+        StartTime: new Date(now.getTime() - 1000 * 60 * 5),
+        EndTime: now,
+        MetricName: 'ApproximateAgeOfOldestMessage',
+        Namespace: 'AWS/SQS',
+        Period: 300,
+        Dimensions: [{ Name: 'QueueName', Value: queueName }],
+        Statistics: ['Maximum']
+    };
+    const client = (0, cloudWatch_js_1.getCloudWatchClient)();
+    const cmd = new client_cloudwatch_1.GetMetricStatisticsCommand(params);
+    try {
+        const data = await client.send(cmd);
+        debug('getQueueAge', queueName, data);
+        if (!data.Datapoints || data.Datapoints.length === 0)
+            return 0;
+        return Math.max(...data.Datapoints.map(d => d.Maximum));
+    }
+    catch (e) {
+        debug('getQueueAge error', queueName, e);
+        return 0;
+    }
+}
 /**
  * Aggregates inmportant attributes across queues and reports a summary.
- * Attributes:
+ * Attributes (from SQS GetQueueAttributes):
  *  - ApproximateNumberOfMessages: Sum
  *  - ApproximateNumberOfMessagesDelayed: Sum
  *  - ApproximateNumberOfMessagesNotVisible: Sum
+ * Metrics (from CloudWatch):
  *  - ApproximateAgeOfOldestMessage: Max
  */
 async function getAggregateData(queueName) {
-    const maxAttributes = new Set(['ApproximateAgeOfOldestMessage']);
     const { prefix, suffixRegex } = interpretWildcard(queueName);
     const qrls = await (0, sqs_js_1.getMatchingQueues)(prefix, suffixRegex);
     // debug({ qrls })
@@ -68,15 +99,14 @@ async function getAggregateData(queueName) {
             const newAtrribute = parseInt(result.Attributes[key], 10);
             if (newAtrribute > 0) {
                 total.contributingQueueNames.add(queue);
-                if (maxAttributes.has(key)) {
-                    total[key] = Math.max(total[key] || 0, newAtrribute);
-                }
-                else {
-                    total[key] = (total[key] || 0) + newAtrribute;
-                }
+                total[key] = (total[key] || 0) + newAtrribute;
             }
         }
     }
+    // Fetch ApproximateAgeOfOldestMessage from CloudWatch (not available via SQS API)
+    // Only query queues with messages to minimize CloudWatch API costs
+    const ageResults = await Promise.all([...total.contributingQueueNames].map(queue => getQueueAge(queue)));
+    total.ApproximateAgeOfOldestMessage = Math.max(0, ...ageResults);
     // debug({ total })
     // convert set to array
     total.contributingQueueNames = [...total.contributingQueueNames.values()];

package/commonjs/src/sqs.js

@@ -61,8 +61,7 @@ async function getQueueAttributes(qrls) {
             AttributeNames: [
                 'ApproximateNumberOfMessages',
                 'ApproximateNumberOfMessagesNotVisible',
-                'ApproximateNumberOfMessagesDelayed',
-                'ApproximateAgeOfOldestMessage'
+                'ApproximateNumberOfMessagesDelayed'
             ]
         };
         const command = new client_sqs_1.GetQueueAttributesCommand(input);
@@ -84,8 +83,7 @@ async function getQueueAttributes(qrls) {
                         Attributes: {
                             ApproximateNumberOfMessages: '0',
                             ApproximateNumberOfMessagesNotVisible: '0',
-                            ApproximateNumberOfMessagesDelayed: '0',
-                            ApproximateAgeOfOldestMessage: '0'
+                            ApproximateNumberOfMessagesDelayed: '0'
                         }
                     };
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qdone",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "A distributed scheduler for SQS",
   "type": "module",
   "main": "./index.js",

package/src/defaults.js

@@ -90,8 +90,10 @@ export function getOptionsWithDefaults (options) {
   // For API invocations don't force caller to supply default options
   if (!options) options = {}
 
-  // Activate DLQ if any option is set
-  const dlq = options.dlq || !!(options['dlq-suffix'] || options['dlq-after'] || options['dlq-name'] || options.dlqSuffix || options.dlqAfter || options.dlqName)
+  // Activate DLQ if any sub-option is set. Use ?? so that undefined (not
+  // passed) falls through to the default, while explicit false is preserved.
+  const hasDlqSubOption = !!(options['dlq-suffix'] || options['dlq-after'] || options['dlq-name'] || options.dlqSuffix || options.dlqAfter || options.dlqName)
+  const dlq = options.dlq ?? (hasDlqSubOption || undefined)
 
   const opt = {
     // Shared
@@ -123,7 +125,7 @@ export function getOptionsWithDefaults (options) {
     delay: options.delay || process.env.QDONE_DELAY || defaults.delay,
     sendRetries: options.sendRetries || options['send-retries'] || process.env.QDONE_SEND_RETRIES || defaults.sendRetries,
     failDelay: options.failDelay || options['fail-delay'] || process.env.QDONE_FAIL_DELAY || defaults.failDelay,
-    dlq: dlq === false ? false : defaults.dlq,
+    dlq: dlq ?? defaults.dlq,
     dlqSuffix: options.dlqSuffix || options['dlq-suffix'] || process.env.QDONE_DLQ_SUFFIX || defaults.dlqSuffix,
     dlqAfter: options.dlqAfter || options['dlq-after'] || process.env.QDONE_DLQ_AFTER || defaults.dlqAfter,
     tags: options.tags || undefined,

package/src/monitor.js

@@ -3,7 +3,8 @@
  */
 
 import { getMatchingQueues, getQueueAttributes } from './sqs.js'
-import { putAggregateData } from './cloudWatch.js'
+import { putAggregateData, getCloudWatchClient } from './cloudWatch.js'
+import { GetMetricStatisticsCommand } from '@aws-sdk/client-cloudwatch'
 import { getOptionsWithDefaults } from './defaults.js'
 import { normalizeQueueName } from './qrlCache.js'
 import Debug from 'debug'
@@ -38,16 +39,44 @@ export function interpretWildcard (queueName) {
   return { prefix, suffix, safeSuffix, suffixRegex }
 }
 
+/**
+ * Gets ApproximateAgeOfOldestMessage for a single queue from CloudWatch.
+ * This metric is not available via the SQS GetQueueAttributes API.
+ */
+export async function getQueueAge (queueName) {
+  const now = new Date()
+  const params = {
+    StartTime: new Date(now.getTime() - 1000 * 60 * 5),
+    EndTime: now,
+    MetricName: 'ApproximateAgeOfOldestMessage',
+    Namespace: 'AWS/SQS',
+    Period: 300,
+    Dimensions: [{ Name: 'QueueName', Value: queueName }],
+    Statistics: ['Maximum']
+  }
+  const client = getCloudWatchClient()
+  const cmd = new GetMetricStatisticsCommand(params)
+  try {
+    const data = await client.send(cmd)
+    debug('getQueueAge', queueName, data)
+    if (!data.Datapoints || data.Datapoints.length === 0) return 0
+    return Math.max(...data.Datapoints.map(d => d.Maximum))
+  } catch (e) {
+    debug('getQueueAge error', queueName, e)
+    return 0
+  }
+}
+
 /**
  * Aggregates inmportant attributes across queues and reports a summary.
- * Attributes:
+ * Attributes (from SQS GetQueueAttributes):
  *  - ApproximateNumberOfMessages: Sum
  *  - ApproximateNumberOfMessagesDelayed: Sum
  *  - ApproximateNumberOfMessagesNotVisible: Sum
+ * Metrics (from CloudWatch):
  *  - ApproximateAgeOfOldestMessage: Max
  */
 export async function getAggregateData (queueName) {
-  const maxAttributes = new Set(['ApproximateAgeOfOldestMessage'])
   const { prefix, suffixRegex } = interpretWildcard(queueName)
   const qrls = await getMatchingQueues(prefix, suffixRegex)
   // debug({ qrls })
@@ -61,14 +90,18 @@ export async function getAggregateData (queueName) {
       const newAtrribute = parseInt(result.Attributes[key], 10)
       if (newAtrribute > 0) {
         total.contributingQueueNames.add(queue)
-        if (maxAttributes.has(key)) {
-          total[key] = Math.max(total[key] || 0, newAtrribute)
-        } else {
-          total[key] = (total[key] || 0) + newAtrribute
-        }
+        total[key] = (total[key] || 0) + newAtrribute
       }
     }
   }
+
+  // Fetch ApproximateAgeOfOldestMessage from CloudWatch (not available via SQS API)
+  // Only query queues with messages to minimize CloudWatch API costs
+  const ageResults = await Promise.all(
+    [...total.contributingQueueNames].map(queue => getQueueAge(queue))
+  )
+  total.ApproximateAgeOfOldestMessage = Math.max(0, ...ageResults)
+
   // debug({ total })
   // convert set to array
   total.contributingQueueNames = [...total.contributingQueueNames.values()]

package/src/sqs.js

@@ -55,8 +55,7 @@ export async function getQueueAttributes (qrls) {
       AttributeNames: [
         'ApproximateNumberOfMessages',
         'ApproximateNumberOfMessagesNotVisible',
-        'ApproximateNumberOfMessagesDelayed',
-        'ApproximateAgeOfOldestMessage'
+        'ApproximateNumberOfMessagesDelayed'
       ]
     }
     const command = new GetQueueAttributesCommand(input)
@@ -77,8 +76,7 @@ export async function getQueueAttributes (qrls) {
             Attributes: {
               ApproximateNumberOfMessages: '0',
               ApproximateNumberOfMessagesNotVisible: '0',
-              ApproximateNumberOfMessagesDelayed: '0',
-              ApproximateAgeOfOldestMessage: '0'
+              ApproximateNumberOfMessagesDelayed: '0'
             }
           }
         }