[load-testing-rest] pass PolledOperationOptions to getLongRunningPoller (#35164)

This PR passes PolledOperationOptions to getLongRunningPoller, allowing
customers to change the interval between polls.

Author: jeremymeng

sdk/loadtesting/load-testing-rest/review/load-testing-node.api.md

@@ -193,13 +193,13 @@ export interface FunctionFlexConsumptionTargetResourceConfigurationsOutput exten
 export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
 
 // @public (undocumented)
-export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestUploadFileSuccessResponse): Promise<FileUploadAndValidatePoller>;
+export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestUploadFileSuccessResponse, polledOperationOptions?: PolledOperationOptions): Promise<FileUploadAndValidatePoller>;
 
 // @public (undocumented)
-export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestRunCreateOrUpdateSuccessResponse): Promise<TestRunCompletionPoller>;
+export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestRunCreateOrUpdateSuccessResponse, polledOperationOptions?: PolledOperationOptions): Promise<TestRunCompletionPoller>;
 
 // @public (undocumented)
-export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestProfileRunCreateOrUpdateSuccessResponse): Promise<TestProfileRunCompletionPoller>;
+export function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestProfileRunCreateOrUpdateSuccessResponse, polledOperationOptions?: PolledOperationOptions): Promise<TestProfileRunCompletionPoller>;
 
 // @public
 export type GetPage<TPage> = (pageLink: string) => Promise<{

sdk/loadtesting/load-testing-rest/src/pollingHelper.ts

@@ -12,33 +12,38 @@ import type {
   TestRunCreateOrUpdateSuccessResponse,
   TestProfileRunCreateOrUpdateSuccessResponse,
   TestProfileRunCompletionPoller,
+  PolledOperationOptions,
 } from "./models.js";
 
 export async function getLongRunningPoller(
   client: AzureLoadTestingClient,
   initialResponse: TestUploadFileSuccessResponse,
+  polledOperationOptions?: PolledOperationOptions,
 ): Promise<FileUploadAndValidatePoller>;
 export async function getLongRunningPoller(
   client: AzureLoadTestingClient,
   initialResponse: TestRunCreateOrUpdateSuccessResponse,
+  polledOperationOptions?: PolledOperationOptions,
 ): Promise<TestRunCompletionPoller>;
 export async function getLongRunningPoller(
   client: AzureLoadTestingClient,
   initialResponse: TestProfileRunCreateOrUpdateSuccessResponse,
+  polledOperationOptions?: PolledOperationOptions,
 ): Promise<TestProfileRunCompletionPoller>;
 export async function getLongRunningPoller(
   client: AzureLoadTestingClient,
   initialResponse:
     | TestRunCreateOrUpdateSuccessResponse
     | TestUploadFileSuccessResponse
     | TestProfileRunCreateOrUpdateSuccessResponse,
+  polledOperationOptions: PolledOperationOptions = {},
 ): Promise<TestRunCompletionPoller | FileUploadAndValidatePoller | TestProfileRunCompletionPoller> {
   if (isFileUpload(initialResponse)) {
-    return getFileValidationPoller(client, initialResponse);
+    return getFileValidationPoller(client, initialResponse, polledOperationOptions);
   } else if (isTestRunCreation(initialResponse)) {
-    return getTestRunCompletionPoller(client, initialResponse);
+    return getTestRunCompletionPoller(client, initialResponse, polledOperationOptions);
   } else if (isTestProfileRunCreation(initialResponse)) {
-    return getTestProfileRunCompletionPoller(client, initialResponse);
+    return getTestProfileRunCompletionPoller(client, initialResponse, polledOperationOptions);
   }
 
   throw new Error("The Operation is not a long running operation.");

sdk/loadtesting/load-testing-rest/test/public/node/testAdministration.spec.ts

@@ -9,11 +9,15 @@ import type {
 } from "../../../src/index.js";
 import { isUnexpected } from "../../../src/index.js";
 import type { Recorder } from "@azure-tools/test-recorder";
-import { env } from "@azure-tools/test-recorder";
+import { env, isPlaybackMode } from "@azure-tools/test-recorder";
 import fs from "node:fs";
 import { getLongRunningPoller } from "../../../src/pollingHelper.js";
 import { describe, it, assert, beforeEach, afterEach } from "vitest";
 
+const testPollingOptions = {
+  updateIntervalInMs: isPlaybackMode() ? 0 : undefined,
+};
+
 describe("Test Administration Operations", () => {
   let recorder: Recorder;
   let client: AzureLoadTestingClient;
@@ -100,7 +104,11 @@ describe("Test Administration Operations", () => {
       throw fileUploadResult.body.error;
     }
 
-    const fileValidatePoller = await getLongRunningPoller(client, fileUploadResult);
+    const fileValidatePoller = await getLongRunningPoller(
+      client,
+      fileUploadResult,
+      testPollingOptions,
+    );
     await fileValidatePoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(60000), // timeout of 60 seconds
     });
@@ -209,7 +217,11 @@ describe("Test Profile Administration Operations", () => {
       throw fileUploadResult.body.error;
     }
 
-    const fileValidatePoller = await getLongRunningPoller(client, fileUploadResult);
+    const fileValidatePoller = await getLongRunningPoller(
+      client,
+      fileUploadResult,
+      testPollingOptions,
+    );
     await fileValidatePoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(60000), // timeout of 60 seconds
     });

sdk/loadtesting/load-testing-rest/test/public/node/testRun.spec.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import type { Recorder } from "@azure-tools/test-recorder";
-import { env } from "@azure-tools/test-recorder";
+import { env, isPlaybackMode } from "@azure-tools/test-recorder";
 import { createRecorder, createClient } from "../utils/recordedClient.js";
 import type {
   AppComponent,
@@ -15,6 +15,10 @@ import fs from "node:fs";
 import { getLongRunningPoller } from "../../../src/pollingHelper.js";
 import { describe, it, assert, beforeEach, afterEach } from "vitest";
 
+const testPollingOptions = {
+  updateIntervalInMs: isPlaybackMode() ? 0 : undefined,
+};
+
 describe("Test Run Operations", () => {
   let recorder: Recorder;
   let client: AzureLoadTestingClient;
@@ -61,7 +65,11 @@ describe("Test Run Operations", () => {
       throw fileUploadResult.body.error;
     }
 
-    const fileValidatePoller = await getLongRunningPoller(client, fileUploadResult);
+    const fileValidatePoller = await getLongRunningPoller(
+      client,
+      fileUploadResult,
+      testPollingOptions,
+    );
     await fileValidatePoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(60000), // timeout of 60 seconds
     });
@@ -121,7 +129,11 @@ describe("Test Run Operations", () => {
       throw testRunCreationResult.body.error;
     }
 
-    const testRunPoller = await getLongRunningPoller(client, testRunCreationResult);
+    const testRunPoller = await getLongRunningPoller(
+      client,
+      testRunCreationResult,
+      testPollingOptions,
+    );
     await testRunPoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(600000),
     });
@@ -234,7 +246,11 @@ describe("Test Profile Run Operations", () => {
       throw fileUploadResult.body.error;
     }
 
-    const fileValidatePoller = await getLongRunningPoller(client, fileUploadResult);
+    const fileValidatePoller = await getLongRunningPoller(
+      client,
+      fileUploadResult,
+      testPollingOptions,
+    );
     await fileValidatePoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(60000), // timeout of 60 seconds
     });
@@ -293,7 +309,11 @@ describe("Test Profile Run Operations", () => {
       throw testProfileRunCreationResult.body.error;
     }
 
-    const testProfileRunPoller = await getLongRunningPoller(client, testProfileRunCreationResult);
+    const testProfileRunPoller = await getLongRunningPoller(
+      client,
+      testProfileRunCreationResult,
+      testPollingOptions,
+    );
     const polledResult = await testProfileRunPoller.pollUntilDone({
       abortSignal: AbortSignal.timeout(1200000),
     });