refactor(app-config): rename canConnect as connectionAllowed

packages/backend/src/db/migrations/20241002121145_persist_virtual_attributes_in_app_config.js

@@ -1,6 +1,6 @@
 export async function up(knex) {
   await knex.schema.alterTable('app_configs', (table) => {
-    table.boolean('can_connect').defaultTo(false);
+    table.boolean('connectionAllowed').defaultTo(false);
   });
 
   const appConfigs = await knex('app_configs').select('*');
@@ -17,17 +17,21 @@ export async function up(knex) {
     const shared = appConfig.shared;
     const active = appConfig.disabled === false;
 
-    const canConnectConditions = [hasSomeActiveAppAuthClients, shared, active];
-    const canConnect = canConnectConditions.every(Boolean);
+    const connectionAllowedConditions = [
+      hasSomeActiveAppAuthClients,
+      shared,
+      active,
+    ];
+    const connectionAllowed = connectionAllowedConditions.every(Boolean);
 
     await knex('app_configs')
       .where('id', appConfig.id)
-      .update({ can_connect: canConnect });
+      .update({ connection_allowed: connectionAllowed });
   }
 }
 
 export async function down(knex) {
   await knex.schema.alterTable('app_configs', (table) => {
-    table.dropColumn('can_connect');
+    table.dropColumn('connectionAllowed');
   });
 }

packages/backend/src/models/__snapshots__/app-config.test.js.snap

@@ -7,7 +7,7 @@ exports[`AppConfig model > jsonSchema should have correct validations 1`] = `
       "default": false,
       "type": "boolean",
     },
-    "canConnect": {
+    "connectionAllowed": {
       "default": false,
       "type": "boolean",
     },

packages/backend/src/models/app-auth-client.js

@@ -63,7 +63,7 @@ class AppAuthClient extends Base {
   async triggerAppConfigUpdate() {
     const appConfig = await this.$relatedQuery('appConfig').select('*');
 
-    await appConfig?.updateCanConnectProperty();
+    await appConfig?.updateConnectionAllowedProperty();
   }
 
   // TODO: Make another abstraction like beforeSave instead of using

packages/backend/src/models/app-config.js

@@ -12,7 +12,7 @@ class AppConfig extends Base {
     properties: {
       id: { type: 'string', format: 'uuid' },
       key: { type: 'string' },
-      canConnect: { type: 'boolean', default: false },
+      connectionAllowed: { type: 'boolean', default: false },
       allowCustomConnection: { type: 'boolean', default: false },
       shared: { type: 'boolean', default: false },
       disabled: { type: 'boolean', default: false },
@@ -46,7 +46,7 @@ class AppConfig extends Base {
     return await App.findOneByKey(this.key);
   }
 
-  async computeCanConnectProperty(oldAppConfig) {
+  async computeConnectionAllowedProperty(oldAppConfig) {
     const appAuthClients = await oldAppConfig.$relatedQuery('appAuthClients');
     const hasSomeActiveAppAuthClients = !!appAuthClients?.some(
       (appAuthClient) => appAuthClient.active
@@ -57,27 +57,29 @@ class AppConfig extends Base {
 
     const conditions = [hasSomeActiveAppAuthClients, shared, active];
 
-    const canConnect = conditions.every(Boolean);
+    const connectionAllowed = conditions.every(Boolean);
 
-    return canConnect;
+    return connectionAllowed;
   }
 
-  async updateCanConnectProperty() {
-    const canConnect = await this.computeCanConnectProperty(this);
+  async updateConnectionAllowedProperty() {
+    const connectionAllowed = await this.computeConnectionAllowedProperty(this);
 
     return await this.$query().patch({
-      canConnect,
+      connectionAllowed,
     });
   }
 
-  async computeAndAssignCanConnectProperty(oldAppConfig) {
-    this.canConnect = await this.computeCanConnectProperty(oldAppConfig);
+  async computeAndAssignConnectionAllowedProperty(oldAppConfig) {
+    this.connectionAllowed = await this.computeConnectionAllowedProperty(
+      oldAppConfig
+    );
   }
 
   async $beforeInsert(queryContext) {
     await super.$beforeInsert(queryContext);
 
-    await this.computeAndAssignCanConnectProperty(this);
+    await this.computeAndAssignConnectionAllowedProperty(this);
   }
 
   async $beforeUpdate(opt, queryContext) {
@@ -85,7 +87,7 @@ class AppConfig extends Base {
 
     const oldAppConfig = opt.old;
 
-    await this.computeAndAssignCanConnectProperty(oldAppConfig);
+    await this.computeAndAssignConnectionAllowedProperty(oldAppConfig);
   }
 }
 

packages/backend/src/models/app-config.test.js

@@ -65,7 +65,7 @@ describe('AppConfig model', () => {
     });
   });
 
-  describe('canConnect', () => {
+  describe('connectionAllowed', () => {
     it('should return true when app is enabled, shared and allows custom connection with an active app auth client at least', async () => {
       await createAppAuthClient({
         appKey: 'deepl',
@@ -84,7 +84,7 @@ describe('AppConfig model', () => {
         key: 'deepl',
       });
 
-      expect(appConfig.canConnect).toBe(true);
+      expect(appConfig.connectionAllowed).toBe(true);
     });
 
     it('should return true when app is enabled, shared and allows custom connection with no active app auth client', async () => {
@@ -100,7 +100,7 @@ describe('AppConfig model', () => {
         key: 'deepl',
       });
 
-      expect(appConfig.canConnect).toBe(false);
+      expect(appConfig.connectionAllowed).toBe(false);
     });
 
     it('should return false when app is enabled, shared and allows custom connection without any app auth clients', async () => {
@@ -111,7 +111,7 @@ describe('AppConfig model', () => {
         key: 'deepl',
       });
 
-      expect(appConfig.canConnect).toBe(false);
+      expect(appConfig.connectionAllowed).toBe(false);
     });
 
     it('should return false when app is disabled', async () => {
@@ -120,7 +120,7 @@ describe('AppConfig model', () => {
         allowCustomConnection: true,
       });
 
-      expect(appConfig.canConnect).toBe(false);
+      expect(appConfig.connectionAllowed).toBe(false);
     });
 
     it(`should return false when app doesn't allow custom connection`, async () => {
@@ -129,7 +129,7 @@ describe('AppConfig model', () => {
         allowCustomConnection: false,
       });
 
-      expect(appConfig.canConnect).toBe(false);
+      expect(appConfig.connectionAllowed).toBe(false);
     });
   });
 

packages/backend/src/serializers/app-config.js

@@ -5,7 +5,7 @@ const appConfigSerializer = (appConfig) => {
     allowCustomConnection: appConfig.allowCustomConnection,
     shared: appConfig.shared,
     disabled: appConfig.disabled,
-    canConnect: appConfig.canConnect,
+    connectionAllowed: appConfig.connectionAllowed,
     canCustomConnect: appConfig.canCustomConnect,
     createdAt: appConfig.createdAt.getTime(),
     updatedAt: appConfig.updatedAt.getTime(),

packages/backend/src/serializers/app-config.test.js

@@ -16,7 +16,7 @@ describe('appConfig serializer', () => {
       allowCustomConnection: appConfig.allowCustomConnection,
       shared: appConfig.shared,
       disabled: appConfig.disabled,
-      canConnect: appConfig.canConnect,
+      connectionAllowed: appConfig.connectionAllowed,
       canCustomConnect: appConfig.canCustomConnect,
       createdAt: appConfig.createdAt.getTime(),
       updatedAt: appConfig.updatedAt.getTime(),