[OGUI-1604] Add middleware to 'edit layout' requests

QualityControl/lib/api.js

@@ -43,7 +43,13 @@ export const setup = (http, ws) => {
   http.get('/layout/:id', layoutService.getLayoutHandler.bind(layoutService));
   http.get('/layout', layoutService.getLayoutByNameHandler.bind(layoutService));
   http.post('/layout', layoutService.postLayoutHandler.bind(layoutService));
-  http.put('/layout/:id', layoutService.putLayoutHandler.bind(layoutService));
+  http.put(
+    '/layout/:id',
+    layoutServiceMiddleware(jsonDb),
+    layoutIdMiddleware(jsonDb),
+    layoutOwnerMiddleware(jsonDb),
+    layoutService.putLayoutHandler.bind(layoutService),
+  );
   http.delete(
     '/layout/:id',
     layoutServiceMiddleware(jsonDb),
@@ -53,6 +59,8 @@ export const setup = (http, ws) => {
   );
   http.patch(
     '/layout/:id',
+    layoutServiceMiddleware(jsonDb),
+    layoutIdMiddleware(jsonDb),
     minimumRoleMiddleware(UserRole.GLOBAL),
     layoutService.patchLayoutHandler.bind(layoutService),
   );

QualityControl/lib/controllers/LayoutController.js

@@ -20,8 +20,6 @@ import { LayoutPatchDto } from './../dtos/LayoutPatchDto.js';
 
 import {
   InvalidInputError,
-  NotFoundError,
-  UnauthorizedAccessError,
   updateAndSendExpressResponseFromNativeError,
 }
   from '@aliceo2/web-ui';
@@ -126,47 +124,35 @@ export class LayoutController {
   async putLayoutHandler(req, res) {
     const { id } = req.params;
     try {
-      if (!id) {
-        updateAndSendExpressResponseFromNativeError(res, new InvalidInputError('Missing parameter "id" of layout'));
-      } else if (!req.body) {
-        updateAndSendExpressResponseFromNativeError(
-          res,
-          new InvalidInputError('Missing body content to update layout with'),
-        );
-      } else {
-        const { personid } = req.session;
-        const { owner_id } = await this._dataService.readLayout(id);
-
-        if (Number(owner_id) !== Number(personid)) {
+      let layoutProposed = {};
+      try {
+        if (!req.body) {
           updateAndSendExpressResponseFromNativeError(
             res,
-            new UnauthorizedAccessError('Only the owner of the layout can update it'),
+            new InvalidInputError('Missing request body to update layout'),
           );
-        } else {
-          let layoutProposed = {};
-          try {
-            layoutProposed = await LayoutDto.validateAsync(req.body);
-          } catch (error) {
-            updateAndSendExpressResponseFromNativeError(
-              res,
-              new Error(`Failed to update layout ${error?.details?.[0]?.message || ''}`),
-            );
-            return;
-          }
-
-          const layouts = await this._dataService.listLayouts({ name: layoutProposed.name });
-          const layoutExistsWithName = layouts.every((layout) => layout.id !== layoutProposed.id);
-          if (layouts.length > 0 && layoutExistsWithName) {
-            updateAndSendExpressResponseFromNativeError(
-              res,
-              new InvalidInputError(`Proposed layout name: ${layoutProposed.name} already exists`),
-            );
-            return;
-          }
-          const layout = await this._dataService.updateLayout(id, layoutProposed);
-          res.status(201).json({ id: layout });
+          return;
         }
+        layoutProposed = await LayoutDto.validateAsync(req.body);
+      } catch (error) {
+        updateAndSendExpressResponseFromNativeError(
+          res,
+          new InvalidInputError(`Failed to update layout ${error?.details?.[0]?.message || ''}`),
+        );
+        return;
       }
+
+      const layouts = await this._dataService.listLayouts({ name: layoutProposed.name });
+      const layoutExistsWithName = layouts.every((layout) => layout.id !== layoutProposed.id);
+      if (layouts.length > 0 && layoutExistsWithName) {
+        updateAndSendExpressResponseFromNativeError(
+          res,
+          new InvalidInputError(`Proposed layout name: ${layoutProposed.name} already exists`),
+        );
+        return;
+      }
+      const layout = await this._dataService.updateLayout(id, layoutProposed);
+      res.status(201).json({ id: layout });
     } catch (error) {
       updateAndSendExpressResponseFromNativeError(res, error);
     }
@@ -229,33 +215,22 @@ export class LayoutController {
    */
   async patchLayoutHandler(req, res) {
     const { id } = req.params;
-    if (!id) {
-      updateAndSendExpressResponseFromNativeError(res, new InvalidInputError('Missing ID'));
-    } else {
-      let layout = {};
-      try {
-        layout = await LayoutPatchDto.validateAsync(req.body);
-      } catch {
-        updateAndSendExpressResponseFromNativeError(
-          res,
-          new InvalidInputError('Invalid request body to update layout'),
-        );
-        return;
-      }
-
-      try {
-        await this._dataService.readLayout(id);
-      } catch {
-        updateAndSendExpressResponseFromNativeError(res, new NotFoundError(`Unable to find layout with id: ${id}`));
-        return;
-      }
-      try {
-        const layoutUpdated = await this._dataService.updateLayout(id, layout);
-        res.status(201).json(layoutUpdated);
-      } catch {
-        updateAndSendExpressResponseFromNativeError(res, new Error(`Unable to update layout with id: ${id}`));
-        return;
-      }
+    let layout = {};
+    try {
+      layout = await LayoutPatchDto.validateAsync(req.body);
+    } catch {
+      updateAndSendExpressResponseFromNativeError(
+        res,
+        new InvalidInputError('Invalid request body to update layout'),
+      );
+      return;
+    }
+    try {
+      const layoutUpdated = await this._dataService.updateLayout(id, layout);
+      res.status(201).json(layoutUpdated);
+    } catch {
+      updateAndSendExpressResponseFromNativeError(res, new Error(`Unable to update layout with id: ${id}`));
+      return;
     }
   }
 }

QualityControl/package.json

@@ -44,7 +44,8 @@
     "globals": "^15.14.0",
     "nock": "^13.5.0",
     "puppeteer": "^24.0.0",
-    "sinon": "^19.0.2"
+    "sinon": "^19.0.2",
+    "supertest": "^7.0.0"
   },
   "bundleDependencies": [
     "@aliceo2/web-ui",

QualityControl/test/api/layouts/api-put-layout.test.js

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+ * See http://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+ * All rights not expressly granted are reserved.
+ *
+ * This software is distributed under the terms of the GNU General Public
+ * License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+import { suite, test } from 'node:test';
+import { ADMIN_TEST_TOKEN } from '../../setup/testServerSetup.js';
+import request from 'supertest';
+
+export const apiPutLayoutTests = () => {
+  suite('PUT /layout/:id', () => {
+    test('should return a 404 error if the id of the layout does not exist', async () => {
+      await request('localhost:8080/api/layout/test')
+        .put(`?token=${ADMIN_TEST_TOKEN}`)
+        .expect(404, {
+          message: 'layout (test) not found',
+          status: 404,
+          title: 'Not Found',
+        });
+    });
+
+    test('should return a 404 error if the layout id is not provided', async () => {
+      await request('localhost:8080/api/layout/')
+        .put(`?id=${null}&token=${ADMIN_TEST_TOKEN}`)
+        .expect(404, {
+          message: 'layout id not provided',
+          status: 404,
+          title: 'Not Found',
+        });
+    });
+
+    test.skip('should return a 401 error if the user is not the owner of the layout', async () => {
+
+    });
+    test.skip('should successfully update a layout', async () => {
+
+    });
+  });
+};