Merge pull request #2476 from automatisch/remove-folders-endpoint

feat: Convert folders API endpoints to user-scoped ones

packages/backend/src/controllers/api/v1/folders/delete-folder.ee.js

@@ -1,11 +0,0 @@
-import Folder from '../../../../models/folder.js';
-
-export default async (request, response) => {
-  const folder = await Folder.query()
-    .findById(request.params.folderId)
-    .throwIfNotFound();
-
-  await folder.delete();
-
-  response.status(204).end();
-};

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

@@ -1,8 +0,0 @@
-import { renderObject } from '../../../../helpers/renderer.js';
-import Folder from '../../../../models/folder.js';
-
-export default async (request, response) => {
-  const folders = await Folder.query().orderBy('name', 'asc');
-
-  renderObject(response, folders);
-};

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

@@ -1,47 +0,0 @@
-import { vi, describe, it, expect, beforeEach } from 'vitest';
-import request from 'supertest';
-import app from '../../../../app.js';
-import { createApiToken } from '../../../../../test/factories/api-token.js';
-import { createUser } from '../../../../../test/factories/user.js';
-import { createFolder } from '../../../../../test/factories/folder.js';
-import getFoldersMock from '../../../../../test/mocks/rest/api/v1/folders/get-folders.js';
-import * as license from '../../../../helpers/license.ee.js';
-
-describe('GET /api/v1/folders', () => {
-  let folderA, folderB, folderC, currentUser, anotherUser, token;
-
-  beforeEach(async () => {
-    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
-
-    currentUser = await createUser();
-    anotherUser = await createUser();
-
-    folderC = await createFolder({
-      name: 'Folder C',
-      userId: currentUser.id,
-    });
-
-    folderA = await createFolder({
-      name: 'Folder A',
-      userId: anotherUser.id,
-    });
-
-    folderB = await createFolder({
-      name: 'Folder B',
-      userId: anotherUser.id,
-    });
-
-    token = (await createApiToken()).token;
-  });
-
-  it('should return all folders', async () => {
-    const response = await request(app)
-      .get('/api/v1/folders')
-      .set('x-api-token', token)
-      .expect(200);
-
-    const expectedPayload = await getFoldersMock([folderA, folderB, folderC]);
-
-    expect(response.body).toStrictEqual(expectedPayload);
-  });
-});

packages/backend/src/controllers/api/v1/users/delete-folder.ee.js

@@ -0,0 +1,16 @@
+import User from '../../../../models/user.js';
+
+export default async (request, response) => {
+  const user = await User.query()
+    .findById(request.params.userId)
+    .throwIfNotFound();
+
+  const folder = await user
+    .$relatedQuery('folders')
+    .findById(request.params.folderId)
+    .throwIfNotFound();
+
+  await folder.delete();
+
+  response.status(204).end();
+};

packages/backend/src/controllers/api/v1/users/delete-folder.ee.test.js

@@ -3,39 +3,49 @@ import request from 'supertest';
 import { beforeEach, describe, it, vi } from 'vitest';
 import { createApiToken } from '../../../../../test/factories/api-token.js';
 import { createFolder } from '../../../../../test/factories/folder.js';
+import { createUser } from '../../../../../test/factories/user.js';
 import app from '../../../../app.js';
 import * as license from '../../../../helpers/license.ee.js';
 
