Merge pull request #1925 from ably/fix-fetch-disable-connectivity-check

Fix web FetchRequest does not respect `disableConnectivityCheck` client option
ably · Jan 23, 2025 · f8047f6 · f8047f6
2 parents 18ed0f6 + 5cdeddc
commit f8047f6
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 13 deletions.
diff --git a/src/platform/web/lib/http/http.ts b/src/platform/web/lib/http/http.ts
@@ -117,18 +117,25 @@ const Http = class {
       this.Request = async (method, uri, headers, params, body) => {
         return fetchRequestImplementation(method, client ?? null, uri, headers, params, body);
       };
-      this.checkConnectivity = async function () {
-        Logger.logAction(
-          this.logger,
-          Logger.LOG_MICRO,
-          '(Fetch)Http.checkConnectivity()',
-          'Sending; ' + connectivityCheckUrl,
-        );
-        const requestResult = await this.doUri(HttpMethods.Get, connectivityCheckUrl, null, null, null);
-        const result = !requestResult.error && (requestResult.body as string)?.replace(/\n/, '') == 'yes';
-        Logger.logAction(this.logger, Logger.LOG_MICRO, '(Fetch)Http.checkConnectivity()', 'Result: ' + result);
-        return result;
-      };
+
+      if (client?.options.disableConnectivityCheck) {
+        this.checkConnectivity = async function () {
+          return true;
+        };
+      } else {
+        this.checkConnectivity = async function () {
+          Logger.logAction(
+            this.logger,
+            Logger.LOG_MICRO,
+            '(Fetch)Http.checkConnectivity()',
+            'Sending; ' + connectivityCheckUrl,
+          );
+          const requestResult = await this.doUri(HttpMethods.Get, connectivityCheckUrl, null, null, null);
+          const result = !requestResult.error && (requestResult.body as string)?.replace(/\n/, '') == 'yes';
+          Logger.logAction(this.logger, Logger.LOG_MICRO, '(Fetch)Http.checkConnectivity()', 'Result: ' + result);
+          return result;
+        };
+      }
     } else {
       this.Request = async () => {
         const error = hasImplementation

diff --git a/test/browser/connection.test.js b/test/browser/connection.test.js
@@ -1,6 +1,6 @@
 'use strict';
 
-define(['shared_helper', 'chai'], function (Helper, chai) {
+define(['ably', 'shared_helper', 'chai'], function (Ably, Helper, chai) {
   var { expect, assert } = chai;
   var transportPreferenceName = 'ably-transport-preference';
 
@@ -453,6 +453,62 @@ define(['shared_helper', 'chai'], function (Helper, chai) {
         }
         this.test.helper.closeAndFinish(done, realtime);
       });
+
+      // this is identical to disable_connectivity_check test in connectivity, but here we specifically test browser supported request implementations
+      for (const scenario of [
+        {
+          description: 'XHR request disable connectivity check',
+          ctx: { initialFetchSupported: Ably.Rest.Platform.Config.fetchSupported },
+          before: (ctx) => {
+            Ably.Rest.Platform.Config.fetchSupported = false;
+          },
+          after: (ctx) => {
+            Ably.Rest.Platform.Config.fetchSupported = ctx.initialFetchSupported;
+          },
+        },
+        {
+          description: 'Fetch request disable connectivity check',
+          ctx: { initialXhrSupported: Ably.Rest.Platform.Config.xhrSupported },
+          before: (ctx) => {
+            Ably.Rest.Platform.Config.xhrSupported = false;
+          },
+          after: (ctx) => {
+            Ably.Rest.Platform.Config.xhrSupported = ctx.initialXhrSupported;
+          },
+        },
+      ]) {
+        /** @nospec */
+        it(scenario.description, async function () {
+          const helper = this.test.helper;
+          scenario.before(scenario.ctx);
+          let thrownError = null;
+          let res = null;
+
+          try {
+            helper.recordPrivateApi('pass.clientOption.connectivityCheckUrl');
+            helper.recordPrivateApi('pass.clientOption.disableConnectivityCheck');
+            const options = {
+              connectivityCheckUrl: helper.unroutableHost,
+              disableConnectivityCheck: true,
+              autoConnect: false,
+            };
+
+            helper.recordPrivateApi('call.http.checkConnectivity');
+            res = await helper.AblyRealtime(options).http.checkConnectivity();
+          } catch (error) {
+            thrownError = error;
+          } finally {
+            scenario.after(scenario.ctx);
+          }
+
+          expect(
+            res && !thrownError,
+            'Connectivity check completed ' +
+              (thrownError &&
+                (helper.recordPrivateApi('call.Utils.inspectError'), helper.Utils.inspectError(thrownError))),
+          ).to.be.ok;
+        });
+      }
     });
   }
 });