Identify bundle loads from Mapbox CDN vs bundled

GitOrigin-RevId: a5dc60f85abc8f9e46d8d599feb8015353fc6a29

Author: mapbox-github-ci-writer-2[bot]

build/rollup_plugins.js

@@ -16,7 +16,7 @@ import minifyStyleSpec from './rollup_plugin_minify_style_spec.js';
  *
  * @param {Object} options
  * @param {string | 'dev' | 'production'} [options.mode] - build mode
- * @param {string | 'esm' | 'umd'} [options.format] - output format
+ * @param {'umd' | 'csp' | 'esm'} [options.format] - bundle format, reported as `bundleFormat` in telemetry
  * @param {boolean} [options.minified] - whether to minify the output
  * @param {boolean} [options.production] - whether this is a production build
  * @param {boolean} [options.test] - whether this is a test build
@@ -31,7 +31,7 @@ export const plugins = ({mode, format, minified, production, test, keepClassName
         sourceMap: true,
         tsconfig: './tsconfig.browser.json',
         define: {
-            'import.meta.env': JSON.stringify({mode}),
+            'import.meta.env': JSON.stringify({mode, format}),
         }
     }),
     json({

rollup.config.csp.ts

@@ -17,7 +17,7 @@ const config = (input: InputOption, file: string, format: ModuleFormat): RollupO
         banner
     },
     treeshake: {preset: 'recommended', moduleSideEffects: (id) => !id.endsWith('devtools.ts')},
-    plugins: plugins({minified: true, production: true, keepClassNames: true, test: false, mode: 'production'})
+    plugins: plugins({minified: true, production: true, keepClassNames: true, test: false, mode: 'production', format: 'csp'})
 });
 
 export default [

rollup.config.ts

@@ -63,7 +63,7 @@ export default ({watch}: {watch: boolean}): RollupOptions[] => {
         },
         onwarn: production ? onwarn : undefined,
         treeshake: production ? {preset: 'recommended', moduleSideEffects: (id) => !id.endsWith('devtools.ts')} : false,
-        plugins: [preserveDynamicImport(), ...plugins({minified, production, test: false, keepClassNames: false, mode: BUILD})]
+        plugins: [preserveDynamicImport(), ...plugins({minified, production, test: false, keepClassNames: false, mode: BUILD, format: 'umd'})]
     }, {
         // Next, bundle together the three "chunks" produced in the previous pass
         // into a single, final bundle. See rollup/bundle_prelude.js and

src/index.esm.ts

@@ -1,6 +1,13 @@
 import assert from './style-spec/util/assert';
 import _Point from '@mapbox/point-geometry';
 import {version as _version} from '../package.json';
+import {setBundleDistribution} from './util/mapbox';
+import {isMapboxHTTPCDNURL} from './util/mapbox_url';
+
+// Detect whether this ESM bundle was served from the Mapbox CDN (telemetry only).
+// `import.meta.url` is the module URL; bundlers rewrite it to a local URL, yielding 'other'.
+// eslint-disable-next-line no-restricted-syntax -- this file is the ESM-only entry, never bundled as UMD
+setBundleDistribution(isMapboxHTTPCDNURL(import.meta.url) ? 'cdn' : 'other');
 
 // Source class instance types — returned by map.getSource()
 export type * from './source/source_types';

src/index.ts

@@ -20,7 +20,6 @@ import config, {setAccessToken, setBaseApiUrl, setMaxParallelImageRequests, getD
 import {Debug} from './util/debug';
 import {isSafari} from './util/util';
 import {setRTLTextPlugin, getRTLTextPluginStatus} from './source/rtl_text_plugin';
-import {setSdkInfo} from './util/mapbox';
 import {addTileProvider} from './source/tile_provider';
 import {getWorkerCount, setWorkerCount} from './util/worker_pool';
 import WorkerClass from './util/worker_class';
@@ -29,9 +28,17 @@ import {clearTileCache} from './util/tile_request_cache';
 import {WorkerPerformanceUtils} from './util/worker_performance_utils';
 import {FreeCameraOptions} from './ui/free_camera';
 import browser from './util/browser';
+import {isMapboxHTTPCDNURL} from './util/mapbox_url';
+import {setSdkInfo, setBundleDistribution} from './util/mapbox';
 
 import type {Class} from './types/class';
 
+// Detect whether this UMD/CSP bundle was served from the Mapbox CDN (telemetry only).
+// Classic scripts expose their URL via `document.currentScript`; the `typeof document`
+// guard keeps the bundle importable in Node/SSR.
+const currentScript = typeof document !== 'undefined' ? document.currentScript as HTMLScriptElement | null : null;
+setBundleDistribution(currentScript && currentScript.src && isMapboxHTTPCDNURL(currentScript.src) ? 'cdn' : 'other');
+
 // Explicit type re-exports
 export type * from './ui/events';
 export type * from './style-spec/types';

src/types/import-meta.d.ts

@@ -1,6 +1,7 @@
 interface ImportMeta {
     env: {
         mode?: 'dev' | 'production';
+        format?: 'umd' | 'csp' | 'esm';
         [key: string]: unknown;
     };
 }

src/util/mapbox.ts

@@ -344,6 +344,16 @@ export function setSdkInfo(info: string) {
     sdkInfo = info;
 }
 
+// Whether the running bundle was served from the Mapbox CDN (vs. self-hosted or bundled into
+// the consumer's app), reported as the `bundleDistribution` telemetry field. The entry files
+// (index.ts / index.esm.ts) inspect their own script URL locally and pass only the resulting
+// enum here at import time — no URL is ever retained or transmitted.
+let bundleDistribution: 'cdn' | 'other' = 'other';
+
+export function setBundleDistribution(distribution: 'cdn' | 'other') {
+    bundleDistribution = distribution;
+}
+
 type TelemetryEventType = 'appUserTurnstile' | 'map.load' | 'map.auth' | 'gljs.performance' | 'style.load' | 'metrics';
 
 export class TelemetryEvent {
@@ -571,7 +581,9 @@ export class MapLoadEvent extends TelemetryEvent {
             sdkVersion,
             skuId: SKU_ID,
             skuToken: this.skuToken,
-            userId: this.anonId
+            userId: this.anonId,
+            bundleFormat: import.meta.env.format || 'unknown',
+            bundleDistribution
         };
 
         if (sdkInfo) additionalPayload.sdkInfo = sdkInfo;
@@ -863,7 +875,9 @@ export class TurnstileEvent extends TelemetryEvent {
             sdkVersion,
             skuId: SKU_ID,
             "enabled.telemetry": false,
-            userId: this.anonId
+            userId: this.anonId,
+            bundleFormat: import.meta.env.format || 'unknown',
+            bundleDistribution
         };
 
         if (sdkInfo) additionalPayload.sdkInfo = sdkInfo;

test/unit/util/mapbox.test.ts

@@ -783,6 +783,10 @@ describe("mapbox", () => {
             expect(!!mapLoadEvent.userId).toBeTruthy();
             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             expect(!!mapLoadEvent.created).toBeTruthy();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            expect(mapLoadEvent.bundleFormat).toEqual('unknown');
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            expect(mapLoadEvent.bundleDistribution).toEqual('other');
         });
 
         test('does not POST when mapboxgl.ACCESS_TOKEN is not set', () => {
@@ -1211,6 +1215,10 @@ describe("mapbox", () => {
             expect(mapLoadEvent.version).toEqual('2.2');
             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             expect(mapLoadEvent.sdkInfo).toBeUndefined();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            expect(mapLoadEvent.bundleFormat).toEqual('unknown');
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            expect(mapLoadEvent.bundleDistribution).toEqual('other');
         });
 
         test('setSdkInfo ignores invalid values', async () => {
@@ -1661,4 +1669,32 @@ describe("mapbox", () => {
             expect(mapbox.parseAccessToken('a.!!!.c')).toBeNull();
         });
     });
+
+    describe('setBundleDistribution', () => {
+        let event: any;
+        const skuToken = '1234567890123';
+        beforeEach(() => {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+            window.useFakeXMLHttpRequest();
+            event = new mapbox.MapLoadEvent();
+        });
+        afterEach(() => {
+            // Reset the module-level state set by these tests (default is 'other').
+            mapbox.setBundleDistribution('other');
+        });
+
+        async function getBundleDistribution(): Promise<string> {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+            const reqBody = await window.server.requests[0].requestBody;
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            return JSON.parse(reqBody.slice(1, reqBody.length - 1)).bundleDistribution;
+        }
+
+        test('payload reflects the bundleDistribution set via setBundleDistribution', async () => {
+            mapbox.setBundleDistribution('cdn');
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+            event.postMapLoadEvent(1, skuToken);
+            expect(await getBundleDistribution()).toEqual('cdn');
+        });
+    });
 });