Update splitchanges and use properties validator

Author: ZamoraEmmanuel

client/__tests__/track.test.js

@@ -145,7 +145,7 @@ describe('track', () => {
 
   test('should be 400 if properties is invalid', async () => {
     const expected = [
-      'properties must be a plain object.'
+      'Input must be a plain object.'
     ];
     const response = await request(app)
       .get('/client/track?key=my-key&event-type=my-event&traffic-type=my-traffic&value=1&properties=lalala')
@@ -158,7 +158,7 @@ describe('track', () => {
       'key too long, key must be 250 characters or less.',
       'you passed "@!test", event-type must adhere to the regular expression /^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$/g. This means an event_type must be alphanumeric, cannot be more than 80 characters long, and can only include a dash, underscore, period, or colon as separators of alphanumeric characters.',
       'you passed an empty traffic-type, traffic-type must be a non-empty string.',
-      'properties must be a plain object.',
+      'Input must be a plain object.',
       'value must be null or number.'
     ];
     const key = getLongKey();

client/client.router.js

@@ -12,7 +12,6 @@ const propertiesValidator = require('../utils/inputValidation/properties');
 const keysValidator = require('../utils/inputValidation/keys');
 const clientController = require('./client.controller');
 const { parseValidators } = require('../utils/utils');
-const validateEvaluationOptions = require('../utils/inputValidation/evaluationOptions');
 
 /**
  * treatmentValidation  performs input validation for treatment call.
@@ -25,7 +24,7 @@ const treatmentValidation = (req, res, next) => {
   const bucketingKeyValidation = req.query['bucketing-key'] !== undefined ? keyValidator(req.query['bucketing-key'], 'bucketing-key') : null;
   const featureFlagNameValidation = splitValidator(req.query['split-name']);
   const attributesValidation = attributesValidator(req.query.attributes);
-  const optionsValidation = validateEvaluationOptions(req.query.options);
+  const optionsValidation = propertiesValidator(req.query.options);
 
   const error = parseValidators([matchingKeyValidation, bucketingKeyValidation, featureFlagNameValidation, attributesValidation, optionsValidation]);
   if (error.length) {
@@ -59,7 +58,7 @@ const treatmentsValidation = (req, res, next) => {
   const bucketingKeyValidation = req.query['bucketing-key'] !== undefined ? keyValidator(req.query['bucketing-key'], 'bucketing-key') : null;
   const featureFlagsNameValidation = splitsValidator(req.query['split-names']);
   const attributesValidation = attributesValidator(req.query.attributes);
-  const optionsValidation = validateEvaluationOptions(req.query.options);
+  const optionsValidation = propertiesValidator(req.query.options);
 
   const error = parseValidators([matchingKeyValidation, bucketingKeyValidation, featureFlagsNameValidation, attributesValidation, optionsValidation]);
   if (error.length) {
@@ -93,7 +92,7 @@ const flagSetsValidation = (req, res, next) => {
   const bucketingKeyValidation = req.query['bucketing-key'] !== undefined ? keyValidator(req.query['bucketing-key'], 'bucketing-key') : null;
   const flagSetNameValidation = flagSetsValidator(req.query['flag-sets']);
   const attributesValidation = attributesValidator(req.query.attributes);
-  const optionsValidation = validateEvaluationOptions(req.query.options);
+  const optionsValidation = propertiesValidator(req.query.options);
 
   const error = parseValidators([matchingKeyValidation, bucketingKeyValidation, flagSetNameValidation, attributesValidation, optionsValidation]);
   if (error.length) {
@@ -158,7 +157,7 @@ const trackValidation = (req, res, next) => {
 const allTreatmentValidation = (req, res, next) => {
   const keysValidation = keysValidator(req.query.keys);
   const attributesValidation = attributesValidator(req.query.attributes);
-  const optionsValidation = validateEvaluationOptions(req.query.options);
+  const optionsValidation = propertiesValidator(req.query.options);
 
   const error = parseValidators([keysValidation, attributesValidation, optionsValidation]);
   if (error.length) {

utils/inputValidation/__tests__/evaluationOptions.test.js

@@ -2,7 +2,7 @@ const propertiesValidator = require('../properties');
 
 describe('properties validator', () => {
   test('should return error on invalid properties', done => {
-    const expected = 'properties must be a plain object.';
+    const expected = 'Input must be a plain object.';
 
     const result = propertiesValidator('test');
 
@@ -13,7 +13,7 @@ describe('properties validator', () => {
   });
 
   test('should return error on invalid properties 2', done => {
-    const expected = 'properties must be a plain object.';
+    const expected = 'Input must be a plain object.';
 
     const result = propertiesValidator('[]');
 
@@ -24,7 +24,7 @@ describe('properties validator', () => {
   });
 
   test('should return error on invalid properties 3', done => {
-    const expected = 'properties must be a plain object.';
+    const expected = 'Input must be a plain object.';
 
     const result = propertiesValidator('true');
 

utils/inputValidation/__tests__/properties.test.js

@@ -1,17 +1,40 @@
+const { isObject, isString } = require('../lang');
 const errorWrapper = require('./wrapper/error');
 const okWrapper = require('./wrapper/ok');
-const lang = require('../lang');
 
-const validateProperties = (maybeProperties) => {
+const allowedTypes = ['boolean', 'string', 'number'];
+
+function validatePropertiesObject(obj) {
+  if (!isObject(obj)) return false;
+  return Object.values(obj).every(v => allowedTypes.includes(typeof v));
+}
+
+const validateOptionsOrProperties = (maybeInput) => {
   // eslint-disable-next-line eqeqeq
-  if (maybeProperties == undefined) return okWrapper(null);
+  if (maybeInput == undefined) return okWrapper(null);
 
+  let input;
   try {
-    const properties = JSON.parse(maybeProperties);
-    return (lang.isObject(properties)) ? okWrapper(properties) : errorWrapper('properties must be a plain object.');
+    input = isString(maybeInput) ? JSON.parse(maybeInput) : maybeInput;
+    if (!isObject(input)) {
+      return errorWrapper('Input must be a plain object.');
+    }
+
+    if (input.properties !== undefined) {
+      if (!validatePropertiesObject(input.properties)) {
+        return errorWrapper('options.properties must only contain boolean, string, or number values.');
+      }
+      return okWrapper(input);
+    }
+
+    if (validatePropertiesObject(input)) {
+      return okWrapper(input);
+    }
+
+    return errorWrapper('Input must be a plain object.');
   } catch (e) {
-    return errorWrapper('properties must be a plain object.');
+    return errorWrapper('Input must be a plain object.');
   }
 };
 
-module.exports = validateProperties;
+module.exports = validateOptionsOrProperties;