fix(filters-actions-spam): ZMSA-71-2: Allow spam action to be null thus deleting it (#967)

* ZMSA-71-2: Allow spam action to be null thus deleting it

* remove .only from filter spam action tests

Author: NickOvt

lib/api/filters.js

@@ -10,7 +10,7 @@ const { nextPageCursorSchema, previousPageCursorSchema, sessSchema, sessIPSchema
 const { publish, FILTER_DELETED, FILTER_CREATED, FORWARD_ADDED } = require('../events');
 const { successRes, totalRes, previousCursorRes, nextCursorRes } = require('../schemas/response/general-schemas');
 const { GetAllFiltersResult, GetFiltersResult } = require('../schemas/response/filters-schemas');
-const { FilterQuery, FilterAction } = require('../schemas/request/filters-schemas');
+const { FilterQuery, FilterAction, FilterActionUpdate } = require('../schemas/request/filters-schemas');
 const { userId, filterId } = require('../schemas/request/general-schemas');
 const { mongopagingFindWrapper } = require('../mongopaging-find-wrapper');
 
@@ -995,7 +995,7 @@ module.exports = (db, server, userHandler, settingsHandler) => {
                     name: Joi.string().trim().max(255).empty('').description('Name of the Filter'),
 
                     query: FilterQuery,
-                    action: FilterAction,
+                    action: FilterActionUpdate,
 
                     disabled: booleanSchema.description('If true then this filter is ignored'),
 

lib/filter-handler.js

@@ -283,6 +283,10 @@ class FilterHandler {
                     return;
                 }
 
+                if (key === 'spam' && filterData.action[key] === null) {
+                    return;
+                }
+
                 // if a previous filter already has set a value then do not touch it
                 if (!filterActions.has(key)) {
                     filterActions.set(key, filterData.action[key]);

lib/schemas/request/filters-schemas.js

@@ -51,4 +51,8 @@ const FilterQuery = Joi.object({
     .description('Rules that a message must match')
     .$_setFlag('objectName', 'Query');
 
-module.exports = { FilterAction, FilterQuery };
+const FilterActionUpdate = FilterAction.keys({
+    spam: booleanSchema.allow(null).description('If true then store matching messages to Junk Mail folder (null clears action)')
+});
+
+module.exports = { FilterAction, FilterQuery, FilterActionUpdate };

test/api/filters-test.js

@@ -207,6 +207,50 @@ describe('API Filters', function () {
         expect(responseGet.body.action.mailbox).to.be.equal(inbox);
     });
 
+    describe('Filter spam action', function () {
+        let spamFilter;
+
+        it('should POST /users/{user}/filters expect success / with spam action', async () => {
+            const response = await server
+                .post(`/users/${user}/filters`)
+                .send({
+                    name: 'spam action filter',
+                    query: {
+                        from: 'account-spam'
+                    },
+                    action: {
+                        spam: true,
+                        seen: true
+                    }
+                })
+                .expect(200);
+            expect(response.body.success).to.be.true;
+            spamFilter = response.body.id;
+
+            const filterDataResponse = await server.get(`/users/${user}/filters/${spamFilter}`).expect(200);
+            expect(filterDataResponse.body.success).to.be.true;
+            expect(filterDataResponse.body.action.spam).to.equal(true);
+            expect(filterDataResponse.body.action.seen).to.equal(true);
+        });
+
+        it('should PUT /users/{user}/filters/{filter} expect success / clear spam action', async () => {
+            const response = await server
+                .put(`/users/${user}/filters/${spamFilter}`)
+                .send({
+                    action: {
+                        spam: null
+                    }
+                })
+                .expect(200);
+            expect(response.body.success).to.be.true;
+
+            const filterDataResponse = await server.get(`/users/${user}/filters/${spamFilter}`).expect(200);
+            expect(filterDataResponse.body.success).to.be.true;
+            expect(filterDataResponse.body.action).to.not.have.property('spam');
+            expect(filterDataResponse.body.action.seen).to.equal(true);
+        });
+    });
+
     describe('Filter metaData', function () {
         let metaDataFilter;