From 0a4ac1cece7ca822c0682b77b4f31c6cb3f63def Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Wed, 27 Mar 2024 13:59:10 +0100 Subject: [PATCH] feat: Implement new admin get app auth client API endpoint --- .../api/v1/admin/apps/get-auth-client.ee.js | 11 ++++ .../v1/admin/apps/get-auth-client.ee.test.js | 55 +++++++++++++++++++ .../api/v1/apps/get-auth-client.ee.test.js | 2 +- .../src/routes/api/v1/admin/apps.ee.js | 4 +- .../v1/{ => admin}/apps/get-auth-client.js | 0 5 files changed, 69 insertions(+), 3 deletions(-) create mode 100644 packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.js create mode 100644 packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.test.js rename packages/backend/test/mocks/rest/api/v1/{ => admin}/apps/get-auth-client.js (100%) diff --git a/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.js b/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.js new file mode 100644 index 00000000..c43ac23e --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.js @@ -0,0 +1,11 @@ +import { renderObject } from '../../../../../helpers/renderer.js'; +import AppAuthClient from '../../../../../models/app-auth-client.js'; + +export default async (request, response) => { + const appAuthClient = await AppAuthClient.query() + .findById(request.params.appAuthClientId) + .where({ app_key: request.params.appKey }) + .throwIfNotFound(); + + renderObject(response, appAuthClient); +}; diff --git a/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.test.js b/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.test.js new file mode 100644 index 00000000..f9f6c7ee --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/apps/get-auth-client.ee.test.js @@ -0,0 +1,55 @@ +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 { createUser } from '../../../../../../test/factories/user.js'; +import { createRole } from '../../../../../../test/factories/role.js'; +import getAppAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/get-auth-client.js'; +import { createAppAuthClient } from '../../../../../../test/factories/app-auth-client.js'; +import * as license from '../../../../../helpers/license.ee.js'; + +describe('GET /api/v1/admin/apps/:appKey/auth-clients/:appAuthClientId', () => { + let currentUser, adminRole, currentAppAuthClient, token; + + beforeEach(async () => { + vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); + + adminRole = await createRole({ key: 'admin' }); + currentUser = await createUser({ roleId: adminRole.id }); + + currentAppAuthClient = await createAppAuthClient({ + appKey: 'deepl', + }); + + token = createAuthTokenByUserId(currentUser.id); + }); + + it('should return specified app auth client', async () => { + const response = await request(app) + .get(`/api/v1/admin/apps/deepl/auth-clients/${currentAppAuthClient.id}`) + .set('Authorization', token) + .expect(200); + + const expectedPayload = getAppAuthClientMock(currentAppAuthClient); + expect(response.body).toEqual(expectedPayload); + }); + + it('should return not found response for not existing app auth client ID', async () => { + const notExistingAppAuthClientUUID = Crypto.randomUUID(); + + await request(app) + .get( + `/api/v1/admin/apps/deepl/auth-clients/${notExistingAppAuthClientUUID}` + ) + .set('Authorization', token) + .expect(404); + }); + + it('should return bad request response for invalid UUID', async () => { + await request(app) + .get('/api/v1/admin/apps/deepl/auth-clients/invalidAppAuthClientUUID') + .set('Authorization', token) + .expect(400); + }); +}); diff --git a/packages/backend/src/controllers/api/v1/apps/get-auth-client.ee.test.js b/packages/backend/src/controllers/api/v1/apps/get-auth-client.ee.test.js index 7b60f397..7eace94e 100644 --- a/packages/backend/src/controllers/api/v1/apps/get-auth-client.ee.test.js +++ b/packages/backend/src/controllers/api/v1/apps/get-auth-client.ee.test.js @@ -4,7 +4,7 @@ import Crypto from 'crypto'; import app from '../../../../app.js'; import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; import { createUser } from '../../../../../test/factories/user.js'; -import getAppAuthClientMock from '../../../../../test/mocks/rest/api/v1/apps/get-auth-client.js'; +import getAppAuthClientMock from '../../../../../test/mocks/rest/api/v1/admin/apps/get-auth-client.js'; import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; import * as license from '../../../../helpers/license.ee.js'; diff --git a/packages/backend/src/routes/api/v1/admin/apps.ee.js b/packages/backend/src/routes/api/v1/admin/apps.ee.js index 0994d054..ef3d97c5 100644 --- a/packages/backend/src/routes/api/v1/admin/apps.ee.js +++ b/packages/backend/src/routes/api/v1/admin/apps.ee.js @@ -4,7 +4,7 @@ import { authenticateUser } from '../../../../helpers/authentication.js'; import { authorizeAdmin } from '../../../../helpers/authorization.js'; import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js'; import getAuthClientsAction from '../../../../controllers/api/v1/admin/apps/get-auth-clients.ee.js'; -import getRoleAction from '../../../../controllers/api/v1/admin/roles/get-role.ee.js'; +import getAuthClientAction from '../../../../controllers/api/v1/admin/apps/get-auth-client.ee.js'; const router = Router(); @@ -21,7 +21,7 @@ router.get( authenticateUser, authorizeAdmin, checkIsEnterprise, - asyncHandler(getRoleAction) + asyncHandler(getAuthClientAction) ); export default router; diff --git a/packages/backend/test/mocks/rest/api/v1/apps/get-auth-client.js b/packages/backend/test/mocks/rest/api/v1/admin/apps/get-auth-client.js similarity index 100% rename from packages/backend/test/mocks/rest/api/v1/apps/get-auth-client.js rename to packages/backend/test/mocks/rest/api/v1/admin/apps/get-auth-client.js