Add a check to prevent non-string URLs from being passed to fieldRedaction method (#2667)

rads-1996 · Copilot · web-flow · commit 223d8c2381e5 · 2025-11-21T14:47:46.000-08:00
* Add a check to prevent non-string URLs from being passed tO fieldRedaction

* Move the check to the fieldredaction method

* Update shared/AppInsightsCore/Tests/Unit/src/ApplicationInsightsCore.Tests.ts

removed unused config

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* Updated fieldRedaction method with string check

* Retrigger CI/CD pipeline

* Retrigger CI/CD pipeline

* Retrigger CI/CD pipeline

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/shared/AppInsightsCore/Tests/Unit/src/ApplicationInsightsCore.Tests.ts b/shared/AppInsightsCore/Tests/Unit/src/ApplicationInsightsCore.Tests.ts
@@ -2,7 +2,8 @@ import { Assert, AITestClass, PollingAssert } from "@microsoft/ai-test-framework
 import { 
     IConfiguration, ITelemetryPlugin, ITelemetryItem, IPlugin, IAppInsightsCore, normalizeJsName,
     random32, mwcRandomSeed, newId, randomValue, mwcRandom32, isNullOrUndefined, SenderPostManager,
-    OnCompleteCallback, IPayloadData, _ISenderOnComplete, TransportType, _ISendPostMgrConfig, fieldRedaction
+    OnCompleteCallback, IPayloadData, _ISenderOnComplete, TransportType, _ISendPostMgrConfig, fieldRedaction,
+    isString
 } from "../../../src/applicationinsights-core-js"
 import { AppInsightsCore } from "../../../src/JavaScriptSDK/AppInsightsCore";
 import { IChannelControls } from "../../../src/JavaScriptSDK.Interfaces/IChannelControls";
@@ -2106,6 +2107,38 @@ export class ApplicationInsightsCoreTests extends AITestClass {
             }
         });
 
+        this.testCase({
+            name: "FieldRedaction: should return non-string values unchanged without processing",
+            test: () => {
+                
+                let config = {} as IConfiguration;
+                // Test with null - should return null unchanged
+                const nullUrl = null;
+                const redactedLocation = fieldRedaction(nullUrl as any, config);
+                Assert.strictEqual(redactedLocation, null, "fieldRedaction should return null unchanged");
+                
+                // Test with number - should return the number unchanged
+                const numberUrl = 12345;
+                const redactedNumber = fieldRedaction(numberUrl as any, config);
+                Assert.strictEqual(redactedNumber, 12345, "fieldRedaction should return number unchanged");
+                
+                // Test with object - should return the object unchanged
+                const objectUrl = { url: "https://example.com" };
+                const redactedObject = fieldRedaction(objectUrl as any, config);
+                Assert.strictEqual(redactedObject, objectUrl, "fieldRedaction should return object unchanged");
+                
+                // Test with array - should return the array unchanged
+                const arrayUrl = ["https://example.com"];
+                const redactedArray = fieldRedaction(arrayUrl as any, config);
+                Assert.strictEqual(redactedArray, arrayUrl, "fieldRedaction should return array unchanged");
+                
+                // Test with boolean - should return the boolean unchanged
+                const boolUrl = true;
+                const redactedBool = fieldRedaction(boolUrl as any, config);
+                Assert.strictEqual(redactedBool, true, "fieldRedaction should return boolean unchanged");
+            }
+        });
+
         this.testCase({
             name: "FieldRedaction: should handle URLs with Unicode characters",
             test: () => {
diff --git a/shared/AppInsightsCore/src/JavaScriptSDK/EnvUtils.ts b/shared/AppInsightsCore/src/JavaScriptSDK/EnvUtils.ts
@@ -461,7 +461,7 @@ function redactQueryParameters(url: string, config?: IConfiguration): string {
  * @returns The redacted URL string or the original string if no redaction was needed or possible.
  */
 export function fieldRedaction(input: string, config: IConfiguration): string {
-    if (!input || input.indexOf(" ") !== -1) {
+    if (!input || !isString(input) || input.indexOf(" ") !== -1) {
         return input;
     }
     const isRedactionDisabled = config && config.redactUrls === false;

Original file line number	Diff line number	Diff line change
`@@ -461,7 +461,7 @@ function redactQueryParameters(url: string, config?: IConfiguration): string {`
`461`	`461`	`* @returns The redacted URL string or the original string if no redaction was needed or possible.`
`462`	`462`	`*/`
`463`	`463`	`export function fieldRedaction(input: string, config: IConfiguration): string {`
`464`		`- if (!input \|\| input.indexOf(" ") !== -1) {`
	`464`	`+ if (!input \|\| !isString(input) \|\| input.indexOf(" ") !== -1) {`
`465`	`465`	`return input;`
`466`	`466`	`}`
`467`	`467`	`const isRedactionDisabled = config && config.redactUrls === false;`