feat: Delete method for user settings (#2762)

Author: banusha2

plugins/users/README.md

@@ -35,6 +35,10 @@ server.register({
 
 `PUT /users/{id}/settings`
 
+#### Delete all user's settings
+
+`DELETE /users/{id}/settings`
+
 **Arguments**
 
 * `settings` - An optional new object with user settings.

plugins/users/index.js

@@ -2,6 +2,7 @@
 
 const getSettingsRoute = require('./settings/get');
 const updateSettingsRoute = require('./settings/update');
+const removeSettingsRoute = require('./settings/delete');
 
 /**
  * Users API Plugin
@@ -11,7 +12,7 @@ const updateSettingsRoute = require('./settings/update');
 const usersPlugin = {
     name: 'users',
     async register(server) {
-        server.route([getSettingsRoute(), updateSettingsRoute()]);
+        server.route([getSettingsRoute(), updateSettingsRoute(), removeSettingsRoute()]);
     }
 };
 

plugins/users/settings/delete.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+
+module.exports = () => ({
+    method: 'DELETE',
+    path: '/users/settings',
+    options: {
+        description: 'Reset user settings',
+        notes: 'Reset user settings',
+        tags: ['api', 'users'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', '!guest']
+        },
+
+        handler: async (request, h) => {
+            const { userFactory } = request.server.app;
+            const { scmContext, username } = request.auth.credentials;
+            const user = await userFactory.get({ username, scmContext });
+
+            if (!user) {
+                throw boom.notFound('User does not exist');
+            }
+
+            return user.removeSettings().then(results => {
+                return h.response(results).code(200);
+            });
+        }
+    }
+});

test/plugins/user.test.js

@@ -14,6 +14,7 @@ const getUserMock = user => {
     mock.getPermissions = sinon.stub();
     mock.getSettings = sinon.stub();
     mock.updateSettings = sinon.stub();
+    mock.removeSettings = sinon.stub();
 
     return mock;
 };
@@ -92,7 +93,8 @@ describe('user plugin test', () => {
                 1: {
                     showPRJobs: true
                 },
-                displayJobNameLength: 25
+                displayJobNameLength: 25,
+                timestampFormat: 'LOCAL_TIMEZONE'
             };
         });
 
@@ -213,4 +215,75 @@ describe('user plugin test', () => {
             });
         });
     });
+
+    describe('DELETE /user/settings', () => {
+        let options;
+
+        beforeEach(() => {
+            options = {
+                method: 'DELETE',
+                url: `/users/settings`,
+                payload: {
+                    settings: {}
+                },
+                auth: {
+                    credentials: {
+                        username,
+                        scmContext,
+                        scope: ['user']
+                    },
+                    strategy: ['token']
+                }
+            };
+            settings = {
+                1: {
+                    showPRJobs: true
+                },
+                displayJobNameLength: 20,
+                timestampFormat: 'LOCAL_TIMEZONE'
+            };
+        });
+
+        it('exposes a route for resetting user settings', () => {
+            userFactoryMock.get.resolves(userMock);
+            userMock.removeSettings.resolves({});
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 200);
+                assert.deepEqual(reply.result, {});
+            });
+        });
+
+        it('throws error not found when user does not exist', () => {
+            const error = {
+                statusCode: 404,
+                error: 'Not Found',
+                message: 'User does not exist'
+            };
+
+            userFactoryMock.get.resolves(null);
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 404);
+                assert.deepEqual(reply.result, error);
+            });
+        });
+
+        it('throws error when get user call returns error', () => {
+            userFactoryMock.get.rejects(new Error('Failed'));
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 500);
+            });
+        });
+
+        it('throws error when update user settings call returns error', () => {
+            userFactoryMock.get.resolves(userMock);
+            userMock.updateSettings.rejects(new Error('Failed'));
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 500);
+            });
+        });
+    });
 });