fix(api): add proper error messages for invalid cloud database endpoints

Validate publicEndpoint before calling split() to prevent null reference errors.
Return user-friendly error messages instead of raw JavaScript errors.

References: #RI-7778

Author: valkirilov

redisinsight/api/src/constants/custom-error-codes.ts

@@ -47,6 +47,7 @@ export enum CustomErrorCodes {
   CloudJobNotFound = 11_113,
   CloudSubscriptionAlreadyExistsFree = 11_114,
   CloudDatabaseImportForbidden = 11_115,
+  CloudDatabaseEndpointInvalid = 11_116,
 
   // General database errors [11200, 11299]
   DatabaseAlreadyExists = 11_200,

redisinsight/api/src/constants/error-messages.ts

@@ -144,6 +144,8 @@ export default {
   CLOUD_DATABASE_ALREADY_EXISTS_FREE: 'Free database already exists',
   CLOUD_DATABASE_IMPORT_FORBIDDEN:
     'Adding your Redis Cloud database to Redis Insight is disabled due to a setting restricting database connection management.',
+  CLOUD_DATABASE_ENDPOINT_INVALID:
+    'Database endpoint is not available or not fully provisioned yet.',
   CLOUD_PLAN_NOT_FOUND_FREE: 'Unable to find free cloud plan',
   CLOUD_SUBSCRIPTION_ALREADY_EXISTS_FREE: 'Free subscription already exists',
   COMMON_DEFAULT_IMPORT_ERROR: 'Unable to import default data',

redisinsight/api/src/modules/cloud/autodiscovery/cloud-autodiscovery.service.spec.ts

@@ -29,6 +29,8 @@ import { CloudApiUnauthorizedException } from 'src/modules/cloud/common/exceptio
 import { CloudUserCapiService } from 'src/modules/cloud/user/cloud-user.capi.service';
 import { CloudSubscriptionCapiService } from 'src/modules/cloud/subscription/cloud-subscription.capi.service';
 import { CloudDatabaseCapiService } from 'src/modules/cloud/database/cloud-database.capi.service';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import { CustomErrorCodes } from 'src/constants';
 
 describe('CloudAutodiscoveryService', () => {
   let service: CloudAutodiscoveryService;
@@ -364,5 +366,62 @@ describe('CloudAutodiscoveryService', () => {
         mockImportCloudDatabaseResponseFixed,
       ]);
     });
+    it.each([
+      {
+        description: 'null',
+        publicEndpoint: null,
+      },
+      {
+        description: 'undefined',
+        publicEndpoint: undefined,
+      },
+      {
+        description: 'empty string',
+        publicEndpoint: '',
+      },
+      {
+        description: 'whitespace only',
+        publicEndpoint: '   ',
+      },
+      {
+        description: 'does not contain colon',
+        publicEndpoint: 'hostname',
+      },
+    ])(
+      'should return error when publicEndpoint is $description',
+      async ({ publicEndpoint }) => {
+        cloudDatabaseCapiService.getDatabase.mockResolvedValueOnce({
+          ...mockCloudDatabase,
+          publicEndpoint,
+          status: CloudDatabaseStatus.Active,
+        });
+
+        const result = await service.addRedisCloudDatabases(
+          mockSessionMetadata,
+          mockCloudCapiAuthDto,
+          [mockImportCloudDatabaseDto],
+        );
+
+        expect(result).toEqual([
+          {
+            ...mockImportCloudDatabaseResponse,
+            status: ActionStatus.Fail,
+            message: ERROR_MESSAGES.CLOUD_DATABASE_ENDPOINT_INVALID,
+            error: {
+              message: ERROR_MESSAGES.CLOUD_DATABASE_ENDPOINT_INVALID,
+              statusCode: 400,
+              error: 'CloudDatabaseEndpointInvalid',
+              errorCode: CustomErrorCodes.CloudDatabaseEndpointInvalid,
+            },
+            databaseDetails: {
+              ...mockCloudDatabase,
+              publicEndpoint,
+              status: CloudDatabaseStatus.Active,
+            },
+          },
+        ]);
+        expect(databaseService.create).not.toHaveBeenCalled();
+      },
+    );
   });
 });

redisinsight/api/src/modules/cloud/autodiscovery/cloud-autodiscovery.service.ts

@@ -3,6 +3,7 @@ import {
   Logger,
   ServiceUnavailableException,
 } from '@nestjs/common';
+import { CloudDatabaseEndpointInvalidException } from 'src/modules/cloud/job/exceptions';
 import { uniqBy } from 'lodash';
 import ERROR_MESSAGES from 'src/constants/error-messages';
 import {
@@ -29,6 +30,7 @@ import {
   CloudDatabase,
   CloudDatabaseStatus,
 } from 'src/modules/cloud/database/models';
+import { isValidCloudDatabaseEndpoint } from 'src/modules/cloud/database/utils';
 import config from 'src/utils/config';
 
 const cloudConfig = config.get('cloud');
@@ -222,6 +224,16 @@ export class CloudAutodiscoveryService {
                 databaseDetails: database,
               };
             }
