From 529eec69e9e57d9acbdfd0b31283c6df02dd9383 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Thu, 6 Feb 2025 12:44:15 +0100 Subject: [PATCH] feat: Implement an API endpoint to get flow folder --- .../controllers/api/v1/flows/get-folder.js | 12 +++ .../api/v1/flows/get-folder.test.js | 79 +++++++++++++++++++ packages/backend/src/helpers/authorization.js | 4 + packages/backend/src/routes/api/v1/flows.js | 2 + .../mocks/rest/api/v1/flows/get-folder.js | 21 +++++ 5 files changed, 118 insertions(+) create mode 100644 packages/backend/src/controllers/api/v1/flows/get-folder.js create mode 100644 packages/backend/src/controllers/api/v1/flows/get-folder.test.js create mode 100644 packages/backend/test/mocks/rest/api/v1/flows/get-folder.js diff --git a/packages/backend/src/controllers/api/v1/flows/get-folder.js b/packages/backend/src/controllers/api/v1/flows/get-folder.js new file mode 100644 index 00000000..6c3bc0eb --- /dev/null +++ b/packages/backend/src/controllers/api/v1/flows/get-folder.js @@ -0,0 +1,12 @@ +import { renderObject } from '../../../../helpers/renderer.js'; + +export default async (request, response) => { + const flow = await request.currentUser + .$relatedQuery('flows') + .findOne({ id: request.params.flowId }) + .throwIfNotFound(); + + const folder = await flow.$relatedQuery('folder').throwIfNotFound(); + + renderObject(response, folder); +}; diff --git a/packages/backend/src/controllers/api/v1/flows/get-folder.test.js b/packages/backend/src/controllers/api/v1/flows/get-folder.test.js new file mode 100644 index 00000000..867356be --- /dev/null +++ b/packages/backend/src/controllers/api/v1/flows/get-folder.test.js @@ -0,0 +1,79 @@ +import { describe, it, expect, beforeEach } from 'vitest'; +import request from 'supertest'; +import Crypto from 'crypto'; +import app from '../../../../app.js'; +import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id'; +import { createUser } from '../../../../../test/factories/user'; +import { createFlow } from '../../../../../test/factories/flow'; +import { createStep } from '../../../../../test/factories/step'; +import { createPermission } from '../../../../../test/factories/permission'; +import { createFolder } from '../../../../../test/factories/folder'; +import getFolderMock from '../../../../../test/mocks/rest/api/v1/flows/get-folder'; + +describe('GET /api/v1/flows/:flowId/folder', () => { + let currentUser, currentUserRole, token; + + beforeEach(async () => { + currentUser = await createUser(); + currentUserRole = await currentUser.$relatedQuery('role'); + + token = await createAuthTokenByUserId(currentUser.id); + }); + + it('should return the folder data of current user', async () => { + const folder = await createFolder({ userId: currentUser.id }); + + const currentUserFlow = await createFlow({ + userId: currentUser.id, + folderId: folder.id, + }); + + await createStep({ flowId: currentUserFlow.id }); + await createStep({ flowId: currentUserFlow.id }); + + await createPermission({ + action: 'read', + subject: 'Flow', + roleId: currentUserRole.id, + }); + + const response = await request(app) + .get(`/api/v1/flows/${currentUserFlow.id}/folder`) + .set('Authorization', token) + .expect(200); + + const expectedPayload = await getFolderMock(folder); + + expect(response.body).toStrictEqual(expectedPayload); + }); + + it('should return not found response for not existing flow UUID', async () => { + await createPermission({ + action: 'read', + subject: 'Flow', + roleId: currentUserRole.id, + conditions: [], + }); + + const notExistingFlowUUID = Crypto.randomUUID(); + + await request(app) + .get(`/api/v1/flows/${notExistingFlowUUID}/folder`) + .set('Authorization', token) + .expect(404); + }); + + it('should return bad request response for invalid UUID', async () => { + await createPermission({ + action: 'read', + subject: 'Flow', + roleId: currentUserRole.id, + conditions: [], + }); + + await request(app) + .get('/api/v1/flows/invalidFlowUUID/folder') + .set('Authorization', token) + .expect(400); + }); +}); diff --git a/packages/backend/src/helpers/authorization.js b/packages/backend/src/helpers/authorization.js index 38ec539e..107774b1 100644 --- a/packages/backend/src/helpers/authorization.js +++ b/packages/backend/src/helpers/authorization.js @@ -153,6 +153,10 @@ const authorizationList = { action: 'update', subject: 'Flow', }, + 'GET /api/v1/flows/:flowId/folder': { + action: 'read', + subject: 'Flow', + }, }; export const authorizeUser = async (request, response, next) => { diff --git a/packages/backend/src/routes/api/v1/flows.js b/packages/backend/src/routes/api/v1/flows.js index 259bd0fb..0218878b 100644 --- a/packages/backend/src/routes/api/v1/flows.js +++ b/packages/backend/src/routes/api/v1/flows.js @@ -3,6 +3,7 @@ import { authenticateUser } from '../../../helpers/authentication.js'; import { authorizeUser } from '../../../helpers/authorization.js'; import getFlowsAction from '../../../controllers/api/v1/flows/get-flows.js'; import getFlowAction from '../../../controllers/api/v1/flows/get-flow.js'; +import getFolderAction from '../../../controllers/api/v1/flows/get-folder.js'; import updateFlowAction from '../../../controllers/api/v1/flows/update-flow.js'; import updateFlowStatusAction from '../../../controllers/api/v1/flows/update-flow-status.js'; import updateFlowFolderAction from '../../../controllers/api/v1/flows/update-flow-folder.js'; @@ -17,6 +18,7 @@ const router = Router(); router.get('/', authenticateUser, authorizeUser, getFlowsAction); router.get('/:flowId', authenticateUser, authorizeUser, getFlowAction); +router.get('/:flowId/folder', authenticateUser, authorizeUser, getFolderAction); router.post('/', authenticateUser, authorizeUser, createFlowAction); router.patch('/:flowId', authenticateUser, authorizeUser, updateFlowAction); diff --git a/packages/backend/test/mocks/rest/api/v1/flows/get-folder.js b/packages/backend/test/mocks/rest/api/v1/flows/get-folder.js new file mode 100644 index 00000000..2e0c498b --- /dev/null +++ b/packages/backend/test/mocks/rest/api/v1/flows/get-folder.js @@ -0,0 +1,21 @@ +const getFlowMock = async (folder) => { + const data = { + id: folder.id, + name: folder.name, + createdAt: folder.createdAt.getTime(), + updatedAt: folder.updatedAt.getTime(), + }; + + return { + data: data, + meta: { + count: 1, + currentPage: null, + isArray: false, + totalPages: null, + type: 'Folder', + }, + }; +}; + +export default getFlowMock;