From 1cb380a077d64645b2f0cccc1ca13e4794fdb245 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Fri, 28 Feb 2025 16:26:48 +0100 Subject: [PATCH] feat: Implement admin update template API endpoint --- .../v1/admin/templates/update-template.ee.js | 17 +++++ .../templates/update-template.ee.test.js | 76 +++++++++++++++++++ .../src/routes/api/v1/admin/templates.ee.js | 9 +++ .../v1/admin/templates/update-template.ee.js | 22 ++++++ 4 files changed, 124 insertions(+) create mode 100644 packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.js create mode 100644 packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.test.js create mode 100644 packages/backend/test/mocks/rest/api/v1/admin/templates/update-template.ee.js diff --git a/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.js b/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.js new file mode 100644 index 00000000..5da705e0 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.js @@ -0,0 +1,17 @@ +import { renderObject } from '../../../../../helpers/renderer.js'; +import Template from '../../../../../models/template.ee.js'; + +export default async (request, response) => { + const template = await Template.query() + .patchAndFetchById(request.params.templateId, templateParams(request)) + .throwIfNotFound(); + + renderObject(response, template, { + serializer: 'AdminTemplate', + }); +}; + +const templateParams = (request) => { + const { name } = request.body; + return { name }; +}; diff --git a/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.test.js b/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.test.js new file mode 100644 index 00000000..ebac1ed7 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/templates/update-template.ee.test.js @@ -0,0 +1,76 @@ +import { vi, 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.js'; +import { createRole } from '../../../../../../test/factories/role.js'; +import { createUser } from '../../../../../../test/factories/user.js'; +import { createTemplate } from '../../../../../../test/factories/template.js'; +import updateTemplateMock from '../../../../../../test/mocks/rest/api/v1/admin/templates/update-template.ee.js'; +import * as license from '../../../../../helpers/license.ee.js'; + +describe('PATCH /api/v1/admin/templates/:templateId', () => { + let currentUser, token, role; + + beforeEach(async () => { + vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); + + role = await createRole({ name: 'Admin' }); + currentUser = await createUser({ roleId: role.id }); + + token = await createAuthTokenByUserId(currentUser.id); + }); + + it('should return the updated template', async () => { + const template = await createTemplate(); + const updatedName = 'Updated Template Name'; + + const response = await request(app) + .patch(`/api/v1/admin/templates/${template.id}`) + .set('Authorization', token) + .send({ name: updatedName }) + .expect(200); + + const refetchedTemplate = await template.$query(); + + const expectedPayload = await updateTemplateMock({ + ...refetchedTemplate, + name: updatedName, + }); + + expect(response.body).toStrictEqual(expectedPayload); + }); + + it('should return unprocessable entity response for invalid name', async () => { + const template = await createTemplate(); + + const response = await request(app) + .patch(`/api/v1/admin/templates/${template.id}`) + .set('Authorization', token) + .send({ name: '' }) + .expect(422); + + expect(response.body).toStrictEqual({ + errors: { + name: ['must NOT have fewer than 1 characters'], + }, + meta: { type: 'ModelValidation' }, + }); + }); + + it('should return not found response for not existing template UUID', async () => { + const notExistingTemplateUUID = Crypto.randomUUID(); + + await request(app) + .patch(`/api/v1/admin/templates/${notExistingTemplateUUID}`) + .set('Authorization', token) + .expect(404); + }); + + it('should return bad request response for invalid UUID', async () => { + await request(app) + .patch('/api/v1/admin/templates/invalidTemplateUUID') + .set('Authorization', token) + .expect(400); + }); +}); diff --git a/packages/backend/src/routes/api/v1/admin/templates.ee.js b/packages/backend/src/routes/api/v1/admin/templates.ee.js index 896e379e..50bcd5a6 100644 --- a/packages/backend/src/routes/api/v1/admin/templates.ee.js +++ b/packages/backend/src/routes/api/v1/admin/templates.ee.js @@ -5,6 +5,7 @@ import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js'; import createTemplateAction from '../../../../controllers/api/v1/admin/templates/create-template.ee.js'; import getTemplatesAction from '../../../../controllers/api/v1/admin/templates/get-templates.ee.js'; +import updateTemplateAction from '../../../../controllers/api/v1/admin/templates/update-template.ee.js'; const router = Router(); @@ -24,4 +25,12 @@ router.post( createTemplateAction ); +router.patch( + '/:templateId', + authenticateUser, + authorizeAdmin, + checkIsEnterprise, + updateTemplateAction +); + export default router; diff --git a/packages/backend/test/mocks/rest/api/v1/admin/templates/update-template.ee.js b/packages/backend/test/mocks/rest/api/v1/admin/templates/update-template.ee.js new file mode 100644 index 00000000..fd88199c --- /dev/null +++ b/packages/backend/test/mocks/rest/api/v1/admin/templates/update-template.ee.js @@ -0,0 +1,22 @@ +const updateTemplateMock = async (template) => { + const data = { + id: template.id, + name: template.name, + createdAt: template.createdAt.getTime(), + updatedAt: template.updatedAt.getTime(), + flowData: template.flowData, + }; + + return { + data: data, + meta: { + count: 1, + currentPage: null, + isArray: false, + totalPages: null, + type: 'Template', + }, + }; +}; + +export default updateTemplateMock;