Added DISABLE_SSO_TRACE flag to control logging to sso trace (#3443)

* Added DISABLE_SSO_TRACE flag to control logging to sso trace * Fixed liniting issue * Added DISABLE_SSO_TRACE env to jackson options , so that could be used in npm package * Refactored code for disabling sso tracing * Change return value of traceId from empty string to undefined * revert unnecessary line breaks --------- Co-authored-by: Deepak Prabhakara <[email protected]>
boxyhq · Dec 18, 2024 · 93d6cd4 · 93d6cd4
1 parent a1348bd
commit 93d6cd4
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 5 deletions.
diff --git a/.env.example b/.env.example
@@ -115,4 +115,7 @@ ENTERPRISE_ORY_PROJECT_ID=
 #OPENID_REQUEST_PROFILE_SCOPE=false
 
 # Uncomment below if you wish to forward the OpenID params (https://openid.net/specs/openid-connect-core-1_0-errata2.html#AuthRequest) to the OpenID IdP
-#OPENID_REQUEST_FORWARD_PARAMS=true
+#OPENID_REQUEST_FORWARD_PARAMS=true
+
+# disable logging into sso trace
+# DISABLE_SSO_TRACE=true
diff --git a/lib/env.ts b/lib/env.ts
@@ -10,6 +10,7 @@ const hostUrl = process.env.HOST_URL || 'localhost';
 const hostPort = Number(process.env.PORT || '5225');
 const externalUrl = process.env.EXTERNAL_URL || 'http://' + hostUrl + ':' + hostPort;
 const apiKeys = (process.env.JACKSON_API_KEYS || '').split(',');
+const disableSSOTrace = process.env.DISABLE_SSO_TRACE === 'true';
 
 let ssl;
 if (process.env.DB_SSL === 'true') {
@@ -117,6 +118,7 @@ const jacksonOptions: JacksonOption = {
     projectId: process.env.ENTERPRISE_ORY_PROJECT_ID,
     sdkToken: process.env.ENTERPRISE_ORY_SDK_TOKEN,
   },
+  disableSSOTrace,
 };
 
 const adminPortalSSODefaults = {

diff --git a/npm/src/index.ts b/npm/src/index.ts
@@ -92,7 +92,7 @@ export const controllers = async (
   const productStore = db.store('product:config');
   const tracesStore = db.store('saml:tracer', tracesTTL);
 
-  const ssoTraces = new SSOTraces({ tracesStore });
+  const ssoTraces = new SSOTraces({ tracesStore, opts });
   const eventController = new EventController({ opts });
   const productController = new ProductController({ productStore, opts });
 

diff --git a/npm/src/sso-traces/index.ts b/npm/src/sso-traces/index.ts
@@ -1,4 +1,4 @@
-import { GetByProductParams, Records, Storable } from '../typings';
+import { GetByProductParams, Records, Storable, JacksonOption } from '../typings';
 import { generateMnemonic } from '@boxyhq/error-code-mnemonic';
 import { IndexNames } from '../controller/utils';
 import { keyFromParts } from '../db/utils';
@@ -56,9 +56,11 @@ const INTERVAL_1_DAY_MS = 24 * 60 * 60 * 1000;
  */
 class SSOTraces {
   tracesStore: Storable;
+  opts: JacksonOption;
 
-  constructor({ tracesStore }) {
+  constructor({ tracesStore, opts }) {
     this.tracesStore = tracesStore;
+    this.opts = opts;
     // Clean up stale traces at the start
     this.cleanUpStaleTraces();
     // Set timer to run every day
@@ -68,6 +70,10 @@ class SSOTraces {
   }
 
   public async saveTrace(payload: SSOTrace) {
+    if (this.opts.disableSSOTrace) {
+      return;
+    }
+
     try {
       const { context } = payload;
       // Friendly trace id

diff --git a/npm/src/typings.ts b/npm/src/typings.ts
@@ -508,6 +508,7 @@ export interface JacksonOption {
     projectId: string | undefined;
     sdkToken: string | undefined;
   };
+  disableSSOTrace?: boolean;
 }
 
 export interface SLORequestParams {

diff --git a/npm/test/sso-traces/tracer.test.ts b/npm/test/sso-traces/tracer.test.ts
@@ -8,9 +8,10 @@ const INTERVAL_1_WEEK_MS = 7 * 24 * 60 * 60 * 1000;
 
 tap.before(async () => {
   const { db: dbOptions } = jacksonOptions;
+  const opts = jacksonOptions;
   const db = await DB.new(dbOptions);
   const tracesStore = db.store('saml:tracer');
-  ssoTraces = new SSOTraces({ tracesStore });
+  ssoTraces = new SSOTraces({ tracesStore, opts });
 });
 
 tap.test('SSOTraces', async () => {