feat: allow sorting on /api/logs

Author: mvegter

lib/database/utilities/QueryBuilder.js

@@ -44,6 +44,31 @@ class QueryBuilder {
         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.
      *

lib/domain/dtos/GetAllLogsDto.js

@@ -24,7 +24,17 @@ const FilterDto = attributes({
 const QueryDto = attributes({
     filter: FilterDto,
     page: PaginationDto,
-})(class QueryDto {});
+    sort: {
+        type: Array,
+        itemType: String,
+    },
+})(class QueryDto {
+    // eslint-disable-next-line require-jsdoc
+    get sort() {
+        const val = this.get('sort');
+        return !val ? val : val.join('').split(',');
+    }
+});
 
 const GetAllLogsDto = attributes({
     query: QueryDto,

lib/usecases/log/GetAllLogsUseCase.js

@@ -34,7 +34,7 @@ class GetAllLogsUseCase {
     async execute(dto = {}) {
         const queryBuilder = new QueryBuilder();
         const { query = {} } = dto;
-        const { filter, page = {} } = query;
+        const { filter, page = {}, sort = ['-id'] } = query;
 
         if (filter) {
             const { origin } = filter;
@@ -47,6 +47,8 @@ class GetAllLogsUseCase {
         queryBuilder.limit(limit);
         queryBuilder.offset(offset);
 
+        queryBuilder.orderBy(sort);
+
         return TransactionHelper.provide(() => LogRepository.findAll(queryBuilder));
     }
 }

spec/openapi.yaml

@@ -29,6 +29,7 @@ paths:
         - $ref: '#/components/parameters/filterOrigin'
         - $ref: '#/components/parameters/pageOffset'
         - $ref: '#/components/parameters/pageLimit'
+        - $ref: '#/components/parameters/sortLogs'
       responses:
         '200':
           $ref: '#/components/responses/ArrayOfLogs'
@@ -109,6 +110,19 @@ components:
         type: integer
         minimum: 0
         default: 0
+    sortLogs:
+      in: query
+      name: sort
+      description: The sort order of the returned items.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+        default:
+          - -id
+      style: form
+      explode: false
   responses:
     ArrayOfLogs:
       description: Expected response to a valid request.

test/e2e/logs.test.js

@@ -109,7 +109,7 @@ module.exports = () => {
 
         it('should support pagination, offset 0 and limit 1', (done) => {
             request(server)
-                .get('/api/logs?page[offset]=0&page[limit]=1')
+                .get('/api/logs?page[offset]=0&page[limit]=1&sort=id')
                 .expect(200)
                 .end((err, res) => {
                     if (err) {
@@ -129,7 +129,7 @@ module.exports = () => {
 
         it('should support pagination, offset 1 and limit 1', (done) => {
             request(server)
-                .get('/api/logs?page[offset]=1&page[limit]=1')
+                .get('/api/logs?page[offset]=1&page[limit]=1&sort=id')
                 .expect(200)
                 .end((err, res) => {
                     if (err) {
@@ -167,6 +167,46 @@ module.exports = () => {
                     done();
                 });
         });
+
+        it('should support sorting, id DESC', (done) => {
+            request(server)
+                .get('/api/logs?sort=-id')
+                .expect(200)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { data } = res.body;
+                    expect(data[0].entryId).to.be.greaterThan(data[1].entryId);
+
+                    done();
+                });
+        });
+
+        it('should support sorting, id ASC', (done) => {
+            request(server)
+                .get('/api/logs?sort=id')
+                .expect(200)
+                .end((err, res) => {
+                    if (err) {
+                        done(err);
+                        return;
+                    }
+
+                    // Response must satisfy the OpenAPI specification
+                    expect(res).to.satisfyApiSpec;
+
+                    const { data } = res.body;
+                    expect(data[1].entryId).to.be.greaterThan(data[0].entryId);
+
+                    done();
+                });
+        });
     });
 
     describe('POST /api/logs', () => {