Set transform request types to include null (#6180)

* Add null as a valid type to give to Map.setTransformRequest

* Add a test for setting transformRequest to null

* Update test to use a spy

---------

Co-authored-by: Harel M <[email protected]>

Author: madoci

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Fix white artifacts when using non-zero elevation ([#6032](https://github.com/maplibre/maplibre-gl-js/pull/6032))
 - Fix geolocate control lock loss on window resize ([#3504](https://github.com/maplibre/maplibre-gl-js/issues/3504))
 - Fix a memory leak in `GeoJSONSource` when rapidly updating data ([#6163](https://github.com/maplibre/maplibre-gl-js/pull/6163))
+- Fix `Map.setTransformRequest` parameter type to include `null` ([#6179](https://github.com/maplibre/maplibre-gl-js/issues/6179))
 
 - _...Add new stuff here..._
 

src/ui/map.ts

@@ -1875,7 +1875,7 @@ export class Map extends Camera {
      * map.setTransformRequest((url: string, resourceType: string) => {});
      * ```
      */
-    setTransformRequest(transformRequest: RequestTransformFunction): this {
+    setTransformRequest(transformRequest: RequestTransformFunction | null): this {
         this._requestManager.setTransformRequest(transformRequest);
         return this;
     }
@@ -2205,12 +2205,12 @@ export class Map extends Camera {
     }
 
     /**
-     * Change the tile Level of Detail behavior of the specified source. These parameters have no effect when 
+     * Change the tile Level of Detail behavior of the specified source. These parameters have no effect when
      * pitch == 0, and the largest effect when the horizon is visible on screen.
      *
      * @param maxZoomLevelsOnScreen - The maximum number of distinct zoom levels allowed on screen at a time.
      * There will generally be fewer zoom levels on the screen, the maximum can only be reached when the horizon
-     * is at the top of the screen. Increasing the maximum number of zoom levels causes the zoom level to decay 
+     * is at the top of the screen. Increasing the maximum number of zoom levels causes the zoom level to decay
      * faster toward the horizon.
      * @param tileCountMaxMinRatio - The ratio of the maximum number of tiles loaded (at high pitch) to the minimum
      * number of tiles loaded. Increasing this ratio allows more tiles to be loaded at high pitch angles. If the ratio

src/ui/map_tests/map_basic.test.ts

@@ -4,7 +4,7 @@ import {createMap, beforeMapTest, createStyle, createStyleSource} from '../../ut
 import {Tile} from '../../source/tile';
 import {OverscaledTileID} from '../../source/tile_id';
 import {fixedLngLat} from '../../../test/unit/lib/fixed';
-import {type RequestTransformFunction} from '../../util/request_manager';
+import {type RequestTransformFunction, ResourceType} from '../../util/request_manager';
 import {type MapSourceDataEvent} from '../events';
 import {MessageType} from '../../util/actor_messages';
 
@@ -69,6 +69,16 @@ describe('Map', () => {
             map.setTransformRequest(transformRequest);
             map.setTransformRequest(transformRequest);
         });
+
+        test('removes function when called with null', () => {
+            const map = createMap();
+
+            const transformRequest = vi.fn();
+            map.setTransformRequest(transformRequest);
+            map.setTransformRequest(null);
+            map._requestManager.transformRequest('', ResourceType.Unknown);
+            expect(transformRequest).not.toHaveBeenCalled();
+        });
     });
 
     describe('is_Loaded', () => {
@@ -117,7 +127,7 @@ describe('Map', () => {
 
             expect(map.isStyleLoaded()).toBe(false);
             await map.once('load');
-            expect(map.isStyleLoaded()).toBe(true);  
+            expect(map.isStyleLoaded()).toBe(true);
         });
 
         test('Map.areTilesLoaded', async () => {
@@ -130,7 +140,7 @@ describe('Map', () => {
             map.style.sourceCaches.geojson._tiles[fakeTileId.key] = new Tile(fakeTileId, undefined);
             expect(map.areTilesLoaded()).toBe(false);
             map.style.sourceCaches.geojson._tiles[fakeTileId.key].state = 'loaded';
-            expect(map.areTilesLoaded()).toBe(true);  
+            expect(map.areTilesLoaded()).toBe(true);
         });
     });
 

src/util/request_manager.ts

@@ -21,10 +21,10 @@ export const enum ResourceType {
 export type RequestTransformFunction = (url: string, resourceType?: ResourceType) => RequestParameters | undefined;
 
 export class RequestManager {
-    _transformRequestFn: RequestTransformFunction;
+    _transformRequestFn: RequestTransformFunction | null;
 
-    constructor(transformRequestFn?: RequestTransformFunction) {
-        this._transformRequestFn = transformRequestFn;
+    constructor(transformRequestFn?: RequestTransformFunction | null) {
+        this._transformRequestFn = transformRequestFn ?? null;
     }
 
     transformRequest(url: string, type: ResourceType) {
@@ -35,7 +35,7 @@ export class RequestManager {
         return {url};
     }
 
-    setTransformRequest(transformRequest: RequestTransformFunction) {
+    setTransformRequest(transformRequest: RequestTransformFunction | null) {
         this._transformRequestFn = transformRequest;
     }
 }