[core-https] Port request policies to new pipeline model

sdk/core/core-https/api-extractor.json

@@ -11,7 +11,7 @@
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
-    "publicTrimmedFilePath": "./types/latest/coreHttps.d.ts"
+    "publicTrimmedFilePath": "./types/latest/core-https.d.ts"
   },
   "messages": {
     "tsdocMessageReporting": {

sdk/core/core-https/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@azure/core-https",
-  "version": "1.0.0",
+  "version": "1.0.0-preview.1",
   "private": true,
   "description": "Isomorphic client library for making HTTPS requests in node.js and browser.",
   "sdk-type": "client",
   "main": "dist/index.js",
   "module": "dist-esm/src/index.js",
   "browser": {
     "./dist-esm/src/defaultHttpsClient.js": "./dist-esm/src/defaultHttpsClient.browser.js",
+    "./dist-esm/src/policies/disableResponseDecompressionPolicy.js": "./dist-esm/src/policies/disableResponseDecompressionPolicy.browser.js",
+    "./dist-esm/src/policies/formDataPolicy.js": "./dist-esm/src/policies/formDataPolicy.browser.js",
+    "./dist-esm/src/policies/proxyPolicy.js": "./dist-esm/src/policies/proxyPolicy.browser.js",
     "./dist-esm/src/util/inspect.js": "./dist-esm/src/util/inspect.browser.js",
-    "./dist-esm/src/util/url.js": "./dist-esm/src/util/url.browser.js"
+    "./dist-esm/src/util/url.js": "./dist-esm/src/util/url.browser.js",
+    "./dist-esm/src/util/userAgentPlatform.js": "./dist-esm/src/util/userAgentPlatform.browser.js"
   },
-  "types": "types/latest/coreHttps.d.ts",
+  "types": "types/latest/core-https.d.ts",
   "typesVersions": {
     "<3.6": {
       "types/latest/src/*": [
@@ -76,12 +80,23 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-https/",
   "sideEffects": false,
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
+  "//metadata": {
+    "constantPaths": [
+      {
+        "path": "src/constants.ts",
+        "prefix": "SDK_VERSION"
+      }
+    ]
+  },
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
+    "@azure/core-tracing": "1.0.0-preview.8",
+    "@azure/logger": "^1.0.0",
     "@opentelemetry/api": "^0.6.1",
     "form-data": "^3.0.0",
     "tslib": "^2.0.0",
-    "https-proxy-agent": "^5.0.0"
+    "https-proxy-agent": "^5.0.0",
+    "uuid": "^8.1.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "7.7.11",
@@ -94,6 +109,7 @@
     "@types/mocha": "^7.0.2",
     "@types/node": "^8.0.0",
     "@types/sinon": "^9.0.4",
+    "@types/uuid": "^8.0.0",
     "@typescript-eslint/eslint-plugin": "^2.0.0",
     "@typescript-eslint/parser": "^2.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",

sdk/core/core-https/review/core-https.api.md

@@ -5,6 +5,8 @@
 ```ts
 
 import { AbortSignalLike } from '@azure/abort-controller';
+import { Debugger } from '@azure/logger';
+import { SpanOptions } from '@azure/core-tracing';
 
 // @public
 export interface AddPipelineOptions {
@@ -20,6 +22,9 @@ export function createEmptyPipeline(): Pipeline;
 // @public
 export function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders;
 
+// @public
+export function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline;
+
 // @public
 export function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest;
 
@@ -28,14 +33,42 @@ export class DefaultHttpsClient implements HttpsClient {
     sendRequest(request: PipelineRequest): Promise<PipelineResponse>;
 }
 
+// @public
+export function disableResponseDecompressionPolicy(): PipelinePolicy;
+
+// @public
+export const disableResponseDecompressionPolicyName = "disableResponseDecompressionPolicy";
+
+// @public
+export function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy;
+
+// @public
+export interface ExponentialRetryPolicyOptions {
+    maxRetries?: number;
+    maxRetryDelayInMs?: number;
+    retryDelayInMs?: number;
+}
+
+// @public
+export const expontentialRetryPolicyName = "exponentialRetryPolicy";
+
 // @public
 export type FormDataMap = {
     [key: string]: FormDataValue | FormDataValue[];
 };
 
+// @public
+export function formDataPolicy(): PipelinePolicy;
+
+// @public
+export const formDataPolicyName = "formDataPolicy";
+
 // @public
 export type FormDataValue = string | Blob;
 
+// @public
+export function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined;
+
 // @public
 export interface HttpHeaders extends Iterable<[string, string]> {
     clone(): HttpHeaders;
@@ -54,6 +87,36 @@ export interface HttpsClient {
     sendRequest: SendRequest;
 }
 
+// @public
+export interface InternalPipelineOptions extends PipelineOptions {
+    decompressResponse?: boolean;
+    loggingOptions?: LogPolicyOptions;
+}
+
+// @public
+export function keepAlivePolicy(options?: KeepAlivePolicyOptions): PipelinePolicy;
+
+// @public
+export const keepAlivePolicyName = "keepAlivePolicy";
+
+// @public
+export interface KeepAlivePolicyOptions {
+    enable?: boolean;
+}
+
+// @public
+export function logPolicy(options?: LogPolicyOptions): PipelinePolicy;
+
+// @public
+export const logPolicyName = "logPolicy";
+
+// @public
+export interface LogPolicyOptions {
+    additionalAllowedHeaderNames?: string[];
+    additionalAllowedQueryParameters?: string[];
+    logger?: Debugger;
+}
+
 // @public
 export interface Pipeline {
     addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions): void;
@@ -66,6 +129,16 @@ export interface Pipeline {
     sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>;
 }
 
+// @public
+export interface PipelineOptions {
+    httpsClient?: HttpsClient;
+    keepAliveOptions?: KeepAlivePolicyOptions;
+    proxyOptions?: ProxySettings;
+    redirectOptions?: PipelineRedirectOptions;
+    retryOptions?: ExponentialRetryPolicyOptions;
+    userAgentOptions?: UserAgentPolicyOptions;
+}
+
 // @public
 export type PipelinePhase = "Serialize" | "Retry";
 
@@ -75,18 +148,26 @@ export interface PipelinePolicy {
     sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse>;
 }
 
+// @public
+export interface PipelineRedirectOptions extends RedirectPolicyOptions {
+    disable?: boolean;
+}
+
 // @public
 export interface PipelineRequest {
     abortSignal?: AbortSignalLike;
     body?: RequestBodyType;
+    clone(): PipelineRequest;
     formData?: FormDataMap;
     headers: HttpHeaders;
     keepAlive?: boolean;
     method: HttpMethods;
     onDownloadProgress?: (progress: TransferProgressEvent) => void;
     onUploadProgress?: (progress: TransferProgressEvent) => void;
     proxySettings?: ProxySettings;
+    requestId: string;
     skipDecompressResponse?: boolean;
+    spanOptions?: SpanOptions;
     streamResponseBody?: boolean;
     timeout: number;
     url: string;
@@ -104,7 +185,9 @@ export interface PipelineRequestOptions {
     onDownloadProgress?: (progress: TransferProgressEvent) => void;
     onUploadProgress?: (progress: TransferProgressEvent) => void;
     proxySettings?: ProxySettings;
+    requestId?: string;
     skipDecompressResponse?: boolean;
+    spanOptions?: SpanOptions;
     streamResponseBody?: boolean;
     timeout?: number;
     url: string;
@@ -121,6 +204,12 @@ export interface PipelineResponse {
     status: number;
 }
 
+// @public
+export function proxyPolicy(proxySettings?: ProxySettings | undefined): PipelinePolicy;
+
+// @public
+export const proxyPolicyName = "proxyPolicy";
+
 // @public
 export interface ProxySettings {
     host: string;
@@ -134,6 +223,17 @@ export type RawHttpHeaders = {
     [headerName: string]: string;
 };
 
+// @public
+export function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy;
+
+// @public
+export const redirectPolicyName = "redirectPolicy";
+
+// @public
+export interface RedirectPolicyOptions {
+    maxRetries?: number;
+}
+
 // @public
 export type RequestBodyType = NodeJS.ReadableStream | Blob | ArrayBuffer | ArrayBufferView | FormData | string | null;
 
@@ -160,11 +260,58 @@ export interface RestErrorOptions {
 // @public
 export type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
 
+// @public
+export function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy;
+
+// @public
+export const setClientRequestIdPolicyName = "setClientRequestIdPolicy";
+
+// @public
+export function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy;
+
+// @public
+export const systemErrorRetryPolicyName = "systemErrorRetryPolicy";
+
+// @public
+export interface SystemErrorRetryPolicyOptions {
+    maxRetries?: number;
+    maxRetryDelayInMs?: number;
+    retryDelayInMs?: number;
+}
+
+// @public
+export function throttlingRetryPolicy(): PipelinePolicy;
+
+// @public
+export const throttlingRetryPolicyName = "throttlingRetryPolicy";
+
+// @public
+export function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy;
+
+// @public
+export const tracingPolicyName = "tracingPolicy";
+
+// @public
+export interface TracingPolicyOptions {
+    userAgentPrefix?: string;
+}
+
 // @public
 export type TransferProgressEvent = {
     loadedBytes: number;
 };
 
+// @public
+export function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy;
+
+// @public
+export const userAgentPolicyName = "userAgentPolicy";
+
+// @public
+export interface UserAgentPolicyOptions {
+    userAgentPrefix?: string;
+}
+
 
 // (No @packageDocumentation comment for this package)
 

sdk/core/core-https/rollup.base.config.js

@@ -14,7 +14,7 @@ const input = "dist-esm/src/index.js";
 const production = process.env.NODE_ENV === "production";
 
 export function nodeConfig(test = false) {
-  const externalNodeBuiltins = ["stream", "https", "zlib", "url", "util"];
+  const externalNodeBuiltins = ["os", "stream", "https", "zlib", "url", "util"];
   const baseConfig = {
     input: input,
     external: depNames.concat(externalNodeBuiltins),

sdk/core/core-https/src/constants.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export const SDK_VERSION: string = "1.0.0-preview.1";

sdk/core/core-https/src/index.ts

@@ -20,9 +20,51 @@ export {
   PipelinePhase,
   PipelinePolicy,
   Pipeline,
-  createEmptyPipeline
+  createEmptyPipeline,
+  InternalPipelineOptions,
+  PipelineOptions,
+  PipelineRedirectOptions,
+  createPipelineFromOptions
 } from "./pipeline";
 export { DefaultHttpsClient } from "./defaultHttpsClient";
 export { createHttpHeaders } from "./httpHeaders";
 export { createPipelineRequest, PipelineRequestOptions } from "./pipelineRequest";
 export { RestError, RestErrorOptions } from "./restError";
+export {
+  disableResponseDecompressionPolicy,
+  disableResponseDecompressionPolicyName
+} from "./policies/disableResponseDecompressionPolicy";
+export {
+  exponentialRetryPolicy,
+  ExponentialRetryPolicyOptions,
+  expontentialRetryPolicyName
+} from "./policies/exponentialRetryPolicy";
+export {
+  setClientRequestIdPolicy,
+  setClientRequestIdPolicyName
+} from "./policies/setClientRequestIdPolicy";
+export {
+  keepAlivePolicy,
+  keepAlivePolicyName,
+  KeepAlivePolicyOptions
+} from "./policies/keepAlivePolicy";
+export { logPolicy, logPolicyName, LogPolicyOptions } from "./policies/logPolicy";
+export { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from "./policies/proxyPolicy";
+export {
+  redirectPolicy,
+  redirectPolicyName,
+  RedirectPolicyOptions
+} from "./policies/redirectPolicy";
+export {
+  systemErrorRetryPolicy,
+  SystemErrorRetryPolicyOptions,
+  systemErrorRetryPolicyName
+} from "./policies/systemErrorRetryPolicy";
+export { throttlingRetryPolicy, throttlingRetryPolicyName } from "./policies/throttlingRetryPolicy";
+export { tracingPolicy, tracingPolicyName, TracingPolicyOptions } from "./policies/tracingPolicy";
+export {
+  userAgentPolicy,
+  userAgentPolicyName,
+  UserAgentPolicyOptions
+} from "./policies/userAgentPolicy";
+export { formDataPolicy, formDataPolicyName } from "./policies/formDataPolicy";