feat: add verbose retry log attribute

nestjs · Jul 5, 2024 · 0222704 · 0222704
1 parent 8f3fd93
commit 0222704
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/lib/common/mongoose.utils.ts b/lib/common/mongoose.utils.ts
@@ -19,6 +19,7 @@ export function getConnectionToken(name?: string) {
 export function handleRetry(
   retryAttempts = 9,
   retryDelay = 3000,
+  verboseRetryLog = false,
 ): <T>(source: Observable<T>) => Observable<T> {
   const logger = new Logger('MongooseModule');
   return <T>(source: Observable<T>) =>
@@ -32,6 +33,16 @@ export function handleRetry(
               })...`,
               '',
             );
+            const verboseMessage = verboseRetryLog
+              ? ` Message: ${error.message}.`
+              : '';
+
+            logger.error(
+              `Unable to connect to the database.${verboseMessage} Retrying (${
+                errorCount + 1
+              })...`,
+              error.stack,
+            );
             if (errorCount + 1 >= retryAttempts) {
               throw error;
             }

diff --git a/lib/interfaces/mongoose-options.interface.ts b/lib/interfaces/mongoose-options.interface.ts
@@ -1,5 +1,5 @@
 import { ModuleMetadata, Type } from '@nestjs/common';
-import { ConnectOptions, MongooseError, Connection } from 'mongoose';
+import { ConnectOptions, Connection, MongooseError } from 'mongoose';
 
 export interface MongooseModuleOptions extends ConnectOptions {
   uri?: string;
@@ -10,6 +10,10 @@ export interface MongooseModuleOptions extends ConnectOptions {
   connectionErrorFactory?: (error: MongooseError) => MongooseError;
   lazyConnection?: boolean;
   onConnectionCreate?: (connection: Connection) => void;
+  /**
+   * If `true`, will show verbose error messages on each connection retry.
+   */
+  verboseRetryLog?: boolean;
 }
 
 export interface MongooseOptionsFactory {

diff --git a/lib/mongoose-core.module.ts b/lib/mongoose-core.module.ts
@@ -73,7 +73,7 @@ export class MongooseCoreModule implements OnApplicationShutdown {
               mongooseConnectionName,
             ),
           ).pipe(
-            handleRetry(retryAttempts, retryDelay),
+            handleRetry(retryAttempts, retryDelay, options.verboseRetryLog),
             catchError((error) => {
               throw mongooseConnectionError(error);
             }),
@@ -128,7 +128,11 @@ export class MongooseCoreModule implements OnApplicationShutdown {
               mongooseConnectionName,
             ),
           ).pipe(
-            handleRetry(retryAttempts, retryDelay),
+            handleRetry(
+              retryAttempts,
+              retryDelay,
+              mongooseOptions.verboseRetryLog,
+            ),
             catchError((error) => {
               throw mongooseConnectionError(error);
             }),