Improvements to error masking (#4264)

microsoft · Sep 20, 2024 · 64e387a · 64e387a
1 parent a497345
commit 64e387a
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/src/commands/createFunctionApp/FunctionAppCreateStep.ts b/src/commands/createFunctionApp/FunctionAppCreateStep.ts
@@ -7,7 +7,7 @@ import { type NameValuePair, type Site, type SiteConfig, type WebSiteManagementC
 import { BlobServiceClient } from '@azure/storage-blob';
 import { ParsedSite, WebsiteOS, type CustomLocation, type IAppServiceWizardContext } from '@microsoft/vscode-azext-azureappservice';
 import { LocationListStep } from '@microsoft/vscode-azext-azureutils';
-import { AzureWizardExecuteStep, parseError, randomUtils } from '@microsoft/vscode-azext-utils';
+import { AzureWizardExecuteStep, maskUserInfo, parseError, randomUtils } from '@microsoft/vscode-azext-utils';
 import { type AppResource } from '@microsoft/vscode-azext-utils/hostapi';
 import { type Progress } from 'vscode';
 import { FuncVersion, getMajorVersion } from '../../FuncVersion';
@@ -53,7 +53,7 @@ export class FunctionAppCreateStep extends AzureWizardExecuteStep<IFunctionAppWi
                 await enableFileLogging(context, site);
             } catch (error) {
                 // optional part of creating function app, so not worth blocking on error
-                context.telemetry.properties.fileLoggingError = parseError(error).message;
+                context.telemetry.properties.fileLoggingError = maskUserInfo(parseError(error).message, []);
             }
         }
 

diff --git a/src/commands/createFunctionApp/stacks/getStackPicks.ts b/src/commands/createFunctionApp/stacks/getStackPicks.ts
@@ -6,7 +6,7 @@
 import { type ServiceClient } from '@azure/core-client';
 import { createPipelineRequest } from '@azure/core-rest-pipeline';
 import { createGenericClient, LocationListStep, type AzExtPipelineResponse } from '@microsoft/vscode-azext-azureutils';
-import { openUrl, parseError, type AgentQuickPickItem, type IAzureQuickPickItem } from '@microsoft/vscode-azext-utils';
+import { maskUserInfo, openUrl, parseError, type AgentQuickPickItem, type IAzureQuickPickItem } from '@microsoft/vscode-azext-utils';
 import { funcVersionLink } from '../../../FuncVersion';
 import { hiddenStacksSetting, noRuntimeStacksAvailableLabel } from '../../../constants';
 import { previewDescription } from '../../../constants-nls';
@@ -166,7 +166,7 @@ async function getStacks(context: IFunctionAppWizardContext & { _stacks?: Functi
             // Some environments (like Azure Germany/Mooncake) don't support the stacks ARM API yet
             // And since the stacks don't change _that_ often, we'll just use a backup hard-coded value
             stacksArmResponse = <StacksArmResponse>JSON.parse(backupStacks);
-            context.telemetry.properties.getStacksError = parseError(error).message;
+            context.telemetry.properties.getStacksError = maskUserInfo(parseError(error).message, []);
         }
 
         context._stacks = stacksArmResponse.value.map(d => d.properties);

diff --git a/src/debug/validatePreDebug.ts b/src/debug/validatePreDebug.ts
@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { BlobServiceClient } from '@azure/storage-blob';
-import { AzExtFsExtra, parseError, type IActionContext } from "@microsoft/vscode-azext-utils";
+import { AzExtFsExtra, maskUserInfo, parseError, type IActionContext } from "@microsoft/vscode-azext-utils";
 import * as path from 'path';
 import * as semver from 'semver';
 import * as vscode from 'vscode';
@@ -90,7 +90,7 @@ export async function preDebugValidate(actionContext: IActionContext, debugConfi
         } else {
             // Don't block debugging for "unexpected" errors. The func cli might still work
             shouldContinue = true;
-            context.telemetry.properties.preDebugValidateError = pe.message;
+            context.telemetry.properties.preDebugValidateError = maskUserInfo(pe.message, []);
         }
     }
 

diff --git a/src/funcCoreTools/validateFuncCoreToolsIsLatest.ts b/src/funcCoreTools/validateFuncCoreToolsIsLatest.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { callWithTelemetryAndErrorHandling, DialogResponses, parseError, type IActionContext } from '@microsoft/vscode-azext-utils';
+import { callWithTelemetryAndErrorHandling, DialogResponses, maskUserInfo, parseError, type IActionContext } from '@microsoft/vscode-azext-utils';
 import * as semver from 'semver';
 import type * as vscode from 'vscode';
 import { PackageManager } from '../constants';
@@ -120,7 +120,7 @@ async function getNewestFunctionRuntimeVersion(packageManager: PackageManager |
             return (await getNpmDistTag(context, versionFromSetting)).value;
         }
     } catch (error) {
-        context.telemetry.properties.latestRuntimeError = parseError(error).message;
+        context.telemetry.properties.latestRuntimeError = maskUserInfo(parseError(error).message, []);
     }
 
     return undefined;

diff --git a/src/templates/CentralTemplateProvider.ts b/src/templates/CentralTemplateProvider.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { parseError, type IActionContext } from '@microsoft/vscode-azext-utils';
+import { maskUserInfo, parseError, type IActionContext } from '@microsoft/vscode-azext-utils';
 import { Disposable, workspace, type ConfigurationChangeEvent } from 'vscode';
 import { FuncVersion } from '../FuncVersion';
 import { ProjectLanguage, TemplateFilter, projectTemplateKeySetting } from '../constants';
@@ -237,7 +237,7 @@ export class CentralTemplateProvider implements Disposable {
             // This error should be the most actionable to the user, so save it and throw later if cache/backup doesn't work
             latestErrorMessage = localize('latestTemplatesError', 'Failed to get latest templates: {0}', errorMessage);
             ext.outputChannel.appendLog(latestErrorMessage);
-            context.telemetry.properties.latestTemplatesError = errorMessage;
+            context.telemetry.properties.latestTemplatesError = maskUserInfo(errorMessage, []);
         }
 
         // 3. Use the cached templates, even if they don't match latestTemplateVersion
@@ -293,7 +293,7 @@ export class CentralTemplateProvider implements Disposable {
             } catch (error) {
                 const errorMessage: string = parseError(error).message;
                 ext.outputChannel.appendLog(localize('cachedTemplatesError', 'Failed to get cached templates: {0}', errorMessage));
-                context.telemetry.properties.cachedTemplatesError = errorMessage;
+                context.telemetry.properties.cachedTemplatesError = maskUserInfo(errorMessage, []);
             }
         }
 
@@ -313,7 +313,7 @@ export class CentralTemplateProvider implements Disposable {
             } catch (error) {
                 const errorMessage: string = parseError(error).message;
                 ext.outputChannel.appendLog(localize('backupTemplatesError', 'Failed to get backup templates: {0}', errorMessage));
-                context.telemetry.properties.backupTemplatesError = errorMessage;
+                context.telemetry.properties.backupTemplatesError = maskUserInfo(errorMessage, []);
             }
         }