+            if (!isValidCloudDatabaseEndpoint(publicEndpoint)) {
+              const exception = new CloudDatabaseEndpointInvalidException();
+              return {
+                ...dto,
+                status: ActionStatus.Fail,
+                message: exception.message,
+                error: exception?.getResponse(),
+                databaseDetails: database,
+              };
+            }
             const [host, port] = publicEndpoint.split(':');
 
             await this.databaseService.create(sessionMetadata, {

redisinsight/api/src/modules/cloud/database/utils/cloud-data-converter.ts

@@ -17,6 +17,14 @@ export function convertRedisCloudModuleName(name: string): string {
   return REDIS_CLOUD_MODULES_NAMES[name] ?? name;
 }
 
+export function isValidCloudDatabaseEndpoint(
+  publicEndpoint: string | null | undefined,
+): boolean {
+  return (
+    !!publicEndpoint && !!publicEndpoint.trim() && publicEndpoint.includes(':')
+  );
+}
+
 export const parseCloudDatabaseCapiResponse = (
   database: ICloudCapiDatabase,
   tags: ICloudCapiDatabaseTag[],

redisinsight/api/src/modules/cloud/job/exceptions/cloud-database-endpoint-invalid.exception.ts

@@ -0,0 +1,23 @@
+import {
+  HttpException,
+  HttpExceptionOptions,
+  HttpStatus,
+} from '@nestjs/common';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import { CustomErrorCodes } from 'src/constants';
+
+export class CloudDatabaseEndpointInvalidException extends HttpException {
+  constructor(
+    message = ERROR_MESSAGES.CLOUD_DATABASE_ENDPOINT_INVALID,
+    options?: HttpExceptionOptions,
+  ) {
+    const response = {
+      message,
+      statusCode: HttpStatus.BAD_REQUEST,
+      error: 'CloudDatabaseEndpointInvalid',
+      errorCode: CustomErrorCodes.CloudDatabaseEndpointInvalid,
+    };
+
+    super(response, response.statusCode, options);
+  }
+}

redisinsight/api/src/modules/cloud/job/exceptions/index.ts

@@ -1,4 +1,5 @@
 export * from './cloud-database-already-exists-free.exception';
+export * from './cloud-database-endpoint-invalid.exception';
 export * from './cloud-database-import-forbidden.exception';
 export * from './cloud-database-in-failed-state.exception';
 export * from './cloud-database-in-unexpected-state.exception';

redisinsight/api/src/modules/cloud/job/jobs/create-free-database.cloud-job.ts

@@ -15,6 +15,7 @@ import { WaitForActiveDatabaseCloudJob } from 'src/modules/cloud/job/jobs/wait-f
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CloudJobStatus, CloudJobStep } from 'src/modules/cloud/job/models';
 import {
+  CloudDatabaseEndpointInvalidException,
   CloudDatabaseImportForbiddenException,
   CloudJobUnexpectedErrorException,
   CloudTaskNoResourceIdException,
@@ -30,6 +31,7 @@ import { ClientContext, SessionMetadata } from 'src/common/models';
 import { DatabaseInfoService } from 'src/modules/database/database-info.service';
 import { FeatureService } from 'src/modules/feature/feature.service';
 import { KnownFeatures } from 'src/modules/feature/constants';
+import { isValidCloudDatabaseEndpoint } from 'src/modules/cloud/database/utils';
 
 const cloudConfig = config.get('cloud');
 
@@ -138,6 +140,10 @@ export class CreateFreeDatabaseCloudJob extends CloudJob {
 
       const { publicEndpoint, name, password } = cloudDatabase;
 
+      if (!isValidCloudDatabaseEndpoint(publicEndpoint)) {
+        throw new CloudDatabaseEndpointInvalidException();
+      }
+
       const [host, port] = publicEndpoint.split(':');
 
       const database = await this.dependencies.databaseService.create(

redisinsight/api/src/modules/cloud/job/jobs/import-free-database.cloud-job.ts

@@ -16,7 +16,11 @@ import { CloudCapiKeyService } from 'src/modules/cloud/capi-key/cloud-capi-key.s
 import { SessionMetadata } from 'src/common/models';
 import { KnownFeatures } from 'src/modules/feature/constants';
 import { FeatureService } from 'src/modules/feature/feature.service';
-import { CloudDatabaseImportForbiddenException } from 'src/modules/cloud/job/exceptions';
+import {
+  CloudDatabaseEndpointInvalidException,
+  CloudDatabaseImportForbiddenException,
+} from 'src/modules/cloud/job/exceptions';
+import { isValidCloudDatabaseEndpoint } from 'src/modules/cloud/database/utils';
 
 const cloudConfig = config.get('cloud');
 
@@ -82,6 +86,10 @@ export class ImportFreeDatabaseCloudJob extends CloudJob {
 
     const { publicEndpoint, name, password } = cloudDatabase;
 
+    if (!isValidCloudDatabaseEndpoint(publicEndpoint)) {
+      throw new CloudDatabaseEndpointInvalidException();
+    }
+
     const [host, port] = publicEndpoint.split(':');
 
     const database = await this.dependencies.databaseService.create(

redisinsight/ui/src/constants/customErrorCodes.ts

@@ -47,6 +47,7 @@ export enum CustomErrorCodes {
   CloudJobNotFound = 11_113,
   CloudSubscriptionAlreadyExistsFree = 11_114,
   CloudDatabaseImportForbidden = 11_115,
+  CloudDatabaseEndpointInvalid = 11_116,
 
   // General database errors [11200, 11299]
   DatabaseAlreadyExists = 11_200,