more within try block. escape regex special chars (#14001)

microsoft · Jul 31, 2023 · 10bddf8 · 10bddf8
1 parent a9f4179
commit 10bddf8
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/src/extension.node.ts b/src/extension.node.ts
@@ -243,9 +243,14 @@ function addConsoleLogger() {
     }
 }
 
+function escapeRegExp(text: string) {
+    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+}
+
 function tryGetUsername() {
     try {
-        return userInfo().username;
+        const username = escapeRegExp(userInfo().username);
+        return new RegExp(username, 'ig');
     } catch (e) {
         console.info(
             `jupyter extension failed to get username info with ${e}\n username will not be obfuscated in local logs`
@@ -255,7 +260,8 @@ function tryGetUsername() {
 
 function tryGetHomePath() {
     try {
-        return getUserHomeDir().fsPath;
+        const homeDir = escapeRegExp(getUserHomeDir().fsPath);
+        return new RegExp(homeDir, 'ig');
     } catch (e) {
         console.info(
             `jupyter extension failed to get home directory path with ${e}\n home Path will not be obfuscated in local logs`

diff --git a/src/extension.web.ts b/src/extension.web.ts
@@ -245,7 +245,7 @@ function addConsoleLogger() {
 
 function addOutputChannel(context: IExtensionContext, serviceManager: IServiceManager) {
     const standardOutputChannel = window.createOutputChannel(OutputChannelNames.jupyter, 'log');
-    registerLogger(new OutputChannelLogger(standardOutputChannel, ''));
+    registerLogger(new OutputChannelLogger(standardOutputChannel));
     serviceManager.addSingletonInstance<OutputChannel>(IOutputChannel, standardOutputChannel, STANDARD_OUTPUT_CHANNEL);
     serviceManager.addSingletonInstance<OutputChannel>(
         IOutputChannel,

diff --git a/src/platform/logging/outputChannelLogger.ts b/src/platform/logging/outputChannelLogger.ts
@@ -10,9 +10,9 @@ const format = require('format-util') as typeof import('format-util');
 export class OutputChannelLogger implements ILogger {
     private readonly homeReplaceRegEx?: RegExp;
     private readonly userNameReplaceRegEx?: RegExp;
-    constructor(private readonly channel: OutputChannel, home?: string, userName?: string) {
-        this.homeReplaceRegEx = home ? new RegExp(home, 'ig') : undefined;
-        this.userNameReplaceRegEx = userName ? new RegExp(userName, 'ig') : undefined;
+    constructor(private readonly channel: OutputChannel, homeRegEx?: RegExp, userNameRegEx?: RegExp) {
+        this.homeReplaceRegEx = homeRegEx;
+        this.userNameReplaceRegEx = userNameRegEx;
     }
     private format(level: string | undefined, message: string, ...data: Arguments) {
         let logMessage = level