feat: added DELETE /api/tags/:tagId endpoint

Author: mvegter

lib/database/repositories/TagRepository.js

@@ -59,6 +59,23 @@ class TagRepository {
         const result = await Tag.create(TagAdapter.toDatabase(entity));
         return TagAdapter.toEntity(result);
     }
+
+    /**
+     * Removes a specific entity.
+     *
+     * @param {Object} queryBuilder The QueryBuilder to use.
+     * @returns {Promise|Null} Promise object representing the full mock data
+     */
+    async removeOne(queryBuilder) {
+        queryBuilder.limit(1);
+
+        const tag = await this.findOne(queryBuilder);
+        if (tag) {
+            await Tag.destroy(queryBuilder.toImplementation());
+        }
+
+        return tag;
+    }
 }
 
 module.exports = new TagRepository();

lib/server/controllers/tags.controller.js

@@ -11,7 +11,15 @@
  * or submit itself to any jurisdiction.
  */
 
-const { tag: { CreateTagUseCase, GetAllTagsUseCase, GetLogsByTagUseCase, GetTagUseCase } } = require('../../usecases');
+const {
+    tag: {
+        CreateTagUseCase,
+        DeleteTagUseCase,
+        GetAllTagsUseCase,
+        GetLogsByTagUseCase,
+        GetTagUseCase,
+    },
+} = require('../../usecases');
 const { dtos: { CreateTagDto, GetAllTagsDto, GetTagDto } } = require('../../domain');
 const { dtoValidator } = require('../utilities');
 
@@ -64,15 +72,29 @@ const createTag = async (request, response, next) => {
  *                        next middleware function.
  * @returns {undefined}
  */
-const deleteTag = (request, response, next) => {
-    response.status(501).json({
-        errors: [
-            {
-                status: '501',
-                title: 'Not implemented',
-            },
-        ],
-    });
+const deleteTag = async (request, response, next) => {
+    const value = await dtoValidator(GetTagDto, request, response);
+    if (!value) {
+        return;
+    }
+
+    const logs = await new DeleteTagUseCase()
+        .execute(value);
+
+    if (logs === null) {
+        response.status(404).json({
+            errors: [
+                {
+                    status: '404',
+                    title: `Tag with this id (${value.params.tagId}) could not be found`,
+                },
+            ],
+        });
+    } else {
+        response.status(200).json({
+            data: logs,
+        });
+    }
 };
 
 /**

lib/usecases/tag/DeleteTagUseCase.js

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * 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.
+ */
+
+const {
+    repositories: {
+        TagRepository,
+    },
+    utilities: {
+        QueryBuilder,
+        TransactionHelper,
+    },
+} = require('../../database');
+
+/**
+ * DeleteTagUseCase
+ */
+class DeleteTagUseCase {
+    /**
+     * Executes this use case.
+     *
+     * @param {Object} dto The GetAllLogs DTO which contains all request data.
+     * @returns {Promise} Promise object represents the result of this use case.
+     */
+    async execute(dto = {}) {
+        const queryBuilder = new QueryBuilder();
+        const { params } = dto;
+        const { tagId } = params;
+
+        queryBuilder.where('id', tagId);
+
+        return TransactionHelper.provide(() => TagRepository.removeOne(queryBuilder));
+    }
+}
+
+module.exports = DeleteTagUseCase;

lib/usecases/tag/index.js

@@ -12,12 +12,14 @@
  */
 
 const CreateTagUseCase = require('./CreateTagUseCase');
+const DeleteTagUseCase = require('./DeleteTagUseCase');
 const GetAllTagsUseCase = require('./GetAllTagsUseCase');
 const GetLogsByTagUseCase = require('./GetLogsByTagUseCase');
 const GetTagUseCase = require('./GetTagUseCase');
 
 module.exports = {
     CreateTagUseCase,
+    DeleteTagUseCase,
     GetAllTagsUseCase,
     GetLogsByTagUseCase,
     GetTagUseCase,

spec/openapi.yaml

@@ -154,6 +154,20 @@ paths:
           $ref: '#/components/responses/UnexpectedError'
       tags:
         - tag
+    delete:
+      operationId: deleteTagById
+      summary: Deletes a tag by Id
+      responses:
+        '200':
+          $ref: '#/components/responses/Tag'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        default:
+          $ref: '#/components/responses/UnexpectedError'
+      tags:
+        - tag
   /tags/{tagId}/logs:
     parameters:
       - $ref: '#/components/parameters/TagId'

test/application/usecases/tag/DeleteTagUseCase.test.js

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * 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.
+ */
+
+const { repositories: { TagRepository } } = require('../../../../lib/database');
+const { tag: { CreateTagUseCase, DeleteTagUseCase } } = require('../../../../lib/usecases');
+const { dtos: { CreateTagDto } } = require('../../../../lib/domain');
+const chai = require('chai');
+
+const { expect } = chai;
+
+module.exports = () => {
+    let createdTag;
+
+    beforeEach(async () => {
+        const createTagDto = await CreateTagDto.validateAsync({
+            body: {
+                text: `TAG#${new Date().getTime()}`,
+            },
+        });
+
+        createdTag = await new CreateTagUseCase()
+            .execute(createTagDto);
+    });
+
+    it('should remove a tag', async () => {
+        const nTagsBefore = await TagRepository.count();
+
+        await new DeleteTagUseCase()
+            .execute({
+                params: {
+                    tagId: createdTag.id,
+                },
+            });
+
+        const nTagsAfter = await TagRepository.count();
+        expect(nTagsAfter).to.be.lessThan(nTagsBefore);
+    });
+
+    it('should return the removed tag', async () => {
+        const nTagsBefore = await TagRepository.count();
+
+        const result = await new DeleteTagUseCase()
+            .execute({
+                params: {
+                    tagId: createdTag.id,
+                },
+            });
+
+        const nTagsAfter = await TagRepository.count();
+        expect(nTagsAfter).to.be.lessThan(nTagsBefore);
+
+        expect(result.id).to.equal(createdTag.id);
+        expect(result.text).to.equal(createdTag.text);
+    });
+};

test/application/usecases/tag/index.js

@@ -12,11 +12,13 @@
  */
 
 const CreateTagUseCase = require('./CreateTagUseCase.test');
+const DeleteTagUseCase = require('./DeleteTagUseCase.test');
 const GetAllTagsUseCase = require('./GetAllTagsUseCase.test');
 const GetTagUseCase = require('./GetTagUseCase.test');
 
 module.exports = () => {
     describe('CreateTagUseCase', CreateTagUseCase);
+    describe('DeleteTagUseCase', DeleteTagUseCase);
     describe('GetAllTagsUseCase', GetAllTagsUseCase);
     describe('GetTagUseCase', GetTagUseCase);
 };

test/e2e/tags.test.js

@@ -15,6 +15,8 @@ const path = require('path');
 const chai = require('chai');
 const request = require('supertest');
 const chaiResponseValidator = require('chai-openapi-response-validator');
+const { tag: { CreateTagUseCase } } = require('../../lib/usecases');
+const { dtos: { CreateTagDto } } = require('../../lib/domain');
 
 const { expect } = chai;
 
@@ -300,6 +302,123 @@ module.exports = () => {
         });
     });
 
