feat(api): add get folders endpoint for users

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

@@ -0,0 +1,12 @@
+import User from '../../../../models/user.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const user = await User.query()
+    .findById(request.params.userId)
+    .throwIfNotFound();
+
+  const folders = await user.$relatedQuery('folders').orderBy('name', 'asc');
+
+  renderObject(response, folders, { serializer: 'Folder' });
+};

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

@@ -0,0 +1,75 @@
+import Crypto from 'node:crypto';
+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/users/:userId/folders', () => {
+  let folderA, folderB, currentUser, token;
+
+  beforeEach(async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    currentUser = await createUser();
+
+    folderA = await createFolder({
+      name: 'Folder A',
+      userId: currentUser.id,
+    });
+
+    folderB = await createFolder({
+      name: 'Folder B',
+      userId: currentUser.id,
+    });
+
+    await createFolder({
+      name: 'Folder C',
+    });
+
+    token = (await createApiToken()).token;
+  });
+
+  it('should return folders of the given user', async () => {
+    const response = await request(app)
+      .get(`/api/v1/users/${currentUser.id}/folders`)
+      .set('x-api-token', token)
+      .expect(200);
+
+    const expectedPayload = await getFoldersMock([folderA, folderB]);
+
+    expect(response.body).toStrictEqual(expectedPayload);
+  });
+
+  it('should respond with HTTP 404 for non-existent user', async () => {
+    const notExistingUserId = Crypto.randomUUID();
+
+    await request(app)
+      .get(`/api/v1/users/${notExistingUserId}/folders`)
+      .set('x-api-token', token)
+      .expect(404);
+  });
+
+  it('should return bad request response for invalid user UUID', async () => {
+    await request(app)
+      .get(`/api/v1/users/invalidUserUUID/folders`)
+      .set('x-api-token', token)
+      .expect(400);
+  });
+
+  it('should respond with HTTP 404 for no folders of the given user', async () => {
+    const user = await createUser();
+
+    const response = await request(app)
+      .get(`/api/v1/users/${user.id}/folders`)
+      .set('x-api-token', token)
+      .expect(200);
+
+    const expectedPayload = await getFoldersMock([]);
+
+    expect(response.body).toStrictEqual(expectedPayload);
+  });
+});

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

@@ -1,10 +1,12 @@
 import { Router } from 'express';
 import appsRouter from './v1/apps.ee.js';
 import foldersRouter from './v1/folders.ee.js';
+import usersRouter from './v1/users.ee.js';
 
 const router = Router();
 
 router.use('/v1/apps', appsRouter);
 router.use('/v1/folders', foldersRouter);
+router.use('/v1/users', usersRouter);
 
 export default router;

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

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

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

@@ -15,7 +15,7 @@ const getFoldersMock = async (folders) => {
       currentPage: null,
       isArray: true,
       totalPages: null,
-      type: 'Folder',
+      type: folders.length ? 'Folder' : 'Object',
     },
   };
 };

packages/backend/vitest.config.js

@@ -28,11 +28,11 @@ export default defineConfig({
       ],
       thresholds: {
         autoUpdate: true,
-        statements: 99.38,
+        statements: 99.39,
-        branches: 98.25,
+        branches: 98.28,
-        functions: 99.02,
+        functions: 99.03,
-        lines: 99.38,
+        lines: 99.39,
       },
     },
   },
-});
+});