[core-https] Hide client constructors (Azure#13859)

Migrate DefaultHttpsClient from a constructor pattern to a factory.

Author: xirzec

sdk/core/core-client/package.json

@@ -78,7 +78,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.2.0",
-    "@azure/core-https": "1.0.0-beta.1",
+    "@azure/core-https": "1.0.0-beta.2",
     "@azure/core-tracing": "1.0.0-preview.9",
     "@opentelemetry/api": "^0.10.2",
     "tslib": "^2.0.0"

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

@@ -1,13 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { HttpsClient, DefaultHttpsClient } from "@azure/core-https";
+import { HttpsClient, createDefaultHttpsClient } from "@azure/core-https";
 
 let cachedHttpsClient: HttpsClient | undefined;
 
 export function getCachedDefaultHttpsClient(): HttpsClient {
   if (!cachedHttpsClient) {
-    cachedHttpsClient = new DefaultHttpsClient();
+    cachedHttpsClient = createDefaultHttpsClient();
   }
 
   return cachedHttpsClient;

sdk/core/core-https/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 1.0.0-beta.2 (Unreleased)
 
+- Changed from exposing `DefaultHttpsClient` as a class directly, to providing `createDefaultHttpsClient()` to instantiate the appropriate runtime class.
+
 ## 1.0.0-beta.1 (2021-02-04)
 
 - Changes from `core-http`:

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

@@ -29,6 +29,9 @@ export interface BearerTokenAuthenticationPolicyOptions {
     scopes: string | string[];
 }
 
+// @public
+export function createDefaultHttpsClient(): HttpsClient;
+
 // @public
 export function createEmptyPipeline(): Pipeline;
 
@@ -47,11 +50,6 @@ export function decompressResponsePolicy(): PipelinePolicy;
 // @public
 export const decompressResponsePolicyName = "decompressResponsePolicy";
 
-// @public
-export class DefaultHttpsClient implements HttpsClient {
-    sendRequest(request: PipelineRequest): Promise<PipelineResponse>;
-}
-
 // @public
 export function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy;
 

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

@@ -31,6 +31,7 @@ export interface AccessTokenCache {
  * Provides an AccessTokenCache implementation which clears
  * the cached AccessToken's after the expiresOnTimestamp has
  * passed.
+ * @internal
  */
 export class ExpiringAccessTokenCache implements AccessTokenCache {
   private tokenRefreshBufferMs: number;

sdk/core/core-https/src/defaultHttpsClient.browser.ts

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { XhrHttpsClient as DefaultHttpsClient } from "./xhrHttpsClient";
+export { createXhrHttpsClient as createDefaultHttpsClient } from "./xhrHttpsClient";

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

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { NodeHttpsClient as DefaultHttpsClient } from "./nodeHttpsClient";
+export { createNodeHttpsClient as createDefaultHttpsClient } from "./nodeHttpsClient";

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

@@ -25,7 +25,7 @@ export {
   PipelineOptions,
   createPipelineFromOptions
 } from "./pipeline";
-export { DefaultHttpsClient } from "./defaultHttpsClient";
+export { createDefaultHttpsClient } from "./defaultHttpsClient";
 export { createHttpHeaders } from "./httpHeaders";
 export { createPipelineRequest, PipelineRequestOptions } from "./pipelineRequest";
 export { RestError, RestErrorOptions } from "./restError";

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

@@ -60,8 +60,9 @@ class ReportTransform extends Transform {
 
 /**
  * A HttpsClient implementation that uses Node's "https" module to send HTTPS requests.
+ * @internal
  */
-export class NodeHttpsClient implements HttpsClient {
+class NodeHttpsClient implements HttpsClient {
   private keepAliveAgent?: https.Agent;
   private proxyAgent?: https.Agent;
 
@@ -306,3 +307,10 @@ function getBodyLength(body: RequestBodyType): number | null {
     return null;
   }
 }
+
+/**
+ * Create a new HttpsClient instance for the NodeJS environment.
+ */
+export function createNodeHttpsClient(): HttpsClient {
+  return new NodeHttpsClient();
+}

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

@@ -20,8 +20,9 @@ function isReadableStream(body: any): body is NodeJS.ReadableStream {
 
 /**
  * A HttpsClient implementation that uses XMLHttpRequest to send HTTPS requests.
+ * @internal
  */
-export class XhrHttpsClient implements HttpsClient {
+class XhrHttpsClient implements HttpsClient {
   /**
    * Makes a request over an underlying transport layer and returns the response.
    * @param request - The request to be made.
@@ -188,3 +189,10 @@ function rejectOnTerminalEvent(
   xhr.addEventListener("abort", () => reject(abortError));
   xhr.addEventListener("timeout", () => reject(abortError));
 }
+
+/**
+ * Create a new HttpsClient instance for the browser environment.
+ */
+export function createXhrHttpsClient(): HttpsClient {
+  return new XhrHttpsClient();
+}