add backward compatibility

Author: shivam2680

lib/DBSQLClient.ts

@@ -166,6 +166,9 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
         LogLevel.warn,
         'Warning: The "clientId" option is deprecated. Please use "userAgentEntry" instead.',
       );
+      if (!options.userAgentEntry) {
+        options.userAgentEntry = deprecatedClientId;
+      }
     }
 
     this.authProvider = this.createAuthProvider(options, authProvider);

lib/utils/buildUserAgentString.ts

@@ -11,7 +11,21 @@ function getOperatingSystemVersion(): string {
   return `${os.type()} ${os.release()}`;
 }
 
+function redactInternalToken(userAgentEntry: string): string {
+  const internalTokenPrefixes = ['dkea', 'dskea', 'dapi', 'dsapi', 'dose'];
+  for (const prefix of internalTokenPrefixes) {
+    if (userAgentEntry.startsWith(prefix)) {
+      return '<REDACTED>';
+    }
+  }
+  return userAgentEntry;
+}
+
 export default function buildUserAgentString(userAgentEntry?: string): string {
+  if (userAgentEntry) {
+    userAgentEntry = redactInternalToken(userAgentEntry);
+  }
+
   const extra = [userAgentEntry, getNodeVersion(), getOperatingSystemVersion()].filter(Boolean);
   return `${productName}/${packageVersion} (${extra.join('; ')})`;
 }

tests/unit/utils/utils.test.ts

@@ -56,6 +56,12 @@ describe('buildUserAgentString', () => {
     const ua = buildUserAgentString();
     checkUserAgentString(ua);
   });
+
+  it('should redact internal token in userAgentEntry', () => {
+    const userAgentEntry = 'dkea-internal-token';
+    const userAgentString = buildUserAgentString(userAgentEntry);
+    expect(userAgentString).to.include('<REDACTED>');
+  });
 });
 
 describe('formatProgress', () => {