[core-http-compat] Policy factory compat (Azure#22798)

* Create a policy wrapper for pipeline interop

Author: xirzec

dataplane.code-workspace

@@ -274,6 +274,9 @@
     },
     {
       "path": "sdk/instrumentation/opentelemetry-instrumentation-azure-sdk"
+    },
+    {
+      "path": "sdk/core/core-http-compat"
     }
   ],
   "settings": {

sdk/core/core-http-compat/review/core-http-compat.api.md

@@ -10,6 +10,7 @@ import { FullOperationResponse } from '@azure/core-client';
 import { HttpMethods } from '@azure/core-rest-pipeline';
 import { OperationArguments } from '@azure/core-client';
 import { OperationSpec } from '@azure/core-client';
+import { PipelinePolicy } from '@azure/core-rest-pipeline';
 import { ProxySettings } from '@azure/core-rest-pipeline';
 import { ServiceClient } from '@azure/core-client';
 import { ServiceClientOptions } from '@azure/core-client';
@@ -20,6 +21,9 @@ export interface CompatResponse extends Omit<FullOperationResponse, "request" |
     request: WebResourceLike;
 }
 
+// @public
+export function createRequestPolicyFactoryPolicy(factories: RequestPolicyFactory[]): PipelinePolicy;
+
 // @public (undocumented)
 export const disbaleKeepAlivePolicyName = "DisableKeepAlivePolicy";
 
@@ -63,6 +67,18 @@ export interface HttpHeadersLike {
     }): RawHttpHeaders;
 }
 
+// @public
+export enum HttpPipelineLogLevel {
+    // (undocumented)
+    ERROR = 1,
+    // (undocumented)
+    INFO = 3,
+    // (undocumented)
+    OFF = 0,
+    // (undocumented)
+    WARNING = 2
+}
+
 // @public
 export interface KeepAliveOptions {
     enable?: boolean;
@@ -79,6 +95,29 @@ export interface RedirectOptions {
     maxRetries?: number;
 }
 
+// @public
+export interface RequestPolicy {
+    // (undocumented)
+    sendRequest(httpRequest: WebResourceLike): Promise<CompatResponse>;
+}
+
+// @public
+export interface RequestPolicyFactory {
+    // (undocumented)
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): RequestPolicy;
+}
+
+// @public
+export const requestPolicyFactoryPolicyName = "RequestPolicyFactoryPolicy";
+
+// @public
+export interface RequestPolicyOptionsLike {
+    // (undocumented)
+    log(logLevel: HttpPipelineLogLevel, message: string): void;
+    // (undocumented)
+    shouldLog(logLevel: HttpPipelineLogLevel): boolean;
+}
+
 // @public
 export type TransferProgressEvent = {
     loadedBytes: number;

sdk/core/core-http-compat/src/extendedClient.ts

@@ -6,15 +6,15 @@ import { createDisableKeepAlivePolicy } from "./policies/disableKeepAlivePolicy"
 import { RedirectOptions } from "./policies/redirectOptions";
 import { redirectPolicyName } from "@azure/core-rest-pipeline";
 import {
-  ServiceClient,
-  ServiceClientOptions,
   CommonClientOptions,
+  FullOperationResponse,
   OperationArguments,
   OperationSpec,
-  FullOperationResponse,
   RawResponseCallback,
+  ServiceClient,
+  ServiceClientOptions,
 } from "@azure/core-client";
-import { toWebResourceLike, toHttpHeaderLike, WebResourceLike, HttpHeadersLike } from "./util";
+import { toCompatResponse } from "./response";
 
 /**
  * Options specific to Shim Clients.
@@ -94,28 +94,10 @@ export class ExtendedServiceClient extends ServiceClient {
 
     if (lastResponse) {
       Object.defineProperty(result, "_response", {
-        value: {
-          ...lastResponse,
-          request: toWebResourceLike(lastResponse.request),
-          headers: toHttpHeaderLike(lastResponse.headers),
-        },
+        value: toCompatResponse(lastResponse),
       });
     }
 
     return result;
   }
 }
-
-/**
- * Http Response that is compatible with the core-v1(core-http).
- */
-export interface CompatResponse extends Omit<FullOperationResponse, "request" | "headers"> {
-  /**
-   * A description of a HTTP request to be made to a remote server.
-   */
-  request: WebResourceLike;
-  /**
-   * A collection of HTTP header key/value pairs.
-   */
-  headers: HttpHeadersLike;
-}

sdk/core/core-http-compat/src/index.ts

@@ -11,8 +11,16 @@ export {
   ExtendedServiceClientOptions,
   ExtendedCommonClientOptions,
   ExtendedClientOptions,
-  CompatResponse,
 } from "./extendedClient";
+export { CompatResponse } from "./response";
+export {
+  requestPolicyFactoryPolicyName,
+  createRequestPolicyFactoryPolicy,
+  RequestPolicyFactory,
+  RequestPolicy,
+  RequestPolicyOptionsLike,
+  HttpPipelineLogLevel,
+} from "./policies/requestPolicyFactoryPolicy";
 export { KeepAliveOptions } from "./policies/keepAliveOptions";
 export { RedirectOptions } from "./policies/redirectOptions";
 export { disbaleKeepAlivePolicyName } from "./policies/disableKeepAlivePolicy";

sdk/core/core-http-compat/src/policies/disableKeepAlivePolicy.ts

@@ -4,8 +4,8 @@
 import {
   PipelinePolicy,
   PipelineRequest,
-  SendRequest,
   PipelineResponse,
+  SendRequest,
 } from "@azure/core-rest-pipeline";
 
 export const disbaleKeepAlivePolicyName = "DisableKeepAlivePolicy";

sdk/core/core-http-compat/src/policies/requestPolicyFactoryPolicy.ts

@@ -0,0 +1,86 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+  PipelinePolicy,
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest,
+} from "@azure/core-rest-pipeline";
+import { WebResourceLike, toPipelineRequest, toWebResourceLike } from "../util";
+import { CompatResponse, toCompatResponse, toPipelineResponse } from "../response";
+
+/**
+ * A compatible interface for core-http request policies
+ */
+export interface RequestPolicy {
+  sendRequest(httpRequest: WebResourceLike): Promise<CompatResponse>;
+}
+
+/**
+ * An enum for compatibility with RequestPolicy
+ */
+export enum HttpPipelineLogLevel {
+  ERROR = 1,
+  INFO = 3,
+  OFF = 0,
+  WARNING = 2,
+}
+
+/**
+ * An interface for compatibility with RequestPolicy
+ */
+export interface RequestPolicyOptionsLike {
+  log(logLevel: HttpPipelineLogLevel, message: string): void;
+  shouldLog(logLevel: HttpPipelineLogLevel): boolean;
+}
+
+const mockRequestPolicyOptions: RequestPolicyOptionsLike = {
+  log(_logLevel: HttpPipelineLogLevel, _message: string): void {
+    /* do nothing */
+  },
+  shouldLog(_logLevel: HttpPipelineLogLevel): boolean {
+    return false;
+  },
+};
+
+/**
+ * An interface for compatibility with core-http's RequestPolicyFactory
+ */
+export interface RequestPolicyFactory {
+  create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): RequestPolicy;
+}
+
+/**
+ * The name of the RequestPolicyFactoryPolicy
+ */
+export const requestPolicyFactoryPolicyName = "RequestPolicyFactoryPolicy";
+
+/**
+ * A policy that wraps policies written for core-http.
+ * @param factories - An array of `RequestPolicyFactory` objects from a core-http pipeline
+ */
+export function createRequestPolicyFactoryPolicy(
+  factories: RequestPolicyFactory[]
+): PipelinePolicy {
+  const orderedFactories = factories.slice().reverse();
+
+  return {
+    name: requestPolicyFactoryPolicyName,
+    async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {
+      let httpPipeline: RequestPolicy = {
+        async sendRequest(httpRequest) {
+          const response = await next(toPipelineRequest(httpRequest));
+          return toCompatResponse(response, { createProxy: true });
+        },
+      };
+      for (const factory of orderedFactories) {
+        httpPipeline = factory.create(httpPipeline, mockRequestPolicyOptions);
+      }
+
+      const webResourceLike = toWebResourceLike(request, { createProxy: true });
+      const response = await httpPipeline.sendRequest(webResourceLike);
+      return toPipelineResponse(response);
+    },
+  };
+}

