Added replaceAll for string prototype & unit tests (microsoft#17582)

* Added replaceAll for string prototype & unit tests

* Create 15288.md

* Bug Fix: use replaceAll for replacing separators.

* Ran prettier on updated files.

Co-authored-by: Aliva Das <[email protected]>

Author: 2 people

news/2 Fixes/15288.md

@@ -0,0 +1 @@
+replaceAll for replacing separators. (thanks [Aliva Das](https://github.com/IceJinx33))

src/client/common/extensions.ts

@@ -37,6 +37,12 @@ declare interface String {
      * Removes leading and trailing quotes from a string
      */
     trimQuotes(): string;
+
+    /**
+     * String.replaceAll implementation
+     * Replaces all instances of a substring with a new string
+     */
+    replaceAll(substr: string, newSubstr: string): string;
 }
 
 /**
@@ -92,6 +98,26 @@ String.prototype.trimQuotes = function (this: string): string {
     return this.replace(/(^['"])|(['"]$)/g, '');
 };
 
+/**
+ * String.replaceAll implementation
+ * Replaces all instances of a substring with a new substring.
+ */
+String.prototype.replaceAll = function (this: string, substr: string, newSubstr: string): string {
+    if (!this) {
+        return this;
+    }
+
+    /** Escaping function from the MDN web docs site
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+     * Escapes all the following special characters in a string . * + ? ^ $ { } ( ) | \ \\ */
+
+    function escapeRegExp(unescapedStr: string): string {
+        return unescapedStr.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+    }
+
+    return this.replace(new RegExp(escapeRegExp(substr), 'g'), newSubstr);
+};
+
 declare interface Promise<T> {
     /**
      * Catches task error and ignores them.

src/client/pythonEnvironments/base/info/interpreter.ts

@@ -73,7 +73,7 @@ export async function getInterpreterInfo(python: PythonExecInfo): Promise<Interp
     const argv = [info.command, ...info.args];
 
     // Concat these together to make a set of quoted strings
-    const quoted = argv.reduce((p, c) => (p ? `${p} "${c}"` : `"${c.replace('\\', '\\\\')}"`), '');
+    const quoted = argv.reduce((p, c) => (p ? `${p} "${c}"` : `"${c.replaceAll('\\', '\\\\')}"`), '');
 
     // Try shell execing the command, followed by the arguments. This will make node kill the process if it
     // takes too long.

src/client/pythonEnvironments/info/interpreter.ts

@@ -73,7 +73,7 @@ export async function getInterpreterInfo(
     const argv = [info.command, ...info.args];
 
     // Concat these together to make a set of quoted strings
-    const quoted = argv.reduce((p, c) => (p ? `${p} "${c}"` : `"${c.replace('\\', '\\\\')}"`), '');
+    const quoted = argv.reduce((p, c) => (p ? `${p} "${c}"` : `"${c.replaceAll('\\', '\\\\')}"`), '');
 
     // Try shell execing the command, followed by the arguments. This will make node kill the process if it
     // takes too long.

src/test/common/extensions.unit.test.ts

@@ -84,6 +84,21 @@ suite('String Extensions', () => {
         expect(quotedString3.trimQuotes()).to.be.equal(expectedString);
         expect(quotedString4.trimQuotes()).to.be.equal(expectedString);
     });
+    test('String should replace all substrings with new substring', () => {
+        //tslint:disable:no-multiline-string
+        const oldString = `foo \\ foo \\ foo`;
+        const expectedString = `foo \\\\ foo \\\\ foo`;
+        const oldString2 = `\\ foo \\ foo`;
+        const expectedString2 = `\\\\ foo \\\\ foo`;
+        const oldString3 = `\\ foo \\`;
+        const expectedString3 = `\\\\ foo \\\\`;
+        const oldString4 = `foo foo`;
+        const expectedString4 = `foo foo`;
+        expect(oldString.replaceAll('\\', '\\\\')).to.be.equal(expectedString);
+        expect(oldString2.replaceAll('\\', '\\\\')).to.be.equal(expectedString2);
+        expect(oldString3.replaceAll('\\', '\\\\')).to.be.equal(expectedString3);
+        expect(oldString4.replaceAll('\\', '\\\\')).to.be.equal(expectedString4);
+    });
 });
 
 suite('Array extensions', () => {