refactor(orderdesk): move message composition to FoxyWebhook class

Author: ndvo

src/foxy/FoxyWebhook.js

@@ -96,6 +96,35 @@ function response(details="", code=200) {
   }
 }
 
+/**
+ * Creates a details message about insufficient inventory.
+ *
+ * @param {Array} pairs with insufficient inventory.
+ * @returns {string} a configurable message.
+ */
+function messageInsufficientInventory(pairs) {
+  if (!pairs.length) return '';
+  const message = config.datastore.error.insufficientInventory ||
+    'Insufficient inventory for these items';
+  return message + ' ' + pairs
+    .map(p => `${p[1].name}: only ${p[1].inventory} available`).join(';')
+}
+
+/**
+ * Creates a details message about invalid price.
+ *
+ * @param {Array} pairs with invalid price.
+ * @returns {string} a configurable message.
+ */
+function messagePriceMismatch(pairs) {
+  if (!pairs.length) return '';
+  const message = config.datastore.error.priceMismatch ||
+    'Prices do not match:';
+  return message + ' ' + pairs
+    .map(p => p[0].name)
+    .join(', ');
+}
+
 /**
  * Verifies a Foxy Signature in a Webhook.
  *
@@ -135,9 +164,10 @@ function verifyWebhookSignature(req) {
 /**
  * Validates a Foxy request.
  *
- * It must be a Signed POST request with content-type application/json
- * @param request
- * @returns {boolean}
+ * It must be a Signed POST request with content-type application/json.
+ *
+ * @param {Request} requestEvent to be evaluated as valid.
+ * @returns {string|boolean} the error with this request.
  */
 function validFoxyRequest(requestEvent) {
   let err = false;
@@ -157,9 +187,11 @@ function validFoxyRequest(requestEvent) {
 
 module.exports = {
   getItems,
+  messageInsufficientInventory,
+  messagePriceMismatch,
   response,
-  verifyWebhookSignature,
+  validFoxyRequest,
   validSignature,
-  validFoxyRequest
+  verifyWebhookSignature,
 }
 

src/functions/datastore-integration-orderdesk/webhook.js

@@ -18,18 +18,10 @@ async function prePayment(body) {
   cartValidator.skipFromEnv();
   const pairs = await buildPairs(body, FoxyWebhook, datastore);
   // Check Prices
-  const invalidPrice = pairs.filter(
-    p => !cartValidator.validPrice(...p)
-  );
-  const priceDetail = invalidPrice.length ? `Invalid items: ${
-    invalidPrice.map(p => p[0].name).join(',')
-  }` : "";
-  const invalidInventory = pairs.filter(
-    p => !cartValidator.validInventory(...p)
-  );
-  const inventoryDetail = invalidInventory.length ? `Insufficient inventory for these items: ${
-    invalidInventory.map(p => `${p[1].name}: only ${p[1].inventory} available`).join(';')
-  }` : ""
+  const invalidPrice = pairs.filter(p => !cartValidator.validPrice(...p));
+  const priceDetail = FoxyWebhook.messagePriceMismatch(invalidPrice);
+  const invalidInventory = pairs.filter(p => !cartValidator.validInventory(...p));
+  const inventoryDetail = FoxyWebhook.messageInsufficientInventory(invalidInventory);
   if (invalidInventory.length || invalidPrice.length) {
     return response([inventoryDetail, priceDetail].filter(m => m.length > 0).join('\n'));
   } else {

test/foxy/FoxyWebhook.test.js

@@ -1,12 +1,26 @@
 const crypto = require("crypto");
 const FoxyWebhook = require('../../src/foxy/FoxyWebhook.js');
+const sinon = require("sinon");
 
 const { expect } = require("chai");
-const { describe, it } = require("mocha");
+const { after, before, describe, it } = require("mocha");
 
+function silenceLog() {
+  log = sinon.stub(console, 'log');
+  logError = sinon.stub(console, 'error');
+}
 
+function restoreLog() {
+  log.restore();
+  logError.restore();
+}
 
 describe("Handles Foxy Webhook Requests", function() {
+  let log;
+  let logError;
+
+  before(silenceLog);
+  after(restoreLog);
 
   describe("Should retrieve items from a Webhook Request", function() {
     it("Should retrieve items when they are present.", function() {
@@ -22,6 +36,11 @@ describe("Handles Foxy Webhook Requests", function() {
 });
 
 describe("Builds Foxy Webhook Responses", function() {
+  let log;
+  let logError;
+
+  before(silenceLog);
+  after(restoreLog);
 
   it ("Should not accept error responses without details", function () {
     expect(() => FoxyWebhook.response("", 500)).to.throw(Error, /An error response needs to specify details/);
@@ -31,6 +50,11 @@ describe("Builds Foxy Webhook Responses", function() {
 });
 
 describe("Verifies Foxy Webhook Signatures", function () {
+  let log;
+  let logError;
+
+  before(silenceLog);
+  after(restoreLog);
   it("Accepts the correct signature",function () {
     const foxySignature = crypto.createHmac('sha256', 'foo').update('bar').digest('hex');
     expect(FoxyWebhook.validSignature('bar', foxySignature, 'foo')).to.be.true;
@@ -48,3 +72,31 @@ describe("Verifies Foxy Webhook Signatures", function () {
     }
   });
 });
+
+describe("Builds useful error messages", function() {
+  let log;
+  let logError;
+
+  before(silenceLog);
+  after(restoreLog);
+
+  describe("Responds useful messages", function () {
+    it("Informs the invalid items when the price is wrong.", async function () {
+      const message = FoxyWebhook.messagePriceMismatch([
+        [{name: 'foo'}, {name: 'foo'}],
+        [{name: 'bar'}, {name: 'bar'}],
+      ])
+      expect(message).to.match(/foo/);
+      expect(message).to.match(/bar/);
+    });
+
+    it("Informs the items with insufficient inventory and the current available inventory.", async function () {
+      const message = FoxyWebhook.messageInsufficientInventory([
+        [{name: 'foo', quantity:3}, {inventory: 2, name: 'foo'}],
+        [{name: 'bar', quantity:3}, {inventory: 1, name: 'bar'}],
+      ])
+      expect(message).to.match(/2 available/);
+      expect(message).to.match(/1 available/);
+    });
+  });
+});

test/functions/datastore-integration-orderdesk/DataStore.test.js

@@ -178,7 +178,6 @@ describe("OrderDesk Datastore", function() {
       [{price: 0, code: '1'}, {name: undefined, price: 0, inventory: undefined, code: '1', update_source: 'Foxy-OrderDesk-Webhook'}],
     ];
     for (let c of cases) {
-      console.debug(c);
       expect(odClient.convertToCanonical(c[0]))
         .to.deep.equal(c[1]);
     }

test/functions/datastore-integration-orderdesk/index.test.js

@@ -1,14 +1,30 @@
-const {afterEach, beforeEach, describe, it } = require("mocha");
+const {after, afterEach, before, beforeEach, describe, it } = require("mocha");
 const {expect} = require("chai");
 const MockFoxyRequest = require("../../MockFoxyRequests.js");
+const sinon = require("sinon");
 
 const crypto = require("crypto");
 const rewire = require("rewire");
 
 const odHandler = rewire("../../../src/functions/datastore-integration-orderdesk/index.js");
 const config = odHandler.__get__('config');
 
+function silenceLog() {
+  log = sinon.stub(console, 'log');
+  logError = sinon.stub(console, 'error');
+}
+
+function restoreLog() {
+  log.restore();
+  logError.restore();
+}
+
 describe("Order Desk Pre-payment Webhook", function() {
+  let log;
+  let logError;
+
+  before(silenceLog);
+  after(restoreLog);
   beforeEach(
     function () {
       config.datastore.provider.orderDesk.storeId = 'foo';

test/functions/datastore-integration-orderdesk/webhook.test.js

@@ -1,16 +1,15 @@
 const rewire = require("rewire");
 const { expect } = require("chai");
-const { describe, it } = require("mocha");
+const { describe, it, before, after } = require("mocha");
+const sinon = require("sinon");
 const webhook = rewire("../../../src/functions/datastore-integration-orderdesk/webhook.js");
 
 const oldFoxyWebhook = webhook.__get__('FoxyWebhook');
 const MockFoxyWebhook = {
+  getItems: function() {return [this.item];},
   item: {},
-  getItems: function() {
-    return [
-      this.item
-    ];
-  },
+  messageInsufficientInventory: () => 'insufficientInventory',
+  messagePriceMismatch: () => 'priceMismatch',
   response: oldFoxyWebhook.response
 }
 
@@ -100,6 +99,23 @@ async function prePaymentExpectInvalid(reg) {
 }
 
 describe("OrderDesk Pre-payment Webhook", function() {
+  let log;
+  let logError;
+
+  before(
+    function() {
+      log = sinon.stub(console, 'log');
+      logError = sinon.stub(console, 'error');
+    }
+  );
+
+  after(
+    function() {
+      log.restore();
+      logError.restore();
+    }
+  );
+
   describe("Validates the cart items prices against a datastore", function() {
     it("Accepts if the prices are the same", async function () {
       resetMocks();
@@ -126,13 +142,13 @@ describe("OrderDesk Pre-payment Webhook", function() {
       expect(result.statusCode).to.equal(200);
       expect(result.body).to.exist;
       expect(JSON.parse(result.body).ok).to.be.false;
-      expect(JSON.parse(result.body).details).to.match(/Invalid items/);
+      expect(JSON.parse(result.body).details).to.match(/priceMismatch/);
     });
 
     it("Rejects if the cart has no price and the datastore does", async function() {
       resetMocks();
       MockFoxyWebhook.item.price = undefined;
-      await prePaymentExpectInvalid(/Invalid items/);
+      await prePaymentExpectInvalid(/priceMismatch/);
     });
   });
 
@@ -162,26 +178,10 @@ describe("OrderDesk Pre-payment Webhook", function() {
     it("Rejects if the quantity is higher", async function () {
       resetMocks();
       MockFoxyWebhook.item.quantity = 10;
-      await prePaymentExpectInvalid(/Insufficient inventory/);
+      await prePaymentExpectInvalid(/insufficientInventory/);
     });
 
   });
-
-  describe("Responds useful messages", function () {
-    it("Informs the invalid items when the price is wrong.", async function () {
-      resetMocks();
-      MockDatastore.item.price = 100;
-      const body = await prePaymentExpectInvalid(/Invalid items/);
-      expect(body.details).match(/Invalid items: foo/);
-    });
-
-    it("Informs the items with insufficient inventory and the current available inventory.", async function () {
-      resetMocks();
-      MockDatastore.item.inventory = 0;
-      const body = await prePaymentExpectInvalid(/Insufficient inventory/);
-      expect(body.details).match(/Insufficient inventory for these items: foo/);
-    });
-  });
 });
 
 describe("Transaction Created Webhook", function() {