+    describe('DELETE /api/tags/:tagId', () => {
+        let createdTag;
+
+        beforeEach(async () => {
+            const createTagDto = await CreateTagDto.validateAsync({
+                body: {
+                    text: `TAG#${new Date().getTime()}`,
+                },
+            });
+
+            createdTag = await new CreateTagUseCase()
+                .execute(createTagDto);
+        });
+
+        it('should return 400 if the tag id is not a number', (done) => {
+            request(server)
+                .delete('/api/tags/abc')
+                .expect(400)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { errors } = res.body;
+                    const titleError = errors.find((err) => err.source.pointer === '/data/attributes/params/tagId');
+                    expect(titleError.detail).to.equal('"params.tagId" must be a number');
+
+                    done();
+                });
+        });
+
+        it('should return 400 if the tag id is not positive', (done) => {
+            request(server)
+                .delete('/api/tags/-1')
+                .expect(400)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { errors } = res.body;
+                    const titleError = errors.find((err) => err.source.pointer === '/data/attributes/params/tagId');
+                    expect(titleError.detail).to.equal('"params.tagId" must be a positive number');
+
+                    done();
+                });
+        });
+
+        it('should return 400 if the tag id is not a whole number', (done) => {
+            request(server)
+                .delete('/api/tags/0.5')
+                .expect(400)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { errors } = res.body;
+                    const titleError = errors.find((err) => err.source.pointer === '/data/attributes/params/tagId');
+                    expect(titleError.detail).to.equal('"params.tagId" must be an integer');
+
+                    done();
+                });
+        });
+
+        it('should return 404 if the tag could not be found', (done) => {
+            request(server)
+                .delete('/api/tags/999999999')
+                .expect(404)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    expect(res.body.errors[0].title).to.equal('Tag with this id (999999999) could not be found');
+
+                    done();
+                });
+        });
+
+        it('should return 200 in all other cases', (done) => {
+            request(server)
+                .delete(`/api/tags/${createdTag.id}`)
+                .expect(200)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    expect(res.body.data.id).to.equal(createdTag.id);
+                    expect(res.body.data.text).to.equal(createdTag.text);
+
+                    done();
+                });
+        });
+    });
+
     describe('GET /api/tags/:tagId/logs', () => {
         it('should return 400 if the tag id is not a number', (done) => {
             request(server)