From 3fd67f693ce29f327f6f9acd69e5a5fb3158d2dc Mon Sep 17 00:00:00 2001
From: Andreea Isac <48239328+andreeis@users.noreply.github.com>
Date: Mon, 20 May 2024 13:14:19 -0700
Subject: [PATCH] Remove unnecessary logging about string expansion (#3761)

* Remove unnecessary logging about string expansion

* Fix typo in var name

---------

Co-authored-by: snehara99 <113148726+snehara99@users.noreply.github.com>
---
 src/expand.ts | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/expand.ts b/src/expand.ts
index c2f547cdf..256dd8056 100644
--- a/src/expand.ts
+++ b/src/expand.ts
@@ -141,12 +141,12 @@ export async function expandString<T>(input: string | T, opts: ExpansionOptions)
 const varValueRegexp = ".+?";
 
 async function expandStringHelper(input: string, opts: ExpansionOptions) {
-    log.debug(localize('expand.expandstringhelper', 'expanding {0}', input));
     const envPreNormalize = opts.envOverride ? opts.envOverride : process.env;
     const env = EnvironmentUtils.create(envPreNormalize);
     const replacements = opts.vars;
     replacements.sourceDirectory = replacements.sourceDir;
     let circularReference: string | undefined;
+    let expansionOccurred: boolean = false;
 
     // We accumulate a list of substitutions that we need to make, preventing
     // recursively expanding or looping forever on bad replacements
@@ -154,6 +154,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
 
     const varRegex = /\$\{(\w+)\}/g;
     for (const mat of matchAll(input, varRegex)) {
+        expansionOccurred = true;
         const full = mat[0];
         const key = mat[1];
         if (key !== 'dollar') {
@@ -169,6 +170,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
 
     const envRegex1 = RegExp(`\\$\\{env:(${varValueRegexp})\\}`, "g");
     for (const mat of matchAll(input, envRegex1)) {
+        expansionOccurred = true;
         const full = mat[0];
         const varName = mat[1];
         const replacement = fixPaths(env[varName]) || '';
@@ -177,6 +179,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
 
     const envRegex2 = RegExp(`\\$\\{env\\.(${varValueRegexp})\\}`, "g");
     for (const mat of matchAll(input, envRegex2)) {
+        expansionOccurred = true;
         const full = mat[0];
         const varName = mat[1];
         const replacement = fixPaths(env[varName]) || '';
@@ -185,6 +188,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
 
     const envRegex3 = RegExp(`\\$env\\{(${varValueRegexp})\\}`, "g");
     for (const mat of matchAll(input, envRegex3)) {
+        expansionOccurred = true;
         const full = mat[0];
         const varName = mat[1];
         const replacement: string = fixPaths(env[varName]) || '';
@@ -208,6 +212,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
             const folderName = mat[1];
             const f = vscode.workspace.workspaceFolders.find(folder => folder.name.toLocaleLowerCase() === folderName.toLocaleLowerCase());
             if (f) {
+                expansionOccurred = true;
                 subs.set(full, f.uri.fsPath);
             }
         }
@@ -217,6 +222,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
         const variants = opts.variantVars;
         const variantRegex = RegExp(`\\$\\{variant:(${varValueRegexp})\\}`, "g");
         for (const mat of matchAll(input, variantRegex)) {
+            expansionOccurred = true;
             const full = mat[0];
             const varName = mat[1];
             const replacement = variants[varName] || '';
@@ -236,6 +242,7 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
             continue;  // Don't execute commands more than once per string
         }
         try {
+            expansionOccurred = true;
             const result = await vscode.commands.executeCommand(command, opts.vars.workspaceFolder);
             subs.set(full, `${result}`);
         } catch (e) {
@@ -243,6 +250,10 @@ async function expandStringHelper(input: string, opts: ExpansionOptions) {
         }
     }
 
+    if (expansionOccurred) {
+        log.debug(localize('expand.expandstringhelper', 'expanded {0}', input));
+    }
+
     return { ...substituteAll(input, subs), circularReference };
 }