node-tdd 4.0.4 → 4.1.0

package/lib/modules/request-recorder/heal-sqs/migration.js

@@ -0,0 +1,106 @@
+// This code logic is used to migrate legacy AWS SQS xml to json
+import xml2js from 'xml2js';
+import objectScan from 'object-scan';
+
+const tryParseXML = (body) => {
+  let parsed = body;
+  try {
+    xml2js.parseString(body, (err, result) => {
+      parsed = JSON.parse(JSON.stringify(result));
+    });
+  } catch (e) {
+    return null;
+  }
+  return parsed;
+};
+
+export default ({ responseBody, header }) => {
+  const responseXml = tryParseXML(responseBody);
+  if (responseXml !== null) {
+    if (header === 'AmazonSQS.ListQueueTags') {
+      const scanner = objectScan(['ListQueueTagsResponse.ListQueueTagsResult[0].Tag[*]'], {
+        rtn: ({ value }) => [value.Key, value.Value[0]],
+        afterFn: ({ result }) => Object.fromEntries(result)
+      });
+      const Tags = scanner(responseXml);
+      return { Tags };
+    }
+    if (header === 'AmazonSQS.GetQueueAttributes') {
+      const scanner = objectScan(['GetQueueAttributesResponse.GetQueueAttributesResult[0].Attribute[*]'], {
+        rtn: ({ value }) => [value.Name[0], value.Value[0]],
+        afterFn: ({ result }) => Object.fromEntries(result)
+      });
+      const Attributes = scanner(responseXml);
+      return { Attributes };
+    }
+    if (header === 'AmazonSQS.GetQueueUrl') {
+      if (responseXml?.ErrorResponse?.Error?.[0]?.Code?.[0] === 'AWS.SimpleQueueService.NonExistentQueue') {
+        return {
+          __type: 'com.amazonaws.sqs#QueueDoesNotExist',
+          message: 'The specified queue does not exist.'
+        };
+      }
+      const QueueUrl = responseXml?.GetQueueUrlResponse?.GetQueueUrlResult?.[0]?.QueueUrl?.[0];
+      return { QueueUrl };
+    }
+    if (header === 'AmazonSQS.CreateQueue') {
+      if (responseXml?.ErrorResponse?.Error?.[0]?.Code?.[0] === 'QueueAlreadyExists') {
+        return {
+          __type: 'com.amazonaws.sqs#QueueNameExists',
+          message: 'The specified queue name does exist.'
+        };
+      }
+      const QueueUrl = responseXml?.CreateQueueResponse?.CreateQueueResult?.[0]?.QueueUrl?.[0];
+      return { QueueUrl };
+    }
+    if (header === 'AmazonSQS.ListQueues') {
+      const scannerQueueUrls = objectScan(
+        ['ListQueuesResponse.ListQueuesResult[0].QueueUrl[*]'],
+        { rtn: 'value', reverse: false }
+      );
+      const scannerNextToken = objectScan(
+        ['ListQueuesResponse.ListQueuesResult[0].NextToken[0]'],
+        { rtn: 'value', reverse: false, abort: true }
+      );
+      return {
+        QueueUrls: scannerQueueUrls(responseXml),
+        NextToken: scannerNextToken(responseXml)
+      };
+    }
+    if (header === 'AmazonSQS.TagQueue') {
+      return {};
+    }
+    if (header === 'AmazonSQS.SetQueueAttributes') {
+      return {};
+    }
+    if (header === 'AmazonSQS.SendMessageBatch') {
+      const scannerSuccessful = objectScan(
+        ['SendMessageBatchResponse.SendMessageBatchResult[0].SendMessageBatchResultEntry[*]'],
+        {
+          rtn: ({ value }) => ({
+            Id: value.Id[0],
+            MessageId: value.MessageId[0],
+            MD5OfMessageBody: value.MD5OfMessageBody[0]
+          }),
+          reverse: false
+        }
+      );
+      const scannerFailed = objectScan(
+        ['SendMessageBatchResponse.SendMessageBatchResult[0].BatchResultErrorEntry[*]'],
+        {
+          rtn: ({ value }) => ({
+            Id: value.Id[0],
+            SenderFault: value.SenderFault[0],
+            Code: value.Code[0]
+          }),
+          reverse: false
+        }
+      );
+      return {
+        Successful: scannerSuccessful(responseXml),
+        Failed: scannerFailed(responseXml)
+      };
+    }
+  }
+  return responseBody;
+};