sdk/core/core-http-compat/src/response.ts

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { FullOperationResponse } from "@azure/core-client";
+import { PipelineResponse, createHttpHeaders } from "@azure/core-rest-pipeline";
+import {
+  HttpHeadersLike,
+  WebResourceLike,
+  toHttpHeaderLike,
+  toPipelineRequest,
+  toWebResourceLike,
+} from "./util";
+/**
+ * Http Response that is compatible with the core-v1(core-http).
+ */
+export interface CompatResponse extends Omit<FullOperationResponse, "request" | "headers"> {
+  /**
+   * A description of a HTTP request to be made to a remote server.
+   */
+  request: WebResourceLike;
+  /**
+   * A collection of HTTP header key/value pairs.
+   */
+  headers: HttpHeadersLike;
+}
+
+const originalResponse = Symbol("Original FullOperationResponse");
+type ExtendedCompatResponse = CompatResponse & { [originalResponse]?: FullOperationResponse };
+
+/**
+ * A helper to convert response objects from the new pipeline back to the old one.
+ * @param response - A response object from core-client.
+ * @returns A response compatible with `HttpOperationResponse` from core-http.
+ */
+export function toCompatResponse(
+  response: FullOperationResponse,
+  options?: { createProxy?: boolean }
+): CompatResponse {
+  let request = toWebResourceLike(response.request);
+  let headers = toHttpHeaderLike(response.headers);
+  if (options?.createProxy) {
+    return new Proxy(response, {
+      get(target, prop, receiver) {
+        if (prop === "headers") {
+          return headers;
+        } else if (prop === "request") {
+          return request;
+        }
+        return Reflect.get(target, prop, receiver);
+      },
+      set(target, prop, value, receiver) {
+        if (prop === "headers") {
+          headers = value;
+        } else if (prop === "request") {
+          request = value;
+        }
+        return Reflect.set(target, prop, value, receiver);
+      },
+    }) as unknown as CompatResponse;
+  } else {
+    return {
+      ...response,
+      request,
+      headers,
+    };
+  }
+}
+
+/**
+ * A helper to convert back to a PipelineResponse
+ * @param compatResponse - A response compatible with `HttpOperationResponse` from core-http.
+ */
+export function toPipelineResponse(compatResponse: CompatResponse): PipelineResponse {
+  const extendedCompatResponse = compatResponse as ExtendedCompatResponse;
+  const response = extendedCompatResponse[originalResponse];
+  const headers = createHttpHeaders(compatResponse.headers.toJson({ preserveCase: true }));
+  if (response) {
+    response.headers = headers;
+    return response;
+  } else {
+    return {
+      ...compatResponse,
+      headers,
+      request: toPipelineRequest(compatResponse.request),
+    };
+  }
+}