From 88754ac5691a0c77700253b07bb09084d1021e1b Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 20:49:53 +0100 Subject: [PATCH 1/9] feat: Add appKey to app auth clients --- .../20240326194638_add_app_key_to_app_auth_clients.js | 11 +++++++++++ packages/backend/src/models/app-auth-client.js | 3 ++- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 packages/backend/src/db/migrations/20240326194638_add_app_key_to_app_auth_clients.js diff --git a/packages/backend/src/db/migrations/20240326194638_add_app_key_to_app_auth_clients.js b/packages/backend/src/db/migrations/20240326194638_add_app_key_to_app_auth_clients.js new file mode 100644 index 00000000..4ab82106 --- /dev/null +++ b/packages/backend/src/db/migrations/20240326194638_add_app_key_to_app_auth_clients.js @@ -0,0 +1,11 @@ +export async function up(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table.string('app_key'); + }); +} + +export async function down(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table.dropColumn('app_key'); + }); +} diff --git a/packages/backend/src/models/app-auth-client.js b/packages/backend/src/models/app-auth-client.js index a2837763..189f7ca3 100644 --- a/packages/backend/src/models/app-auth-client.js +++ b/packages/backend/src/models/app-auth-client.js @@ -9,10 +9,11 @@ class AppAuthClient extends Base { static jsonSchema = { type: 'object', - required: ['name', 'appConfigId', 'formattedAuthDefaults'], + required: ['name', 'appKey', 'appConfigId', 'formattedAuthDefaults'], properties: { id: { type: 'string', format: 'uuid' }, + appKey: { type: 'string' }, appConfigId: { type: 'string', format: 'uuid' }, active: { type: 'boolean' }, authDefaults: { type: ['string', 'null'] }, From abc64d769c230b1c7572dd4a0fd2694ec047bdd6 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 20:56:50 +0100 Subject: [PATCH 2/9] feat: Migrate app config id to app key --- ...26195028_migrate_app_config_id_to_app_key.js | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 packages/backend/src/db/migrations/20240326195028_migrate_app_config_id_to_app_key.js diff --git a/packages/backend/src/db/migrations/20240326195028_migrate_app_config_id_to_app_key.js b/packages/backend/src/db/migrations/20240326195028_migrate_app_config_id_to_app_key.js new file mode 100644 index 00000000..05842ad7 --- /dev/null +++ b/packages/backend/src/db/migrations/20240326195028_migrate_app_config_id_to_app_key.js @@ -0,0 +1,17 @@ +export async function up(knex) { + const appAuthClients = await knex('app_auth_clients').select('*'); + + for (const appAuthClient of appAuthClients) { + const appConfig = await knex('app_configs') + .where('id', appAuthClient.app_config_id) + .first(); + + await knex('app_auth_clients') + .where('id', appAuthClient.id) + .update({ app_key: appConfig.key }); + } +} + +export async function down() { + // void +} From a00d3a2c5ea850886b52fa1dd2a1bf9f0f89d87d Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 20:58:51 +0100 Subject: [PATCH 3/9] feat: Remove app config id from app auth clients --- ..._remove_app_config_id_from_app_auth_clients.js | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js diff --git a/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js b/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js new file mode 100644 index 00000000..b4340557 --- /dev/null +++ b/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js @@ -0,0 +1,15 @@ +export async function up(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table.dropColumn('app_config_id'); + }); +} + +export async function down(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table + .uuid('app_config_id') + .notNullable() + .references('id') + .inTable('app_configs'); + }); +} From 33f7a90042e5a0cda3f53e4d4e60c0fb9cfc8187 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 20:59:33 +0100 Subject: [PATCH 4/9] feat: Remove app auth clients relation from app configs --- packages/backend/src/models/app-config.js | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/packages/backend/src/models/app-config.js b/packages/backend/src/models/app-config.js index eabc3b4b..77cdb6cd 100644 --- a/packages/backend/src/models/app-config.js +++ b/packages/backend/src/models/app-config.js @@ -1,6 +1,5 @@ import App from './app.js'; import Base from './base.js'; -import AppAuthClient from './app-auth-client.js'; class AppConfig extends Base { static tableName = 'app_configs'; @@ -22,17 +21,6 @@ class AppConfig extends Base { return ['canConnect', 'canCustomConnect']; } - static relationMappings = () => ({ - appAuthClients: { - relation: Base.HasManyRelation, - modelClass: AppAuthClient, - join: { - from: 'app_configs.id', - to: 'app_auth_clients.app_config_id', - }, - }, - }); - get canCustomConnect() { return !this.disabled && this.allowCustomConnection; } From d21888c04719fb61e4bea35b6092c76106487a1e Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 21:00:14 +0100 Subject: [PATCH 5/9] feat: Remove app config relation from app auth clients --- packages/backend/src/models/app-auth-client.js | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/packages/backend/src/models/app-auth-client.js b/packages/backend/src/models/app-auth-client.js index 189f7ca3..0121a727 100644 --- a/packages/backend/src/models/app-auth-client.js +++ b/packages/backend/src/models/app-auth-client.js @@ -1,7 +1,6 @@ import AES from 'crypto-js/aes.js'; import enc from 'crypto-js/enc-utf8.js'; import appConfig from '../config/app.js'; -import AppConfig from './app-config.js'; import Base from './base.js'; class AppAuthClient extends Base { @@ -9,12 +8,11 @@ class AppAuthClient extends Base { static jsonSchema = { type: 'object', - required: ['name', 'appKey', 'appConfigId', 'formattedAuthDefaults'], + required: ['name', 'appKey', 'formattedAuthDefaults'], properties: { id: { type: 'string', format: 'uuid' }, appKey: { type: 'string' }, - appConfigId: { type: 'string', format: 'uuid' }, active: { type: 'boolean' }, authDefaults: { type: ['string', 'null'] }, formattedAuthDefaults: { type: 'object' }, @@ -23,17 +21,6 @@ class AppAuthClient extends Base { }, }; - static relationMappings = () => ({ - appConfig: { - relation: Base.BelongsToOneRelation, - modelClass: AppConfig, - join: { - from: 'app_auth_clients.app_config_id', - to: 'app_configs.id', - }, - }, - }); - encryptData() { if (!this.eligibleForEncryption()) return; From 6dc54ecabc44c55600cb37cd81e85c175c24c40e Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 21:15:48 +0100 Subject: [PATCH 6/9] feat: Implement new get auth clients api endpoint --- .../api/v1/apps/get-auth-clients.ee.js | 10 +++++ .../api/v1/apps/get-auth-clients.ee.test.js | 42 +++++++++++++++++++ packages/backend/src/routes/api/v1/apps.js | 8 ++++ .../backend/test/factories/app-auth-client.js | 3 +- .../get-auth-clients.js} | 0 5 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.js create mode 100644 packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.test.js rename packages/backend/test/mocks/rest/api/v1/{app-auth-clients/get-app-auth-clients.js => apps/get-auth-clients.js} (100%) diff --git a/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.js b/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.js new file mode 100644 index 00000000..06eceec1 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.js @@ -0,0 +1,10 @@ +import { renderObject } from '../../../../helpers/renderer.js'; +import AppAuthClient from '../../../../models/app-auth-client.js'; + +export default async (request, response) => { + const appAuthClients = await AppAuthClient.query() + .where({ app_key: request.params.appKey, active: true }) + .orderBy('created_at', 'desc'); + + renderObject(response, appAuthClients); +}; diff --git a/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.test.js b/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.test.js new file mode 100644 index 00000000..3f04a10f --- /dev/null +++ b/packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.test.js @@ -0,0 +1,42 @@ +import { vi, describe, it, expect, beforeEach } from 'vitest'; +import request from 'supertest'; +import app from '../../../../app.js'; +import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; +import { createUser } from '../../../../../test/factories/user.js'; +import getAuthClientsMock from '../../../../../test/mocks/rest/api/v1/apps/get-auth-clients.js'; +import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; +import * as license from '../../../../helpers/license.ee.js'; + +describe('GET /api/v1/app/:appKey/auth-clients', () => { + let currentUser, token; + + beforeEach(async () => { + vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); + + currentUser = await createUser(); + + token = createAuthTokenByUserId(currentUser.id); + }); + + it('should return specified app auth client info', async () => { + const appAuthClientOne = await createAppAuthClient({ + appKey: 'deepl', + }); + + const appAuthClientTwo = await createAppAuthClient({ + appKey: 'deepl', + }); + + const response = await request(app) + .get('/api/v1/apps/deepl/auth-clients') + .set('Authorization', token) + .expect(200); + + const expectedPayload = getAuthClientsMock([ + appAuthClientTwo, + appAuthClientOne, + ]); + + expect(response.body).toEqual(expectedPayload); + }); +}); diff --git a/packages/backend/src/routes/api/v1/apps.js b/packages/backend/src/routes/api/v1/apps.js index 24d9c52f..9bbc1e4f 100644 --- a/packages/backend/src/routes/api/v1/apps.js +++ b/packages/backend/src/routes/api/v1/apps.js @@ -7,6 +7,7 @@ import getAppAction from '../../../controllers/api/v1/apps/get-app.js'; import getAppsAction from '../../../controllers/api/v1/apps/get-apps.js'; import getAuthAction from '../../../controllers/api/v1/apps/get-auth.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 getTriggersAction from '../../../controllers/api/v1/apps/get-triggers.js'; import getTriggerSubstepsAction from '../../../controllers/api/v1/apps/get-trigger-substeps.js'; import getActionsAction from '../../../controllers/api/v1/apps/get-actions.js'; @@ -26,6 +27,13 @@ router.get( asyncHandler(getConfigAction) ); +router.get( + '/:appKey/auth-clients', + authenticateUser, + checkIsEnterprise, + asyncHandler(getAuthClientsAction) +); + router.get( '/:appKey/triggers', authenticateUser, diff --git a/packages/backend/test/factories/app-auth-client.js b/packages/backend/test/factories/app-auth-client.js index 3d51f80f..0cadf197 100644 --- a/packages/backend/test/factories/app-auth-client.js +++ b/packages/backend/test/factories/app-auth-client.js @@ -1,5 +1,4 @@ import { faker } from '@faker-js/faker'; -import { createAppConfig } from './app-config.js'; import AppAuthClient from '../../src/models/app-auth-client'; const formattedAuthDefaults = { @@ -12,7 +11,7 @@ const formattedAuthDefaults = { export const createAppAuthClient = async (params = {}) => { params.name = params?.name || faker.person.fullName(); params.id = params?.id || faker.string.uuid(); - params.appConfigId = params?.appConfigId || (await createAppConfig()).id; + params.appKey = params?.appKey || 'deepl'; params.active = params?.active ?? true; params.formattedAuthDefaults = params?.formattedAuthDefaults || formattedAuthDefaults; diff --git a/packages/backend/test/mocks/rest/api/v1/app-auth-clients/get-app-auth-clients.js b/packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js similarity index 100% rename from packages/backend/test/mocks/rest/api/v1/app-auth-clients/get-app-auth-clients.js rename to packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js From 70f5e45c1fdb749f15ceeb1cc2d1793d2af65b71 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 21:19:10 +0100 Subject: [PATCH 7/9] chore: Remove old app auth clients API endpoint --- .../app-auth-clients/get-app-auth-clients.js | 10 ----- .../get-app-auth-clients.test.js | 37 ------------------- .../src/routes/api/v1/app-auth-clients.js | 8 ---- 3 files changed, 55 deletions(-) delete mode 100644 packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.js delete mode 100644 packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.test.js diff --git a/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.js b/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.js deleted file mode 100644 index ff1b9af1..00000000 --- a/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.js +++ /dev/null @@ -1,10 +0,0 @@ -import { renderObject } from '../../../../helpers/renderer.js'; -import AppAuthClient from '../../../../models/app-auth-client.js'; - -export default async (request, response) => { - const appAuthClients = await AppAuthClient.query() - .where({ active: true }) - .orderBy('created_at', 'desc'); - - renderObject(response, appAuthClients); -}; diff --git a/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.test.js b/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.test.js deleted file mode 100644 index 0c92fe02..00000000 --- a/packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-clients.test.js +++ /dev/null @@ -1,37 +0,0 @@ -import { vi, describe, it, expect, beforeEach } from 'vitest'; -import request from 'supertest'; -import app from '../../../../app.js'; -import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js'; -import { createUser } from '../../../../../test/factories/user.js'; -import getAppAuthClientsMock from '../../../../../test/mocks/rest/api/v1/app-auth-clients/get-app-auth-clients.js'; -import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js'; -import * as license from '../../../../helpers/license.ee.js'; - -describe('GET /api/v1/app-auth-clients', () => { - let currentUser, token; - - beforeEach(async () => { - vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); - - currentUser = await createUser(); - - token = createAuthTokenByUserId(currentUser.id); - }); - - it('should return specified app auth client info', async () => { - const appAuthClientOne = await createAppAuthClient(); - const appAuthClientTwo = await createAppAuthClient(); - - const response = await request(app) - .get('/api/v1/app-auth-clients') - .set('Authorization', token) - .expect(200); - - const expectedPayload = getAppAuthClientsMock([ - appAuthClientTwo, - appAuthClientOne, - ]); - - expect(response.body).toEqual(expectedPayload); - }); -}); diff --git a/packages/backend/src/routes/api/v1/app-auth-clients.js b/packages/backend/src/routes/api/v1/app-auth-clients.js index efbcceb4..6a15826f 100644 --- a/packages/backend/src/routes/api/v1/app-auth-clients.js +++ b/packages/backend/src/routes/api/v1/app-auth-clients.js @@ -3,17 +3,9 @@ import asyncHandler from 'express-async-handler'; import { authenticateUser } from '../../../helpers/authentication.js'; import { checkIsEnterprise } from '../../../helpers/check-is-enterprise.js'; import getAppAuthClientAction from '../../../controllers/api/v1/app-auth-clients/get-app-auth-client.js'; -import getAppAuthClientsAction from '../../../controllers/api/v1/app-auth-clients/get-app-auth-clients.js'; const router = Router(); -router.get( - '/', - authenticateUser, - checkIsEnterprise, - asyncHandler(getAppAuthClientsAction) -); - router.get( '/:appAuthClientId', authenticateUser, From 186160ebf47d7a7a83832d9260fd0aa4c0525493 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 21:23:22 +0100 Subject: [PATCH 8/9] feat: Make appKey column of app auth clients not nullable --- ...add_not_nullable_to_app_key_of_app_auth_clients.js | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 packages/backend/src/db/migrations/20240326202110_add_not_nullable_to_app_key_of_app_auth_clients.js diff --git a/packages/backend/src/db/migrations/20240326202110_add_not_nullable_to_app_key_of_app_auth_clients.js b/packages/backend/src/db/migrations/20240326202110_add_not_nullable_to_app_key_of_app_auth_clients.js new file mode 100644 index 00000000..9c6145b4 --- /dev/null +++ b/packages/backend/src/db/migrations/20240326202110_add_not_nullable_to_app_key_of_app_auth_clients.js @@ -0,0 +1,11 @@ +export async function up(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table.string('app_key').notNullable().alter(); + }); +} + +export async function down(knex) { + await knex.schema.table('app_auth_clients', (table) => { + table.string('app_key').nullable().alter(); + }); +} From 01ae96840e7d9df747107fa7add1e11e48e77610 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 26 Mar 2024 21:27:38 +0100 Subject: [PATCH 9/9] refactor: Remove redundant appConfigId from get auth clients mock --- ...0326195748_remove_app_config_id_from_app_auth_clients.js | 6 +----- .../backend/test/mocks/rest/api/v1/apps/get-auth-clients.js | 1 - 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js b/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js index b4340557..12b7c7d5 100644 --- a/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js +++ b/packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js @@ -6,10 +6,6 @@ export async function up(knex) { export async function down(knex) { await knex.schema.table('app_auth_clients', (table) => { - table - .uuid('app_config_id') - .notNullable() - .references('id') - .inTable('app_configs'); + table.uuid('app_config_id').references('id').inTable('app_configs'); }); } diff --git a/packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js b/packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js index 1674eb8f..0a697dec 100644 --- a/packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js +++ b/packages/backend/test/mocks/rest/api/v1/apps/get-auth-clients.js @@ -1,7 +1,6 @@ const getAppAuthClientsMock = (appAuthClients) => { return { data: appAuthClients.map((appAuthClient) => ({ - appConfigId: appAuthClient.appConfigId, name: appAuthClient.name, id: appAuthClient.id, active: appAuthClient.active,