Merge pull request #848 from amarlankri/logging/feat/add-getter

[FEAT] Add getter functions for logging interceptor fields
algoan · Feb 16, 2024 · 471ff54 · 471ff54
2 parents 0ceeaa3 + 606b596
commit 471ff54
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/packages/logging-interceptor/src/logging.interceptor.ts b/packages/logging-interceptor/src/logging.interceptor.ts
@@ -76,6 +76,13 @@ export class LoggingInterceptor implements NestInterceptor {
     this.mask = options?.mask;
   }
 
+  /**
+   * Return the user prefix
+   */
+  public getUserPrefix(): string {
+    return this.userPrefix;
+  }
+
   /**
    * User prefix setter
    * ex. [MyPrefix - LoggingInterceptor - 200 - GET - /]
@@ -84,6 +91,13 @@ export class LoggingInterceptor implements NestInterceptor {
     this.userPrefix = `${prefix} - `;
   }
 
+  /**
+   * Return the disable masking flag
+   */
+  public getDisabledMasking(): boolean {
+    return this.disableMasking;
+  }
+
   /**
    * Set the disable masking flag
    * @param disableMasking
@@ -92,6 +106,13 @@ export class LoggingInterceptor implements NestInterceptor {
     this.disableMasking = disableMasking;
   }
 
+  /**
+   * Return the masking placeholder
+   */
+  public getMaskingPlaceholder(): string | undefined {
+    return this.maskingPlaceholder;
+  }
+
   /**
    * Set the masking placeholder
    * @param placeholder
@@ -100,6 +121,13 @@ export class LoggingInterceptor implements NestInterceptor {
     this.maskingPlaceholder = placeholder;
   }
 
+  /**
+   * Return the masking options
+   */
+  public getMask(): LoggingInterceptorMaskingOptions | undefined {
+    return this.mask;
+  }
+
   /**
    * Set the masking options
    * @param mask

diff --git a/packages/logging-interceptor/test/logging.interceptor.test.ts b/packages/logging-interceptor/test/logging.interceptor.test.ts
@@ -399,6 +399,39 @@ describe('Logging interceptor', () => {
     });
   });
 
+  describe('LoggingInterceptor - Getters and setters', () => {
+    it('allows to set and get a user prefix', async () => {
+      const interceptor = new LoggingInterceptor();
+      const prefix = 'MyPrefix';
+      interceptor.setUserPrefix(prefix);
+      expect(interceptor.getUserPrefix()).toEqual(`${prefix} - `);
+    });
+
+    it('allows to set and get the disable masking flag', async () => {
+      const interceptor = new LoggingInterceptor();
+      interceptor.setDisableMasking(true);
+      expect(interceptor.getDisabledMasking()).toEqual(true);
+    });
+
+    it('allows to set and get the masking placeholder', async () => {
+      const interceptor = new LoggingInterceptor();
+      const placeholder = '****';
+      interceptor.setMaskingPlaceholder(placeholder);
+      expect(interceptor.getMaskingPlaceholder()).toEqual(placeholder);
+    });
+
+    it('allows to set and get the masking options', async () => {
+      const interceptor = new LoggingInterceptor();
+      const mask = {
+        requestHeader: {
+          authorization: true,
+        },
+      };
+      interceptor.setMask(mask);
+      expect(interceptor.getMask()).toEqual(mask);
+    });
+  });
+
   describe('LoggingInterceptor - Masking options', () => {
     const placeholder = '****';