Comments and naming

Author: MarkDuckworth

packages/firestore/src/platform/browser/webchannel_connection.ts

@@ -60,7 +60,7 @@ export class WebChannelConnection extends RestConnection {
   private readonly longPollingOptions: ExperimentalLongPollingOptions;
 
   /** A collection of open WebChannel instances */
-  private webChannels: WebChannel[] = [];
+  private openWebChannels: WebChannel[] = [];
 
   constructor(info: DatabaseInfo) {
     super(info);
@@ -242,7 +242,7 @@ export class WebChannelConnection extends RestConnection {
       request
     );
     const channel = webchannelTransport.createWebChannel(url, request);
-    this.trackWebChannel(channel);
+    this.addOpenWebChannel(channel);
 
     // WebChannel supports sending the first message with the handshake - saving
     // a network round trip. However, it will have to call send in the same
@@ -325,7 +325,7 @@ export class WebChannelConnection extends RestConnection {
           `RPC '${rpcName}' stream ${streamId} transport closed`
         );
         streamBridge.callOnClose();
-        this.untrackWebChannel(channel);
+        this.removeOpenWebChannel(channel);
       }
     });
 
@@ -437,16 +437,26 @@ export class WebChannelConnection extends RestConnection {
    * Closes and cleans up any resources associated with the connection.
    */
   terminate(): void {
-    this.webChannels.forEach(webChannel => webChannel.close());
-    this.webChannels = [];
+    // If the Firestore instance is terminated, we will explicitly
+    // close any remaining open WebChannel instances.
+    this.openWebChannels.forEach(webChannel => webChannel.close());
+    this.openWebChannels = [];
   }
 
-  trackWebChannel(webChannel: WebChannel): void {
-    this.webChannels.push(webChannel);
+  /**
+   * Add a WebChannel instance to the collection of open instances.
+   * @param webChannel
+   */
+  addOpenWebChannel(webChannel: WebChannel): void {
+    this.openWebChannels.push(webChannel);
   }
 
-  untrackWebChannel(webChannel: WebChannel): void {
-    this.webChannels = this.webChannels.filter(
+  /**
+   * Remove a WebChannel instance to the collection of open instances.
+   * @param webChannel
+   */
+  removeOpenWebChannel(webChannel: WebChannel): void {
+    this.openWebChannels = this.openWebChannels.filter(
       instance => instance === webChannel
     );
   }