[core-rest-pipeline][core-client] Replace "HTTPS" with "HTTP" in interface names (Azure#14142)

Despite no service being allowed to ship a non-TLS encrypted endpoint, it turns out there are cases (such as the AutoRest test server) where we want Core to be able to make insecure connections.

The work to support such connections will be added in a later PR (to avoid risk) but this PR renames all public interfaces to make it clear that connections do not need to be TLS encrypted.

Author: xirzec

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

@@ -5,8 +5,8 @@
 ```ts
 
 import { AbortSignalLike } from '@azure/abort-controller';
+import { HttpClient } from '@azure/core-rest-pipeline';
 import { HttpMethods } from '@azure/core-rest-pipeline';
-import { HttpsClient } from '@azure/core-rest-pipeline';
 import { InternalPipelineOptions } from '@azure/core-rest-pipeline';
 import { OperationTracingOptions } from '@azure/core-tracing';
 import { Pipeline } from '@azure/core-rest-pipeline';
@@ -37,7 +37,7 @@ export interface BaseMapper {
 
 // @public
 export interface CommonClientOptions extends PipelineOptions {
-    httpsClient?: HttpsClient;
+    httpClient?: HttpClient;
 }
 
 // @public (undocumented)

sdk/core/core-client/src/httpClientCache.ts

@@ -1,14 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { HttpsClient, createDefaultHttpsClient } from "@azure/core-rest-pipeline";
+import { HttpClient, createDefaultHttpClient } from "@azure/core-rest-pipeline";
 
-let cachedHttpsClient: HttpsClient | undefined;
+let cachedHttpClient: HttpClient | undefined;
 
-export function getCachedDefaultHttpsClient(): HttpsClient {
-  if (!cachedHttpsClient) {
-    cachedHttpsClient = createDefaultHttpsClient();
+export function getCachedDefaultHttpClient(): HttpClient {
+  if (!cachedHttpClient) {
+    cachedHttpClient = createDefaultHttpClient();
   }
 
-  return cachedHttpsClient;
+  return cachedHttpClient;
 }

sdk/core/core-client/src/interfaces.ts

@@ -9,7 +9,7 @@ import {
   TransferProgressEvent,
   PipelineRequest,
   PipelineOptions,
-  HttpsClient
+  HttpClient
 } from "@azure/core-rest-pipeline";
 
 /**
@@ -547,5 +547,5 @@ export interface CommonClientOptions extends PipelineOptions {
   /**
    * The HttpClient that will be used to send HTTP requests.
    */
-  httpsClient?: HttpsClient;
+  httpClient?: HttpClient;
 }

sdk/core/core-client/src/serviceClient.ts

@@ -3,7 +3,7 @@
 
 import { TokenCredential } from "@azure/core-auth";
 import {
-  HttpsClient,
+  HttpClient,
   PipelineRequest,
   PipelineResponse,
   Pipeline,
@@ -19,7 +19,7 @@ import { getStreamingResponseStatusCodes } from "./interfaceHelpers";
 import { getRequestUrl } from "./urlHelpers";
 import { flattenResponse } from "./utils";
 import { URL } from "./url";
-import { getCachedDefaultHttpsClient } from "./httpClientCache";
+import { getCachedDefaultHttpClient } from "./httpClientCache";
 import { getOperationRequestInfo } from "./operationHelpers";
 import { createClientPipeline } from "./pipeline";
 
@@ -70,7 +70,7 @@ export class ServiceClient {
   /**
    * The HTTP client that will be used to send requests.
    */
-  private readonly _httpsClient: HttpsClient;
+  private readonly _httpClient: HttpClient;
 
   /**
    * The pipeline used by this client to make requests
@@ -85,7 +85,7 @@ export class ServiceClient {
   constructor(options: ServiceClientOptions = {}) {
     this._requestContentType = options.requestContentType;
     this._baseUri = options.baseUri;
-    this._httpsClient = options.httpsClient || getCachedDefaultHttpsClient();
+    this._httpClient = options.httpClient || getCachedDefaultHttpClient();
 
     this.pipeline = options.pipeline || createDefaultPipeline(options);
   }
@@ -94,7 +94,7 @@ export class ServiceClient {
    * Send the provided httpRequest.
    */
   async sendRequest(request: PipelineRequest): Promise<PipelineResponse> {
-    return this.pipeline.sendRequest(this._httpsClient, request);
+    return this.pipeline.sendRequest(this._httpClient, request);
   }
 
   /**

sdk/core/core-client/test/serviceClient.spec.ts

@@ -20,7 +20,7 @@ import {
 import {
   createHttpHeaders,
   createEmptyPipeline,
-  HttpsClient,
+  HttpClient,
   createPipelineRequest
 } from "@azure/core-rest-pipeline";
 
@@ -30,7 +30,7 @@ import {
 } from "../src/operationHelpers";
 import { deserializationPolicy } from "../src/deserializationPolicy";
 import { TokenCredential } from "@azure/core-auth";
-import { getCachedDefaultHttpsClient } from "../src/httpClientCache";
+import { getCachedDefaultHttpClient } from "../src/httpClientCache";
 
 describe("ServiceClient", function() {
   describe("Auth scopes", () => {
@@ -85,7 +85,7 @@ describe("ServiceClient", function() {
       try {
         let request: OperationRequest;
         const client = new ServiceClient({
-          httpsClient: {
+          httpClient: {
             sendRequest: (req) => {
               request = req;
               return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });
@@ -111,7 +111,7 @@ describe("ServiceClient", function() {
       try {
         let request: OperationRequest;
         const client = new ServiceClient({
-          httpsClient: {
+          httpClient: {
             sendRequest: (req) => {
               request = req;
               return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });
@@ -141,7 +141,7 @@ describe("ServiceClient", function() {
 
       let request: OperationRequest;
       const client = new ServiceClient({
-        httpsClient: {
+        httpClient: {
           sendRequest: (req) => {
             request = req;
             return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });
@@ -168,7 +168,7 @@ describe("ServiceClient", function() {
 
       let request: OperationRequest;
       const client = new ServiceClient({
-        httpsClient: {
+        httpClient: {
           sendRequest: (req) => {
             request = req;
             return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });
@@ -196,7 +196,7 @@ describe("ServiceClient", function() {
     const pipeline = createEmptyPipeline();
     pipeline.addPolicy(serializationPolicy(), { phase: "Serialize" });
     const client = new ServiceClient({
-      httpsClient: {
+      httpClient: {
         sendRequest: (req) => {
           request = req;
           return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });
@@ -256,7 +256,7 @@ describe("ServiceClient", function() {
   it("should call rawResponseCallback with the full response", async function() {
     let request: OperationRequest;
     const client = new ServiceClient({
-      httpsClient: {
+      httpClient: {
         sendRequest: (req) => {
           request = req;
           return Promise.resolve({
@@ -329,7 +329,7 @@ describe("ServiceClient", function() {
 
   it("should deserialize response bodies", async function() {
     let request: OperationRequest;
-    const httpsClient: HttpsClient = {
+    const httpClient: HttpClient = {
       sendRequest: (req) => {
         request = req;
         return Promise.resolve({
@@ -344,7 +344,7 @@ describe("ServiceClient", function() {
     const pipeline = createEmptyPipeline();
     pipeline.addPolicy(deserializationPolicy());
     const client1 = new ServiceClient({
-      httpsClient,
+      httpClient,
       pipeline
     });
 
@@ -791,7 +791,7 @@ describe("ServiceClient", function() {
     const operationInfo = getOperationRequestInfo(request);
     operationInfo.operationSpec = operationSpec;
 
-    const httpsClient: HttpsClient = {
+    const httpClient: HttpClient = {
       sendRequest: (req) => {
         request = req;
         return Promise.resolve({
@@ -808,7 +808,7 @@ describe("ServiceClient", function() {
     const pipeline = createEmptyPipeline();
     pipeline.addPolicy(deserializationPolicy());
     const client = new ServiceClient({
-      httpsClient,
+      httpClient,
       pipeline
     });
 
@@ -871,7 +871,7 @@ describe("ServiceClient", function() {
     const operationInfo = getOperationRequestInfo(request);
     operationInfo.operationSpec = operationSpec;
 
-    const httpsClient: HttpsClient = {
+    const httpClient: HttpClient = {
       sendRequest: (req) => {
         request = req;
         return Promise.resolve({
@@ -888,7 +888,7 @@ describe("ServiceClient", function() {
     const pipeline = createEmptyPipeline();
     pipeline.addPolicy(deserializationPolicy());
     const client = new ServiceClient({
-      httpsClient,
+      httpClient,
       pipeline
     });
 
@@ -903,7 +903,7 @@ describe("ServiceClient", function() {
 
   it("should re-use the common instance of DefaultHttpClient", function() {
     const client = new ServiceClient();
-    assert.strictEqual((client as any)._httpsClient, getCachedDefaultHttpsClient());
+    assert.strictEqual((client as any)._httpClient, getCachedDefaultHttpClient());
   });
 });
 
@@ -915,7 +915,7 @@ async function testSendOperationRequest(
 ): Promise<void> {
   let request: OperationRequest;
   const client = new ServiceClient({
-    httpsClient: {
+    httpClient: {
       sendRequest: (req) => {
         request = req;
         return Promise.resolve({ request, status: 200, headers: createHttpHeaders() });

sdk/core/core-rest-pipeline/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.0.0-beta.2 (Unreleased)
 
+- Renamed interfaces with `HTTPS` in the name to have `HTTP` instead.
 - Changed from exposing `DefaultHttpsClient` as a class directly, to providing `createDefaultHttpsClient()` to instantiate the appropriate runtime class.
 - Fix an issue when passing in proxy hosts. [PR 13911](https://github.com/Azure/azure-sdk-for-js/pull/13911)
 - Package rename to `core-rest-pipeline` to better reflect its purpose.

sdk/core/core-rest-pipeline/README.md

@@ -30,20 +30,20 @@ A `SendRequest` method is a method that given a `PipelineRequest` can asynchrono
 export type SendRequest = (request: PipelineRequest) => Promise<PipelineResponse>;
 ```
 
-### HttpsClient
+### HttpClient
 
-An `HttpsClient` is any object that satisfies the following interface to implement a `SendRequest` method:
+An `HttpClient` is any object that satisfies the following interface to implement a `SendRequest` method:
 
 ```ts
-export interface HttpsClient {
+export interface HttpClient {
   /**
    * The method that makes the request and returns a response.
    */
   sendRequest: SendRequest;
 }
 ```
 
-`HttpsClient`s are expected to actually make the HTTP request to a server endpoint, using some platform-specific mechanism for doing so.
+`HttpClient`s are expected to actually make the HTTP request to a server endpoint, using some platform-specific mechanism for doing so.
 
 ### Pipeline Policies
 
@@ -64,7 +64,7 @@ export interface PipelinePolicy {
 }
 ```
 
-It is similar in shape to `HttpsClient`, but includes a policy name as well as a slightly modified `SendRequest` signature that allows it to conditionally call the next policy in the pipeline.
+It is similar in shape to `HttpClient`, but includes a policy name as well as a slightly modified `SendRequest` signature that allows it to conditionally call the next policy in the pipeline.
 
 One can view the role of policies as that of `middleware`, a concept that is familiar to NodeJS developers who have worked with frameworks such as [Express](https://expressjs.com/).
 
@@ -99,13 +99,13 @@ A `Pipeline` satisfies the following interface:
 export interface Pipeline {
   addPolicy(policy: PipelinePolicy, options?: AddPolicyOptions): void;
   removePolicy(options: { name?: string; phase?: PipelinePhase }): PipelinePolicy[];
-  sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>;
+  sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>;
   getOrderedPolicies(): PipelinePolicy[];
   clone(): Pipeline;
 }
 ```
 
-As you can see it allows for policies to be added or removed and it is loosely coupled with `HttpsClient` to perform the real request to the server endpoint.
+As you can see it allows for policies to be added or removed and it is loosely coupled with `HttpClient` to perform the real request to the server endpoint.
 
 One important concept for `Pipeline`s is that they group policies into ordered phases:
 

sdk/core/core-rest-pipeline/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@azure/core-rest-pipeline",
   "version": "1.0.0-beta.2",
-  "description": "Isomorphic client library for making HTTPS requests in node.js and browser.",
+  "description": "Isomorphic client library for making HTTP 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/defaultHttpClient.js": "./dist-esm/src/defaultHttpClient.browser.js",
     "./dist-esm/src/policies/decompressResponsePolicy.js": "./dist-esm/src/policies/decompressResponsePolicy.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",

sdk/core/core-rest-pipeline/review/core-rest-pipeline.api.md

@@ -30,7 +30,7 @@ export interface BearerTokenAuthenticationPolicyOptions {
 }
 
 // @public
-export function createDefaultHttpsClient(): HttpsClient;
+export function createDefaultHttpClient(): HttpClient;
 
 // @public
 export function createEmptyPipeline(): Pipeline;
@@ -80,6 +80,11 @@ export type FormDataValue = string | Blob;
 // @public
 export function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined;
 
+// @public
+export interface HttpClient {
+    sendRequest: SendRequest;
+}
+
 // @public
 export interface HttpHeaders extends Iterable<[string, string]> {
     delete(name: string): void;
@@ -92,11 +97,6 @@ export interface HttpHeaders extends Iterable<[string, string]> {
 // @public
 export type HttpMethods = "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE";
 
-// @public
-export interface HttpsClient {
-    sendRequest: SendRequest;
-}
-
 // @public
 export interface InternalPipelineOptions extends PipelineOptions {
     loggingOptions?: LogPolicyOptions;
@@ -130,7 +130,7 @@ export interface Pipeline {
         name?: string;
         phase?: PipelinePhase;
     }): PipelinePolicy[];
-    sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>;
+    sendRequest(httpClient: HttpClient, request: PipelineRequest): Promise<PipelineResponse>;
 }
 
 // @public

sdk/core/core-rest-pipeline/src/defaultHttpClient.browser.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { HttpClient } from "./interfaces";
+import { createXhrHttpClient } from "./xhrHttpClient";
+
+/**
+ * Create the correct HttpClient for the current environment.
+ */
+export function createDefaultHttpClient(): HttpClient {
+  return createXhrHttpClient();
+}