refactor: remove usage of any for networkDetails; (#7458)

* refactor: remove usage of any for networkDetails;

* chore: use new Response in unit tests;

Author: ondreian

api-extractor/report/hls.js.api.md

@@ -99,8 +99,10 @@ export interface AssetListLoadedData {
     assetListResponse: AssetListJSON;
     // (undocumented)
     event: InterstitialEventWithAssetList;
+    // Warning: (ae-forgotten-export) The symbol "NullableNetworkDetails" needs to be exported by the entry point hls.d.ts
+    //
     // (undocumented)
-    networkDetails: any;
+    networkDetails: NullableNetworkDetails;
 }
 
 // Warning: (ae-missing-release-tag) "AssetListLoadingData" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -1269,7 +1271,7 @@ export interface ErrorData {
     // (undocumented)
     mimeType?: string;
     // (undocumented)
-    networkDetails?: any;
+    networkDetails?: NullableNetworkDetails;
     // (undocumented)
     parent?: PlaylistLevelType;
     // (undocumented)
@@ -1717,7 +1719,7 @@ export interface FragLoadedData {
     // (undocumented)
     frag: Fragment;
     // (undocumented)
-    networkDetails: unknown;
+    networkDetails: NullableNetworkDetails;
     // (undocumented)
     part: Part | null;
     // (undocumented)
@@ -1743,7 +1745,7 @@ export interface FragLoadFailResult extends ErrorData {
     // (undocumented)
     frag: Fragment;
     // (undocumented)
-    networkDetails: any;
+    networkDetails: NullableNetworkDetails;
     // (undocumented)
     part?: Part;
     // (undocumented)
@@ -2990,7 +2992,7 @@ export class KeyLoader extends Logger implements ComponentAPI {
     // (undocumented)
     abort(type?: PlaylistLevelType): void;
     // (undocumented)
-    createKeyLoadError(frag: Fragment, details: ErrorDetails | undefined, error: Error, networkDetails?: any, response?: {
+    createKeyLoadError(frag: Fragment, details: ErrorDetails | undefined, error: Error, networkDetails?: NullableNetworkDetails, response?: {
         url: string;
         data: undefined;
         code: number;
@@ -3397,7 +3399,7 @@ export interface LevelLoadedData {
     // (undocumented)
     levelInfo: Level;
     // (undocumented)
-    networkDetails: any;
+    networkDetails: NullableNetworkDetails;
     // (undocumented)
     stats: LoaderStats;
     // (undocumented)
@@ -3639,30 +3641,30 @@ export interface LoaderContext {
 // Warning: (ae-missing-release-tag) "LoaderOnAbort" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type LoaderOnAbort<T extends LoaderContext> = (stats: LoaderStats, context: T, networkDetails: any) => void;
+export type LoaderOnAbort<T extends LoaderContext> = (stats: LoaderStats, context: T, networkDetails: NullableNetworkDetails) => void;
 
 // Warning: (ae-missing-release-tag) "LoaderOnError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export type LoaderOnError<T extends LoaderContext> = (error: {
     code: number;
     text: string;
-}, context: T, networkDetails: any, stats: LoaderStats) => void;
+}, context: T, networkDetails: NullableNetworkDetails, stats: LoaderStats) => void;
 
 // Warning: (ae-missing-release-tag) "LoaderOnProgress" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type LoaderOnProgress<T extends LoaderContext> = (stats: LoaderStats, context: T, data: string | ArrayBuffer, networkDetails: any) => void;
+export type LoaderOnProgress<T extends LoaderContext> = (stats: LoaderStats, context: T, data: string | ArrayBuffer, networkDetails: NullableNetworkDetails) => void;
 
 // Warning: (ae-missing-release-tag) "LoaderOnSuccess" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type LoaderOnSuccess<T extends LoaderContext> = (response: LoaderResponse, stats: LoaderStats, context: T, networkDetails: any) => void;
+export type LoaderOnSuccess<T extends LoaderContext> = (response: LoaderResponse, stats: LoaderStats, context: T, networkDetails: NullableNetworkDetails) => void;
 
 // Warning: (ae-missing-release-tag) "LoaderOnTimeout" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type LoaderOnTimeout<T extends LoaderContext> = (stats: LoaderStats, context: T, networkDetails: any) => void;
+export type LoaderOnTimeout<T extends LoaderContext> = (stats: LoaderStats, context: T, networkDetails: NullableNetworkDetails) => void;
 
 // Warning: (ae-missing-release-tag) "LoaderResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -3811,7 +3813,7 @@ export interface ManifestLoadedData {
     // (undocumented)
     levels: LevelParsed[];
     // (undocumented)
-    networkDetails: any;
+    networkDetails: NullableNetworkDetails;
     // (undocumented)
     sessionData: Record<string, AttrList> | null;
     // (undocumented)
@@ -4840,7 +4842,7 @@ export interface TrackLoadedData {
     // (undocumented)
     id: number;
     // (undocumented)
-    networkDetails: any;
+    networkDetails: NullableNetworkDetails;
     // (undocumented)
     stats: LoaderStats;
     // (undocumented)

src/controller/content-steering-controller.ts

@@ -25,6 +25,7 @@ import type {
   SteeringManifestLoadedData,
 } from '../types/events';
 import type { MediaAttributes, MediaPlaylist } from '../types/media-playlist';
+import type { NullableNetworkDetails } from '../types/network-details';
 
 export type SteeringManifest = {
   VERSION: 1;
@@ -456,7 +457,7 @@ export default class ContentSteeringController
         response: LoaderResponse,
         stats: LoaderStats,
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
       ) => {
         this.log(`Loaded steering manifest: "${url}"`);
         const steeringData = response.data as SteeringManifest;
@@ -501,7 +502,7 @@ export default class ContentSteeringController
       onError: (
         error: { code: number; text: string },
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
         stats: LoaderStats,
       ) => {
         this.log(
@@ -531,7 +532,7 @@ export default class ContentSteeringController
       onTimeout: (
         stats: LoaderStats,
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
       ) => {
         this.log(`Timeout loading steering manifest (${context.url})`);
         this.scheduleRefresh(this.uri || context.url);

src/loader/fragment-loader.ts

@@ -13,6 +13,7 @@ import type {
   LoaderCallbacks,
   LoaderConfiguration,
 } from '../types/loader';
+import type { NullableNetworkDetails } from '../types/network-details';
 
 const MIN_CHUNK_SIZE = Math.pow(2, 17); // 128kb
 
@@ -394,7 +395,7 @@ export interface FragLoadFailResult extends ErrorData {
     text: string;
     url: string;
   };
-  networkDetails: any;
+  networkDetails: NullableNetworkDetails;
 }
 
 export type FragmentLoadProgressCallback = (

src/loader/interstitial-asset-list.ts

@@ -16,6 +16,7 @@ import type {
   LoaderResponse,
   LoaderStats,
 } from '../types/loader';
+import type { NullableNetworkDetails } from '../types/network-details';
 
 export class AssetListLoader {
   private hls: Hls;
@@ -74,7 +75,7 @@ export class AssetListLoader {
         response: LoaderResponse,
         stats: LoaderStats,
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
       ) => {
         const assetListResponse = response.data as AssetListJSON;
         const assets = assetListResponse?.ASSETS;
@@ -100,7 +101,7 @@ export class AssetListLoader {
       onError: (
         error: { code: number; text: string },
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
         stats: LoaderStats,
       ) => {
         const errorData = this.assignAssetListError(
@@ -118,7 +119,7 @@ export class AssetListLoader {
       onTimeout: (
         stats: LoaderStats,
         context: LoaderContext,
-        networkDetails: any,
+        networkDetails: NullableNetworkDetails,
       ) => {
         const errorData = this.assignAssetListError(
           interstitial,
@@ -144,7 +145,7 @@ export class AssetListLoader {
     error: Error,
     url: string,
     stats?: LoaderStats,
-    networkDetails?: any,
+    networkDetails?: NullableNetworkDetails,
   ): ErrorData {
     interstitial.error = error;
     return {

src/loader/key-loader.ts

@@ -22,6 +22,7 @@ import type {
   LoaderStats,
   PlaylistLevelType,
 } from '../types/loader';
+import type { NullableNetworkDetails } from '../types/network-details';
 import type { ILogger } from '../utils/logger';
 import type { KeySystemFormats } from '../utils/mediakeys-helper';
 
@@ -81,7 +82,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
     frag: Fragment,
     details: ErrorDetails = ErrorDetails.KEY_LOAD_ERROR,
     error: Error,
-    networkDetails?: any,
+    networkDetails?: NullableNetworkDetails,
     response?: { url: string; data: undefined; code: number; text: string },
   ): LoadError {
     return new LoadError({
@@ -91,7 +92,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
       frag,
       response,
       error,
-      networkDetails,
+      networkDetails: networkDetails || null,
     });
   }
 
@@ -304,7 +305,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
           response: LoaderResponse,
           stats: LoaderStats,
           context: KeyLoaderContext,
-          networkDetails: any,
+          networkDetails: NullableNetworkDetails,
         ) => {
           const { frag, keyInfo, url: uri } = context;
           const id = getKeyId(keyInfo.decryptdata) || uri;
@@ -332,7 +333,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
         onError: (
           response: { code: number; text: string },
           context: KeyLoaderContext,
-          networkDetails: any,
+          networkDetails: NullableNetworkDetails,
           stats: LoaderStats,
         ) => {
           this.resetLoader(context);
@@ -352,7 +353,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
         onTimeout: (
           stats: LoaderStats,
           context: KeyLoaderContext,
-          networkDetails: any,
+          networkDetails: NullableNetworkDetails,
         ) => {
           this.resetLoader(context);
           reject(
@@ -368,7 +369,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
         onAbort: (
           stats: LoaderStats,
           context: KeyLoaderContext,
-          networkDetails: any,
+          networkDetails: NullableNetworkDetails,
         ) => {
           this.resetLoader(context);
           reject(

src/loader/playlist-loader.ts

@@ -34,6 +34,7 @@ import type {
   PlaylistLoaderContext,
 } from '../types/loader';
 import type { MediaAttributes, MediaPlaylist } from '../types/media-playlist';
+import type { NullableNetworkDetails } from '../types/network-details';
 
 function mapContextToLevelType(
   context: PlaylistLoaderContext,
@@ -413,7 +414,7 @@ class PlaylistLoader implements NetworkComponentAPI {
     response: LoaderResponse,
     stats: LoaderStats,
     context: PlaylistLoaderContext,
-    networkDetails: any,
+    networkDetails: NullableNetworkDetails,
   ): void {
     const hls = this.hls;
     const string = response.data as string;
@@ -503,7 +504,7 @@ class PlaylistLoader implements NetworkComponentAPI {
     response: LoaderResponse,
     stats: LoaderStats,
     context: PlaylistLoaderContext,
-    networkDetails: any,
+    networkDetails: NullableNetworkDetails,
     loader: Loader<PlaylistLoaderContext> | undefined,
   ): void {
     const hls = this.hls;
@@ -574,7 +575,7 @@ class PlaylistLoader implements NetworkComponentAPI {
     response: LoaderResponse,
     context: PlaylistLoaderContext,
     error: Error,
-    networkDetails: any,
+    networkDetails: NullableNetworkDetails,
     stats: LoaderStats,
   ): void {
     this.hls.trigger(Events.ERROR, {
@@ -594,7 +595,7 @@ class PlaylistLoader implements NetworkComponentAPI {
 
   private handleNetworkError(
     context: PlaylistLoaderContext,
-    networkDetails: any,
+    networkDetails: NullableNetworkDetails,
     timeout = false,
     response: { code: number; text: string } | undefined,
     stats: LoaderStats,
@@ -663,7 +664,10 @@ class PlaylistLoader implements NetworkComponentAPI {
     };
 
     if (response) {
-      const url = networkDetails?.url || context.url;
+      let url = context.url;
+      if (networkDetails && 'url' in networkDetails) {
+        url = networkDetails.url;
+      }
       errorData.response = { url, data: undefined as any, ...response };
     }
 
@@ -675,7 +679,7 @@ class PlaylistLoader implements NetworkComponentAPI {
     response: LoaderResponse,
     stats: LoaderStats,
     context: PlaylistLoaderContext,
-    networkDetails: any,
+    networkDetails: NullableNetworkDetails,
     loader: Loader<PlaylistLoaderContext> | undefined,
   ): void {
     const hls = this.hls;

src/types/events.ts

@@ -35,6 +35,7 @@ import type {
 } from '../controller/interstitials-schedule';
 import type { ErrorDetails, ErrorTypes } from '../errors';
 import type { HlsListeners } from '../events';
+import type { NullableNetworkDetails } from './network-details';
 import type { Fragment, MediaFragment, Part } from '../loader/fragment';
 import type {
   AssetListJSON,
@@ -132,7 +133,7 @@ export interface ManifestLoadedData {
   captions?: MediaPlaylist[];
   contentSteering: ContentSteeringOptions | null;
   levels: LevelParsed[];
-  networkDetails: any;
+  networkDetails: NullableNetworkDetails;
   sessionData: Record<string, AttrList> | null;
   sessionKeys: LevelKey[] | null;
   startTimeOffset: number | null;
@@ -208,7 +209,7 @@ export interface TrackLoadedData {
   details: LevelDetails;
   id: number;
   groupId: string;
-  networkDetails: any;
+  networkDetails: NullableNetworkDetails;
   stats: LoaderStats;
   deliveryDirectives: HlsUrlParameters | null;
   track: MediaPlaylist;
@@ -219,7 +220,7 @@ export interface LevelLoadedData {
   id: number;
   level: number;
   levelInfo: Level;
-  networkDetails: any;
+  networkDetails: NullableNetworkDetails;
   stats: LoaderStats;
   deliveryDirectives: HlsUrlParameters | null;
   withoutMultiVariant?: boolean;
@@ -326,7 +327,7 @@ export interface ErrorData {
   level?: number | undefined;
   levelRetry?: boolean;
   loader?: Loader<LoaderContext>;
-  networkDetails?: any;
+  networkDetails?: NullableNetworkDetails;
   stalled?: { start: number };
   stats?: LoaderStats;
   mimeType?: string;
@@ -394,7 +395,7 @@ export interface FragLoadedData {
   frag: Fragment;
   part: Part | null;
   payload: ArrayBuffer;
-  networkDetails: unknown;
+  networkDetails: NullableNetworkDetails;
 }
 
 export interface PartsLoadedData {
@@ -474,7 +475,7 @@ export interface AssetListLoadingData {
 export interface AssetListLoadedData {
   event: InterstitialEventWithAssetList;
   assetListResponse: AssetListJSON;
-  networkDetails: any;
+  networkDetails: NullableNetworkDetails;
 }
 
 export interface InterstitialsUpdatedData {