Merge pull request #889 from rocket-admin/agent_improvements

Refactor connection token validation to return structured result

Author: Artuomka

autoadmin-ws-server/src/index.js

@@ -115,7 +115,7 @@ async function checkConnectionToken(connectionToken) {
       console.info('-> response.data', response.data);
       return false;
     }
-    const result = response.data === true;
+    const result = !!response.data.isValid;
     if (result) {
       tokenCacheResult.set(connectionToken, true);
     }

backend/src/entities/connection/connection.controller.ts

@@ -77,6 +77,7 @@ import { FoundOneConnectionDs } from './application/data-structures/found-one-co
 import { FoundGroupResponseDto } from '../group/dto/found-group-response.dto.js';
 import { FoundUserGroupsInConnectionDTO } from './application/dto/found-user-groups-in-connection.dto.js';
 import { SuccessResponse } from '../../microservices/saas-microservice/data-structures/common-responce.ds.js';
+import { TokenValidationResult } from './use-cases/validate-connection-token.use.case.js';
 
 @UseInterceptors(SentryInterceptor)
 @Controller()
@@ -614,9 +615,9 @@ export class ConnectionController {
     type: Boolean,
   })
   @Get('/connection/token/')
-  async validateConnectionAgentToken(@Query('token') token: string): Promise<boolean> {
+  async validateConnectionAgentToken(@Query('token') token: string): Promise<TokenValidationResult> {
     if (!token || typeof token !== 'string' || token.length === 0) {
-      return false;
+      return { isValid: false };
     }
     return await this.validateConnectionTokenUseCase.execute(token, InTransactionEnum.OFF);
   }
@@ -656,7 +657,7 @@ export class ConnectionController {
       if (connectionData.type === ConnectionTypesEnum.dynamodb) {
         return errors;
       }
-      
+
       if (!connectionData.database) errors.push(Messages.DATABASE_MISSING);
       if (process.env.NODE_ENV !== 'test' && !connectionData.ssh) {
         if (!this.isMongoHost(connectionData.host)) {

backend/src/entities/connection/use-cases/use-cases.interfaces.ts

@@ -20,6 +20,7 @@ import { FoundOneConnectionDs } from '../application/data-structures/found-one-c
 import { FoundGroupResponseDto } from '../../group/dto/found-group-response.dto.js';
 import { FoundUserGroupsInConnectionDTO } from '../application/dto/found-user-groups-in-connection.dto.js';
 import { SuccessResponse } from '../../../microservices/saas-microservice/data-structures/common-responce.ds.js';
+import { TokenValidationResult } from './validate-connection-token.use.case.js';
 
 export interface IFindConnections {
   execute(user: CreateUserDs, inTransaction: InTransactionEnum): Promise<FoundConnectionsDs>;
@@ -83,7 +84,7 @@ export interface IRestoreConnection {
 }
 
 export interface IValidateConnectionToken {
-  execute(token: string, inTransaction: InTransactionEnum): Promise<boolean>;
+  execute(token: string, inTransaction: InTransactionEnum): Promise<TokenValidationResult>;
 }
 
 export interface IRefreshConnectionAgentToken {

backend/src/entities/connection/use-cases/validate-connection-token.use.case.ts

@@ -5,9 +5,12 @@ import { BaseType } from '../../../common/data-injection.tokens.js';
 import { Encryptor } from '../../../helpers/encryption/encryptor.js';
 import { IValidateConnectionToken } from './use-cases.interfaces.js';
 
+export type TokenValidationResult = {
+  isValid: boolean;
+};
 @Injectable()
 export class ValidateConnectionTokenUseCase
-  extends AbstractUseCase<string, boolean>
+  extends AbstractUseCase<string, TokenValidationResult>
   implements IValidateConnectionToken
 {
   constructor(
@@ -17,9 +20,9 @@ export class ValidateConnectionTokenUseCase
     super();
   }
 
-  protected async implementation(connectionToken: string): Promise<boolean> {
+  protected async implementation(connectionToken: string): Promise<TokenValidationResult> {
     connectionToken = Encryptor.hashDataHMAC(connectionToken);
     const foundConnection = await this._dbContext.connectionRepository.findOneAgentConnectionByToken(connectionToken);
-    return !!foundConnection;
+    return { isValid: !!foundConnection };
   }
 }