feat: filtering on GET /api/logs

Author: mvegter

.validaterc

@@ -18,8 +18,8 @@
     "parameters": {
       "no_parameter_description": "error",
       "param_name_case_convention": [
-        "error",
-        "lower_snake_case"
+        "warning",
+        "lower_camel_case"
       ],
       "invalid_type_format_pair": "error",
       "content_type_parameter": "error",
@@ -33,7 +33,7 @@
       "snake_case_only": "off",
       "paths_case_convention": [
         "error",
-        "lower_snake_case"
+        "lower_camel_case"
       ]
     },
     "responses": {
@@ -56,12 +56,12 @@
       "inconsistent_property_type": "error",
       "property_case_convention": [
         "error",
-        "lower_snake_case"
+        "lower_camel_case"
       ],
       "property_case_collision": "error",
       "enum_case_convention": [
         "error",
-        "lower_snake_case"
+        "lower_camel_case"
       ]
     },
     "walker": {

lib/database/adapters/LogAdapter.js

@@ -25,11 +25,12 @@ class LogAdapter {
      */
     static toEntity(databaseObject) {
         return Object.assign(new Log(), {
-            entryID: databaseObject.id,
+            entryId: databaseObject.id,
             authorID: 'Batman',
             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' },
@@ -46,7 +47,7 @@ class LogAdapter {
      */
     static toDatabase(entityObject) {
         return {
-            id: entityObject.entryID,
+            id: entityObject.entryId,
             title: entityObject.title,
             subtype: 'run',
             origin: 'process',

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,98 @@
+/**
+ * @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 = {};
+    }
+
+    /**
+     * The numbers of items to return.
+     *
+     * @param {Number} number The numbers of items to return.
+     * @returns {Object} The current QueryBuilder instance.
+     */
+    limit(number) {
+        this.options.limit = number;
+        return this;
+    }
+
+    /**
+     * The number of items to skip before starting to collect the result set.
+     *
+     * @param {Number} number  The number of items to skip.
+     * @returns {Object} The current QueryBuilder instance.
+     */
+    offset(number) {
+        this.options.offset = number;
+        return this;
+    }
+
+    /**
+     * Set the order of elements.
+     *
+     * @param {String|Array} order Either a string or an array of strings.
+     * @returns {Object} The current QueryBuilder instance.
+     */
+    orderBy(order) {
+        if (Array.isArray(order)) {
+            for (const orderElement of order) {
+                this.orderBy(orderElement);
+            }
+            return this;
+        }
+
+        if (!this.options.order) {
+            this.options.order = [];
+        }
+
+        if (order.startsWith('-')) {
+            this.options.order.push([order.substr(1), 'DESC']);
+        } else {
+            this.options.order.push([order, 'ASC']);
+        }
+    }
+
+    /**
+     * 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/CreateLogDto.js

@@ -11,18 +11,18 @@
  * or submit itself to any jurisdiction.
  */
 
-const { attributes } = require('structure');
+const Joi = require('@hapi/joi');
 
-const BodyDto = attributes({
-    title: {
-        type: String,
-        required: true,
-        minLength: 3,
-    },
-})(class BodyDto {});
+const BodyDto = Joi.object({
+    title: Joi.string()
+        .required()
+        .min(3),
+});
 
-const CreateLogDto = attributes({
+const CreateLogDto = Joi.object({
+    query: Joi.object({}),
     body: BodyDto,
-})(class CreateLogDto {});
+    params: Joi.object({}),
+});
 
 module.exports = CreateLogDto;

lib/domain/dtos/GetAllLogsDto.js

@@ -0,0 +1,44 @@
+/**
+ * @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 Joi = require('@hapi/joi');
+const PaginationDto = require('./PaginationDto');
+
+const CustomJoi = Joi.extend({
+    base: Joi.array(),
+    type: 'stringArray',
+    coerce: (value) => ({ value: value.split ? value.split(',') : value }),
+});
+
+const FilterDto = Joi.object({
+    origin: Joi.string()
+        .valid('human', 'process'),
+});
+
+const QueryDto = Joi.object({
+    filter: FilterDto,
+    page: PaginationDto,
+    sort: CustomJoi.stringArray()
+        .items(Joi.string()
+            .valid('id', '-id')
+            .valid('title', '-title')),
+    token: Joi.string(),
+});
+
+const GetAllLogsDto = Joi.object({
+    body: Joi.object({}),
+    params: Joi.object({}),
+    query: QueryDto,
+});
+
+module.exports = GetAllLogsDto;

lib/domain/dtos/GetLogDto.js

@@ -11,19 +11,22 @@
  * or submit itself to any jurisdiction.
  */
 
-const { attributes } = require('structure');
+const Joi = require('@hapi/joi');
 
-const ParamsDto = attributes({
-    id: {
-        type: Number,
-        required: true,
-        integer: true,
-        positive: true,
-    },
-})(class ParamsDto {});
+const ParamsDto = Joi.object({
+    id: Joi.number()
+        .integer()
+        .positive(),
+});
 
-const GetLogDto = attributes({
+const QueryDto = Joi.object({
+    token: Joi.string(),
+});
+
+const GetLogDto = Joi.object({
+    body: Joi.object({}),
     params: ParamsDto,
-})(class GetLogDto {});
+    query: QueryDto,
+});
 
 module.exports = GetLogDto;

test/framework/index.js lib/domain/dtos/PaginationDto.jstest/framework/index.js renamed to lib/domain/dtos/PaginationDto.js

@@ -11,8 +11,16 @@
  * or submit itself to any jurisdiction.
  */
 
-const HttpSuite = require('./http');
+const Joi = require('@hapi/joi');
 
-module.exports = () => {
-    describe('HTTP', HttpSuite);
-};
+const PaginationDto = Joi.object({
+    limit: Joi.number()
+        .integer()
+        .min(1)
+        .max(100),
+    offset: Joi.number()
+        .integer()
+        .min(0),
+});
+
+module.exports = PaginationDto;

lib/domain/dtos/index.js

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