Renamed function

Author: maneesht

common/api-review/util.api.md

@@ -398,6 +398,9 @@ export function ordinal(i: number): string;
 // @public (undocumented)
 export type PartialObserver<T> = Partial<Observer<T>>;
 
+// @public
+export function pingServer(endpoint: string): Promise<boolean>;
+
 // Warning: (ae-internal-missing-underscore) The name "promiseWithTimeout" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
@@ -474,11 +477,6 @@ export interface Subscribe<T> {
     (observer: PartialObserver<T>): Unsubscribe;
 }
 
-// Warning: (ae-missing-release-tag) "testConnectionAlive" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export function testConnectionAlive(endpoint: string): Promise<boolean>;
-
 // Warning: (ae-missing-release-tag) "Unsubscribe" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

packages/auth/src/core/auth/emulator.ts

@@ -18,11 +18,7 @@ import { Auth } from '../../model/public_types';
 import { AuthErrorCode } from '../errors';
 import { _assert } from '../util/assert';
 import { _castAuth } from './auth_impl';
-import {
-  deepEqual,
-  isCloudWorkstation,
-  testConnectionAlive
-} from '@firebase/util';
+import { deepEqual, isCloudWorkstation, pingServer } from '@firebase/util';
 
 /**
  * Changes the {@link Auth} instance to communicate with the Firebase Auth Emulator, instead of production
@@ -107,7 +103,7 @@ export function connectAuthEmulator(
 
   if (isCloudWorkstation(host)) {
     // Workaround to get cookies in Firebase Studio
-    void testConnectionAlive(`${protocol}//${host}:${port}`);
+    void pingServer(`${protocol}//${host}:${port}`);
   }
 }
 

packages/data-connect/src/api/DataConnect.ts

@@ -24,7 +24,7 @@ import {
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
-import { isCloudWorkstation, testConnectionAlive } from '@firebase/util';
+import { isCloudWorkstation, pingServer } from '@firebase/util';
 
 import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
 import { Code, DataConnectError } from '../core/error';
@@ -239,7 +239,7 @@ export function connectDataConnectEmulator(
   sslEnabled = false
 ): void {
   if (isCloudWorkstation(host)) {
-    void testConnectionAlive(`https://${host}${port ? `:${port}` : ''}`);
+    void pingServer(`https://${host}${port ? `:${port}` : ''}`);
   }
   dc.enableEmulator({ host, port, sslEnabled });
 }

packages/firestore/src/lite-api/database.ts

@@ -28,7 +28,7 @@ import {
   EmulatorMockTokenOptions,
   getDefaultEmulatorHostnameAndPort,
   isCloudWorkstation,
-  testConnectionAlive
+  pingServer
 } from '@firebase/util';
 
 import {
@@ -335,7 +335,7 @@ export function connectFirestoreEmulator(
   };
   const newHostSetting = `${host}:${port}`;
   if (useSsl) {
-    void testConnectionAlive(`https://${newHostSetting}`);
+    void pingServer(`https://${newHostSetting}`);
   }
   if (settings.host !== DEFAULT_HOST && settings.host !== newHostSetting) {
     logWarn(

packages/functions/src/service.ts

@@ -30,7 +30,7 @@ import { Provider } from '@firebase/component';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { MessagingInternalComponentName } from '@firebase/messaging-interop-types';
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
-import { isCloudWorkstation, testConnectionAlive } from '@firebase/util';
+import { isCloudWorkstation, pingServer } from '@firebase/util';
 
 export const DEFAULT_REGION = 'us-central1';
 
@@ -180,7 +180,7 @@ export function connectFunctionsEmulator(
     useSsl ? 's' : ''
   }://${host}:${port}`;
   if (useSsl) {
-    void testConnectionAlive(functionsInstance.emulatorOrigin);
+    void pingServer(functionsInstance.emulatorOrigin);
   }
 }
 

packages/storage/src/service.ts

@@ -46,7 +46,7 @@ import {
   createMockUserToken,
   EmulatorMockTokenOptions,
   isCloudWorkstation,
-  testConnectionAlive
+  pingServer
 } from '@firebase/util';
 import { Connection, ConnectionType } from './implementation/connection';
 
@@ -148,7 +148,7 @@ export function connectStorageEmulator(
   storage.host = `${host}:${port}`;
   const useSsl = isCloudWorkstation(host);
   if (useSsl) {
-    void testConnectionAlive(`https://${storage.host}`);
+    void pingServer(`https://${storage.host}`);
   }
   storage._isUsingEmulator = true;
   storage._protocol = useSsl ? 'https' : 'http';

packages/util/src/url.ts

@@ -23,7 +23,12 @@ export function isCloudWorkstation(host: string): boolean {
   return host.endsWith('.cloudworkstations.dev');
 }
 
-export async function testConnectionAlive(endpoint: string): Promise<boolean> {
+/**
+ * Makes a fetch request to the given server.
+ * Mostly used for forwarding cookies in Firebase Studio.
+ * @public
+ */
+export async function pingServer(endpoint: string): Promise<boolean> {
   const result = await fetch(endpoint, {
     credentials: 'include'
   });