Fix experimentalAutoDetectLongPolling and add logging (#4078)

.changeset/proud-pigs-work.md

@@ -0,0 +1,6 @@
+---
+"@firebase/firestore": patch
+"@firebase/webchannel-wrapper": patch
+---
+
+Fix an issue that prevented `experimentalAutoDetectLongPolling` from working correctly.

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

@@ -22,7 +22,12 @@ import {
   WebChannel,
   WebChannelError,
   WebChannelOptions,
-  XhrIo
+  XhrIo,
+  getStatEventTarget,
+  EventTarget,
+  StatEvent,
+  Event,
+  Stat
 } from '@firebase/webchannel-wrapper';
 
 import {
@@ -164,6 +169,7 @@ export class WebChannelConnection extends RestConnection {
       '/channel'
     ];
     const webchannelTransport = createWebChannelTransport();
+    const requestStats = getStatEventTarget();
     const request: WebChannelOptions = {
       // Required for backend stickiness, routing behavior is based on this
       // parameter.
@@ -257,12 +263,13 @@ export class WebChannelConnection extends RestConnection {
     // Note that eventually this function could go away if we are confident
     // enough the code is exception free.
     const unguardedEventListen = <T>(
-      type: string,
-      fn: (param?: T) => void
+      target: EventTarget,
+      type: string | number,
+      fn: (param: T) => void
     ): void => {
       // TODO(dimond): closure typing seems broken because WebChannel does
       // not implement goog.events.Listenable
-      channel.listen(type, (param: unknown) => {
+      target.listen(type, (param: unknown) => {
         try {
           fn(param as T);
         } catch (e) {
@@ -273,21 +280,21 @@ export class WebChannelConnection extends RestConnection {
       });
     };
 
-    unguardedEventListen(WebChannel.EventType.OPEN, () => {
+    unguardedEventListen(channel, WebChannel.EventType.OPEN, () => {
       if (!closed) {
         logDebug(LOG_TAG, 'WebChannel transport opened.');
       }
     });
 
-    unguardedEventListen(WebChannel.EventType.CLOSE, () => {
+    unguardedEventListen(channel, WebChannel.EventType.CLOSE, () => {
       if (!closed) {
         closed = true;
         logDebug(LOG_TAG, 'WebChannel transport closed');
         streamBridge.callOnClose();
       }
     });
 
-    unguardedEventListen<Error>(WebChannel.EventType.ERROR, err => {
+    unguardedEventListen<Error>(channel, WebChannel.EventType.ERROR, err => {
       if (!closed) {
         closed = true;
         logWarn(LOG_TAG, 'WebChannel transport errored:', err);
@@ -308,10 +315,11 @@ export class WebChannelConnection extends RestConnection {
     }
 
     unguardedEventListen<WebChannelResponse>(
+      channel,
       WebChannel.EventType.MESSAGE,
       msg => {
         if (!closed) {
-          const msgData = msg!.data[0];
+          const msgData = msg.data[0];
           hardAssert(!!msgData, 'Got a webchannel message without data.');
           // TODO(b/35143891): There is a bug in One Platform that caused errors
           // (and only errors) to be wrapped in an extra array. To be forward
@@ -348,6 +356,14 @@ export class WebChannelConnection extends RestConnection {
       }
     );
 
+    unguardedEventListen<StatEvent>(requestStats, Event.STAT_EVENT, event => {
+      if (event.stat === Stat.PROXY) {
+        logDebug(LOG_TAG, 'Detected buffering proxy');
+      } else if (event.stat === Stat.NOPROXY) {
+        logDebug(LOG_TAG, 'Detected no buffering proxy');
+      }
+    });
+
     setTimeout(() => {
       // Technically we could/should wait for the WebChannel opened event,
       // but because we want to send the first message with the WebChannel

packages/webchannel-wrapper/externs/overrides.js

@@ -64,3 +64,16 @@ goog.net.WebChannel.Options.internalChannelParams;
 
 /** @type {boolean|undefined} */
 goog.net.WebChannel.Options.forceLongPolling;
+
+/** @type {boolean|undefined} */
+goog.net.WebChannel.Options.detectBufferingProxy;
+
+goog.labs.net.webChannel.requestStats.Event = {};
+goog.labs.net.webChannel.requestStats.Event.STAT_EVENT;
+
+goog.labs.net.webChannel.requestStats.StatEvent = {};
+goog.labs.net.webChannel.requestStats.StatEvent.stat;
+
+goog.labs.net.webChannel.requestStats.Stat = {};
+goog.labs.net.webChannel.requestStats.Stat.PROXY;
+goog.labs.net.webChannel.requestStats.Stat.NOPROXY;

packages/webchannel-wrapper/package.json

@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "google-closure-compiler": "20200628.0.0",
-    "google-closure-library": "20200830.0.0",
+    "google-closure-compiler": "20201102.0.1",
+    "google-closure-library": "20201006.0.0",
     "gulp": "4.0.2",
     "gulp-sourcemaps": "2.6.5",
     "rollup": "2.33.2",

packages/webchannel-wrapper/src/index.d.ts

@@ -31,6 +31,15 @@ export namespace WebChannel {
   };
 }
 
+export var Event: {
+  STAT_EVENT: string;
+};
+
+export var Stat: {
+  PROXY: number;
+  NOPROXY: number;
+};
+
 export var ErrorCode: {
   NO_ERROR: number;
   HTTP_ERROR: number;
@@ -100,15 +109,24 @@ export interface WebChannelOptions {
   requestRefreshThresholds?: { [key: string]: number };
 }
 
-export interface WebChannel {
+export interface EventTarget {
+  listen(type: string | number, cb: (param: unknown) => void): void;
+}
+
+export interface WebChannel extends EventTarget {
   open(): void;
   close(): void;
-  listen(type: string, cb: (param: unknown) => void): void;
   send(msg: unknown): void;
 }
 
+export interface StatEvent {
+  stat: number;
+}
+
 export interface WebChannelTransport {
   createWebChannel(url: string, options: WebChannelOptions): WebChannel;
 }
 
 export function createWebChannelTransport(): WebChannelTransport;
+
+export function getStatEventTarget(): EventTarget;

packages/webchannel-wrapper/src/index.js

@@ -23,7 +23,9 @@ goog.provide('firebase.webchannel.wrapper');
 
 // goog.net.WebChannelTransport
 goog.require('goog.net.createWebChannelTransport');
+goog.require('goog.labs.net.webChannel.requestStats');
 goog.require('goog.labs.net.webChannel.WebChannelBaseTransport');
+
 /**
  * NOTE: The `createWebChannel` function takes an options object as a second param
  * whose properties are typically mangled. We override these in externs/overrides.js
@@ -60,7 +62,6 @@ goog.net.WebChannel.EventType['MESSAGE'] =
 goog.events.EventTarget.prototype['listen'] =
   goog.events.EventTarget.prototype.listen;
 
-// goog.net.XhrIo
 goog.require('goog.net.XhrIo');
 goog.net.XhrIo.prototype['listenOnce'] = goog.net.XhrIo.prototype.listenOnce;
 goog.net.XhrIo.prototype['getLastError'] =
@@ -76,7 +77,11 @@ goog.net.XhrIo.prototype['send'] = goog.net.XhrIo.prototype.send;
 
 module['exports']['createWebChannelTransport'] =
   goog.net.createWebChannelTransport;
+module['exports']['getStatEventTarget'] =
+  goog.labs.net.webChannel.requestStats.getStatEventTarget;
 module['exports']['ErrorCode'] = goog.net.ErrorCode;
 module['exports']['EventType'] = goog.net.EventType;
+module['exports']['Event'] = goog.labs.net.webChannel.requestStats.Event;
+module['exports']['Stat'] = goog.labs.net.webChannel.requestStats.Stat;
 module['exports']['WebChannel'] = goog.net.WebChannel;
 module['exports']['XhrIo'] = goog.net.XhrIo;

yarn.lock

@@ -8137,50 +8137,45 @@ google-closure-compiler-java@^20200112.0.0:
   resolved "https://registry.npmjs.org/google-closure-compiler-java/-/google-closure-compiler-java-20200112.0.0.tgz#2b99f5e2869a573a1b35558ff3b6e6bc054a116f"
   integrity sha512-h/ExDCXAw88nOniQSbbK6et31kOwmaDxl6t52dnETCIzituQtGToPzy21vUel1o8o+FvWUybLoap+dEYBam1pA==
 
-google-closure-compiler-java@^20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler-java/-/google-closure-compiler-java-20200628.0.0.tgz#cb9138001acd7fb6195b1d0c2d3c6205a85389d1"
-  integrity sha512-ikQEHiuaRR8d3w4QWsJqC2baDfoIyw/KqDW7LXyxbq6WpRiJ+ItTAtShVoqzQTyn3IXVL8viUMGb/AxkUv01RA==
+google-closure-compiler-java@^20201102.0.1:
+  version "20201102.0.1"
+  resolved "https://registry.npmjs.org/google-closure-compiler-java/-/google-closure-compiler-java-20201102.0.1.tgz#15fa3e0701ee1a756168fdaf3b53fe61425b1b64"
+  integrity sha512-pXJIlyqepHhih0HCbShkAZJyViIxdyd4V7MnCUZEXLIIlygw92e2dC+5XiONDQZgRlF93BPmWCy9jr7wYoW1hQ==
 
 google-closure-compiler-js@^20200112.0.0:
   version "20200112.0.0"
   resolved "https://registry.npmjs.org/google-closure-compiler-js/-/google-closure-compiler-js-20200112.0.0.tgz#cb9fc1636671f3ce927e668e29db69b65cae6f2d"
   integrity sha512-xW47rSuiRaql6q1YN7+b3FXIW74b1nCcENVwm9cigw1H5gWoBMBJOmpZiXnjMfmYC+MALjPQ8giMzvSeP+2X5A==
 
-google-closure-compiler-js@^20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler-js/-/google-closure-compiler-js-20200628.0.0.tgz#476d50d8b5155dd9d923a1394e0af76bcc8905ec"
-  integrity sha512-kGO/fvKDNOawBmzpWEzLW2EMb0ikTc0Y1hZEedLOex/cOm9zc5Cn8w2L0f963ydgFcj4fszzIgAtmZ9CRxqkfg==
-
 google-closure-compiler-linux@^20200112.0.0:
   version "20200112.0.0"
   resolved "https://registry.npmjs.org/google-closure-compiler-linux/-/google-closure-compiler-linux-20200112.0.0.tgz#e6c7943cc0114046dbe9fc685e4d7d4eb536c1dc"
   integrity sha512-imTfdYP7BVTzzp3y7MuZP+98nEkbX7LZsZtxalNpl56vd+Ysc9/vOHXS14CdSoThaXIVlzX/lfjOlBRqPow+ew==
 
-google-closure-compiler-linux@^20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler-linux/-/google-closure-compiler-linux-20200628.0.0.tgz#25de6807f13f066a0329384b39c605f5b03484f2"
-  integrity sha512-SSglqHEW+PtHCOXPwhZFxFzRVxXdvyunkfwP0y2FAO2b0xF6lRfrZSgs0/lgkwlcO2RHnJtIhU8y4bzYMn24QQ==
+google-closure-compiler-linux@^20201102.0.1:
+  version "20201102.0.1"
+  resolved "https://registry.npmjs.org/google-closure-compiler-linux/-/google-closure-compiler-linux-20201102.0.1.tgz#a66f18142866c5d3186d0d0c0809538d38f7b998"
+  integrity sha512-aRbyTGnQoFXchcpEFNrP1p/WIvYOgN3hYKI+MOHWkvwVJBY2P8gpb07hAigO8fj+QKD/SFCl+2pXP+JniWOEqw==
 
 google-closure-compiler-osx@^20200112.0.0:
   version "20200112.0.0"
   resolved "https://registry.npmjs.org/google-closure-compiler-osx/-/google-closure-compiler-osx-20200112.0.0.tgz#df7a22c0dc32702b47c8ac4521f79bbe439effad"
   integrity sha512-E3S1KqZw4+Zov0VXCkjomPrYhyuuV6jH9InBchQ7cZfipFJjhQmSRf39u4Mu0sINW7GXfODZbzBwOXhEIquFQw==
 
-google-closure-compiler-osx@^20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler-osx/-/google-closure-compiler-osx-20200628.0.0.tgz#d4e8c0a0cfea1fcf935f7af0db46cdcebeabe308"
-  integrity sha512-Ntd/kYqjYu7CScvne0yscZGqQV19y7BCu5PXxGtcs9G5KLe7Ep9RxPWznvFGZXky5vPc6Yq9p6E2uOhpA20cIg==
+google-closure-compiler-osx@^20201102.0.1:
+  version "20201102.0.1"
+  resolved "https://registry.npmjs.org/google-closure-compiler-osx/-/google-closure-compiler-osx-20201102.0.1.tgz#5099b29a7db553ded849e06cbbce194ecf9cd231"
+  integrity sha512-VguqEAOYI6XYZN6JcLMP8fpsoXk1Z9YuntMjv0IDVydkbZaHYOI4zE39FJhMuWiN7gOzSX2b/BBC6GsSh1F3fw==
 
 google-closure-compiler-windows@^20200112.0.0:
   version "20200112.0.0"
   resolved "https://registry.npmjs.org/google-closure-compiler-windows/-/google-closure-compiler-windows-20200112.0.0.tgz#8300d1e651f2c84ed565e729ccf40d6ed7e63771"
   integrity sha512-+5+UJFKXH0LGnYEHSVJxWwhtvX/MI6uebkAQkhma0057QsKs8fOToWuHL8/UbJULB4WUPa3DlHy0+Izs5z6lCQ==
 
-google-closure-compiler-windows@^20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler-windows/-/google-closure-compiler-windows-20200628.0.0.tgz#6b175fd2e432576c86575248b4634c8c58e738a3"
-  integrity sha512-Il4NIhzvemgEk2kC33tDj9HVpqXEU8SmS1f3AmkLMAUbSI5FdBBzTqjLRa8Y/ucEz4nTRqvpTvbOG3vhIVUUWw==
+google-closure-compiler-windows@^20201102.0.1:
+  version "20201102.0.1"
+  resolved "https://registry.npmjs.org/google-closure-compiler-windows/-/google-closure-compiler-windows-20201102.0.1.tgz#8b6c5c3f7050a738b71c59f9dd9863fb6cca282a"
+  integrity sha512-LlynipQi/iP76mjkOu6Rc1mCRuxTAhRvLjq10aGfVjKwpbCAF0Jq2a5k2ygr4xYiINNi2/L2qUw6ObPm9wQCOw==
 
 google-closure-compiler@20200112.0.0:
   version "20200112.0.0"
@@ -8198,27 +8193,31 @@ google-closure-compiler@20200112.0.0:
     google-closure-compiler-osx "^20200112.0.0"
     google-closure-compiler-windows "^20200112.0.0"
 
-google-closure-compiler@20200628.0.0:
-  version "20200628.0.0"
-  resolved "https://registry.npmjs.org/google-closure-compiler/-/google-closure-compiler-20200628.0.0.tgz#939e8be9b27fb4504d051263ef0b96d75e444a57"
-  integrity sha512-ZMhFmlzNCWdL43UbTHzdFa4fgAfBR37TbAOKLSLUATT3RvCNu0AvX0rQBuJNzmI21ySsM9T3r5WXPBwiL0Hn4g==
+google-closure-compiler@20201102.0.1:
+  version "20201102.0.1"
+  resolved "https://registry.npmjs.org/google-closure-compiler/-/google-closure-compiler-20201102.0.1.tgz#372670b1b047969d12de663698593e31944ad1bf"
+  integrity sha512-Cz+1jOswH0MwMVPu1rRH1xD4KYuY5XW2ox5aXwqaAxevqmirhr36f8wgKPHuVRSovFejW640r6UFwyrOT6U0CA==
   dependencies:
     chalk "2.x"
-    google-closure-compiler-java "^20200628.0.0"
-    google-closure-compiler-js "^20200628.0.0"
+    google-closure-compiler-java "^20201102.0.1"
     minimist "1.x"
     vinyl "2.x"
     vinyl-sourcemaps-apply "^0.2.0"
   optionalDependencies:
-    google-closure-compiler-linux "^20200628.0.0"
-    google-closure-compiler-osx "^20200628.0.0"
-    google-closure-compiler-windows "^20200628.0.0"
+    google-closure-compiler-linux "^20201102.0.1"
+    google-closure-compiler-osx "^20201102.0.1"
+    google-closure-compiler-windows "^20201102.0.1"
 
 google-closure-library@20200830.0.0:
   version "20200830.0.0"
   resolved "https://registry.npmjs.org/google-closure-library/-/google-closure-library-20200830.0.0.tgz#9f3807e5a4af55ebf2c8a22853d53b8da39a48e8"
   integrity sha512-s4ma73K+FTeVywSMjVOxQ435t6kPfSlxEtIflq7Gabp2fxAnc9i8vUpvT8ZP/GH89LwSJReIaBGtrn72rfNC5Q==
 
+google-closure-library@20201006.0.0:
+  version "20201006.0.0"
+  resolved "https://registry.npmjs.org/google-closure-library/-/google-closure-library-20201006.0.0.tgz#5b2f325309566a63b97e22e57c71263fa98f22b4"
+  integrity sha512-jYTKvUBUkTFCO+PJLcqJrh4BNMHlInzPYpijg8lty/HIF1rH+qutHchlFdiSNad8HBVKIlMf3UzXRPXvmujrIg==
+
 google-gax@^1.14.2:
   version "1.15.3"
   resolved "https://registry.npmjs.org/google-gax/-/google-gax-1.15.3.tgz#e88cdcbbd19c7d88cc5fd7d7b932c4d1979a5aca"