feat: added origin filtering on /api/logs

Author: mvegter

.validaterc

@@ -18,7 +18,7 @@
     "parameters": {
       "no_parameter_description": "error",
       "param_name_case_convention": [
-        "error",
+        "warning",
         "lower_snake_case"
       ],
       "invalid_type_format_pair": "error",

lib/database/adapters/LogAdapter.js

@@ -30,6 +30,7 @@ class LogAdapter {
             title: databaseObject.title,
             creationTime: new Date(databaseObject.createdAt).getTime(),
             tags: [`Tag${databaseObject.id}`, `Tag${++databaseObject.id}`],
+            origin: databaseObject.origin,
             content: [
                 { content: 'Batman wrote this...', sender: 'Batman' },
                 { content: 'Nightwing wrote this...', sender: 'Nightwing' },

lib/database/repositories/LogRepository.js

@@ -30,10 +30,11 @@ class LogRepository {
     /**
      * Returns all entities.
      *
+     * @param {Object} queryBuilder The QueryBuilder to use.
      * @returns {Promise} Promise object representing the full mock data
      */
-    async findAll() {
-        return Log.findAll().map(LogAdapter.toEntity);
+    async findAll(queryBuilder) {
+        return Log.findAll(queryBuilder.toImplementation()).map(LogAdapter.toEntity);
     }
 
     /**

lib/database/utilities/QueryBuilder.js

@@ -0,0 +1,51 @@
+/**
+ * @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.
+ */
+
+/**
+ * Sequelize implementation of the QueryBuilder.
+ */
+class QueryBuilder {
+    /**
+     * Creates a new `QueryBuilder` instance.
+     */
+    constructor() {
+        this.options = {};
+    }
+
+    /**
+     * Returns the implementation specific query.
+     *
+     * @returns {Object} Implementation specific query.
+     */
+    toImplementation() {
+        return this.options;
+    }
+
+    /**
+     * Adds a filter on the given column value pair.
+     *
+     * @param {*} column The target column.
+     * @param {*} value The required value.
+     * @returns {Object} The current QueryBuilder instance.
+     */
+    where(column, value) {
+        if (!this.options.where) {
+            this.options.where = {};
+        }
+
+        this.options.where[column] = value;
+        return this;
+    }
+}
+
+module.exports = QueryBuilder;

lib/database/utilities/index.js

@@ -11,8 +11,10 @@
  * or submit itself to any jurisdiction.
  */
 
+const QueryBuilder = require('./QueryBuilder');
 const TransactionHelper = require('./TransactionHelper');
 
 module.exports = (sequelize) => ({
+    QueryBuilder,
     TransactionHelper: TransactionHelper(sequelize),
 });

lib/domain/dtos/GetAllLogsDto.js

@@ -0,0 +1,31 @@
+/**
+ * @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 { attributes } = require('structure');
+
+const FilterDto = attributes({
+    origin: {
+        type: String,
+        equal: ['human', 'process'],
+    },
+})(class FilterDto {});
+
+const QueryDto = attributes({
+    filter: FilterDto,
+})(class QueryDto {});
+
+const GetAllLogsDto = attributes({
+    query: QueryDto,
+})(class GetAllLogsDto {});
+
+module.exports = GetAllLogsDto;

lib/domain/dtos/index.js

@@ -12,9 +12,11 @@
  */
 
 const CreateLogDto = require('./CreateLogDto');
+const GetAllLogsDto = require('./GetAllLogsDto');
 const GetLogDto = require('./GetLogDto');
 
 module.exports = {
     CreateLogDto,
+    GetAllLogsDto,
     GetLogDto,
 };

lib/server/controllers/logs.controller.js

@@ -12,7 +12,7 @@
  */
 
 const { log: { CreateLogUseCase, GetAllLogsUseCase, GetLogUseCase } } = require('../../usecases');
-const { dtos: { CreateLogDto, GetLogDto } } = require('../../domain');
+const { dtos: { CreateLogDto, GetAllLogsDto, GetLogDto } } = require('../../domain');
 
 /**
  * Create a new log
@@ -105,8 +105,23 @@ const getAttachment = (request, response, next) => {
  * @returns {undefined}
  */
 const index = async (request, response, next) => {
+    const getAllLogsDto = new GetAllLogsDto(request);
+    const { valid, errors } = getAllLogsDto.validate();
+
+    if (!valid) {
+        response.status(400).json({
+            errors: errors.map((error) => ({
+                status: '422',
+                source: { pointer: `/data/attributes/${error.path.join('/')}` },
+                title: 'Invalid Attribute',
+                detail: error.message,
+            })),
+        });
+        return;
+    }
+
     const logs = await new GetAllLogsUseCase()
-        .execute();
+        .execute(getAllLogsDto);
     response.status(200).json({
         data: logs,
     });

lib/usecases/log/GetAllLogsUseCase.js

@@ -16,6 +16,7 @@ const {
         LogRepository,
     },
     utilities: {
+        QueryBuilder,
         TransactionHelper,
     },
 } = require('../../database');
@@ -27,10 +28,22 @@ class GetAllLogsUseCase {
     /**
      * 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() {
-        return TransactionHelper.provide(() => LogRepository.findAll());
+    async execute(dto = {}) {
+        const queryBuilder = new QueryBuilder();
+        const { query = {} } = dto;
+        const { filter } = query;
+
+        if (filter) {
+            const { origin } = filter;
+            if (origin) {
+                queryBuilder.where('origin', origin);
+            }
+        }
+
+        return TransactionHelper.provide(() => LogRepository.findAll(queryBuilder));
     }
 }
 

spec/openapi.yaml

@@ -25,9 +25,18 @@ paths:
     get:
       operationId: listLogs
       summary: List all logs
+      parameters:
+        - name: filter[origin]
+          description: Filter logs by their origin
+          in: query
+          schema:
+            type: string
+            enum: [human, process]
       responses:
         '200':
           $ref: '#/components/responses/ArrayOfLogs'
+        '400':
+          $ref: '#/components/responses/BadRequest'
       tags:
         - log
     post:
@@ -134,6 +143,11 @@ components:
           $ref: '#/components/schemas/ArrayOfLogs'
       required:
         - data
+    ArrayOfTags:
+      description: A list of Tag objects.
+      type: array
+      items:
+        $ref: '#/components/schemas/Tag'
     DeployInformation:
       description: Deploy information
       type: object
@@ -179,11 +193,24 @@ components:
       description: Describes an intervention or an event that happened.
       type: object
       properties:
+        entryID:
+          description: Id of the log.
+          type: integer
+          format: int64
         title:
           description: Title of the log.
           type: string
+        origin:
+          description: Type of creator.
+          type: string
+          enum: [human, process]
+        tags:
+          $ref: '#/components/schemas/ArrayOfTags'
       required:
+        - entryID
         - title
+        - origin
+        - tags
     LogResponse:
       description: Response containing a single log.
       type: object
@@ -192,3 +219,6 @@ components:
           $ref: '#/components/schemas/Log'
       required:
         - data
+    Tag:
+      description: A label attached to something for the purpose of identification.
+      type: string