Safely mutate properties using lodash/omit (#543)

Author: daffl

lib/common/_remove.js

@@ -1,30 +1,25 @@
+const omit = require('lodash/omit');
 
 const getItems = require('./get-items');
 const replaceItems = require('./replace-items');
-const deleteByDot = require('../common/delete-by-dot');
 
 module.exports = function (func) {
   return context => {
     const items = getItems(context);
-
-    (Array.isArray(items) ? items : [items]).forEach(item => {
+    const converter = item => {
       if (typeof func === 'function') {
         func(item);
       }
 
-      removeProps('_computed', item);
-      removeProps('_include', item);
-      delete item._elapsed;
-    });
+      const keys = ['_elapsed', '_computed', '_include'];
+      const { _computed = [], _include = [] } = item;
+
+      return omit(item, keys.concat(_computed).concat(_include));
+    };
+    const converted = Array.isArray(items) ? items.map(converter) : converter(items);
+
+    replaceItems(context, converted);
 
-    replaceItems(context, items);
     return context;
   };
 };
-
-function removeProps (name, item) {
-  if (name in item) {
-    item[name].forEach(key => { deleteByDot(item, key); });
-    delete item[name];
-  }
-}

lib/common/delete-by-dot.js

@@ -1,13 +1,14 @@
+const omit = require('lodash/omit');
 
-const _remove = require('../common/_remove');
 const checkContext = require('./check-context');
 
 module.exports = function (...fieldNames) {
   return context => {
     checkContext(context, 'before', null, 'discardQuery');
 
     const query = (context.params || {}).query || {};
-    _remove(query, fieldNames);
+
+    context.params.query = omit(query, fieldNames);
 
     return context;
   };

lib/services/de-populate.js

@@ -1,13 +1,18 @@
+const omit = require('lodash/omit');
 
-const _remove = require('../common/_remove');
 const checkContextIf = require('./check-context-if');
 const getItems = require('./get-items');
+const replaceItems = require('./replace-items');
 
 module.exports = function (...fieldNames) {
   return context => {
     checkContextIf(context, 'before', ['create', 'update', 'patch'], 'discard');
 
-    _remove(getItems(context), fieldNames);
+    const items = getItems(context);
+    const convert = item => omit(item, fieldNames);
+    const converted = Array.isArray(items) ? items.map(convert) : convert(items);
+
+    replaceItems(context, converted);
 
     return context;
   };

lib/services/discard-query.js

@@ -8,7 +8,6 @@ const checkContext = require('./check-context');
 const checkContextIf = require('./check-context-if');
 const combine = require('./combine');
 const debug = require('./debug');
-const deleteByDot = require('../common/delete-by-dot');
 const dePopulate = require('./de-populate');
 const disablePagination = require('./disable-pagination');
 const discard = require('./discard');
@@ -59,7 +58,6 @@ module.exports = Object.assign({
   checkContextIf,
   combine,
   debug,
-  deleteByDot,
   dePopulate,
   disablePagination,
   disallow,

lib/services/discard.js

@@ -1,6 +1,6 @@
 const existsByDot = require('lodash/has');
+const omit = require('lodash/omit');
 
-const deleteByDot = require('../common/delete-by-dot');
 const checkContext = require('./check-context');
 const errors = require('@feathersjs/errors');
 
@@ -19,9 +19,11 @@ module.exports = function (...fieldNames) {
 
     fieldNames.forEach(name => {
       if (existsByDot(data, name)) {
-        if (ifThrow) throw new errors.BadRequest(`Field ${name} may not be patched. (preventChanges)`);
+        if (ifThrow) {
+          throw new errors.BadRequest(`Field ${name} may not be patched. (preventChanges)`);
+        }
         // Delete data.contactPerson.name
-        deleteByDot(data, name);
+        context.data = omit(data, name);
       }
       // Delete data['contactPerson.name']
       if (data[name]) {

lib/services/index.js

@@ -1,9 +1,9 @@
 const getByDot = require('lodash/get');
 const setByDot = require('lodash/set');
+const omit = require('lodash/omit');
 
 const getItems = require('./get-items');
 const replaceItems = require('./replace-items');
-const deleteByDot = require('../common/delete-by-dot');
 
 module.exports = function (schema1) {
   return context => {
@@ -43,9 +43,7 @@ module.exports = function (schema1) {
       let exclude = schema.exclude;
       exclude = typeof exclude === 'string' ? [exclude] : exclude;
       if (exclude) {
-        exclude.forEach(key => {
-          deleteByDot(item, key);
-        });
+        item = omit(item, exclude);
       }
 
       const _computed = Object.keys(computed);

lib/services/prevent-changes.js

@@ -20,7 +20,7 @@ describe('common hook discard', () => {
       ['after',                     afterJane(),   'create', null,      ['last'],        { first: 'Jane'}                       ],
       ['call internally on server', afterJane(),   'create', undefined, ['last'],        { first: 'Jane'}                       ],
       ['not throw field missing',   beforeJohn(),  'create', 'rest',    ['first', 'xx'], { last: 'Doe' }                        ],
-      ['not throw field undefined', beforeUndef(), 'create', 'rest',    ['first'],       { first: undefined, last: 'Doe' }      ], // ???
+      ['not throw field undefined', beforeUndef(), 'create', 'rest',    ['first'],       { last: 'Doe' }      ],
       ['not throw field null',      beforeNull(),  'create', 'rest',    ['first'],       { last: 'Doe' }                        ],
     ];
     /* eslint-enable */