Maked DynamicHeaderProvider an internal interface and addresses other comments on PR

mghaznav · mghaznav · commit 4d071b54c1dd · 2025-10-10T15:51:45.000Z
diff --git a/common/api-review/telemetry-react.api.md b/common/api-review/telemetry-react.api.md
@@ -8,11 +8,6 @@ import { FirebaseApp } from '@firebase/app';
 import { FirebaseOptions } from '@firebase/app';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
-// @public
-export interface DynamicHeaderProvider {
-    getHeader(): Promise<Record<string, string> | null>;
-}
-
 // @public
 export function FirebaseTelemetry({ firebaseOptions, telemetryOptions }: {
     firebaseOptions?: FirebaseOptions;
diff --git a/common/api-review/telemetry.api.md b/common/api-review/telemetry.api.md
@@ -12,11 +12,6 @@ import { LoggerProvider } from '@opentelemetry/sdk-logs';
 // @public
 export function captureError(telemetry: Telemetry, error: unknown, attributes?: AnyValueMap): void;
 
-// @public
-export interface DynamicHeaderProvider {
-    getHeader(): Promise<Record<string, string> | null>;
-}
-
 // @public
 export function flush(telemetry: Telemetry): Promise<void>;
 
diff --git a/docs-devsite/_toc.yaml b/docs-devsite/_toc.yaml
@@ -697,17 +697,13 @@ toc:
 - title: telemetry
   path: /docs/reference/js/telemetry_.md
   section:
-  - title: DynamicHeaderProvider
-    path: /docs/reference/js/telemetry_.dynamicheaderprovider.md
   - title: Telemetry
     path: /docs/reference/js/telemetry_.telemetry.md
   - title: TelemetryOptions
     path: /docs/reference/js/telemetry_.telemetryoptions.md
 - title: telemetry/react
   path: /docs/reference/js/telemetry_react.md
   section:
-  - title: DynamicHeaderProvider
-    path: /docs/reference/js/telemetry_react.dynamicheaderprovider.md
   - title: Telemetry
     path: /docs/reference/js/telemetry_react.telemetry.md
   - title: TelemetryOptions
diff --git a/docs-devsite/telemetry_.dynamicheaderprovider.md b/docs-devsite/telemetry_.dynamicheaderprovider.md
diff --git a/docs-devsite/telemetry_.md b/docs-devsite/telemetry_.md
@@ -27,7 +27,6 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [DynamicHeaderProvider](./telemetry_.dynamicheaderprovider.md#dynamicheaderprovider_interface) | An interface for classes that provide dynamic headers.<!-- -->Classes that implement this interface can be used to supply custom headers for logging. |
 |  [Telemetry](./telemetry_.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
 |  [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) | Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
 
diff --git a/docs-devsite/telemetry_react.dynamicheaderprovider.md b/docs-devsite/telemetry_react.dynamicheaderprovider.md
diff --git a/docs-devsite/telemetry_react.md b/docs-devsite/telemetry_react.md
@@ -21,7 +21,6 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Interface | Description |
 |  --- | --- |
-|  [DynamicHeaderProvider](./telemetry_react.dynamicheaderprovider.md#dynamicheaderprovider_interface) | An interface for classes that provide dynamic headers.<!-- -->Classes that implement this interface can be used to supply custom headers for logging. |
 |  [Telemetry](./telemetry_react.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
 |  [TelemetryOptions](./telemetry_react.telemetryoptions.md#telemetryoptions_interface) | Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
 
diff --git a/packages/telemetry/src/logging/appcheck-provider.ts b/packages/telemetry/src/logging/appcheck-provider.ts
@@ -15,13 +15,18 @@
  * limitations under the License.
  */
 
-import { DynamicHeaderProvider } from '../public-types';
+import { DynamicHeaderProvider } from '../types';
 import { Provider } from '@firebase/component';
 import {
   FirebaseAppCheckInternal,
   AppCheckInternalComponentName
 } from '@firebase/app-check-interop-types';
 
+/**
+ * An implementation of DynamicHeaderProvider that can be used to provide App Check token headers.
+ *
+ * @internal
+ */
 export class AppCheckProvider implements DynamicHeaderProvider {
   appCheck: FirebaseAppCheckInternal | null;
 
@@ -41,11 +46,12 @@ export class AppCheckProvider implements DynamicHeaderProvider {
     }
 
     const appCheckToken = await this.appCheck.getToken();
-    // If the error field is defined, the token field will be populated with a dummy token
+    // The error field must be checked as when there is an error, the token field is populated with
+    // a dummy error.
     if (!appCheckToken || !!appCheckToken.error) {
       return null;
     }
 
-    return {'X-Firebase-AppCheck': appCheckToken.token};
+    return { 'X-Firebase-AppCheck': appCheckToken.token };
   }
-}
+}
diff --git a/packages/telemetry/src/logging/fetch-transport.test.ts b/packages/telemetry/src/logging/fetch-transport.test.ts
@@ -20,8 +20,8 @@
 
 import * as sinon from 'sinon';
 import * as assert from 'assert';
-import { DynamicHeaderProvider } from '../public-types';
-import { FetchTransportEdge } from './fetch-transport.edge';
+import { DynamicHeaderProvider } from '../types';
+import { FetchTransport } from './fetch-transport';
 import {
   ExportResponseRetryable,
   ExportResponseFailure,
@@ -40,7 +40,7 @@ const testTransportParameters = {
 const requestTimeout = 1000;
 const testPayload = Uint8Array.from([1, 2, 3]);
 
-describe('FetchTransportEdge', () => {
+describe('FetchTransport', () => {
   afterEach(() => {
     sinon.restore();
   });
@@ -51,7 +51,7 @@ describe('FetchTransportEdge', () => {
       const fetchStub = sinon
         .stub(globalThis, 'fetch')
         .resolves(new Response('test response', { status: 200 }));
-      const transport = new FetchTransportEdge(testTransportParameters);
+      const transport = new FetchTransport(testTransportParameters);
 
       //act
       transport.send(testPayload, requestTimeout).then(response => {
@@ -88,7 +88,7 @@ describe('FetchTransportEdge', () => {
       sinon
         .stub(globalThis, 'fetch')
         .resolves(new Response('', { status: 404 }));
-      const transport = new FetchTransportEdge(testTransportParameters);
+      const transport = new FetchTransport(testTransportParameters);
 
       //act
       transport.send(testPayload, requestTimeout).then(response => {
@@ -109,7 +109,7 @@ describe('FetchTransportEdge', () => {
         .resolves(
           new Response('', { status: 503, headers: { 'Retry-After': '5' } })
         );
-      const transport = new FetchTransportEdge(testTransportParameters);
+      const transport = new FetchTransport(testTransportParameters);
 
       //act
       transport.send(testPayload, requestTimeout).then(response => {
@@ -133,7 +133,7 @@ describe('FetchTransportEdge', () => {
       abortError.name = 'AbortError';
       sinon.stub(globalThis, 'fetch').rejects(abortError);
       const clock = sinon.useFakeTimers();
-      const transport = new FetchTransportEdge(testTransportParameters);
+      const transport = new FetchTransport(testTransportParameters);
 
       //act
       transport.send(testPayload, requestTimeout).then(response => {
@@ -156,7 +156,7 @@ describe('FetchTransportEdge', () => {
       // arrange
       sinon.stub(globalThis, 'fetch').throws(new Error('fetch failed'));
       const clock = sinon.useFakeTimers();
-      const transport = new FetchTransportEdge(testTransportParameters);
+      const transport = new FetchTransport(testTransportParameters);
 
       //act
       transport.send(testPayload, requestTimeout).then(response => {
@@ -185,7 +185,7 @@ describe('FetchTransportEdge', () => {
         getHeader: sinon.stub().resolves({ 'dynamic-header': 'dynamic-value' })
       };
 
-      const transport = new FetchTransportEdge({
+      const transport = new FetchTransport({
         ...testTransportParameters,
         dynamicHeaders: [dynamicProvider]
       });
@@ -226,7 +226,7 @@ describe('FetchTransportEdge', () => {
         getHeader: sinon.stub().resolves(null)
       };
 
-      const transport = new FetchTransportEdge({
+      const transport = new FetchTransport({
         ...testTransportParameters,
         dynamicHeaders: [dynamicProvider]
       });
diff --git a/packages/telemetry/src/logging/fetch-transport.ts b/packages/telemetry/src/logging/fetch-transport.ts
@@ -23,7 +23,7 @@ import {
   ExportResponse
 } from '@opentelemetry/otlp-exporter-base';
 import { diag } from '@opentelemetry/api';
-import { DynamicHeaderProvider } from '../public-types';
+import { DynamicHeaderProvider } from '../types';
 
 function isExportRetryable(statusCode: number): boolean {
   const retryCodes = [429, 502, 503, 504];
@@ -58,11 +58,11 @@ export interface FetchTransportParameters {
 }
 
 /**
- * An implementation of IExporterTransport that can be used in the Edge Runtime.
+ * An implementation of IExporterTransport.
  *
  * @internal
  */
-export class FetchTransportEdge implements IExporterTransport {
+export class FetchTransport implements IExporterTransport {
   constructor(private parameters: FetchTransportParameters) {}
 
   async send(data: Uint8Array, timeoutMillis: number): Promise<ExportResponse> {
diff --git a/packages/telemetry/src/logging/logger-provider.ts b/packages/telemetry/src/logging/logger-provider.ts
@@ -29,8 +29,8 @@ import {
   OTLPExporterBase,
   createOtlpNetworkExportDelegate
 } from '@opentelemetry/otlp-exporter-base';
-import { FetchTransportEdge } from './fetch-transport.edge';
-import { DynamicHeaderProvider } from '../public-types';
+import { FetchTransport } from './fetch-transport';
+import { DynamicHeaderProvider } from '../types';
 
 /**
  * Create a logger provider for the current execution environment.
@@ -60,7 +60,7 @@ export function createLoggerProvider(
   });
 }
 
-/** OTLP exporter that uses custom FetchTransportEdge. */
+/** OTLP exporter that uses custom FetchTransport. */
 class OTLPLogExporter
   extends OTLPExporterBase<ReadableLogRecord[]>
   implements LogRecordExporter
@@ -77,7 +77,7 @@ class OTLPLogExporter
           compression: 'none'
         },
         JsonLogsSerializer,
-        new FetchTransportEdge({
+        new FetchTransport({
           url: config.url!,
           headers: () => ({
             'Content-Type': 'application/json'
diff --git a/packages/telemetry/src/public-types.ts b/packages/telemetry/src/public-types.ts
@@ -47,20 +47,3 @@ export interface TelemetryOptions {
    */
   endpointUrl?: string;
 }
-
-/**
- * An interface for classes that provide dynamic headers.
- *
- * Classes that implement this interface can be used to supply custom headers for logging.
- *
- * @public
- */
-export interface DynamicHeaderProvider {
-  /**
-   * Returns a record of headers to be added to a request.
-   *
-   * @returns A {@link Promise} that resolves to a {@link Record<string, string>} of header
-   * key-value pairs, or null if no headers are to be added.
-   */
-  getHeader(): Promise<Record<string, string> | null>;
-}
diff --git a/packages/telemetry/src/types.ts b/packages/telemetry/src/types.ts
@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * An interface for classes that provide dynamic headers.
+ *
+ * Classes that implement this interface can be used to supply custom headers for logging.
+ *
+ * @internal
+ */
+export interface DynamicHeaderProvider {
+  /**
+   * Returns a record of headers to be added to a request.
+   *
+   * @returns A {@link Promise} that resolves to a {@link Record<string, string>} of header
+   * key-value pairs, or null if no headers are to be added.
+   */
+  getHeader(): Promise<Record<string, string> | null>;
+}