-describe('DELETE /api/v1/folders/:folderId', () => {
-  let token;
+describe('DELETE /api/v1/users/:userId/folders/:folderId', () => {
+  let token, user, folder;
 
   beforeEach(async () => {
     vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
 
     token = (await createApiToken()).token;
+    user = await createUser();
+    folder = await createFolder({ userId: user.id });
   });
 
   it('should remove the folder and return no content', async () => {
-    const folder = await createFolder();
-
     await request(app)
-      .delete(`/api/v1/folders/${folder.id}`)
+      .delete(`/api/v1/users/${folder.userId}/folders/${folder.id}`)
       .set('x-api-token', token)
       .expect(204);
   });
 
+  it('should return not found response for not existing user UUID', async () => {
+    const notExistingUserUUID = Crypto.randomUUID();
+
+    await request(app)
+      .delete(`/api/v1/users/${notExistingUserUUID}/folders/${folder.id}`)
+      .set('x-api-token', token)
+      .expect(404);
+  });
+
   it('should return not found response for not existing folder UUID', async () => {
     const notExistingFolderUUID = Crypto.randomUUID();
 
     await request(app)
-      .delete(`/api/v1/folders/${notExistingFolderUUID}`)
+      .delete(`/api/v1/users/${user.id}/folders/${notExistingFolderUUID}`)
       .set('x-api-token', token)
       .expect(404);
   });
 
-  it('should return bad request response for invalid UUID', async () => {
+  it('should return bad request response for invalid folder UUID', async () => {
     await request(app)
-      .delete('/api/v1/folders/invalidFolderUUID')
+      .delete(`/api/v1/users/${user.id}/folders/invalidFolderUUID`)
       .set('x-api-token', token)
       .expect(400);
   });

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

@@ -5,7 +5,7 @@ import app from '../../../../app.js';
 import { createApiToken } from '../../../../../test/factories/api-token.js';
 import { createUser } from '../../../../../test/factories/user.js';
 import { createFolder } from '../../../../../test/factories/folder.js';
-import getFoldersMock from '../../../../../test/mocks/rest/api/v1/folders/get-folders.js';
+import getFoldersMock from '../../../../../test/mocks/rest/api/v1/users/get-folders.js';
 import * as license from '../../../../helpers/license.ee.js';
 
 describe('GET /api/v1/users/:userId/folders', () => {

packages/backend/src/routes/api/index.js

@@ -2,7 +2,6 @@ import { Router } from 'express';
 import appsRouter from './v1/apps.ee.js';
 import executionsRouter from './v1/executions.ee.js';
 import flowsRouter from './v1/flows.ee.js';
-import foldersRouter from './v1/folders.ee.js';
 import templatesRouter from './v1/templates.ee.js';
 import usersRouter from './v1/users.ee.js';
 import userInvitationsRouter from './v1/user-invitations.ee.js';
@@ -12,7 +11,6 @@ const router = Router();
 router.use('/v1/apps', appsRouter);
 router.use('/v1/executions', executionsRouter);
 router.use('/v1/flows', flowsRouter);
-router.use('/v1/folders', foldersRouter);
 router.use('/v1/templates', templatesRouter);
 router.use('/v1/users', usersRouter);
 router.use('/v1/user-invitations', userInvitationsRouter);

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

@@ -1,10 +0,0 @@
-import { Router } from 'express';
-import getFoldersAction from '../../../controllers/api/v1/folders/get-folders.ee.js';
-import deleteFolderAction from '../../../controllers/api/v1/folders/delete-folder.ee.js';
-
-const router = Router();
-
-router.get('/', getFoldersAction);
-router.delete('/:folderId', deleteFolderAction);
-
-export default router;

packages/backend/src/routes/api/v1/users.ee.js

@@ -4,6 +4,7 @@ import getFoldersAction from '../../../controllers/api/v1/users/get-folders.ee.j
 import getUserAction from '../../../controllers/api/v1/users/get-user.ee.js';
 import deleteUserAction from '../../../controllers/api/v1/users/delete-user.ee.js';
 import getUsersAction from '../../../controllers/api/v1/users/get-users.ee.js';
+import deleteFolderAction from '../../../controllers/api/v1/users/delete-folder.ee.js';
 
 const router = Router();
 
@@ -12,5 +13,6 @@ router.get('/:userId', getUserAction);
 router.delete('/:userId', deleteUserAction);
 router.get('/:userId/folders', getFoldersAction);
 router.post('/:userId/folders', createFolderAction);
+router.delete('/:userId/folders/:folderId', deleteFolderAction);
 
 export default router;

packages/backend/vitest.config.js

@@ -30,9 +30,9 @@ export default defineConfig({
         autoUpdate: true,
         statements: 99.44,
         branches: 98.41,
-        functions: 99.1,
+        functions: 99.09,
         lines: 99.44,
       },
     },
   },
-});
+});