amphora 8.0.0-0 → 8.2.2

package/.circleci/config.yml

@@ -57,7 +57,6 @@ jobs:
           paths:
             - node_modules
       - run: npm test
-      - run: cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
 
   test_node14:
     docker:

package/lib/bootstrap.test.js

@@ -12,7 +12,6 @@ const _ = require('lodash'),
 
 describe(_.startCase(filename), function () {
   let sandbox,
-    bootstrapFake, // eslint-disable-line
     db,
     sitesFake,
     fakeLog;
@@ -41,8 +40,6 @@ describe(_.startCase(filename), function () {
       prefix: 'example4.com',
       subsite: 'example4'
     }];
-
-    bootstrapFake = files.getYaml(path.resolve('./test/fixtures/config/bootstrap'));
   });
 
   beforeEach(function () {

package/lib/render.js

@@ -87,8 +87,12 @@ function renderComponent(req, res, hrStart) {
   return components.get(_ref, locals)
     .then(cmptData => formDataForRenderer(cmptData, { _ref }, locals))
     .tap(logTime(hrStart, _ref))
-    .then(({data, options}) => renderer.render(data, options, res))
-    .catch(err => log('error', err, { url: _.get(res, 'locals.url') }));
+    .then(({ data, options }) => renderer.render(data, options, res))
+    .catch(err => {
+      log('error', err, { url: _.get(res, 'locals.url') });
+
+      return responses.handleError(res)(err);
+    });
 }
 
 /**

package/lib/render.test.js

@@ -7,6 +7,7 @@ const _ = require('lodash'),
   expect = require('chai').expect,
   sinon = require('sinon'),
   schema = require('./schema'),
+  responses = require('./responses'),
   components = require('./services/components'),
   composer = require('./services/composer'),
   createMockReq = require('../test/fixtures/mocks/req'),
@@ -81,6 +82,7 @@ describe(_.startCase(filename), function () {
     sandbox.stub(components);
     sandbox.stub(composer);
     sandbox.stub(schema);
+    sandbox.stub(responses, 'handleError').returns(() => {});
     lib.setLog(mockLog);
     lib.resetUriRouteHandlers();
     lib.registerRenderers({
@@ -177,6 +179,7 @@ describe(_.startCase(filename), function () {
       return fn(req, getMockRes())
         .then(() => {
           sinon.assert.calledWith(mockLog, 'error', error);
+          sinon.assert.calledOnce(responses.handleError);
           lib.registerRenderers(undefined);
         });
     });

package/lib/responses.js

@@ -9,6 +9,25 @@ const _ = require('lodash'),
   filter = require('through2-filter'),
   metaController = require('./services/metadata');
 
+/**
+ * Returns a the name of the log level appropriate for a given HTTP response code.
+ * - 5xx = error
+ * - 4xx = warn
+ * - default = info
+ *
+ * @param {number} code: An HTTP status code.
+ * @returns {string}
+ */
+function logLevelFromStatusCode(code) {
+  if (code >= 500) {
+    return 'error';
+  }
+  if (code >= 400) {
+    return 'warn';
+  }
+  return 'info';
+}
+
 /**
  * Finds prefixToken, and removes it and anything before it.
  *
@@ -283,17 +302,17 @@ function notFound(err, res) {
  * @param {object} res
  */
 function serverError(err, res) {
-  // error is required to be logged
-  log('error', err.message, { stack: err.stack, url: _.get(res, 'locals.url') });
-
   const message = err.message || 'Server Error', // completely hide these messages from outside
-    code = 500;
+    code = 500,
+    level = logLevelFromStatusCode(code);
+
+  log(level, err.message, { code, stack: err.stack, url: _.get(res, 'locals.url') });
 
   sendDefaultResponseForCode(code, message, res);
 }
 
 /**
- * All client errors should look like this.
+ * All unauthorized requests should look like this.
  *
  * @param {object} res
  */
@@ -312,14 +331,32 @@ function unauthorized(res) {
  * @param {object} res
  */
 function clientError(err, res) {
-  log('error', err.message, { stack: err.stack, url: _.get(res, 'locals.url') });
   // They know it's a 400 already, we don't need to repeat the fact that its an error.
   const message = removePrefix(err.message, ':'),
-    code = 400;
+    code = 400,
+    level = logLevelFromStatusCode(code);
+
+  log(level, err.message, { code, stack: err.stack, url: _.get(res, 'locals.url') });
 
   sendDefaultResponseForCode(code, message, res);
 }
 
+/**
+ * This function dispatches an errors that have a manually set .status attribute.
+ * The .status attribute indicates that the error was intentionally constructed
+ * or caught and assigned a specific response code/message.
+ *
+ * @param {Error} err
+ * @param {object} res
+ */
+function explicitError(err, res) {
+  const code = err.status,
+    level = logLevelFromStatusCode(code);
+
+  log(level, err.message, { code, stack: err.stack, url: _.get(res, 'locals.url') });
+  sendDefaultResponseForCode(code, err.message, res);
+}
+
 /**
  * Handle errors in the standard/generic way
  * @param {object} res
@@ -330,7 +367,7 @@ function handleError(res) {
     if (err.status && err.name !== 'NotFoundError') {
       // If we're in this block, the error has a defined `status` property and
       // the error should be directed out immediately
-      sendDefaultResponseForCode(err.status, err.message, res);
+      explicitError(err, res);
     } else if (err.name === 'NotFoundError' ||
       err.message.indexOf('ENOENT') !== -1 ||
       err.message.indexOf('not found') !== -1) {

package/lib/responses.test.js

@@ -111,13 +111,29 @@ describe(_.startCase(filename), function () {
       fn(res)(new Error('something'));
     });
 
-    it('sends the error code defined in the `status` property', function (done) {
+    it('sends the error code defined in the `status` property, 4xx', function (done) {
       const res = createMockRes(),
         myError = new Error('something');
 
       myError.status = 403;
       expectStatus(res, 403);
-      expectResult(res, 'sendStatus: whatever', done);
+      expectResult(res, 'sendStatus: whatever', function () {
+        sinon.assert.calledWith(fakeLog, 'warn');
+        done();
+      });
+      fn(res)(myError);
+    });
+
+    it('sends the error code defined in the `status` property, 5xx', function (done) {
+      const res = createMockRes(),
+        myError = new Error('something');
+
+      myError.status = 500;
+      expectStatus(res, 500);
+      expectResult(res, 'sendStatus: whatever', function () {
+        sinon.assert.calledWith(fakeLog, 'error');
+        done();
+      });
       fn(res)(myError);
     });
   });
@@ -145,7 +161,7 @@ describe(_.startCase(filename), function () {
 
       expectStatus(res, 400);
       expectResult(res, 'sendStatus: whatever', function () {
-        sinon.assert.calledWith(fakeLog, 'error');
+        sinon.assert.calledWith(fakeLog, 'warn');
         done();
       });
       fn(new Error('something'), res);

package/lib/services/composer.js

@@ -31,11 +31,12 @@ function resolveComponentReferences(data, locals, filter = referenceProperty) {
             cmpt: referenceObject[referenceProperty]
           };
 
-          if (error.status) {
-            logObj.status = error.status;
+          // Errors with a .status property will be handled by lib/responses.js
+          // and logged with a level corresponding to the status code.
+          if (!error.status) {
+            log('error', `${error.message}`, logObj);
           }
 
-          log('error', `${error.message}`, logObj);
 
           return bluebird.reject(error);
         });

package/lib/services/composer.test.js

@@ -113,7 +113,7 @@ describe(_.startCase(filename), function () {
       });
     });
 
-    it('adds the status to the error message if it one is defined', function () {
+    it('adds the status to the error message if it one is defined, skips log', function () {
       const data = {
           a: {_ref: '/c/b'},
           c: {d: {_ref: '/c/e'}}
@@ -127,9 +127,8 @@ describe(_.startCase(filename), function () {
       components.get.withArgs('/c/m').returns(bluebird.reject(myError));
 
       return fn(data).catch((error) => {
-        sinon.assert.calledOnce(logSpy);
         expect(error.message).to.equal(errorMessage);
-        sinon.assert.calledWith(logSpy, 'error', errorMessage, { status: myError.status, cmpt: '/c/e', stack: myError.stack });
+        expect(error.status).to.equal(404);
       });
     });
   });

package/lib/services/db-operations.js

@@ -80,6 +80,30 @@ function splitCascadingData(uri, data) {
   return ops;
 }
 
+/**
+ * Adds user info onto each op object
+ *
+ * @param {Object} locals
+ * @param {Object} locals.user
+ * @returns {Function}
+ */
+function addUserInfoToOp(locals) {
+  if (!locals) {
+    return _.identity;
+  }
+
+  const { user } = locals;
+
+  function addUserProp(op) {
+    op.user = user;
+  }
+
+  return (opsList) => {
+    opsList.forEach(addUserProp);
+    return opsList;
+  };
+}
+
 /**
  * Get a list of all the put operations needed to complete a cascading PUT
  *
@@ -105,8 +129,10 @@ function getPutOperations(putFn, uri, data, locals) {
   }
 
   // run each through the normal put, which may or may not hit custom component logic
-  return bluebird.map(cmptOrLayout, ({ key, value }) => putFn(key, value, locals))
-    .then(ops => _.filter(_.flattenDeep(ops), _.identity));
+  return bluebird
+    .map(cmptOrLayout, ({ key, value }) => putFn(key, value, locals))
+    .then(ops => _.filter(_.flattenDeep(ops), _.identity))
+    .then(addUserInfoToOp(locals));
 }
 
 /**

package/lib/services/pages.js

@@ -27,13 +27,17 @@ const _ = require('lodash'),
  * @param {string} uri
  * @param {{}} data
  * @param {[]} ops
+ * @param {{}} locals
  * @returns {array}
  */
-function addOp(uri, data, ops) {
+function addOp(uri, data, ops, locals = {}) {
+  const { user } = locals;
+
   ops.push({
     type: 'put',
     key: uri,
-    value: JSON.stringify(data)
+    value: JSON.stringify(data),
+    user
   });
 
   return ops;
@@ -257,7 +261,7 @@ function publish(uri, data, locals) {
           publishedMeta = meta;
 
           // add page PUT operation last
-          return addOp(replaceVersion(uri, published), pageData, ops);
+          return addOp(replaceVersion(uri, published), pageData, ops, locals);
         });
     })
     .then(applyBatch)
@@ -306,7 +310,7 @@ function create(uri, data, locals) {
       return getPageClonePutOperations(pageData, locals)
         .then(ops => {
           pageData.layout = layoutReference;
-          return addOp(pageReference, pageData, ops);
+          return addOp(pageReference, pageData, ops, locals);
         });
     })
     .then(applyBatch)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amphora",
-  "version": "8.0.0-0",
+  "version": "8.2.2",
   "description": "An API mixin for Express that saves, publishes and composes data with the key-value store of your choice.",
   "main": "index.js",
   "scripts": {
@@ -17,13 +17,13 @@
   "author": "New York Media",
   "license": "MIT",
   "dependencies": {
-    "amphora-auth": "^2.0.0-0",
-    "amphora-fs": "^2.0.0-0",
+    "amphora-auth": "^2.0.0",
+    "amphora-fs": "^2.0.0",
     "basic-auth": "^1.0.4",
     "bluebird": "^3.5.1",
     "body-parser": "^1.12",
     "clay-log": "^1.2.0",
-    "clayutils": "^3.0.0-0",
+    "clayutils": "^3.0.0",
     "cuid": "^1.2.5",
     "eventify": "^2.0.0",
     "express": "^4.15.3",
@@ -33,7 +33,7 @@
     "highland": "^2.11.1",
     "ioredis": "^4.0.0",
     "js-yaml": "^3.2.0",
-    "lodash": "^4.17.20",
+    "lodash": "^4.14.2",
     "node-fetch": "^1.3.0",
     "passport": "^0.3.2",
     "passport-google-oauth": "^1.0.0",