Merge pull request #1770 from automatisch/add-app-key-to-auth-clients

feat: Implement new get auth clients api endpoint

packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.js

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

packages/backend/src/controllers/api/v1/apps/get-auth-clients.ee.test.js

@@ -3,11 +3,11 @@ 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 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-auth-clients', () => {
+describe('GET /api/v1/app/:appKey/auth-clients', () => {
   let currentUser, token;
 
   beforeEach(async () => {
@@ -19,15 +19,20 @@ describe('GET /api/v1/app-auth-clients', () => {
   });
 
   it('should return specified app auth client info', async () => {
-    const appAuthClientOne = await createAppAuthClient();
+    const appAuthClientOne = await createAppAuthClient({
-    const appAuthClientTwo = await createAppAuthClient();
+      appKey: 'deepl',
+    });
+
+    const appAuthClientTwo = await createAppAuthClient({
+      appKey: 'deepl',
+    });
 
     const response = await request(app)
-      .get('/api/v1/app-auth-clients')
+      .get('/api/v1/apps/deepl/auth-clients')
       .set('Authorization', token)
       .expect(200);
 
-    const expectedPayload = getAppAuthClientsMock([
+    const expectedPayload = getAuthClientsMock([
       appAuthClientTwo,
       appAuthClientOne,
     ]);

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');
+  });
+}

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
+}

packages/backend/src/db/migrations/20240326195748_remove_app_config_id_from_app_auth_clients.js

@@ -0,0 +1,11 @@
+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').references('id').inTable('app_configs');
+  });
+}

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();
+  });
+}

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,11 +8,11 @@ class AppAuthClient extends Base {
 
   static jsonSchema = {
     type: 'object',
-    required: ['name', 'appConfigId', 'formattedAuthDefaults'],
+    required: ['name', 'appKey', 'formattedAuthDefaults'],
 
     properties: {
       id: { type: 'string', format: 'uuid' },
-      appConfigId: { type: 'string', format: 'uuid' },
+      appKey: { type: 'string' },
       active: { type: 'boolean' },
       authDefaults: { type: ['string', 'null'] },
       formattedAuthDefaults: { type: 'object' },
@@ -22,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;
 

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;
   }

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,

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,

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;

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,