feat(places-category): Add warning message for non-empty categories

Author: Joxit

sanitizer/_categories.js

@@ -2,7 +2,8 @@ const _ = require('lodash');
 const categoryTaxonomy = require('pelias-categories');
 
 const WARNINGS = {
-  empty: 'Categories parameter left blank, showing results from all categories.'
+  empty: 'Categories parameter left blank, showing results from all categories.',
+  notEmpty: 'Categories filtering not supported on this endpoint, showing results from all categories.'
 };
 
 // validate inputs, convert types and apply defaults
@@ -39,11 +40,17 @@ function _sanitize (raw, clean, categories) {
 }
 
 function _alwaysBlank (raw, clean, categories) {
+  // error & warning messages
+  const messages = { errors: [], warnings: [] };
+
   if (raw.hasOwnProperty('categories')) {
     clean.categories = [];
+    if (_.isString(raw.categories) && !_.isEmpty(raw.categories)) {
+      messages.warnings.push(WARNINGS.notEmpty);
+    }
   }
 
-  return { errors: [], warnings: [] };
+  return messages;
 }
 
 function _expected () {

test/unit/sanitizer/_categories.js

@@ -186,45 +186,81 @@ module.exports.tests.invalid_categories = function(test, common) {
 module.exports.tests.always_blank = function(test, common) {
   const alwaysBlankSanitizer = require( '../../../sanitizer/_categories')(true);
   test('garbage category', function(t) {
-    var req = {
+    const req = {
       query: {
         categories: 'barf'
       },
       clean: { }
     };
-    var expected_messages = { errors: [], warnings: [] };
+    const expected_messages = { errors: [], warnings: [
+      'Categories filtering not supported on this endpoint, showing results from all categories.'
+    ] };
 
-    var messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
+    const messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
 
     t.deepEqual(messages, expected_messages, 'error with message returned');
     t.deepEqual(req.clean.categories, [], 'should return empty array');
     t.end();
   });
 
   test('all garbage categories', function(t) {
-    var req = {
+    const req = {
       query: {
         categories: 'food'
       },
       clean: { }
     };
-    var expected_messages = { errors: [], warnings: [] };
+    const expected_messages = { errors: [], warnings: [
+      'Categories filtering not supported on this endpoint, showing results from all categories.'
+    ] };
+
+    const messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
+
+    t.deepEqual(messages, expected_messages, 'error with message returned');
+    t.deepEqual(req.clean.categories, [], 'should return empty array');
+    t.end();
+  });
+
+  test('defined categories', function(t) {
+    const req = {
+      query: {
+        categories: undefined
+      },
+      clean: { }
+    };
+    const expected_messages = { errors: [], warnings: [] };
 
-    var messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
+    const messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
+
+    t.deepEqual(messages, expected_messages, 'error with message returned');
+    t.deepEqual(req.clean.categories, [], 'should return empty array');
+    t.end();
+  });
+
+  test('empty categories', function(t) {
+    const req = {
+      query: {
+        categories: ''
+      },
+      clean: { }
+    };
+    const expected_messages = { errors: [], warnings: [] };
+
+    const messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
 
     t.deepEqual(messages, expected_messages, 'error with message returned');
     t.deepEqual(req.clean.categories, [], 'should return empty array');
     t.end();
   });
 
   test('not defined categories', function(t) {
-    var req = {
+    const req = {
       query: { },
       clean: { }
     };
-    var expected_messages = { errors: [], warnings: [] };
+    const expected_messages = { errors: [], warnings: [] };
 
-    var messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
+    const messages = alwaysBlankSanitizer.sanitize(req.query, req.clean);
 
     t.deepEqual(messages, expected_messages, 'error with message returned');
     t.deepEqual(req.clean.categories, undefined, 'categories should be undefined');