feat(api): add create folder endpoint for users

This commit is contained in:
Ali BARIN
2025-04-24 12:56:36 +00:00
parent 115b409b92
commit b15ad10a55
8 changed files with 110 additions and 3 deletions

View File

@@ -0,0 +1,14 @@
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 folder = await user.$relatedQuery('folders').insertAndFetch({
name: request.body.name,
});
renderObject(response, folder, { status: 201 });
};

View File

@@ -0,0 +1,65 @@
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 createFolderMock from '../../../../../test/mocks/rest/api/v1/users/create-folder.js';
import * as license from '../../../../helpers/license.ee.js';
describe('POST /api/v1/users/:userId/folders', () => {
let currentUser, token;
beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
currentUser = await createUser();
token = (await createApiToken()).token;
});
it('should return created folder for the given user', async () => {
const response = await request(app)
.post(`/api/v1/users/${currentUser.id}/folders`)
.set('x-api-token', token)
.send({
name: 'Test Folder',
})
.expect(201);
const refetchedFolder = await currentUser
.$relatedQuery('folders')
.findById(response.body.data.id);
const expectedPayload = await createFolderMock(refetchedFolder);
expect(response.body).toMatchObject(expectedPayload);
});
it('should return unprocessable entity response for invalid data', async () => {
const response = await request(app)
.post(`/api/v1/users/${currentUser.id}/folders`)
.set('x-api-token', token)
.send({})
.expect(422);
expect(response.body.errors.name).toStrictEqual([
"must have required property 'name'",
]);
});
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);
});
});

View File

@@ -16,7 +16,7 @@ describe('POST /internal/api/v1/folders', () => {
token = await createAuthTokenByUserId(currentUser.id);
});
it('should return created flow', async () => {
it('should return created folder', async () => {
await createPermission({
action: 'manage',
subject: 'Flow',

View File

@@ -22,6 +22,9 @@ exports[`Folder model > jsonSchema should have correct validations 1`] = `
"type": "string",
},
},
"required": [
"name",
],
"type": "object",
}
`;

View File

@@ -7,6 +7,8 @@ class Folder extends Base {
static jsonSchema = {
type: 'object',
required: ['name'],
properties: {
id: { type: 'string', format: 'uuid' },
name: { type: 'string', minLength: 1 },

View File

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

View File

@@ -0,0 +1,21 @@
const createFolderMock = async (flow) => {
const data = {
id: flow.id,
name: flow.name,
createdAt: flow.createdAt.getTime(),
updatedAt: flow.updatedAt.getTime(),
};
return {
data: data,
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'Folder',
},
};
};
export default createFolderMock;

View File

@@ -29,8 +29,8 @@ export default defineConfig({
thresholds: {
autoUpdate: true,
statements: 99.39,
branches: 98.28,
functions: 99.03,
branches: 98.29,
functions: 99.04,
lines: 99.39,
},
},