[ServiceBus] Migrate REST-based client to core-rest-pipeline (Azure#19587)

* Move to depend on core v2 libraries.

* Previously WebResourceLike.body is of type any so we were able to assign an object to it, then relies on the internal logic in
`executeAtomXmlOperation()` to stringify it to XML before sending the request. Now that `PipelineRequest.body` is strongly typed, `executeAtomXmlOperation()` is
updated to optionally take the strongly typed request objects for PUT
operations.

* Add a compatibility layer to transform PipelineResponse to HttpResponse like by copying most relevant properties of `WebResourceLike` and add copy of `HttpResponse`

* Bump version

* Stop verifying AbortError error message. It turns out that we now have a different error message after switching to Fetch
http client for browser. Previously we were catching the one from xhrHttpClient
but now we get a DOMException from browser.  As error message isn't part of
public Api surface, the verification of error message is removed.

Author: jeremymeng

common/config/rush/pnpm-lock.yaml

@@ -1,5 +1,17 @@
 # Release History
 
+## 7.6.0-beta.1 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+- Migrate to depend on newer version of Core libraries core-client and core-rest-pipeline which bring better maintainability and performance. [PR #19587](https://github.com/Azure/azure-sdk-for-js/pull/19587)
+
 ## 7.5.1 (2022-03-08)
 
 ### Bugs Fixed

sdk/servicebus/service-bus/CHANGELOG.md

@@ -2,7 +2,7 @@
   "name": "@azure/service-bus",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "7.5.1",
+  "version": "7.6.0-beta.1",
   "license": "MIT",
   "description": "Azure Service Bus SDK for JavaScript",
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/servicebus/service-bus/",
@@ -107,11 +107,14 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-amqp": "^3.1.0",
+    "@azure/core-auth": "^1.3.0",
     "@azure/core-asynciterator-polyfill": "^1.0.0",
-    "@azure/core-http": "^2.0.0",
+    "@azure/core-client": "^1.0.0",
+    "@azure/core-rest-pipeline": "^1.1.0",
     "@azure/core-tracing": "1.0.0-preview.13",
     "@azure/core-paging": "^1.1.1",
-    "@azure/core-auth": "^1.3.0",
+    "@azure/core-util": "^1.0.0-beta.1",
+    "@azure/core-xml": "^1.0.0",
     "@azure/logger": "^1.0.0",
     "@types/is-buffer": "^2.0.0",
     "@types/long": "^4.0.1",
@@ -136,6 +139,7 @@
     "@types/glob": "^7.1.1",
     "@types/mocha": "^7.0.2",
     "@types/node": "^12.0.0",
+    "@types/uuid": "^8.0.0",
     "@types/ws": "^7.2.4",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
@@ -170,6 +174,7 @@
     "rollup": "^2.0.0",
     "ts-node": "^10.0.0",
     "typescript": "~4.2.0",
+    "uuid": "^8.3.0",
     "ws": "^8.0.0",
     "sinon": "^9.0.2",
     "@types/sinon": "^9.0.4",

sdk/servicebus/service-bus/package.json

@@ -6,27 +6,29 @@
 
 /// <reference types="node" />
 
+import { AbortSignalLike } from '@azure/abort-controller';
 import { AmqpAnnotatedMessage } from '@azure/core-amqp';
+import { CommonClientOptions } from '@azure/core-client';
 import { delay } from '@azure/core-amqp';
 import { Delivery } from 'rhea-promise';
-import { HttpResponse } from '@azure/core-http';
+import { HttpMethods } from '@azure/core-rest-pipeline';
 import { default as Long_2 } from 'long';
 import { MessagingError } from '@azure/core-amqp';
 import { NamedKeyCredential } from '@azure/core-auth';
-import { OperationOptions } from '@azure/core-http';
+import { OperationOptions } from '@azure/core-client';
 import { OperationTracingOptions } from '@azure/core-tracing';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { PageSettings } from '@azure/core-paging';
-import { PipelineOptions } from '@azure/core-http';
+import { ProxySettings } from '@azure/core-rest-pipeline';
 import { RetryMode } from '@azure/core-amqp';
 import { RetryOptions } from '@azure/core-amqp';
 import { SASCredential } from '@azure/core-auth';
-import { ServiceClient } from '@azure/core-http';
+import { ServiceClient } from '@azure/core-client';
 import { Span } from '@azure/core-tracing';
 import { SpanContext } from '@azure/core-tracing';
 import { TokenCredential } from '@azure/core-auth';
 import { TokenType } from '@azure/core-amqp';
-import { UserAgentOptions } from '@azure/core-http';
+import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
 import { WebSocketImpl } from 'rhea-promise';
 import { WebSocketOptions } from '@azure/core-amqp';
 
@@ -145,6 +147,35 @@ export type EntityStatus = "Active" | "Creating" | "Deleting" | "ReceiveDisabled
 export interface GetMessageIteratorOptions extends OperationOptionsBase {
 }
 
+// @public
+export interface HttpHeader {
+    name: string;
+    value: string;
+}
+
+// @public
+export interface HttpHeadersLike {
+    clone(): HttpHeadersLike;
+    contains(headerName: string): boolean;
+    get(headerName: string): string | undefined;
+    headerNames(): string[];
+    headersArray(): HttpHeader[];
+    headerValues(): string[];
+    rawHeaders(): RawHttpHeaders;
+    remove(headerName: string): boolean;
+    set(headerName: string, headerValue: string | number): void;
+    toJson(options?: {
+        preserveCase?: boolean;
+    }): RawHttpHeaders;
+}
+
+// @public
+export interface HttpResponse {
+    headers: HttpHeadersLike;
+    request: WebResourceLike;
+    status: number;
+}
+
 // @public
 export function isServiceBusError(err: unknown): err is ServiceBusError;
 
@@ -225,6 +256,11 @@ export interface QueueRuntimeProperties {
     transferMessageCount: number;
 }
 
+// @public
+export type RawHttpHeaders = {
+    [headerName: string]: string;
+};
+
 // @public
 export interface ReceiveMessagesOptions extends OperationOptionsBase {
     maxWaitTimeInMs?: number;
@@ -280,7 +316,7 @@ export class ServiceBusAdministrationClient extends ServiceClient {
 }
 
 // @public
-export interface ServiceBusAdministrationClientOptions extends PipelineOptions {
+export interface ServiceBusAdministrationClientOptions extends CommonClientOptions {
     serviceVersion?: "2021-05" | "2017-04";
 }
 
@@ -302,7 +338,7 @@ export class ServiceBusClient {
 // @public
 export interface ServiceBusClientOptions {
     retryOptions?: RetryOptions;
-    userAgentOptions?: UserAgentOptions;
+    userAgentOptions?: UserAgentPolicyOptions;
     webSocketOptions?: WebSocketOptions;
 }
 
@@ -582,13 +618,42 @@ export interface TopicRuntimeProperties {
     subscriptionCount?: number;
 }
 
+// @public
+export type TransferProgressEvent = {
+    loadedBytes: number;
+};
+
 // @public
 export interface TryAddOptions {
     // @deprecated (undocumented)
     parentSpan?: Span | SpanContext | null;
     tracingOptions?: OperationTracingOptions;
 }
 
+// @public
+export interface WebResourceLike {
+    abortSignal?: AbortSignalLike;
+    body?: any;
+    decompressResponse?: boolean;
+    formData?: any;
+    headers: HttpHeadersLike;
+    keepAlive?: boolean;
+    method: HttpMethods;
+    onDownloadProgress?: (progress: TransferProgressEvent) => void;
+    onUploadProgress?: (progress: TransferProgressEvent) => void;
+    proxySettings?: ProxySettings;
+    query?: {
+        [key: string]: any;
+    };
+    requestId: string;
+    // @deprecated
+    streamResponseBody?: boolean;
+    streamResponseStatusCodes?: Set<number>;
+    timeout: number;
+    url: string;
+    withCredentials: boolean;
+}
+
 export { WebSocketImpl }
 
 export { WebSocketOptions }

sdk/servicebus/service-bus/review/service-bus.api.md

@@ -16,7 +16,7 @@ import {
   TokenCredential,
 } from "@azure/core-auth";
 import { ConnectionContext } from "./connectionContext";
-import { UserAgentOptions } from "@azure/core-http";
+import { UserAgentPolicyOptions } from "@azure/core-rest-pipeline";
 import {
   parseServiceBusConnectionString,
   ServiceBusConnectionStringProperties,
@@ -51,7 +51,7 @@ export interface ServiceBusClientOptions {
   /**
    * Options for adding user agent details to outgoing requests.
    */
-  userAgentOptions?: UserAgentOptions;
+  userAgentOptions?: UserAgentPolicyOptions;
 }
 
 /**

sdk/servicebus/service-bus/src/constructorHelpers.ts

@@ -15,7 +15,7 @@ import { DispositionType, ServiceBusMessageImpl } from "../serviceBusMessage";
 import { getUniqueName } from "../util/utils";
 import { ProcessErrorArgs, ReceiveMode, SubscribeOptions } from "../models";
 import { DispositionStatusOptions } from "./managementClient";
-import { AbortSignalLike } from "@azure/core-http";
+import { AbortSignalLike } from "@azure/abort-controller";
 import {
   onMessageSettled,
   DeferredPromiseAndTimer,

sdk/servicebus/service-bus/src/core/messageReceiver.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { OperationOptions } from "@azure/core-http";
+import { OperationOptions } from "@azure/core-client";
 import {
   createSpanFunction,
   extractSpanContextFromTraceParentHeader,
@@ -192,8 +192,8 @@ export function convertTryAddOptionsForCompatibility(tryAddOptions: TryAddOption
     }
 
     function takeSomeOptionsFromSomewhere(someOptionsPassedIntoTheirFunction) {
-      
-      batch.tryAddMessage(message, { 
+
+      batch.tryAddMessage(message, {
         // "runtime" blend of options from some other part of their app
         ...someOptionsPassedIntoTheirFunction,      // parentSpan comes along for the ride...
 
@@ -208,9 +208,9 @@ export function convertTryAddOptionsForCompatibility(tryAddOptions: TryAddOption
 
     And now they've accidentally been opted into the legacy code path even though they think
     they're using the modern code path.
-    
+
     This does kick the can down the road a bit - at some point we will be putting them in this
-    situation where things looked okay but their spans are becoming unparented but we can 
+    situation where things looked okay but their spans are becoming unparented but we can
     try to announce this (and other changes related to tracing) in our next big rev.
   */
 

sdk/servicebus/service-bus/src/diagnostics/tracing.ts

@@ -13,7 +13,7 @@ export {
   WebSocketOptions,
 } from "@azure/core-amqp";
 export { TokenCredential } from "@azure/core-auth";
-export { OperationOptions } from "@azure/core-http";
+export { OperationOptions } from "@azure/core-client";
 export { Delivery, WebSocketImpl } from "rhea-promise";
 export { ServiceBusClientOptions } from "./constructorHelpers";
 export { CorrelationRuleFilter } from "./core/managementClient";
@@ -68,3 +68,11 @@ export {
   ServiceBusConnectionStringProperties,
 } from "./util/connectionStringUtils";
 export { AuthorizationRule, EntityAvailabilityStatus, EntityStatus } from "./util/utils";
+export {
+  HttpResponse,
+  HttpHeader,
+  RawHttpHeaders,
+  HttpHeadersLike,
+  TransferProgressEvent,
+  WebResourceLike,
+} from "./util/compat";

sdk/servicebus/service-bus/src/index.ts

@@ -4,10 +4,10 @@
 // TODO: this code is a straight-copy from EventHubs. Need to merge.
 
 import { OperationTracingOptions, SpanStatusCode, Span, SpanContext } from "@azure/core-tracing";
-import { OperationOptions } from "@azure/core-http";
+import { OperationOptions } from "@azure/core-client";
 
 /**
- * NOTE: This type is intended to mirror the relevant fields and structure from `@azure/core-http` OperationOptions
+ * NOTE: This type is intended to mirror the relevant fields and structure from `@azure/core-client` OperationOptions
  *
  * Options for configuring tracing and the abortSignal.
  */