refactor: Rename AppAuthClient model as OAuthClient

This commit is contained in:
Faruk AYDIN
2024-12-18 17:42:04 +01:00
parent 4a4628e255
commit 8c4b67e147
61 changed files with 588 additions and 571 deletions

View File

@@ -6,14 +6,14 @@ export default async (request, response) => {
.findOne({ key: request.params.appKey }) .findOne({ key: request.params.appKey })
.throwIfNotFound(); .throwIfNotFound();
const appAuthClient = await appConfig const oauthClient = await appConfig
.$relatedQuery('appAuthClients') .$relatedQuery('oauthClients')
.insert(appAuthClientParams(request)); .insert(oauthClientParams(request));
renderObject(response, appAuthClient, { status: 201 }); renderObject(response, oauthClient, { status: 201 });
}; };
const appAuthClientParams = (request) => { const oauthClientParams = (request) => {
const { active, appKey, name, formattedAuthDefaults } = request.body; const { active, appKey, name, formattedAuthDefaults } = request.body;
return { return {

View File

@@ -5,11 +5,11 @@ import app from '../../../../../app.js';
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../../test/factories/user.js'; import { createUser } from '../../../../../../test/factories/user.js';
import { createRole } from '../../../../../../test/factories/role.js'; import { createRole } from '../../../../../../test/factories/role.js';
import createAppAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/create-auth-client.js'; import createOAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/create-oauth-client.js';
import { createAppConfig } from '../../../../../../test/factories/app-config.js'; import { createAppConfig } from '../../../../../../test/factories/app-config.js';
import * as license from '../../../../../helpers/license.ee.js'; import * as license from '../../../../../helpers/license.ee.js';
describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => { describe('POST /api/v1/admin/apps/:appKey/oauth-clients', () => {
let currentUser, adminRole, token; let currentUser, adminRole, token;
beforeEach(async () => { beforeEach(async () => {
@@ -26,7 +26,7 @@ describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => {
key: 'gitlab', key: 'gitlab',
}); });
const appAuthClient = { const oauthClient = {
active: true, active: true,
appKey: 'gitlab', appKey: 'gitlab',
name: 'First auth client', name: 'First auth client',
@@ -39,17 +39,17 @@ describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => {
}; };
const response = await request(app) const response = await request(app)
.post('/api/v1/admin/apps/gitlab/auth-clients') .post('/api/v1/admin/apps/gitlab/oauth-clients')
.set('Authorization', token) .set('Authorization', token)
.send(appAuthClient) .send(oauthClient)
.expect(201); .expect(201);
const expectedPayload = createAppAuthClientMock(appAuthClient); const expectedPayload = createOAuthClientMock(oauthClient);
expect(response.body).toMatchObject(expectedPayload); expect(response.body).toMatchObject(expectedPayload);
}); });
it('should return not found response for not existing app config', async () => { it('should return not found response for not existing app config', async () => {
const appAuthClient = { const oauthClient = {
active: true, active: true,
appKey: 'gitlab', appKey: 'gitlab',
name: 'First auth client', name: 'First auth client',
@@ -62,9 +62,9 @@ describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => {
}; };
await request(app) await request(app)
.post('/api/v1/admin/apps/gitlab/auth-clients') .post('/api/v1/admin/apps/gitlab/oauth-clients')
.set('Authorization', token) .set('Authorization', token)
.send(appAuthClient) .send(oauthClient)
.expect(404); .expect(404);
}); });
@@ -73,14 +73,14 @@ describe('POST /api/v1/admin/apps/:appKey/auth-clients', () => {
key: 'gitlab', key: 'gitlab',
}); });
const appAuthClient = { const oauthClient = {
appKey: 'gitlab', appKey: 'gitlab',
}; };
const response = await request(app) const response = await request(app)
.post('/api/v1/admin/apps/gitlab/auth-clients') .post('/api/v1/admin/apps/gitlab/oauth-clients')
.set('Authorization', token) .set('Authorization', token)
.send(appAuthClient) .send(oauthClient)
.expect(422); .expect(422);
expect(response.body.meta.type).toStrictEqual('ModelValidation'); expect(response.body.meta.type).toStrictEqual('ModelValidation');

View File

@@ -1,11 +0,0 @@
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);
};

View File

@@ -0,0 +1,11 @@
import { renderObject } from '../../../../../helpers/renderer.js';
import OAuthClient from '../../../../../models/oauth-client.js';
export default async (request, response) => {
const oauthClient = await OAuthClient.query()
.findById(request.params.oauthClientId)
.where({ app_key: request.params.appKey })
.throwIfNotFound();
renderObject(response, oauthClient);
};

View File

@@ -5,12 +5,12 @@ import app from '../../../../../app.js';
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../../test/factories/user.js'; import { createUser } from '../../../../../../test/factories/user.js';
import { createRole } from '../../../../../../test/factories/role.js'; import { createRole } from '../../../../../../test/factories/role.js';
import getAppAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/get-auth-client.js'; import getOAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/get-oauth-client.js';
import { createAppAuthClient } from '../../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../../test/factories/oauth-client.js';
import * as license from '../../../../../helpers/license.ee.js'; import * as license from '../../../../../helpers/license.ee.js';
describe('GET /api/v1/admin/apps/:appKey/auth-clients/:appAuthClientId', () => { describe('GET /api/v1/admin/apps/:appKey/oauth-clients/:oauthClientId', () => {
let currentUser, adminRole, currentAppAuthClient, token; let currentUser, adminRole, currentOAuthClient, token;
beforeEach(async () => { beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
@@ -18,29 +18,29 @@ describe('GET /api/v1/admin/apps/:appKey/auth-clients/:appAuthClientId', () => {
adminRole = await createRole({ name: 'Admin' }); adminRole = await createRole({ name: 'Admin' });
currentUser = await createUser({ roleId: adminRole.id }); currentUser = await createUser({ roleId: adminRole.id });
currentAppAuthClient = await createAppAuthClient({ currentOAuthClient = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
token = await createAuthTokenByUserId(currentUser.id); token = await createAuthTokenByUserId(currentUser.id);
}); });
it('should return specified app auth client', async () => { it('should return specified oauth client', async () => {
const response = await request(app) const response = await request(app)
.get(`/api/v1/admin/apps/deepl/auth-clients/${currentAppAuthClient.id}`) .get(`/api/v1/admin/apps/deepl/oauth-clients/${currentOAuthClient.id}`)
.set('Authorization', token) .set('Authorization', token)
.expect(200); .expect(200);
const expectedPayload = getAppAuthClientMock(currentAppAuthClient); const expectedPayload = getOAuthClientMock(currentOAuthClient);
expect(response.body).toStrictEqual(expectedPayload); expect(response.body).toStrictEqual(expectedPayload);
}); });
it('should return not found response for not existing app auth client ID', async () => { it('should return not found response for not existing oauth client ID', async () => {
const notExistingAppAuthClientUUID = Crypto.randomUUID(); const notExistingOAuthClientUUID = Crypto.randomUUID();
await request(app) await request(app)
.get( .get(
`/api/v1/admin/apps/deepl/auth-clients/${notExistingAppAuthClientUUID}` `/api/v1/admin/apps/deepl/oauth-clients/${notExistingOAuthClientUUID}`
) )
.set('Authorization', token) .set('Authorization', token)
.expect(404); .expect(404);
@@ -48,7 +48,7 @@ describe('GET /api/v1/admin/apps/:appKey/auth-clients/:appAuthClientId', () => {
it('should return bad request response for invalid UUID', async () => { it('should return bad request response for invalid UUID', async () => {
await request(app) await request(app)
.get('/api/v1/admin/apps/deepl/auth-clients/invalidAppAuthClientUUID') .get('/api/v1/admin/apps/deepl/oauth-clients/invalidOAuthClientUUID')
.set('Authorization', token) .set('Authorization', token)
.expect(400); .expect(400);
}); });

View File

@@ -1,10 +1,10 @@
import { renderObject } from '../../../../../helpers/renderer.js'; import { renderObject } from '../../../../../helpers/renderer.js';
import AppAuthClient from '../../../../../models/app-auth-client.js'; import OAuthClient from '../../../../../models/oauth-client.js';
export default async (request, response) => { export default async (request, response) => {
const appAuthClients = await AppAuthClient.query() const oauthClients = await OAuthClient.query()
.where({ app_key: request.params.appKey }) .where({ app_key: request.params.appKey })
.orderBy('created_at', 'desc'); .orderBy('created_at', 'desc');
renderObject(response, appAuthClients); renderObject(response, oauthClients);
}; };

View File

@@ -4,11 +4,11 @@ import app from '../../../../../app.js';
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../../test/factories/user.js'; import { createUser } from '../../../../../../test/factories/user.js';
import { createRole } from '../../../../../../test/factories/role.js'; import { createRole } from '../../../../../../test/factories/role.js';
import getAuthClientsMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/get-auth-clients.js'; import getAdminOAuthClientsMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/get-oauth-clients.js';
import { createAppAuthClient } from '../../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../../test/factories/oauth-client.js';
import * as license from '../../../../../helpers/license.ee.js'; import * as license from '../../../../../helpers/license.ee.js';
describe('GET /api/v1/admin/apps/:appKey/auth-clients', () => { describe('GET /api/v1/admin/apps/:appKey/oauth-clients', () => {
let currentUser, adminRole, token; let currentUser, adminRole, token;
beforeEach(async () => { beforeEach(async () => {
@@ -20,23 +20,23 @@ describe('GET /api/v1/admin/apps/:appKey/auth-clients', () => {
token = await createAuthTokenByUserId(currentUser.id); token = await createAuthTokenByUserId(currentUser.id);
}); });
it('should return specified app auth client info', async () => { it('should return specified oauth client info', async () => {
const appAuthClientOne = await createAppAuthClient({ const oauthClientOne = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
const appAuthClientTwo = await createAppAuthClient({ const oauthClientTwo = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
const response = await request(app) const response = await request(app)
.get('/api/v1/admin/apps/deepl/auth-clients') .get('/api/v1/admin/apps/deepl/oauth-clients')
.set('Authorization', token) .set('Authorization', token)
.expect(200); .expect(200);
const expectedPayload = getAuthClientsMock([ const expectedPayload = getAdminOAuthClientsMock([
appAuthClientTwo, oauthClientTwo,
appAuthClientOne, oauthClientOne,
]); ]);
expect(response.body).toStrictEqual(expectedPayload); expect(response.body).toStrictEqual(expectedPayload);

View File

@@ -1,22 +0,0 @@
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)
.throwIfNotFound();
await appAuthClient.$query().patchAndFetch(appAuthClientParams(request));
renderObject(response, appAuthClient);
};
const appAuthClientParams = (request) => {
const { active, name, formattedAuthDefaults } = request.body;
return {
active,
name,
formattedAuthDefaults,
};
};

View File

@@ -0,0 +1,22 @@
import { renderObject } from '../../../../../helpers/renderer.js';
import OAuthClient from '../../../../../models/oauth-client.js';
export default async (request, response) => {
const oauthClient = await OAuthClient.query()
.findById(request.params.oauthClientId)
.throwIfNotFound();
await oauthClient.$query().patchAndFetch(oauthClientParams(request));
renderObject(response, oauthClient);
};
const oauthClientParams = (request) => {
const { active, name, formattedAuthDefaults } = request.body;
return {
active,
name,
formattedAuthDefaults,
};
};

View File

@@ -6,12 +6,12 @@ import app from '../../../../../app.js';
import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../../test/factories/user.js'; import { createUser } from '../../../../../../test/factories/user.js';
import { createRole } from '../../../../../../test/factories/role.js'; import { createRole } from '../../../../../../test/factories/role.js';
import updateAppAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/update-auth-client.js'; import updateOAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/apps/update-oauth-client.js';
import { createAppConfig } from '../../../../../../test/factories/app-config.js'; import { createAppConfig } from '../../../../../../test/factories/app-config.js';
import { createAppAuthClient } from '../../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../../test/factories/oauth-client.js';
import * as license from '../../../../../helpers/license.ee.js'; import * as license from '../../../../../helpers/license.ee.js';
describe('PATCH /api/v1/admin/apps/:appKey/auth-clients', () => { describe('PATCH /api/v1/admin/apps/:appKey/oauth-clients', () => {
let currentUser, adminRole, token; let currentUser, adminRole, token;
beforeEach(async () => { beforeEach(async () => {
@@ -27,8 +27,8 @@ describe('PATCH /api/v1/admin/apps/:appKey/auth-clients', () => {
}); });
}); });
it('should return updated entity for valid app auth client', async () => { it('should return updated entity for valid oauth client', async () => {
const appAuthClient = { const oauthClient = {
active: true, active: true,
appKey: 'gitlab', appKey: 'gitlab',
formattedAuthDefaults: { formattedAuthDefaults: {
@@ -39,33 +39,33 @@ describe('PATCH /api/v1/admin/apps/:appKey/auth-clients', () => {
}, },
}; };
const existingAppAuthClient = await createAppAuthClient({ const existingOAuthClient = await createOAuthClient({
appKey: 'gitlab', appKey: 'gitlab',
name: 'First auth client', name: 'First auth client',
}); });
const response = await request(app) const response = await request(app)
.patch( .patch(
`/api/v1/admin/apps/gitlab/auth-clients/${existingAppAuthClient.id}` `/api/v1/admin/apps/gitlab/oauth-clients/${existingOAuthClient.id}`
) )
.set('Authorization', token) .set('Authorization', token)
.send(appAuthClient) .send(oauthClient)
.expect(200); .expect(200);
const expectedPayload = updateAppAuthClientMock({ const expectedPayload = updateOAuthClientMock({
...existingAppAuthClient, ...existingOAuthClient,
...appAuthClient, ...oauthClient,
}); });
expect(response.body).toMatchObject(expectedPayload); expect(response.body).toMatchObject(expectedPayload);
}); });
it('should return not found response for not existing app auth client', async () => { it('should return not found response for not existing oauth client', async () => {
const notExistingAppAuthClientId = Crypto.randomUUID(); const notExistingOAuthClientId = Crypto.randomUUID();
await request(app) await request(app)
.patch( .patch(
`/api/v1/admin/apps/gitlab/auth-clients/${notExistingAppAuthClientId}` `/api/v1/admin/apps/gitlab/oauth-clients/${notExistingOAuthClientId}`
) )
.set('Authorization', token) .set('Authorization', token)
.expect(404); .expect(404);
@@ -73,27 +73,27 @@ describe('PATCH /api/v1/admin/apps/:appKey/auth-clients', () => {
it('should return bad request response for invalid UUID', async () => { it('should return bad request response for invalid UUID', async () => {
await request(app) await request(app)
.patch('/api/v1/admin/apps/gitlab/auth-clients/invalidAuthClientUUID') .patch('/api/v1/admin/apps/gitlab/oauth-clients/invalidAuthClientUUID')
.set('Authorization', token) .set('Authorization', token)
.expect(400); .expect(400);
}); });
it('should return HTTP 422 for invalid payload', async () => { it('should return HTTP 422 for invalid payload', async () => {
const appAuthClient = { const oauthClient = {
formattedAuthDefaults: 'invalid input', formattedAuthDefaults: 'invalid input',
}; };
const existingAppAuthClient = await createAppAuthClient({ const existingOAuthClient = await createOAuthClient({
appKey: 'gitlab', appKey: 'gitlab',
name: 'First auth client', name: 'First auth client',
}); });
const response = await request(app) const response = await request(app)
.patch( .patch(
`/api/v1/admin/apps/gitlab/auth-clients/${existingAppAuthClient.id}` `/api/v1/admin/apps/gitlab/oauth-clients/${existingOAuthClient.id}`
) )
.set('Authorization', token) .set('Authorization', token)
.send(appAuthClient) .send(oauthClient)
.expect(422); .expect(422);
expect(response.body.meta.type).toBe('ModelValidation'); expect(response.body.meta.type).toBe('ModelValidation');

View File

@@ -9,18 +9,18 @@ export default async (request, response) => {
.$query() .$query()
.withGraphFetched({ .withGraphFetched({
appConfig: true, appConfig: true,
appAuthClient: true, oauthClient: true,
}); });
renderObject(response, connectionWithAppConfigAndAuthClient, { status: 201 }); renderObject(response, connectionWithAppConfigAndAuthClient, { status: 201 });
}; };
const connectionParams = (request) => { const connectionParams = (request) => {
const { appAuthClientId, formattedData } = request.body; const { oauthClientId, formattedData } = request.body;
return { return {
key: request.params.appKey, key: request.params.appKey,
appAuthClientId, oauthClientId,
formattedData, formattedData,
verified: false, verified: false,
}; };

View File

@@ -3,7 +3,7 @@ import request from 'supertest';
import app from '../../../../app.js'; import app from '../../../../app.js';
import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
import { createAppConfig } from '../../../../../test/factories/app-config.js'; import { createAppConfig } from '../../../../../test/factories/app-config.js';
import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../test/factories/oauth-client.js';
import { createUser } from '../../../../../test/factories/user.js'; import { createUser } from '../../../../../test/factories/user.js';
import { createPermission } from '../../../../../test/factories/permission.js'; import { createPermission } from '../../../../../test/factories/permission.js';
import { createRole } from '../../../../../test/factories/role.js'; import { createRole } from '../../../../../test/factories/role.js';
@@ -267,7 +267,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
}); });
describe('with auth client enabled', async () => { describe('with auth client enabled', async () => {
let appAuthClient; let oauthClient;
beforeEach(async () => { beforeEach(async () => {
await createAppConfig({ await createAppConfig({
@@ -276,7 +276,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
useOnlyPredefinedAuthClients: false, useOnlyPredefinedAuthClients: false,
}); });
appAuthClient = await createAppAuthClient({ oauthClient = await createOAuthClient({
appKey: 'gitlab', appKey: 'gitlab',
active: true, active: true,
formattedAuthDefaults: { formattedAuthDefaults: {
@@ -290,7 +290,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
it('should return created connection', async () => { it('should return created connection', async () => {
const connectionData = { const connectionData = {
appAuthClientId: appAuthClient.id, oauthClientId: oauthClient.id,
}; };
const response = await request(app) const response = await request(app)
@@ -338,7 +338,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
}); });
describe('with auth client disabled', async () => { describe('with auth client disabled', async () => {
let appAuthClient; let oauthClient;
beforeEach(async () => { beforeEach(async () => {
await createAppConfig({ await createAppConfig({
@@ -347,7 +347,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
useOnlyPredefinedAuthClients: false, useOnlyPredefinedAuthClients: false,
}); });
appAuthClient = await createAppAuthClient({ oauthClient = await createOAuthClient({
appKey: 'gitlab', appKey: 'gitlab',
active: false, active: false,
}); });
@@ -355,7 +355,7 @@ describe('POST /api/v1/apps/:appKey/connections', () => {
it('should return with not authorized response', async () => { it('should return with not authorized response', async () => {
const connectionData = { const connectionData = {
appAuthClientId: appAuthClient.id, oauthClientId: oauthClient.id,
}; };
await request(app) await request(app)

View File

@@ -15,7 +15,7 @@ describe('GET /api/v1/apps/:appKey/actions/:actionKey/substeps', () => {
exampleApp = await App.findOneByKey('github'); exampleApp = await App.findOneByKey('github');
}); });
it('should return the app auth info', async () => { it('should return the action substeps info', async () => {
const actions = await App.findActionsByKey('github'); const actions = await App.findActionsByKey('github');
const exampleAction = actions.find( const exampleAction = actions.find(
(action) => action.key === 'createIssue' (action) => action.key === 'createIssue'

View File

@@ -1,11 +0,0 @@
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, active: true })
.throwIfNotFound();
renderObject(response, appAuthClient);
};

View File

@@ -4,7 +4,7 @@ import AppConfig from '../../../../models/app-config.js';
export default async (request, response) => { export default async (request, response) => {
const appConfig = await AppConfig.query() const appConfig = await AppConfig.query()
.withGraphFetched({ .withGraphFetched({
appAuthClients: true, oauthClients: true,
}) })
.findOne({ .findOne({
key: request.params.appKey, key: request.params.appKey,

View File

@@ -9,7 +9,7 @@ export default async (request, response) => {
.select('connections.*') .select('connections.*')
.withGraphFetched({ .withGraphFetched({
appConfig: true, appConfig: true,
appAuthClient: true, oauthClient: true,
}) })
.fullOuterJoinRelated('steps') .fullOuterJoinRelated('steps')
.where({ .where({

View File

@@ -0,0 +1,11 @@
import { renderObject } from '../../../../helpers/renderer.js';
import OAuthClient from '../../../../models/oauth-client.js';
export default async (request, response) => {
const oauthClient = await OAuthClient.query()
.findById(request.params.oauthClientId)
.where({ app_key: request.params.appKey, active: true })
.throwIfNotFound();
renderObject(response, oauthClient);
};

View File

@@ -4,46 +4,46 @@ import Crypto from 'crypto';
import app from '../../../../app.js'; import app from '../../../../app.js';
import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../test/factories/user.js'; import { createUser } from '../../../../../test/factories/user.js';
import getAppAuthClientMock from '../../../../../test/mocks/rest/api/v1/apps/get-auth-client.js'; import getOAuthClientMock from '../../../../../test/mocks/rest/api/v1/apps/get-oauth-client.js';
import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../test/factories/oauth-client.js';
import * as license from '../../../../helpers/license.ee.js'; import * as license from '../../../../helpers/license.ee.js';
describe('GET /api/v1/apps/:appKey/auth-clients/:appAuthClientId', () => { describe('GET /api/v1/apps/:appKey/oauth-clients/:oauthClientId', () => {
let currentUser, currentAppAuthClient, token; let currentUser, currentOAuthClient, token;
beforeEach(async () => { beforeEach(async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
currentUser = await createUser(); currentUser = await createUser();
currentAppAuthClient = await createAppAuthClient({ currentOAuthClient = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
token = await createAuthTokenByUserId(currentUser.id); token = await createAuthTokenByUserId(currentUser.id);
}); });
it('should return specified app auth client', async () => { it('should return specified oauth client', async () => {
const response = await request(app) const response = await request(app)
.get(`/api/v1/apps/deepl/auth-clients/${currentAppAuthClient.id}`) .get(`/api/v1/apps/deepl/oauth-clients/${currentOAuthClient.id}`)
.set('Authorization', token) .set('Authorization', token)
.expect(200); .expect(200);
const expectedPayload = getAppAuthClientMock(currentAppAuthClient); const expectedPayload = getOAuthClientMock(currentOAuthClient);
expect(response.body).toStrictEqual(expectedPayload); expect(response.body).toStrictEqual(expectedPayload);
}); });
it('should return not found response for not existing app auth client ID', async () => { it('should return not found response for not existing oauth client ID', async () => {
const notExistingAppAuthClientUUID = Crypto.randomUUID(); const notExistingOAuthClientUUID = Crypto.randomUUID();
await request(app) await request(app)
.get(`/api/v1/apps/deepl/auth-clients/${notExistingAppAuthClientUUID}`) .get(`/api/v1/apps/deepl/oauth-clients/${notExistingOAuthClientUUID}`)
.set('Authorization', token) .set('Authorization', token)
.expect(404); .expect(404);
}); });
it('should return bad request response for invalid UUID', async () => { it('should return bad request response for invalid UUID', async () => {
await request(app) await request(app)
.get('/api/v1/apps/deepl/auth-clients/invalidAppAuthClientUUID') .get('/api/v1/apps/deepl/oauth-clients/invalidOAuthClientUUID')
.set('Authorization', token) .set('Authorization', token)
.expect(400); .expect(400);
}); });

View File

@@ -1,10 +1,10 @@
import { renderObject } from '../../../../helpers/renderer.js'; import { renderObject } from '../../../../helpers/renderer.js';
import AppAuthClient from '../../../../models/app-auth-client.js'; import OAuthClient from '../../../../models/oauth-client.js';
export default async (request, response) => { export default async (request, response) => {
const appAuthClients = await AppAuthClient.query() const oauthClients = await OAuthClient.query()
.where({ app_key: request.params.appKey, active: true }) .where({ app_key: request.params.appKey, active: true })
.orderBy('created_at', 'desc'); .orderBy('created_at', 'desc');
renderObject(response, appAuthClients); renderObject(response, oauthClients);
}; };

View File

@@ -3,11 +3,11 @@ import request from 'supertest';
import app from '../../../../app.js'; import app from '../../../../app.js';
import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../test/factories/user.js'; import { createUser } from '../../../../../test/factories/user.js';
import getAuthClientsMock from '../../../../../test/mocks/rest/api/v1/apps/get-auth-clients.js'; import getOAuthClientsMock from '../../../../../test/mocks/rest/api/v1/apps/get-oauth-clients.js';
import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../../../../test/factories/oauth-client.js';
import * as license from '../../../../helpers/license.ee.js'; import * as license from '../../../../helpers/license.ee.js';
describe('GET /api/v1/apps/:appKey/auth-clients', () => { describe('GET /api/v1/apps/:appKey/oauth-clients', () => {
let currentUser, token; let currentUser, token;
beforeEach(async () => { beforeEach(async () => {
@@ -18,23 +18,23 @@ describe('GET /api/v1/apps/:appKey/auth-clients', () => {
token = await createAuthTokenByUserId(currentUser.id); token = await createAuthTokenByUserId(currentUser.id);
}); });
it('should return specified app auth client info', async () => { it('should return specified oauth client info', async () => {
const appAuthClientOne = await createAppAuthClient({ const oauthClientOne = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
const appAuthClientTwo = await createAppAuthClient({ const oauthClientTwo = await createOAuthClient({
appKey: 'deepl', appKey: 'deepl',
}); });
const response = await request(app) const response = await request(app)
.get('/api/v1/apps/deepl/auth-clients') .get('/api/v1/apps/deepl/oauth-clients')
.set('Authorization', token) .set('Authorization', token)
.expect(200); .expect(200);
const expectedPayload = getAuthClientsMock([ const expectedPayload = getOAuthClientsMock([
appAuthClientTwo, oauthClientTwo,
appAuthClientOne, oauthClientOne,
]); ]);
expect(response.body).toStrictEqual(expectedPayload); expect(response.body).toStrictEqual(expectedPayload);

View File

@@ -15,7 +15,7 @@ describe('GET /api/v1/apps/:appKey/triggers/:triggerKey/substeps', () => {
exampleApp = await App.findOneByKey('github'); exampleApp = await App.findOneByKey('github');
}); });
it('should return the app auth info', async () => { it('should return the trigger substeps info', async () => {
const triggers = await App.findTriggersByKey('github'); const triggers = await App.findTriggersByKey('github');
const exampleTrigger = triggers.find( const exampleTrigger = triggers.find(
(trigger) => trigger.key === 'newIssues' (trigger) => trigger.key === 'newIssues'

View File

@@ -14,6 +14,6 @@ export default async (request, response) => {
}; };
const connectionParams = (request) => { const connectionParams = (request) => {
const { formattedData, appAuthClientId } = request.body; const { formattedData, oauthClientId } = request.body;
return { formattedData, appAuthClientId }; return { formattedData, oauthClientId };
}; };

View File

@@ -0,0 +1,31 @@
export async function up(knex) {
await knex.schema.renameTable('app_auth_clients', 'oauth_clients');
await knex.schema.raw(
'ALTER INDEX app_auth_clients_pkey RENAME TO oauth_clients_pkey'
);
await knex.schema.raw(
'ALTER INDEX app_auth_clients_name_unique RENAME TO oauth_clients_name_unique'
);
return await knex.schema.alterTable('connections', (table) => {
table.renameColumn('app_auth_client_id', 'oauth_client_id');
});
}
export async function down(knex) {
await knex.schema.renameTable('oauth_clients', 'app_auth_clients');
await knex.schema.raw(
'ALTER INDEX oauth_clients_pkey RENAME TO app_auth_clients_pkey'
);
await knex.schema.raw(
'ALTER INDEX oauth_clients_name_unique RENAME TO app_auth_clients_name_unique'
);
return await knex.schema.alterTable('connections', (table) => {
table.renameColumn('oauth_client_id', 'app_auth_client_id');
});
}

View File

@@ -88,8 +88,8 @@ const sharedAuthenticationStepsWithAuthUrl = [
value: '{key}', value: '{key}',
}, },
{ {
name: 'appAuthClientId', name: 'oauthClientId',
value: '{appAuthClientId}', value: '{oauthClientId}',
}, },
], ],
}, },

View File

@@ -3,10 +3,6 @@
exports[`Connection model > jsonSchema should have correct validations 1`] = ` exports[`Connection model > jsonSchema should have correct validations 1`] = `
{ {
"properties": { "properties": {
"appAuthClientId": {
"format": "uuid",
"type": "string",
},
"createdAt": { "createdAt": {
"type": "string", "type": "string",
}, },
@@ -31,6 +27,10 @@ exports[`Connection model > jsonSchema should have correct validations 1`] = `
"minLength": 1, "minLength": 1,
"type": "string", "type": "string",
}, },
"oauthClientId": {
"format": "uuid",
"type": "string",
},
"updatedAt": { "updatedAt": {
"type": "string", "type": "string",
}, },

View File

@@ -1,6 +1,6 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`AppAuthClient model > jsonSchema should have correct validations 1`] = ` exports[`OAuthClient model > jsonSchema should have correct validations 1`] = `
{ {
"properties": { "properties": {
"active": { "active": {

View File

@@ -1,202 +0,0 @@
import { describe, it, expect, vi } from 'vitest';
import AES from 'crypto-js/aes.js';
import enc from 'crypto-js/enc-utf8.js';
import AppConfig from './app-config.js';
import AppAuthClient from './app-auth-client.js';
import Base from './base.js';
import appConfig from '../config/app.js';
import { createAppAuthClient } from '../../test/factories/app-auth-client.js';
describe('AppAuthClient model', () => {
it('tableName should return correct name', () => {
expect(AppAuthClient.tableName).toBe('app_auth_clients');
});
it('jsonSchema should have correct validations', () => {
expect(AppAuthClient.jsonSchema).toMatchSnapshot();
});
it('relationMappings should return correct associations', () => {
const relationMappings = AppAuthClient.relationMappings();
const expectedRelations = {
appConfig: {
relation: Base.BelongsToOneRelation,
modelClass: AppConfig,
join: {
from: 'app_auth_clients.app_key',
to: 'app_configs.key',
},
},
};
expect(relationMappings).toStrictEqual(expectedRelations);
});
describe('encryptData', () => {
it('should return undefined if eligibleForEncryption is not true', async () => {
vi.spyOn(
AppAuthClient.prototype,
'eligibleForEncryption'
).mockReturnValue(false);
const appAuthClient = new AppAuthClient();
expect(appAuthClient.encryptData()).toBeUndefined();
});
it('should encrypt formattedAuthDefaults and set it to authDefaults', async () => {
vi.spyOn(
AppAuthClient.prototype,
'eligibleForEncryption'
).mockReturnValue(true);
const formattedAuthDefaults = {
key: 'value',
};
const appAuthClient = new AppAuthClient();
appAuthClient.formattedAuthDefaults = formattedAuthDefaults;
appAuthClient.encryptData();
const expectedDecryptedValue = JSON.parse(
AES.decrypt(
appAuthClient.authDefaults,
appConfig.encryptionKey
).toString(enc)
);
expect(formattedAuthDefaults).toStrictEqual(expectedDecryptedValue);
expect(appAuthClient.authDefaults).not.toStrictEqual(
formattedAuthDefaults
);
});
it('should encrypt formattedAuthDefaults and remove formattedAuthDefaults', async () => {
vi.spyOn(
AppAuthClient.prototype,
'eligibleForEncryption'
).mockReturnValue(true);
const formattedAuthDefaults = {
key: 'value',
};
const appAuthClient = new AppAuthClient();
appAuthClient.formattedAuthDefaults = formattedAuthDefaults;
appAuthClient.encryptData();
expect(appAuthClient.formattedAuthDefaults).not.toBeDefined();
});
});
describe('decryptData', () => {
it('should return undefined if eligibleForDecryption is not true', () => {
vi.spyOn(
AppAuthClient.prototype,
'eligibleForDecryption'
).mockReturnValue(false);
const appAuthClient = new AppAuthClient();
expect(appAuthClient.decryptData()).toBeUndefined();
});
it('should decrypt authDefaults and set it to formattedAuthDefaults', async () => {
vi.spyOn(
AppAuthClient.prototype,
'eligibleForDecryption'
).mockReturnValue(true);
const formattedAuthDefaults = {
key: 'value',
};
const authDefaults = AES.encrypt(
JSON.stringify(formattedAuthDefaults),
appConfig.encryptionKey
).toString();
const appAuthClient = new AppAuthClient();
appAuthClient.authDefaults = authDefaults;
appAuthClient.decryptData();
expect(appAuthClient.formattedAuthDefaults).toStrictEqual(
formattedAuthDefaults
);
expect(appAuthClient.authDefaults).not.toStrictEqual(
formattedAuthDefaults
);
});
});
describe('eligibleForEncryption', () => {
it('should return true when formattedAuthDefaults property exists', async () => {
const appAuthClient = await createAppAuthClient();
expect(appAuthClient.eligibleForEncryption()).toBe(true);
});
it("should return false when formattedAuthDefaults property doesn't exist", async () => {
const appAuthClient = await createAppAuthClient();
delete appAuthClient.formattedAuthDefaults;
expect(appAuthClient.eligibleForEncryption()).toBe(false);
});
});
describe('eligibleForDecryption', () => {
it('should return true when authDefaults property exists', async () => {
const appAuthClient = await createAppAuthClient();
expect(appAuthClient.eligibleForDecryption()).toBe(true);
});
it("should return false when authDefaults property doesn't exist", async () => {
const appAuthClient = await createAppAuthClient();
delete appAuthClient.authDefaults;
expect(appAuthClient.eligibleForDecryption()).toBe(false);
});
});
it('$beforeInsert should call AppAuthClient.encryptData', async () => {
const appAuthClientBeforeInsertSpy = vi.spyOn(
AppAuthClient.prototype,
'encryptData'
);
await createAppAuthClient();
expect(appAuthClientBeforeInsertSpy).toHaveBeenCalledOnce();
});
it('$beforeUpdate should call AppAuthClient.encryptData', async () => {
const appAuthClient = await createAppAuthClient();
const appAuthClientBeforeUpdateSpy = vi.spyOn(
AppAuthClient.prototype,
'encryptData'
);
await appAuthClient.$query().patchAndFetch({ name: 'sample' });
expect(appAuthClientBeforeUpdateSpy).toHaveBeenCalledOnce();
});
it('$afterFind should call AppAuthClient.decryptData', async () => {
const appAuthClient = await createAppAuthClient();
const appAuthClientAfterFindSpy = vi.spyOn(
AppAuthClient.prototype,
'decryptData'
);
await appAuthClient.$query();
expect(appAuthClientAfterFindSpy).toHaveBeenCalledOnce();
});
});

View File

@@ -1,5 +1,5 @@
import App from './app.js'; import App from './app.js';
import AppAuthClient from './app-auth-client.js'; import OAuthClient from './oauth-client.js';
import Base from './base.js'; import Base from './base.js';
class AppConfig extends Base { class AppConfig extends Base {
@@ -24,12 +24,12 @@ class AppConfig extends Base {
}; };
static relationMappings = () => ({ static relationMappings = () => ({
appAuthClients: { oauthClients: {
relation: Base.HasManyRelation, relation: Base.HasManyRelation,
modelClass: AppAuthClient, modelClass: OAuthClient,
join: { join: {
from: 'app_configs.key', from: 'app_configs.key',
to: 'app_auth_clients.app_key', to: 'oauth_clients.app_key',
}, },
}, },
}); });

View File

@@ -3,7 +3,7 @@ import { describe, it, expect } from 'vitest';
import Base from './base.js'; import Base from './base.js';
import AppConfig from './app-config.js'; import AppConfig from './app-config.js';
import App from './app.js'; import App from './app.js';
import AppAuthClient from './app-auth-client.js'; import OAuthClient from './oauth-client.js';
describe('AppConfig model', () => { describe('AppConfig model', () => {
it('tableName should return correct name', () => { it('tableName should return correct name', () => {
@@ -22,12 +22,12 @@ describe('AppConfig model', () => {
const relationMappings = AppConfig.relationMappings(); const relationMappings = AppConfig.relationMappings();
const expectedRelations = { const expectedRelations = {
appAuthClients: { oauthClients: {
relation: Base.HasManyRelation, relation: Base.HasManyRelation,
modelClass: AppAuthClient, modelClass: OAuthClient,
join: { join: {
from: 'app_configs.key', from: 'app_configs.key',
to: 'app_auth_clients.app_key', to: 'oauth_clients.app_key',
}, },
}, },
}; };

View File

@@ -2,7 +2,7 @@ import AES from 'crypto-js/aes.js';
import enc from 'crypto-js/enc-utf8.js'; import enc from 'crypto-js/enc-utf8.js';
import App from './app.js'; import App from './app.js';
import AppConfig from './app-config.js'; import AppConfig from './app-config.js';
import AppAuthClient from './app-auth-client.js'; import OAuthClient from './oauth-client.js';
import Base from './base.js'; import Base from './base.js';
import User from './user.js'; import User from './user.js';
import Step from './step.js'; import Step from './step.js';
@@ -24,7 +24,7 @@ class Connection extends Base {
data: { type: 'string' }, data: { type: 'string' },
formattedData: { type: 'object' }, formattedData: { type: 'object' },
userId: { type: 'string', format: 'uuid' }, userId: { type: 'string', format: 'uuid' },
appAuthClientId: { type: 'string', format: 'uuid' }, oauthClientId: { type: 'string', format: 'uuid' },
verified: { type: 'boolean', default: false }, verified: { type: 'boolean', default: false },
draft: { type: 'boolean' }, draft: { type: 'boolean' },
deletedAt: { type: 'string' }, deletedAt: { type: 'string' },
@@ -69,12 +69,12 @@ class Connection extends Base {
to: 'app_configs.key', to: 'app_configs.key',
}, },
}, },
appAuthClient: { oauthClient: {
relation: Base.BelongsToOneRelation, relation: Base.BelongsToOneRelation,
modelClass: AppAuthClient, modelClass: OAuthClient,
join: { join: {
from: 'connections.app_auth_client_id', from: 'connections.oauth_client_id',
to: 'app_auth_clients.id', to: 'oauth_clients.id',
}, },
}, },
}); });
@@ -136,8 +136,8 @@ class Connection extends Base {
if (!this.formattedData) { if (!this.formattedData) {
const authClient = await appConfig const authClient = await appConfig
.$relatedQuery('appAuthClients') .$relatedQuery('oauthClients')
.findById(this.appAuthClientId) .findById(this.oauthClientId)
.where({ active: true }) .where({ active: true })
.throwIfNotFound(); .throwIfNotFound();
@@ -215,13 +215,13 @@ class Connection extends Base {
return updatedConnection; return updatedConnection;
} }
async updateFormattedData({ formattedData, appAuthClientId }) { async updateFormattedData({ formattedData, oauthClientId }) {
if (appAuthClientId) { if (oauthClientId) {
const appAuthClient = await AppAuthClient.query() const oauthClient = await OAuthClient.query()
.findById(appAuthClientId) .findById(oauthClientId)
.throwIfNotFound(); .throwIfNotFound();
formattedData = appAuthClient.formattedAuthDefaults; formattedData = oauthClient.formattedAuthDefaults;
} }
return await this.$query().patchAndFetch({ return await this.$query().patchAndFetch({

View File

@@ -2,7 +2,7 @@ import { describe, it, expect, vi } from 'vitest';
import AES from 'crypto-js/aes.js'; import AES from 'crypto-js/aes.js';
import enc from 'crypto-js/enc-utf8.js'; import enc from 'crypto-js/enc-utf8.js';
import appConfig from '../config/app.js'; import appConfig from '../config/app.js';
import AppAuthClient from './app-auth-client.js'; import OAuthClient from './oauth-client.js';
import App from './app.js'; import App from './app.js';
import AppConfig from './app-config.js'; import AppConfig from './app-config.js';
import Base from './base.js'; import Base from './base.js';
@@ -12,7 +12,7 @@ import User from './user.js';
import Telemetry from '../helpers/telemetry/index.js'; import Telemetry from '../helpers/telemetry/index.js';
import { createConnection } from '../../test/factories/connection.js'; import { createConnection } from '../../test/factories/connection.js';
import { createAppConfig } from '../../test/factories/app-config.js'; import { createAppConfig } from '../../test/factories/app-config.js';
import { createAppAuthClient } from '../../test/factories/app-auth-client.js'; import { createOAuthClient } from '../../test/factories/oauth-client.js';
describe('Connection model', () => { describe('Connection model', () => {
it('tableName should return correct name', () => { it('tableName should return correct name', () => {
@@ -61,12 +61,12 @@ describe('Connection model', () => {
to: 'app_configs.key', to: 'app_configs.key',
}, },
}, },
appAuthClient: { oauthClient: {
relation: Base.BelongsToOneRelation, relation: Base.BelongsToOneRelation,
modelClass: AppAuthClient, modelClass: OAuthClient,
join: { join: {
from: 'connections.app_auth_client_id', from: 'connections.oauth_client_id',
to: 'app_auth_clients.id', to: 'oauth_clients.id',
}, },
}, },
}; };
@@ -307,13 +307,13 @@ describe('Connection model', () => {
); );
}); });
it('should apply app auth client auth defaults when creating with shared app auth client', async () => { it('should apply oauth client auth defaults when creating with shared oauth client', async () => {
await createAppConfig({ await createAppConfig({
key: 'gitlab', key: 'gitlab',
disabled: false, disabled: false,
}); });
const appAuthClient = await createAppAuthClient({ const oauthClient = await createOAuthClient({
appKey: 'gitlab', appKey: 'gitlab',
active: true, active: true,
formattedAuthDefaults: { formattedAuthDefaults: {
@@ -323,7 +323,7 @@ describe('Connection model', () => {
const connection = await createConnection({ const connection = await createConnection({
key: 'gitlab', key: 'gitlab',
appAuthClientId: appAuthClient.id, oauthClientId: oauthClient.id,
formattedData: null, formattedData: null,
}); });
@@ -559,22 +559,22 @@ describe('Connection model', () => {
}); });
describe('updateFormattedData', () => { describe('updateFormattedData', () => {
it('should extend connection data with app auth client auth defaults', async () => { it('should extend connection data with oauth client auth defaults', async () => {
const appAuthClient = await createAppAuthClient({ const oauthClient = await createOAuthClient({
formattedAuthDefaults: { formattedAuthDefaults: {
clientId: 'sample-id', clientId: 'sample-id',
}, },
}); });
const connection = await createConnection({ const connection = await createConnection({
appAuthClientId: appAuthClient.id, oauthClientId: oauthClient.id,
formattedData: { formattedData: {
token: 'sample-token', token: 'sample-token',
}, },
}); });
const updatedConnection = await connection.updateFormattedData({ const updatedConnection = await connection.updateFormattedData({
appAuthClientId: appAuthClient.id, oauthClientId: oauthClient.id,
}); });
expect(updatedConnection.formattedData).toStrictEqual({ expect(updatedConnection.formattedData).toStrictEqual({

View File

@@ -4,8 +4,8 @@ import appConfig from '../config/app.js';
import Base from './base.js'; import Base from './base.js';
import AppConfig from './app-config.js'; import AppConfig from './app-config.js';
class AppAuthClient extends Base { class OAuthClient extends Base {
static tableName = 'app_auth_clients'; static tableName = 'oauth_clients';
static jsonSchema = { static jsonSchema = {
type: 'object', type: 'object',
@@ -27,7 +27,7 @@ class AppAuthClient extends Base {
relation: Base.BelongsToOneRelation, relation: Base.BelongsToOneRelation,
modelClass: AppConfig, modelClass: AppConfig,
join: { join: {
from: 'app_auth_clients.app_key', from: 'oauth_clients.app_key',
to: 'app_configs.key', to: 'app_configs.key',
}, },
}, },
@@ -87,4 +87,4 @@ class AppAuthClient extends Base {
} }
} }
export default AppAuthClient; export default OAuthClient;

View File

@@ -0,0 +1,192 @@
import { describe, it, expect, vi } from 'vitest';
import AES from 'crypto-js/aes.js';
import enc from 'crypto-js/enc-utf8.js';
import AppConfig from './app-config.js';
import OAuthClient from './oauth-client.js';
import Base from './base.js';
import appConfig from '../config/app.js';
import { createOAuthClient } from '../../test/factories/oauth-client.js';
describe('OAuthClient model', () => {
it('tableName should return correct name', () => {
expect(OAuthClient.tableName).toBe('oauth_clients');
});
it('jsonSchema should have correct validations', () => {
expect(OAuthClient.jsonSchema).toMatchSnapshot();
});
it('relationMappings should return correct associations', () => {
const relationMappings = OAuthClient.relationMappings();
const expectedRelations = {
appConfig: {
relation: Base.BelongsToOneRelation,
modelClass: AppConfig,
join: {
from: 'oauth_clients.app_key',
to: 'app_configs.key',
},
},
};
expect(relationMappings).toStrictEqual(expectedRelations);
});
describe('encryptData', () => {
it('should return undefined if eligibleForEncryption is not true', async () => {
vi.spyOn(OAuthClient.prototype, 'eligibleForEncryption').mockReturnValue(
false
);
const oauthClient = new OAuthClient();
expect(oauthClient.encryptData()).toBeUndefined();
});
it('should encrypt formattedAuthDefaults and set it to authDefaults', async () => {
vi.spyOn(OAuthClient.prototype, 'eligibleForEncryption').mockReturnValue(
true
);
const formattedAuthDefaults = {
key: 'value',
};
const oauthClient = new OAuthClient();
oauthClient.formattedAuthDefaults = formattedAuthDefaults;
oauthClient.encryptData();
const expectedDecryptedValue = JSON.parse(
AES.decrypt(oauthClient.authDefaults, appConfig.encryptionKey).toString(
enc
)
);
expect(formattedAuthDefaults).toStrictEqual(expectedDecryptedValue);
expect(oauthClient.authDefaults).not.toStrictEqual(formattedAuthDefaults);
});
it('should encrypt formattedAuthDefaults and remove formattedAuthDefaults', async () => {
vi.spyOn(OAuthClient.prototype, 'eligibleForEncryption').mockReturnValue(
true
);
const formattedAuthDefaults = {
key: 'value',
};
const oauthClient = new OAuthClient();
oauthClient.formattedAuthDefaults = formattedAuthDefaults;
oauthClient.encryptData();
expect(oauthClient.formattedAuthDefaults).not.toBeDefined();
});
});
describe('decryptData', () => {
it('should return undefined if eligibleForDecryption is not true', () => {
vi.spyOn(OAuthClient.prototype, 'eligibleForDecryption').mockReturnValue(
false
);
const oauthClient = new OAuthClient();
expect(oauthClient.decryptData()).toBeUndefined();
});
it('should decrypt authDefaults and set it to formattedAuthDefaults', async () => {
vi.spyOn(OAuthClient.prototype, 'eligibleForDecryption').mockReturnValue(
true
);
const formattedAuthDefaults = {
key: 'value',
};
const authDefaults = AES.encrypt(
JSON.stringify(formattedAuthDefaults),
appConfig.encryptionKey
).toString();
const oauthClient = new OAuthClient();
oauthClient.authDefaults = authDefaults;
oauthClient.decryptData();
expect(oauthClient.formattedAuthDefaults).toStrictEqual(
formattedAuthDefaults
);
expect(oauthClient.authDefaults).not.toStrictEqual(formattedAuthDefaults);
});
});
describe('eligibleForEncryption', () => {
it('should return true when formattedAuthDefaults property exists', async () => {
const oauthClient = await createOAuthClient();
expect(oauthClient.eligibleForEncryption()).toBe(true);
});
it("should return false when formattedAuthDefaults property doesn't exist", async () => {
const oauthClient = await createOAuthClient();
delete oauthClient.formattedAuthDefaults;
expect(oauthClient.eligibleForEncryption()).toBe(false);
});
});
describe('eligibleForDecryption', () => {
it('should return true when authDefaults property exists', async () => {
const oauthClient = await createOAuthClient();
expect(oauthClient.eligibleForDecryption()).toBe(true);
});
it("should return false when authDefaults property doesn't exist", async () => {
const oauthClient = await createOAuthClient();
delete oauthClient.authDefaults;
expect(oauthClient.eligibleForDecryption()).toBe(false);
});
});
it('$beforeInsert should call OAuthClient.encryptData', async () => {
const oauthClientBeforeInsertSpy = vi.spyOn(
OAuthClient.prototype,
'encryptData'
);
await createOAuthClient();
expect(oauthClientBeforeInsertSpy).toHaveBeenCalledOnce();
});
it('$beforeUpdate should call OAuthClient.encryptData', async () => {
const oauthClient = await createOAuthClient();
const oauthClientBeforeUpdateSpy = vi.spyOn(
OAuthClient.prototype,
'encryptData'
);
await oauthClient.$query().patchAndFetch({ name: 'sample' });
expect(oauthClientBeforeUpdateSpy).toHaveBeenCalledOnce();
});
it('$afterFind should call OAuthClient.decryptData', async () => {
const oauthClient = await createOAuthClient();
const oauthClientAfterFindSpy = vi.spyOn(
OAuthClient.prototype,
'decryptData'
);
await oauthClient.$query();
expect(oauthClientAfterFindSpy).toHaveBeenCalledOnce();
});
});

View File

@@ -4,10 +4,10 @@ import { authorizeAdmin } from '../../../../helpers/authorization.js';
import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js'; import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
import createConfigAction from '../../../../controllers/api/v1/admin/apps/create-config.ee.js'; import createConfigAction from '../../../../controllers/api/v1/admin/apps/create-config.ee.js';
import updateConfigAction from '../../../../controllers/api/v1/admin/apps/update-config.ee.js'; import updateConfigAction from '../../../../controllers/api/v1/admin/apps/update-config.ee.js';
import getAuthClientsAction from '../../../../controllers/api/v1/admin/apps/get-auth-clients.ee.js'; import getOAuthClientsAction from '../../../../controllers/api/v1/admin/apps/get-oauth-clients.ee.js';
import getAuthClientAction from '../../../../controllers/api/v1/admin/apps/get-auth-client.ee.js'; import getOAuthClientAction from '../../../../controllers/api/v1/admin/apps/get-oauth-client.ee.js';
import createAuthClientAction from '../../../../controllers/api/v1/admin/apps/create-auth-client.ee.js'; import createOAuthClientAction from '../../../../controllers/api/v1/admin/apps/create-oauth-client.ee.js';
import updateAuthClientAction from '../../../../controllers/api/v1/admin/apps/update-auth-client.ee.js'; import updateOAuthClientAction from '../../../../controllers/api/v1/admin/apps/update-oauth-client.ee.js';
const router = Router(); const router = Router();
@@ -28,35 +28,35 @@ router.patch(
); );
router.get( router.get(
'/:appKey/auth-clients', '/:appKey/oauth-clients',
authenticateUser, authenticateUser,
authorizeAdmin, authorizeAdmin,
checkIsEnterprise, checkIsEnterprise,
getAuthClientsAction getOAuthClientsAction
); );
router.post( router.post(
'/:appKey/auth-clients', '/:appKey/oauth-clients',
authenticateUser, authenticateUser,
authorizeAdmin, authorizeAdmin,
checkIsEnterprise, checkIsEnterprise,
createAuthClientAction createOAuthClientAction
); );
router.get( router.get(
'/:appKey/auth-clients/:appAuthClientId', '/:appKey/oauth-clients/:oauthClientId',
authenticateUser, authenticateUser,
authorizeAdmin, authorizeAdmin,
checkIsEnterprise, checkIsEnterprise,
getAuthClientAction getOAuthClientAction
); );
router.patch( router.patch(
'/:appKey/auth-clients/:appAuthClientId', '/:appKey/oauth-clients/:oauthClientId',
authenticateUser, authenticateUser,
authorizeAdmin, authorizeAdmin,
checkIsEnterprise, checkIsEnterprise,
updateAuthClientAction updateOAuthClientAction
); );
export default router; export default router;

View File

@@ -7,8 +7,8 @@ import getAppsAction from '../../../controllers/api/v1/apps/get-apps.js';
import getAuthAction from '../../../controllers/api/v1/apps/get-auth.js'; import getAuthAction from '../../../controllers/api/v1/apps/get-auth.js';
import getConnectionsAction from '../../../controllers/api/v1/apps/get-connections.js'; import getConnectionsAction from '../../../controllers/api/v1/apps/get-connections.js';
import getConfigAction from '../../../controllers/api/v1/apps/get-config.ee.js'; import getConfigAction from '../../../controllers/api/v1/apps/get-config.ee.js';
import getAuthClientsAction from '../../../controllers/api/v1/apps/get-auth-clients.ee.js'; import getOAuthClientsAction from '../../../controllers/api/v1/apps/get-oauth-clients.ee.js';
import getAuthClientAction from '../../../controllers/api/v1/apps/get-auth-client.ee.js'; import getOAuthClientAction from '../../../controllers/api/v1/apps/get-oauth-client.ee.js';
import getTriggersAction from '../../../controllers/api/v1/apps/get-triggers.js'; import getTriggersAction from '../../../controllers/api/v1/apps/get-triggers.js';
import getTriggerSubstepsAction from '../../../controllers/api/v1/apps/get-trigger-substeps.js'; import getTriggerSubstepsAction from '../../../controllers/api/v1/apps/get-trigger-substeps.js';
import getActionsAction from '../../../controllers/api/v1/apps/get-actions.js'; import getActionsAction from '../../../controllers/api/v1/apps/get-actions.js';
@@ -44,17 +44,17 @@ router.get(
); );
router.get( router.get(
'/:appKey/auth-clients', '/:appKey/oauth-clients',
authenticateUser, authenticateUser,
checkIsEnterprise, checkIsEnterprise,
getAuthClientsAction getOAuthClientsAction
); );
router.get( router.get(
'/:appKey/auth-clients/:appAuthClientId', '/:appKey/oauth-clients/:oauthClientId',
authenticateUser, authenticateUser,
checkIsEnterprise, checkIsEnterprise,
getAuthClientAction getOAuthClientAction
); );
router.get('/:appKey/triggers', authenticateUser, getTriggersAction); router.get('/:appKey/triggers', authenticateUser, getTriggersAction);

View File

@@ -1,10 +0,0 @@
const appAuthClientSerializer = (appAuthClient) => {
return {
id: appAuthClient.id,
appConfigId: appAuthClient.appConfigId,
name: appAuthClient.name,
active: appAuthClient.active,
};
};
export default appAuthClientSerializer;

View File

@@ -1,24 +0,0 @@
import { describe, it, expect, beforeEach } from 'vitest';
import { createAppAuthClient } from '../../test/factories/app-auth-client';
import appAuthClientSerializer from './app-auth-client';
describe('appAuthClient serializer', () => {
let appAuthClient;
beforeEach(async () => {
appAuthClient = await createAppAuthClient();
});
it('should return app auth client data', async () => {
const expectedPayload = {
id: appAuthClient.id,
appConfigId: appAuthClient.appConfigId,
name: appAuthClient.name,
active: appAuthClient.active,
};
expect(appAuthClientSerializer(appAuthClient)).toStrictEqual(
expectedPayload
);
});
});

View File

@@ -2,7 +2,7 @@ const connectionSerializer = (connection) => {
return { return {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -13,7 +13,7 @@ describe('connectionSerializer', () => {
const expectedPayload = { const expectedPayload = {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -4,7 +4,7 @@ import permissionSerializer from './permission.js';
import adminSamlAuthProviderSerializer from './admin-saml-auth-provider.ee.js'; import adminSamlAuthProviderSerializer from './admin-saml-auth-provider.ee.js';
import samlAuthProviderSerializer from './saml-auth-provider.ee.js'; import samlAuthProviderSerializer from './saml-auth-provider.ee.js';
import samlAuthProviderRoleMappingSerializer from './role-mapping.ee.js'; import samlAuthProviderRoleMappingSerializer from './role-mapping.ee.js';
import appAuthClientSerializer from './app-auth-client.js'; import oauthClientSerializer from './oauth-client.js';
import appConfigSerializer from './app-config.js'; import appConfigSerializer from './app-config.js';
import flowSerializer from './flow.js'; import flowSerializer from './flow.js';
import stepSerializer from './step.js'; import stepSerializer from './step.js';
@@ -28,7 +28,7 @@ const serializers = {
AdminSamlAuthProvider: adminSamlAuthProviderSerializer, AdminSamlAuthProvider: adminSamlAuthProviderSerializer,
SamlAuthProvider: samlAuthProviderSerializer, SamlAuthProvider: samlAuthProviderSerializer,
RoleMapping: samlAuthProviderRoleMappingSerializer, RoleMapping: samlAuthProviderRoleMappingSerializer,
AppAuthClient: appAuthClientSerializer, OAuthClient: oauthClientSerializer,
AppConfig: appConfigSerializer, AppConfig: appConfigSerializer,
Flow: flowSerializer, Flow: flowSerializer,
Step: stepSerializer, Step: stepSerializer,

View File

@@ -0,0 +1,10 @@
const oauthClientSerializer = (oauthClient) => {
return {
id: oauthClient.id,
appConfigId: oauthClient.appConfigId,
name: oauthClient.name,
active: oauthClient.active,
};
};
export default oauthClientSerializer;

View File

@@ -0,0 +1,22 @@
import { describe, it, expect, beforeEach } from 'vitest';
import { createOAuthClient } from '../../test/factories/oauth-client';
import oauthClientSerializer from './oauth-client';
describe('oauthClient serializer', () => {
let oauthClient;
beforeEach(async () => {
oauthClient = await createOAuthClient();
});
it('should return oauth client data', async () => {
const expectedPayload = {
id: oauthClient.id,
appConfigId: oauthClient.appConfigId,
name: oauthClient.name,
active: oauthClient.active,
};
expect(oauthClientSerializer(oauthClient)).toStrictEqual(expectedPayload);
});
});

View File

@@ -1,5 +1,5 @@
import { faker } from '@faker-js/faker'; import { faker } from '@faker-js/faker';
import AppAuthClient from '../../src/models/app-auth-client'; import OAuthClient from '../../src/models/oauth-client';
const formattedAuthDefaults = { const formattedAuthDefaults = {
oAuthRedirectUrl: faker.internet.url(), oAuthRedirectUrl: faker.internet.url(),
@@ -8,14 +8,14 @@ const formattedAuthDefaults = {
clientSecret: faker.string.uuid(), clientSecret: faker.string.uuid(),
}; };
export const createAppAuthClient = async (params = {}) => { export const createOAuthClient = async (params = {}) => {
params.name = params?.name || faker.person.fullName(); params.name = params?.name || faker.person.fullName();
params.appKey = params?.appKey || 'deepl'; params.appKey = params?.appKey || 'deepl';
params.active = params?.active ?? true; params.active = params?.active ?? true;
params.formattedAuthDefaults = params.formattedAuthDefaults =
params?.formattedAuthDefaults || formattedAuthDefaults; params?.formattedAuthDefaults || formattedAuthDefaults;
const appAuthClient = await AppAuthClient.query().insertAndFetch(params); const oauthClient = await OAuthClient.query().insertAndFetch(params);
return appAuthClient; return oauthClient;
}; };

View File

@@ -1,17 +0,0 @@
const createAppAuthClientMock = (appAuthClient) => {
return {
data: {
name: appAuthClient.name,
active: appAuthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default createAppAuthClientMock;

View File

@@ -0,0 +1,17 @@
const createOAuthClientMock = (oauthClient) => {
return {
data: {
name: oauthClient.name,
active: oauthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default createOAuthClientMock;

View File

@@ -1,18 +0,0 @@
const getAppAuthClientMock = (appAuthClient) => {
return {
data: {
name: appAuthClient.name,
id: appAuthClient.id,
active: appAuthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default getAppAuthClientMock;

View File

@@ -1,18 +0,0 @@
const getAdminAppAuthClientsMock = (appAuthClients) => {
return {
data: appAuthClients.map((appAuthClient) => ({
name: appAuthClient.name,
id: appAuthClient.id,
active: appAuthClient.active,
})),
meta: {
count: appAuthClients.length,
currentPage: null,
isArray: true,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default getAdminAppAuthClientsMock;

View File

@@ -0,0 +1,18 @@
const getOAuthClientMock = (oauthClient) => {
return {
data: {
name: oauthClient.name,
id: oauthClient.id,
active: oauthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default getOAuthClientMock;

View File

@@ -0,0 +1,18 @@
const getAdminOAuthClientsMock = (oauthClients) => {
return {
data: oauthClients.map((oauthClient) => ({
name: oauthClient.name,
id: oauthClient.id,
active: oauthClient.active,
})),
meta: {
count: oauthClients.length,
currentPage: null,
isArray: true,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default getAdminOAuthClientsMock;

View File

@@ -1,18 +0,0 @@
const updateAppAuthClientMock = (appAuthClient) => {
return {
data: {
id: appAuthClient.id,
name: appAuthClient.name,
active: appAuthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default updateAppAuthClientMock;

View File

@@ -0,0 +1,18 @@
const updateOAuthClientMock = (oauthClient) => {
return {
data: {
id: oauthClient.id,
name: oauthClient.name,
active: oauthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default updateOAuthClientMock;

View File

@@ -2,7 +2,7 @@ const createConnection = (connection) => {
const connectionData = { const connectionData = {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: connection.formattedData, formattedData: connection.formattedData,
verified: connection.verified || false, verified: connection.verified || false,
createdAt: connection.createdAt.getTime(), createdAt: connection.createdAt.getTime(),

View File

@@ -1,18 +0,0 @@
const getAppAuthClientMock = (appAuthClient) => {
return {
data: {
name: appAuthClient.name,
id: appAuthClient.id,
active: appAuthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default getAppAuthClientMock;

View File

@@ -1,18 +0,0 @@
const getAppAuthClientsMock = (appAuthClients) => {
return {
data: appAuthClients.map((appAuthClient) => ({
name: appAuthClient.name,
id: appAuthClient.id,
active: appAuthClient.active,
})),
meta: {
count: appAuthClients.length,
currentPage: null,
isArray: true,
totalPages: null,
type: 'AppAuthClient',
},
};
};
export default getAppAuthClientsMock;

View File

@@ -4,7 +4,7 @@ const getConnectionsMock = (connections) => {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
verified: connection.verified, verified: connection.verified,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -0,0 +1,18 @@
const getOAuthClientMock = (oauthClient) => {
return {
data: {
name: oauthClient.name,
id: oauthClient.id,
active: oauthClient.active,
},
meta: {
count: 1,
currentPage: null,
isArray: false,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default getOAuthClientMock;

View File

@@ -0,0 +1,18 @@
const getOAuthClientsMock = (oauthClients) => {
return {
data: oauthClients.map((oauthClient) => ({
name: oauthClient.name,
id: oauthClient.id,
active: oauthClient.active,
})),
meta: {
count: oauthClients.length,
currentPage: null,
isArray: true,
totalPages: null,
type: 'OAuthClient',
},
};
};
export default getOAuthClientsMock;

View File

@@ -3,7 +3,7 @@ const resetConnectionMock = (connection) => {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
verified: connection.verified, verified: connection.verified,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -3,7 +3,7 @@ const updateConnectionMock = (connection) => {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
verified: connection.verified, verified: connection.verified,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -3,7 +3,7 @@ const getConnectionMock = async (connection) => {
id: connection.id, id: connection.id,
key: connection.key, key: connection.key,
verified: connection.verified, verified: connection.verified,
appAuthClientId: connection.appAuthClientId, oauthClientId: connection.oauthClientId,
formattedData: { formattedData: {
screenName: connection.formattedData.screenName, screenName: connection.formattedData.screenName,
}, },

View File

@@ -4,8 +4,8 @@ const { insertAppConnection } = require('../../helpers/db-helpers');
test.describe('Admin Applications', () => { test.describe('Admin Applications', () => {
test.beforeAll(async () => { test.beforeAll(async () => {
const deleteAppAuthClients = { const deleteOAuthClients = {
text: 'DELETE FROM app_auth_clients WHERE app_key in ($1, $2, $3, $4, $5, $6)', text: 'DELETE FROM oauth_clients WHERE app_key in ($1, $2, $3, $4, $5, $6)',
values: [ values: [
'carbone', 'carbone',
'spotify', 'spotify',
@@ -29,10 +29,8 @@ test.describe('Admin Applications', () => {
}; };
try { try {
const deleteAppAuthClientsResult = await pgPool.query( const deleteOAuthClientsResult = await pgPool.query(deleteOAuthClients);
deleteAppAuthClients expect(deleteOAuthClientsResult.command).toBe('DELETE');
);
expect(deleteAppAuthClientsResult.command).toBe('DELETE');
const deleteAppConfigsResult = await pgPool.query(deleteAppConfigs); const deleteAppConfigsResult = await pgPool.query(deleteAppConfigs);
expect(deleteAppConfigsResult.command).toBe('DELETE'); expect(deleteAppConfigsResult.command).toBe('DELETE');
} catch (err) { } catch (err) {