Fix unload() to return promise when called without parameters (#2666)

Copilot · MSNev · web-flow · commit 92019074945a · 2025-11-26T16:03:19.000-08:00
* Initial plan

* Fix unload function to return promise by default and add tests

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

* Use isPromiseLike helper in unload tests

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

* Fix TypeScript errors in test cases - use testCase instead of testCaseAsync

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

* Remove unused strSubstring import

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

---------

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: MSNev &lt;54870357+MSNev@users.noreply.github.com&gt;
diff --git a/AISKU/Tests/Unit/src/SnippetInitialization.Tests.ts b/AISKU/Tests/Unit/src/SnippetInitialization.Tests.ts
@@ -13,7 +13,7 @@ import {
 } from "@microsoft/applicationinsights-common";
 import { getGlobal } from "@microsoft/applicationinsights-shims";
 import { TelemetryContext } from "@microsoft/applicationinsights-properties-js";
-import { dumpObj, objHasOwnProperty, strSubstring } from "@nevware21/ts-utils";
+import { dumpObj, isPromiseLike, objHasOwnProperty } from "@nevware21/ts-utils";
 import { AppInsightsSku } from "../../../src/AISku";
 
 const TestInstrumentationKey = 'b7170927-2d1c-44f1-acec-59f4e1751c11';
@@ -1016,6 +1016,47 @@ export class SnippetInitializationTests extends AITestClass {
                 Assert.equal(envelope.sampleRate, 50, "sampleRate is generated");
             }
         })
+
+        this.testCase({
+            name: 'Unload: unload() without parameters should return a promise',
+            test: () => {
+                let theSnippet = this._initializeSnippet(snippetCreator(getSnippetConfig(this.sessionPrefix)));
+                const result = theSnippet.unload();
+                Assert.ok(result, "unload() should return a promise when called without parameters");
+                Assert.ok(isPromiseLike(result), "returned value should be promise-like");
+            }
+        });
+
+        this.testCase({
+            name: 'Unload: unload(true) should return a promise',
+            test: () => {
+                let theSnippet = this._initializeSnippet(snippetCreator(getSnippetConfig(this.sessionPrefix)));
+                const result = theSnippet.unload(true);
+                Assert.ok(result, "unload(true) should return a promise");
+                Assert.ok(isPromiseLike(result), "returned value should be promise-like");
+            }
+        });
+
+        this.testCase({
+            name: 'Unload: unload(false) should not return a promise',
+            test: () => {
+                let theSnippet = this._initializeSnippet(snippetCreator(getSnippetConfig(this.sessionPrefix)));
+                const result = theSnippet.unload(false);
+                Assert.equal(result, undefined, "unload(false) should return undefined");
+            }
+        });
+
+        this.testCase({
+            name: 'Unload: unload with callback should not return a promise',
+            test: () => {
+                let theSnippet = this._initializeSnippet(snippetCreator(getSnippetConfig(this.sessionPrefix)));
+                let callbackCalled = false;
+                const result = theSnippet.unload(true, () => {
+                    callbackCalled = true;
+                });
+                Assert.equal(result, undefined, "unload with callback should return undefined");
+            }
+        });
     }
 
     private _initializeSnippet(snippet: Snippet): IApplicationInsights {
diff --git a/AISKU/src/AISku.ts b/AISKU/src/AISku.ts
@@ -517,7 +517,7 @@ export class AppInsightsSku implements IApplicationInsights {
             _self.unload = (isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void | IPromise<ITelemetryUnloadState> => {
                 let unloadDone = false;
                 let result: IPromise<ITelemetryUnloadState>;
-                if (isAsync && !unloadComplete) {
+                if (isAsync !== false && !unloadComplete) {
                     result = createPromise<ITelemetryUnloadState>((resolve) => {
                         // Set the callback to the promise resolve callback
                         unloadComplete = resolve;
