RI-7169 handle redis connection error (#4662)

ArtemHoruzhenko · web-flow · commit 788ab7afbf89 · 2025-07-09T09:54:42.000+03:00
* RI-7169 handle redis connection error

* RI-7188 address review comments

* RI-7188 fix the rest changed enums
diff --git a/redisinsight/api/src/constants/custom-error-codes.ts b/redisinsight/api/src/constants/custom-error-codes.ts
@@ -11,6 +11,7 @@ export enum CustomErrorCodes {
   RedisConnectionAuthUnsupported = 10_905,
   RedisConnectionSentinelMasterRequired = 10_906,
   RedisConnectionIncorrectCertificate = 10_907,
+  RedisConnectionDefaultUserDisabled = 10_908,
 
   // Cloud API [11001, 11099]
   CloudApiInternalServerError = 11_000,
diff --git a/redisinsight/api/src/constants/error-messages.ts b/redisinsight/api/src/constants/error-messages.ts
@@ -44,7 +44,7 @@ export default {
     `Could not connect to ${url}, please check the CA or Client certificate.`,
   INCORRECT_CREDENTIALS: (url) =>
     `Could not connect to ${url}, please check the Username or Password.`,
-
+  DATABASE_DEFAULT_USER_DISABLED: 'Database does not have default user enabled.',
   DATABASE_MANAGEMENT_IS_DISABLED:
     'Database connection management is disabled.',
   CA_CERT_EXIST: 'This ca certificate name is already in use.',
diff --git a/redisinsight/api/src/modules/database/constants/events.ts b/redisinsight/api/src/modules/database/constants/events.ts
@@ -0,0 +1,3 @@
+export enum DatabaseConnectionEvent {
+  DatabaseConnectionFailed = 'DatabaseConnectionFailed',
+}
diff --git a/redisinsight/api/src/modules/database/providers/database.client.factory.spec.ts b/redisinsight/api/src/modules/database/providers/database.client.factory.spec.ts
@@ -10,6 +10,7 @@ import {
   mockStandaloneRedisClient,
   mockSessionMetadata,
   MockRedisClient,
+  mockEventEmitter,
 } from 'src/__mocks__';
 import { DatabaseAnalytics } from 'src/modules/database/database.analytics';
 import { DatabaseService } from 'src/modules/database/database.service';
@@ -30,8 +31,10 @@ import { RedisClient } from 'src/modules/redis/client';
 import { ConnectionType } from 'src/modules/database/entities/database.entity';
 import {
   RedisConnectionTimeoutException,
-  RedisConnectionUnauthorizedException,
 } from 'src/modules/redis/exceptions/connection';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { DatabaseConnectionEvent } from 'src/modules/database/constants/events';
+import { InternalServerErrorException } from '@nestjs/common';
 
 describe('DatabaseClientFactory', () => {
   let service: DatabaseClientFactory;
@@ -40,6 +43,7 @@ describe('DatabaseClientFactory', () => {
   let redisClientStorage: RedisClientStorage;
   let redisClientFactory: LocalRedisClientFactory;
   let analytics: MockType<DatabaseAnalytics>;
+  let eventEmitter: MockType<EventEmitter2>;
 
   beforeEach(async () => {
     jest.clearAllMocks();
@@ -72,6 +76,10 @@ describe('DatabaseClientFactory', () => {
           provide: NodeRedisConnectionStrategy,
           useFactory: mockNodeRedisConnectionStrategy,
         },
+        {
+          provide: EventEmitter2,
+          useValue: mockEventEmitter,
+        },
       ],
     }).compile();
 
@@ -81,6 +89,7 @@ describe('DatabaseClientFactory', () => {
     redisClientStorage = await module.get(RedisClientStorage);
     redisClientFactory = await module.get(RedisClientFactory);
     analytics = await module.get(DatabaseAnalytics);
+    eventEmitter = await module.get(EventEmitter2);
   });
 
   describe('getOrCreateClient', () => {
@@ -247,7 +256,7 @@ describe('DatabaseClientFactory', () => {
         },
       );
     });
-    it('should throw original error', async () => {
+    it('should throw original error and emit connection failed event for RedisConnection* errors', async () => {
       jest
         .spyOn(redisClientFactory, 'createClient')
         .mockRejectedValue(new RedisConnectionTimeoutException());
@@ -259,6 +268,27 @@ describe('DatabaseClientFactory', () => {
         mockDatabase,
         new RedisConnectionTimeoutException(),
       );
+
+      expect(eventEmitter.emit).toHaveBeenCalledWith(
+        DatabaseConnectionEvent.DatabaseConnectionFailed,
+        mockCommonClientMetadata,
+      );
+    });
+
+    it('should throw original error and not emit connection failed when not RedisConnection* errors', async () => {
+      jest
+        .spyOn(redisClientFactory, 'createClient')
+        .mockRejectedValue(new InternalServerErrorException());
+      await expect(
+        service.createClient(mockCommonClientMetadata),
+      ).rejects.toThrow(InternalServerErrorException);
+      expect(analytics.sendConnectionFailedEvent).toHaveBeenCalledWith(
+        mockSessionMetadata,
+        mockDatabase,
+        new InternalServerErrorException(),
+      );
+
+      expect(eventEmitter.emit).not.toHaveBeenCalled();
     });
   });
 });
diff --git a/redisinsight/api/src/modules/database/providers/database.client.factory.ts b/redisinsight/api/src/modules/database/providers/database.client.factory.ts
@@ -1,5 +1,4 @@
 import { Injectable, Logger } from '@nestjs/common';
-import { getRedisConnectionException } from 'src/utils';
 import { DatabaseRepository } from 'src/modules/database/repositories/database.repository';
 import { DatabaseAnalytics } from 'src/modules/database/database.analytics';
 import { DatabaseService } from 'src/modules/database/database.service';
@@ -11,6 +10,9 @@ import {
   RedisClientFactory,
 } from 'src/modules/redis/redis.client.factory';
 import { RedisClientStorage } from 'src/modules/redis/redis.client.storage';
+import { RedisConnectionFailedException } from 'src/modules/redis/exceptions/connection';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { DatabaseConnectionEvent } from 'src/modules/database/constants/events';
 
 type IsClientConnectingMap = {
   [key: string]: boolean;
@@ -37,6 +39,7 @@ export class DatabaseClientFactory {
     private readonly analytics: DatabaseAnalytics,
     private readonly redisClientStorage: RedisClientStorage,
     private readonly redisClientFactory: RedisClientFactory,
+    private readonly eventEmitter: EventEmitter2,
   ) {}
 
   private async processGetClient(
@@ -156,6 +159,13 @@ export class DatabaseClientFactory {
     } catch (error) {
       this.logger.error('Failed to create database client', error);
 
+      if (error instanceof RedisConnectionFailedException) {
+        this.eventEmitter.emit(
+          DatabaseConnectionEvent.DatabaseConnectionFailed,
+          clientMetadata,
+        );
+      }
+
       this.analytics.sendConnectionFailedEvent(
         clientMetadata.sessionMetadata,
         database,
diff --git a/redisinsight/api/src/modules/redis/exceptions/connection/index.ts b/redisinsight/api/src/modules/redis/exceptions/connection/index.ts
@@ -1,5 +1,6 @@
 export * from './redis-connection-auth-unsupported.exception';
 export * from './redis-connection-cluster-nodes-unavailable.exception';
+export * from './redis-connection-default-user-disabled.exception';
 export * from './redis-connection-failed.exception';
 export * from './redis-connection-incorrect-certificate.exception';
 export * from './redis-connection-sentinel-master-required.exception';
diff --git a/redisinsight/api/src/modules/redis/exceptions/connection/redis-connection-default-user-disabled.exception.ts b/redisinsight/api/src/modules/redis/exceptions/connection/redis-connection-default-user-disabled.exception.ts
@@ -0,0 +1,21 @@
+import { HttpExceptionOptions } from '@nestjs/common';
+import { CustomErrorCodes } from 'src/constants';
+import ERROR_MESSAGES from 'src/constants/error-messages';
+import {
+  RedisConnectionFailedException,
+  RedisConnectionFailedStatusCode,
+} from 'src/modules/redis/exceptions/connection/redis-connection-failed.exception';
+
+export class RedisConnectionDefaultUserDisabledException extends RedisConnectionFailedException {
+  constructor(
+    message: string = ERROR_MESSAGES.DATABASE_DEFAULT_USER_DISABLED,
+    options?: HttpExceptionOptions,
+  ) {
+    super({
+      message,
+      error: 'RedisConnectionDefaultUserDisabledException',
+      statusCode: RedisConnectionFailedStatusCode,
+      errorCode: CustomErrorCodes.RedisConnectionDefaultUserDisabled,
+    }, options);
+  }
+}
diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/assistance-chat/AssistanceChat.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/assistance-chat/AssistanceChat.tsx
@@ -76,7 +76,7 @@ const AssistanceChat = () => {
                   ...generateHumanMessage(message),
                   error: {
                     statusCode: 500,
-                    errorCode: CustomErrorCodes.GeneralAiUnexpectedError,
+                    errorCode: CustomErrorCodes.QueryAiInternalServerError,
                   },
                 }),
               )
diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/error-message/ErrorMessage.spec.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/error-message/ErrorMessage.spec.tsx
@@ -27,7 +27,7 @@ describe('ErrorMessage', () => {
 
   it('should render rate limit error', () => {
     const error = {
-      errorCode: CustomErrorCodes.AiQueryRateLimitRequest,
+      errorCode: CustomErrorCodes.QueryAiRateLimitRequest,
       statusCode: 429,
       details: {
         limiterType: 'request',
@@ -51,7 +51,7 @@ describe('ErrorMessage', () => {
 
   it('should render tokens limit error', () => {
     const error = {
-      errorCode: CustomErrorCodes.AiQueryRateLimitMaxTokens,
+      errorCode: CustomErrorCodes.QueryAiRateLimitMaxTokens,
       statusCode: 413,
       details: { tokenLimit: 20000, tokenCount: 575 },
     }
diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/error-message/ErrorMessage.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/error-message/ErrorMessage.tsx
@@ -21,15 +21,15 @@ export interface Props {
 
 const ERROR_CODES_WITHOUT_RESTART = [
   CustomErrorCodes.CloudApiUnauthorized,
-  CustomErrorCodes.GeneralAiUnexpectedError,
-  CustomErrorCodes.AiQueryRateLimitRequest,
-  CustomErrorCodes.AiQueryRateLimitToken,
+  CustomErrorCodes.QueryAiInternalServerError,
+  CustomErrorCodes.QueryAiRateLimitRequest,
+  CustomErrorCodes.QueryAiRateLimitToken,
 ]
 
 const ERROR_CODES_WITHOUT_REPORT_ISSUE = [
-  CustomErrorCodes.AiQueryRateLimitRequest,
-  CustomErrorCodes.AiQueryRateLimitToken,
-  CustomErrorCodes.AiQueryRateLimitMaxTokens,
+  CustomErrorCodes.QueryAiRateLimitRequest,
+  CustomErrorCodes.QueryAiRateLimitToken,
+  CustomErrorCodes.QueryAiRateLimitMaxTokens,
 ]
 
 const ErrorMessage = (props: Props) => {
@@ -43,14 +43,14 @@ const ErrorMessage = (props: Props) => {
     const { statusCode, errorCode, details } = error || {}
 
     if (statusCode === ApiStatusCode.Timeout) return AI_CHAT_ERRORS.timeout()
-    if (errorCode === CustomErrorCodes.GeneralAiUnexpectedError)
+    if (errorCode === CustomErrorCodes.QueryAiInternalServerError)
       return AI_CHAT_ERRORS.unexpected()
     if (
-      errorCode === CustomErrorCodes.AiQueryRateLimitRequest ||
-      errorCode === CustomErrorCodes.AiQueryRateLimitToken
+      errorCode === CustomErrorCodes.QueryAiRateLimitRequest ||
+      errorCode === CustomErrorCodes.QueryAiRateLimitToken
     )
       return AI_CHAT_ERRORS.rateLimit(details?.limiterSeconds)
-    if (errorCode === CustomErrorCodes.AiQueryRateLimitMaxTokens)
+    if (errorCode === CustomErrorCodes.QueryAiRateLimitMaxTokens)
       return AI_CHAT_ERRORS.tokenLimit()
 
     return AI_CHAT_ERRORS.default()
diff --git a/redisinsight/ui/src/constants/customErrorCodes.ts b/redisinsight/ui/src/constants/customErrorCodes.ts
@@ -1,7 +1,18 @@
 export enum CustomErrorCodes {
-  // General [10000, 10999]
+  // General [10000, 10899]
   WindowUnauthorized = 10_001,
 
+  // Redis Connection [10900, 10999]
+  RedisConnectionFailed = 10_900,
+  RedisConnectionTimeout = 10_901,
+  RedisConnectionUnauthorized = 10_902,
+  RedisConnectionClusterNodesUnavailable = 10_903,
+  RedisConnectionUnavailable = 10_904,
+  RedisConnectionAuthUnsupported = 10_905,
+  RedisConnectionSentinelMasterRequired = 10_906,
+  RedisConnectionIncorrectCertificate = 10_907,
+  RedisConnectionDefaultUserDisabled = 10_908,
+
   // Cloud API [11001, 11099]
   CloudApiInternalServerError = 11_000,
   CloudApiUnauthorized = 11_001,
@@ -12,9 +23,12 @@ export enum CustomErrorCodes {
   CloudOauthGithubEmailPermission = 11_006,
   CloudOauthUnknownAuthorizationRequest = 11_007,
   CloudOauthUnexpectedError = 11_008,
+  CloudOauthMissedRequiredData = 11_009,
+  CloudOauthCanceled = 11_010,
   CloudOauthSsoUnsupportedEmail = 11_011,
   CloudCapiUnauthorized = 11_021,
   CloudCapiKeyUnauthorized = 11_022,
+  CloudCapiKeyNotFound = 11_023,
 
   // Cloud Job errors [11100, 11199]
   CloudJobUnexpectedError = 11_100,
@@ -49,14 +63,18 @@ export enum CustomErrorCodes {
   QueryAiForbidden = 11_352,
   QueryAiBadRequest = 11_353,
   QueryAiNotFound = 11_354,
+  QueryAiRateLimitRequest = 11_360,
+  QueryAiRateLimitToken = 11_361,
+  QueryAiRateLimitMaxTokens = 11_362,
 
-  AiQueryRateLimitRequest = 11_360,
-  AiQueryRateLimitToken = 11_361,
-  AiQueryRateLimitMaxTokens = 11362,
-
-  GeneralAiUnexpectedError = 11_391,
-
-  // RDI errors [11400, 11499]
+  // RDI errors [11400, 11599]
   RdiDeployPipelineFailure = 11_401,
+  RdiUnauthorized = 11_402,
+  RdiInternalServerError = 11_403,
   RdiValidationError = 11_404,
+  RdiNotFound = 11_405,
+  RdiForbidden = 11_406,
+  RdiResetPipelineFailure = 11_407,
+  RdiStartPipelineFailure = 11_408,
+  RdiStopPipelineFailure = 11_409,
 }
diff --git a/redisinsight/ui/src/services/apiService.ts b/redisinsight/ui/src/services/apiService.ts
@@ -5,7 +5,7 @@ import axios, {
 } from 'axios'
 import { isNumber } from 'lodash'
 import { sessionStorageService } from 'uiSrc/services'
-import { BrowserStorageItem } from 'uiSrc/constants'
+import { BrowserStorageItem, CustomErrorCodes } from 'uiSrc/constants'
 import { CLOUD_AUTH_API_ENDPOINTS, CustomHeaders } from 'uiSrc/constants/api'
 import { store } from 'uiSrc/slices/store'
 import { logoutUserAction } from 'uiSrc/slices/oauth/cloud'
@@ -108,10 +108,17 @@ export const connectivityErrorsInterceptor = (error: AxiosError) => {
     message?: string
     code?: string
     error?: string
+    errorCode?: number
   }
 
   if (isConnectivityError(response?.status, responseData)) {
-    store?.dispatch<any>(setConnectivityError(ApiErrors.ConnectionLost))
+    let message
+
+    if (responseData?.errorCode === CustomErrorCodes.RedisConnectionDefaultUserDisabled) {
+      message = responseData?.message
+    }
+
+    store?.dispatch<any>(setConnectivityError(message || ApiErrors.ConnectionLost))
   }
 
   return Promise.reject(error)
diff --git a/redisinsight/ui/src/services/tests/apiService.spec.ts b/redisinsight/ui/src/services/tests/apiService.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export enum DatabaseConnectionEvent {`
	`2`	`+ DatabaseConnectionFailed = 'DatabaseConnectionFailed',`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ const AssistanceChat = () => {`
`76`	`76`	`...generateHumanMessage(message),`
`77`	`77`	`error: {`
`78`	`78`	`statusCode: 500,`
`79`		`- errorCode: CustomErrorCodes.GeneralAiUnexpectedError,`
	`79`	`+ errorCode: CustomErrorCodes.QueryAiInternalServerError,`
`80`	`80`	`},`
`81`	`81`	`}),`
`82`	`82`	`)`