package/lib/modules/request-recorder/heal-sqs.js

@@ -0,0 +1,30 @@
+import crypto from 'crypto';
+import { tryParseJson } from './util.js';
+import migration from './heal-sqs/migration.js';
+
+export default (requestBody, responseBody, scope, req) => {
+  if (scope?.basePath !== 'https://sqs.us-west-2.amazonaws.com:443') {
+    return responseBody;
+  }
+
+  const header = req?.options?.headers?.['x-amz-target'];
+
+  if (typeof responseBody === 'string' && responseBody.startsWith('<?xml')) {
+    return migration({ responseBody, header });
+  }
+
+  const requestJson = tryParseJson(requestBody);
+  const responseJson = tryParseJson(responseBody);
+
+  if (header === 'AmazonSQS.SendMessageBatch') {
+    return {
+      Successful: requestJson.Entries.map(({ Id, MessageBody }, idx) => ({
+        Id,
+        MessageId: responseJson?.Successful?.[idx]?.MessageId || crypto.randomUUID(),
+        MD5OfMessageBody: crypto.createHash('md5').update(MessageBody).digest('hex')
+      }))
+    };
+  }
+
+  return responseBody;
+};

package/lib/modules/request-recorder.js

@@ -6,11 +6,12 @@ import Joi from 'joi-strict';
 import nock from 'nock';
 import get from 'lodash.get';
 import cloneDeep from 'lodash.clonedeep';
+import isEqual from 'lodash.isequal';
 import nockCommon from 'nock/lib/common.js';
 import compareUrls from '../util/compare-urls.js';
 import nockListener from './request-recorder/nock-listener.js';
 import nockMock from './request-recorder/nock-mock.js';
-import healSqsSendMessageBatch from './request-recorder/heal-sqs-send-message-batch.js';
+import healSqs from './request-recorder/heal-sqs.js';
 import applyModifiers from './request-recorder/apply-modifiers.js';
 import requestInjector from './request-recorder/request-injector.js';
 
@@ -222,14 +223,16 @@ export default (opts) => {
 
               if (anyFlagPresent(['magic', 'response'])) {
                 const responseBody = tryParseJson([
-                  healSqsSendMessageBatch
+                  healSqs
                 ].reduce(
                   (respBody, fn) => fn(requestBodyString, respBody, scope, req),
                   interceptor.body
                 ));
-                // eslint-disable-next-line no-param-reassign
-                interceptor.body = responseBody;
-                pendingMocks[idx].record.response = responseBody;
+                if (!isEqual(interceptor.body, responseBody)) {
+                  // eslint-disable-next-line no-param-reassign
+                  interceptor.body = responseBody;
+                  pendingMocks[idx].record.response = responseBody;
+                }
               }
 
               expectedCassette.push(pendingMocks[idx].record);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-tdd",
   "type": "module",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "Drop in extension for mocha to abstract commonly used test setups",
   "main": "lib/index.js",
   "scripts": {
@@ -78,6 +78,7 @@
     "joi-strict": "3.0.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "4.4.2",
+    "lodash.isequal": "4.5.0",
     "lru-cache-ext": "4.0.0",
     "minimist": "1.2.8",
     "nock": "13.4.0",
@@ -85,6 +86,7 @@
     "object-scan": "19.0.5",
     "smart-fs": "4.0.1",
     "timekeeper": "2.3.1",
-    "tmp": "0.2.1"
+    "tmp": "0.2.1",
+    "xml2js": "0.6.2"
   }
 }

package/lib/modules/request-recorder/heal-sqs-send-message-batch.js

@@ -1,21 +0,0 @@
-import crypto from 'crypto';
-import { tryParseJson } from './util.js';
-
-export default (requestBody, responseBody, scope, req) => {
-  if (
-    scope?.basePath !== 'https://sqs.us-west-2.amazonaws.com:443'
-    || req?.options?.headers?.['x-amz-target'] !== 'AmazonSQS.SendMessageBatch'
-  ) {
-    return responseBody;
-  }
-
-  const requestJson = tryParseJson(requestBody);
-  const responseJson = tryParseJson(responseBody);
-  return {
-    Successful: requestJson.Entries.map(({ Id, MessageBody }, idx) => ({
-      Id,
-      MessageId: responseJson?.Successful?.[idx]?.MessageId || crypto.randomUUID(),
-      MD5OfMessageBody: crypto.createHash('md5').update(MessageBody).digest('hex')
-    }))
-  };
-};