chore: rename disableSessionCache to disableConcurrentStreams

Author: trivikr

packages/node-http-handler/src/node-http2-handler.spec.ts

@@ -290,25 +290,25 @@ describe(NodeHttp2Handler.name, () => {
     const requestTimeout = 200;
 
     describe("does not throw error when request not timed out", () => {
-      it("disableSessionCache: false (default)", async () => {
+      it("disableConcurrentStreams: false (default)", async () => {
         mockH2Server.removeAllListeners("request");
         mockH2Server.on("request", createResponseFunctionWithDelay(mockResponse, requestTimeout - 100));
 
         nodeH2Handler = new NodeHttp2Handler({ requestTimeout });
         await nodeH2Handler.handle(new HttpRequest(getMockReqOptions()), {});
       });
 
-      it("disableSessionCache: true", async () => {
+      it("disableConcurrentStreams: true", async () => {
         mockH2Server.removeAllListeners("request");
         mockH2Server.on("request", createResponseFunctionWithDelay(mockResponse, requestTimeout - 100));
 
-        nodeH2Handler = new NodeHttp2Handler({ requestTimeout, disableSessionCache: true });
+        nodeH2Handler = new NodeHttp2Handler({ requestTimeout, disableConcurrentStreams: true });
         await nodeH2Handler.handle(new HttpRequest(getMockReqOptions()), {});
       });
     });
 
     describe("throws timeoutError on requestTimeout", () => {
-      it("disableSessionCache: false (default)", async () => {
+      it("disableConcurrentStreams: false (default)", async () => {
         mockH2Server.removeAllListeners("request");
         mockH2Server.on("request", createResponseFunctionWithDelay(mockResponse, requestTimeout + 100));
 
@@ -319,11 +319,11 @@ describe(NodeHttp2Handler.name, () => {
         });
       });
 
-      it("disableSessionCache: true", async () => {
+      it("disableConcurrentStreams: true", async () => {
         mockH2Server.removeAllListeners("request");
         mockH2Server.on("request", createResponseFunctionWithDelay(mockResponse, requestTimeout + 100));
 
-        nodeH2Handler = new NodeHttp2Handler({ requestTimeout, disableSessionCache: true });
+        nodeH2Handler = new NodeHttp2Handler({ requestTimeout, disableConcurrentStreams: true });
         await rejects(nodeH2Handler.handle(new HttpRequest(getMockReqOptions()), {}), {
           name: "TimeoutError",
           message: `Stream timed out because of no activity for ${requestTimeout} ms`,
@@ -336,7 +336,7 @@ describe(NodeHttp2Handler.name, () => {
     const sessionTimeout = 200;
 
     describe("destroys session on sessionTimeout", () => {
-      it("disableSessionCache: false (default)", async (done) => {
+      it("disableConcurrentStreams: false (default)", async (done) => {
         nodeH2Handler = new NodeHttp2Handler({ sessionTimeout });
         await nodeH2Handler.handle(new HttpRequest(getMockReqOptions()), {});
 
@@ -354,8 +354,8 @@ describe(NodeHttp2Handler.name, () => {
         }, sessionTimeout + 100);
       });
 
-      it("disableSessionCache: true", async (done) => {
-        nodeH2Handler = new NodeHttp2Handler({ sessionTimeout, disableSessionCache: true });
+      it("disableConcurrentStreams: true", async (done) => {
+        nodeH2Handler = new NodeHttp2Handler({ sessionTimeout, disableConcurrentStreams: true });
         await nodeH2Handler.handle(new HttpRequest(getMockReqOptions()), {});
 
         // @ts-ignore: access private property
@@ -369,10 +369,10 @@ describe(NodeHttp2Handler.name, () => {
     });
   });
 
-  describe("disableSessionCache", () => {
+  describe("disableConcurrentStreams", () => {
     beforeEach(() => {
       nodeH2Handler = new NodeHttp2Handler({
-        disableSessionCache: true,
+        disableConcurrentStreams: true,
       });
     });
 

packages/node-http-handler/src/node-http2-handler.ts

@@ -24,27 +24,27 @@ export interface NodeHttp2HandlerOptions {
   sessionTimeout?: number;
 
   /**
-   * Disables sharing ClientHttp2Session instance between different HTTP/2 requests
-   * sent to the same URL. When set to true, it will create a new session instance for
-   * each request to a URL. **Default:** false.
+   * Disables processing concurrent streams on a ClientHttp2Session instance. When set
+   * to true, the handler will create a new session instance for each request to a URL.
+   * **Default:** false.
    * https://nodejs.org/api/http2.html#http2_class_clienthttp2session
    */
-  disableSessionCache?: boolean;
+  disableConcurrentStreams?: boolean;
 }
 
 export class NodeHttp2Handler implements HttpHandler {
   private readonly requestTimeout?: number;
   private readonly sessionTimeout?: number;
-  private readonly disableSessionCache?: boolean;
+  private readonly disableConcurrentStreams?: boolean;
 
   public readonly metadata = { handlerProtocol: "h2" };
   private sessionList: ClientHttp2Session[];
   private sessionCache: Map<string, ClientHttp2Session>;
 
-  constructor({ requestTimeout, sessionTimeout, disableSessionCache }: NodeHttp2HandlerOptions = {}) {
+  constructor({ requestTimeout, sessionTimeout, disableConcurrentStreams }: NodeHttp2HandlerOptions = {}) {
     this.requestTimeout = requestTimeout;
     this.sessionTimeout = sessionTimeout;
-    this.disableSessionCache = disableSessionCache;
+    this.disableConcurrentStreams = disableConcurrentStreams;
     this.sessionList = [];
     this.sessionCache = new Map<string, ClientHttp2Session>();
   }
@@ -71,10 +71,10 @@ export class NodeHttp2Handler implements HttpHandler {
 
       const { hostname, method, port, protocol, path, query } = request;
       const authority = `${protocol}//${hostname}${port ? `:${port}` : ""}`;
-      const session = this.disableSessionCache ? this.getSession(authority) : this.getSessionFromCache(authority);
+      const session = this.disableConcurrentStreams ? this.getSession(authority) : this.getSessionFromCache(authority);
 
       const reject = (err: Error) => {
-        if (this.disableSessionCache) {
+        if (this.disableConcurrentStreams) {
           this.destroySession(session);
         }
         fulfilled = true;
@@ -97,7 +97,7 @@ export class NodeHttp2Handler implements HttpHandler {
         });
         fulfilled = true;
         resolve({ response: httpResponse });
-        if (this.disableSessionCache) {
+        if (this.disableConcurrentStreams) {
           // Gracefully closes the Http2Session, allowing any existing streams to complete
           // on their own and preventing new Http2Stream instances from being created.
           session.close();