Merge pull request #2326 from automatisch/list-folders

feat: Implement get folders API endpoint

packages/backend/src/controllers/api/v1/folders/get-folders.js

@@ -0,0 +1,9 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const folders = await request.currentUser
+    .$relatedQuery('folders')
+    .orderBy('name', 'asc');
+
+  renderObject(response, folders);
+};

packages/backend/src/controllers/api/v1/folders/get-folders.test.js

@@ -0,0 +1,53 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../test/factories/user.js';
+import { createFolder } from '../../../../../test/factories/folder.js';
+import { createPermission } from '../../../../../test/factories/permission.js';
+import getFoldersMock from '../../../../../test/mocks/rest/api/v1/folders/get-folders.js';
+
+describe('GET /api/v1/folders', () => {
+  let folderOne, folderTwo, currentUser, currentUserRole, token;
+
+  beforeEach(async () => {
+    currentUser = await createUser();
+    currentUserRole = await currentUser.$relatedQuery('role');
+
+    folderOne = await createFolder({
+      name: 'Folder One',
+      userId: currentUser.id,
+    });
+
+    folderTwo = await createFolder({
+      name: 'Folder Two',
+      userId: currentUser.id,
+    });
+
+    const anotherUser = await createUser();
+
+    await createFolder({
+      name: 'Folder Three',
+      userId: anotherUser.id,
+    });
+
+    token = await createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return folders of the current user', async () => {
+    await createPermission({
+      action: 'read',
+      subject: 'Flow',
+      roleId: currentUserRole.id,
+    });
+
+    const response = await request(app)
+      .get('/api/v1/folders')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getFoldersMock([folderOne, folderTwo]);
+
+    expect(response.body).toStrictEqual(expectedPayload);
+  });
+});

packages/backend/src/helpers/authorization.js

@@ -145,6 +145,10 @@ const authorizationList = {
     action: 'create',
     subject: 'Flow',
   },
+  'GET /api/v1/folders/': {
+    action: 'read',
+    subject: 'Flow',
+  },
 };
 
 export const authorizeUser = async (request, response, next) => {

packages/backend/src/routes/api/v1/folders.js

@@ -1,12 +1,14 @@
 import { Router } from 'express';
 import { authenticateUser } from '../../../helpers/authentication.js';
 import { authorizeUser } from '../../../helpers/authorization.js';
+import getFoldersAction from '../../../controllers/api/v1/folders/get-folders.js';
 import createFolderAction from '../../../controllers/api/v1/folders/create-folder.js';
 import updateFolderAction from '../../../controllers/api/v1/folders/update-folder.js';
 import deleteFolderAction from '../../../controllers/api/v1/folders/delete-folder.js';
 
 const router = Router();
 
+router.get('/', authenticateUser, authorizeUser, getFoldersAction);
 router.post('/', authenticateUser, authorizeUser, createFolderAction);
 router.patch('/:folderId', authenticateUser, authorizeUser, updateFolderAction);
 

packages/backend/test/factories/folder.js

@@ -1,7 +1,9 @@
 import Folder from '../../src/models/folder.js';
 import { faker } from '@faker-js/faker';
+import { createUser } from './user';
 
 export const createFolder = async (params = {}) => {
+  params.userId = params?.userId || (await createUser()).id;
   params.name = params?.name || faker.lorem.word();
 
   const folder = await Folder.query().insertAndFetch(params);

packages/backend/test/mocks/rest/api/v1/folders/get-folders.js

@@ -0,0 +1,23 @@
+const getFoldersMock = async (folders) => {
+  const data = folders.map((folder) => {
+    return {
+      id: folder.id,
+      name: folder.name,
+      createdAt: folder.createdAt.getTime(),
+      updatedAt: folder.updatedAt.getTime(),
+    };
+  });
+
+  return {
+    data: data,
+    meta: {
+      count: data.length,
+      currentPage: null,
+      isArray: true,
+      totalPages: null,
+      type: 'Folder',
+    },
+  };
+};
+
+export default getFoldersMock;