[core-rest-pipeline] Flip keepAlive boolean (Azure#14093)

Booleans should default to false, but keepAlive on PipelineRequest defaulted to true. This change replaces `keepAlive` with `disableKeepAlive`, which can default to false.
AzureSDKAutomation · Mar 4, 2021 · 68a0144 · 68a0144
1 parent 9438fb2
commit 68a0144
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 12 deletions.
diff --git a/sdk/core/core-rest-pipeline/review/core-rest-pipeline.api.md b/sdk/core/core-rest-pipeline/review/core-rest-pipeline.api.md
@@ -154,9 +154,9 @@ export interface PipelinePolicy {
 export interface PipelineRequest {
     abortSignal?: AbortSignalLike;
     body?: RequestBodyType;
+    disableKeepAlive?: boolean;
     formData?: FormDataMap;
     headers: HttpHeaders;
-    keepAlive?: boolean;
     method: HttpMethods;
     onDownloadProgress?: (progress: TransferProgressEvent) => void;
     onUploadProgress?: (progress: TransferProgressEvent) => void;
@@ -173,9 +173,9 @@ export interface PipelineRequest {
 export interface PipelineRequestOptions {
     abortSignal?: AbortSignalLike;
     body?: RequestBodyType;
+    disableKeepAlive?: boolean;
     formData?: FormDataMap;
     headers?: HttpHeaders;
-    keepAlive?: boolean;
     method?: HttpMethods;
     onDownloadProgress?: (progress: TransferProgressEvent) => void;
     onUploadProgress?: (progress: TransferProgressEvent) => void;

diff --git a/sdk/core/core-rest-pipeline/src/interfaces.ts b/sdk/core/core-rest-pipeline/src/interfaces.ts
@@ -139,9 +139,9 @@ export interface PipelineRequest {
   proxySettings?: ProxySettings;
 
   /**
-   * If the connection should be reused.
+   * If the connection should not be reused.
    */
-  keepAlive?: boolean;
+  disableKeepAlive?: boolean;
 
   /**
    * Used to abort the request later.

diff --git a/sdk/core/core-rest-pipeline/src/nodeHttpsClient.ts b/sdk/core/core-rest-pipeline/src/nodeHttpsClient.ts
@@ -202,7 +202,9 @@ class NodeHttpsClient implements HttpsClient {
         try {
           parsedUrl = new URL(proxySettings.host);
         } catch (_error) {
-          throw new Error(`Expecting a valid host string in proxy settings, but found "${proxySettings.host}".`);
+          throw new Error(
+            `Expecting a valid host string in proxy settings, but found "${proxySettings.host}".`
+          );
         }
 
         const proxyAgentOptions: HttpsProxyAgentOptions = {
@@ -217,7 +219,7 @@ class NodeHttpsClient implements HttpsClient {
         this.proxyAgent = (new HttpsProxyAgent(proxyAgentOptions) as unknown) as https.Agent;
       }
       return this.proxyAgent;
-    } else if (request.keepAlive) {
+    } else if (!request.disableKeepAlive) {
       if (!this.keepAliveAgent) {
         this.keepAliveAgent = new https.Agent({
           keepAlive: true

diff --git a/sdk/core/core-rest-pipeline/src/pipelineRequest.ts b/sdk/core/core-rest-pipeline/src/pipelineRequest.ts
@@ -74,9 +74,9 @@ export interface PipelineRequestOptions {
   proxySettings?: ProxySettings;
 
   /**
-   * If the connection should be reused. Defaults to true.
+   * If the connection should not be reused.
    */
-  keepAlive?: boolean;
+  disableKeepAlive?: boolean;
 
   /**
    * Used to abort the request later.
@@ -107,7 +107,7 @@ class PipelineRequestImpl implements PipelineRequest {
   public formData?: FormDataMap;
   public streamResponseStatusCodes?: Set<number>;
   public proxySettings?: ProxySettings;
-  public keepAlive: boolean;
+  public disableKeepAlive: boolean;
   public abortSignal?: AbortSignalLike;
   public requestId: string;
   public spanOptions?: SpanOptions;
@@ -121,7 +121,7 @@ class PipelineRequestImpl implements PipelineRequest {
     this.method = options.method ?? "GET";
     this.timeout = options.timeout ?? 0;
     this.formData = options.formData;
-    this.keepAlive = options.keepAlive ?? true;
+    this.disableKeepAlive = options.disableKeepAlive ?? false;
     this.proxySettings = options.proxySettings;
     this.streamResponseStatusCodes = options.streamResponseStatusCodes;
     this.withCredentials = options.withCredentials ?? false;

diff --git a/sdk/storage/perf-tests/storage-blob/test/core-rest-pipeline.spec.ts b/sdk/storage/perf-tests/storage-blob/test/core-rest-pipeline.spec.ts
@@ -18,8 +18,7 @@ export class CoreHTTPSDownloadWithSASTest extends StorageBlobDownloadWithSASTest
     this.client = createDefaultHttpsClient();
     this.request = createPipelineRequest({
       url: this.sasUrl,
-      streamResponseStatusCodes: new Set([200, 206]),
-      keepAlive: true
+      streamResponseStatusCodes: new Set([200, 206])
     });
   }