import {vi, expect, onTestFinished} from 'vitest'; import {Map, type MapOptions} from '../../ui/map.ts'; import {NullWebGL2RenderingContext} from './null_gl.ts'; import {extend} from '../../util/util.ts'; import {type Dispatcher} from '../../util/dispatcher.ts'; import {type IActor} from '../actor.ts'; import {Evented} from '../evented.ts'; import {type SourceSpecification, type StyleSpecification, type TerrainSpecification} from '@maplibre/maplibre-gl-style-spec'; import {MercatorTransform} from '../../geo/projection/mercator_transform.ts'; import {RequestManager} from '../request_manager.ts'; import {type IReadonlyTransform, type ITransform} from '../../geo/transform_interface.ts'; import {type Style} from '../../style/style.ts'; import {type Terrain} from '../../render/terrain.ts'; import type {Framebuffer} from '../../webgl/framebuffer.ts'; import {Frustum} from '../primitives/frustum.ts'; import {mat4} from 'gl-matrix'; export class StubMap extends Evented { style: Style; transform: IReadonlyTransform; private _requestManager: RequestManager; _terrain: TerrainSpecification; constructor() { super(); this.transform = new MercatorTransform(); this._requestManager = new RequestManager(); } _getMapId(): number { return 1; } getPixelRatio(): number { return 1; } setTerrain(terrain: TerrainSpecification): void { this._terrain = terrain; } getTerrain(): TerrainSpecification { return this._terrain; } migrateProjection(newTransform: ITransform): void { newTransform.apply(this.transform, true); this.transform = newTransform; } } export function createMap(options?: Partial & {deleteStyle?: boolean}): Map { const container = window.document.createElement('div'); const defaultOptions = { container, interactive: false, attributionControl: false, maplibreLogo: false, trackResize: true, style: { 'version': 8, 'sources': {}, 'layers': [] } }; Object.defineProperty(container, 'clientWidth', {value: 200, configurable: true}); Object.defineProperty(container, 'clientHeight', {value: 200, configurable: true}); if (options?.deleteStyle) delete defaultOptions.style; return new Map(extend(defaultOptions, options)); } export function equalWithPrecision( test: {equal: (a: number, b: number, message: string, extra?: unknown) => unknown}, expected: number, actual: number, multiplier: number, message?: string, extra?: unknown ): unknown { message ||= `should be equal to within ${multiplier}`; const expectedRounded = Math.round(expected / multiplier) * multiplier; const actualRounded = Math.round(actual / multiplier) * multiplier; return test.equal(expectedRounded, actualRounded, message, extra); } export function setPerformance(): void { window.performance.mark = vi.fn(); window.performance.clearMeasures = vi.fn(); window.performance.clearMarks = vi.fn(); } export function setMatchMedia(): void { // https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom Object.defineProperty(window, 'matchMedia', { writable: true, value: vi.fn().mockImplementation(query => ({ matches: false, media: query, onchange: null, addListener: vi.fn(), // deprecated removeListener: vi.fn(), // deprecated addEventListener: vi.fn(), removeEventListener: vi.fn(), dispatchEvent: vi.fn(), })), }); } function setResizeObserver() { global.ResizeObserver = vi.fn(class { observe = vi.fn(); unobserve = vi.fn(); disconnect = vi.fn(); }); } let _originalGetContext: typeof HTMLCanvasElement.prototype.getContext | undefined; function setNullGLGetContext() { _originalGetContext ??= HTMLCanvasElement.prototype.getContext; HTMLCanvasElement.prototype.getContext = function (type: string, attributes?: any): any { if (type === 'webgl2') return new NullWebGL2RenderingContext(this, attributes); return _originalGetContext.call(this, type, attributes); } as any; } export function beforeMapTest(): void { setNullGLGetContext(); setPerformance(); setMatchMedia(); setResizeObserver(); onTestFinished(() => { HTMLCanvasElement.prototype.getContext = _originalGetContext; }); } export function getWrapDispatcher(): (actor: IActor) => Dispatcher { return (actor: IActor) => { return { actorsPromise: Promise.resolve([actor]), waitForInitComplete() { return Promise.resolve(); }, getActor() { return Promise.resolve(actor); }, getReadyActor() { return actor; } } as any as Dispatcher; }; } export function getMockDispatcher(): Dispatcher { const wrapDispatcher = getWrapDispatcher(); return wrapDispatcher({ sendAsync() { return Promise.resolve({}); }, }); } export function stubAjaxGetImage(createImageBitmap: typeof global.createImageBitmap): void { global.createImageBitmap = createImageBitmap; global.URL.revokeObjectURL = () => {}; global.URL.createObjectURL = (_) => { return null; }; Object.defineProperty(global.Image.prototype, 'src', { set(url: string) { if (url === 'error') { this.onerror(); } else if (this.onload) { this.onload(); } } }); } /** * This should be used in test that use nise since the internal buffer returned from a file is not an instance of ArrayBuffer for some reason. * @param data - the data read from a file, for example by `fs.readFileSync(...)` * @returns a copy of the data in the file in `ArrayBuffer` format */ export function bufferToArrayBuffer(data: Buffer): ArrayBuffer { const newBuffer = new ArrayBuffer(data.buffer.byteLength); const view = new Uint8Array(newBuffer); data.copy(view); return view.buffer; } /** * This allows test to wait for a certain amount of time before continuing. * @param milliseconds - the amount of time to wait in milliseconds * @returns - a promise that resolves after the specified amount of time */ export const sleep: (milliseconds?: number) => Promise = (milliseconds: number = 0) => { return new Promise(resolve => setTimeout(resolve, milliseconds)); }; export function waitForMetadataEvent(source: Evented): Promise { return new Promise((resolve) => { source.on('data', (e) => { if (e.sourceDataType === 'metadata') { resolve(); } }); }); } export function createStyleSource(): SourceSpecification { return { type: 'geojson', data: { type: 'FeatureCollection', features: [] } }; } export function createStyle(): StyleSpecification { return { version: 8, center: [-73.9749, 40.7736], zoom: 12.5, bearing: 29, pitch: 50, sources: {}, layers: [] }; } export function expectToBeCloseToArray(actual: number[], expected: number[], precision?: number): void { expect(actual).toHaveLength(expected.length); for (let i = 0; i < expected.length; i++) { expect(actual[i]).toBeCloseTo(expected[i], precision); } } export function createTerrain(): Terrain { return { pointCoordinate: () => null, getElevationForLngLatZoom: () => 1000, getElevationForLngLat: () => 1000, getMinTileElevationForLngLatZoom: () => 0, resetElevationCache: () => {}, getFramebuffer: () => ({}), getCoordsTexture: () => ({}), depthAtPoint: () => .9, tileManager: { update: () => {}, getRenderableTiles: () => [], anyTilesAfterTime: () => false } } as any as Terrain; } export function createFramebuffer(): Framebuffer { return { colorAttachment: { get: () => null, set: () => {} }, depthAttachment: { get: () => null, set: () => {} }, destroy: () => {} } as unknown as Framebuffer; } export function waitForEvent(evented: Evented, eventName: string, predicate: (e: any) => boolean): Promise { return new Promise((resolve) => { const listener = (e: Event) => { if (predicate(e)) { resolve(e); } }; evented.on(eventName, listener); }); } export function createTestCameraFrustum(fovy: number, aspectRatio: number, zNear: number, zFar: number, elevation: number, rotation: number): Frustum { const proj = new Float64Array(16) as any as mat4; const invProj = new Float64Array(16) as any as mat4; // Note that left handed coordinate space is used where z goes towards the sky. // Y has to be flipped as well because it's part of the projection/camera matrix used in transform.js mat4.perspective(proj, fovy, aspectRatio, zNear, zFar); mat4.scale(proj, proj, [1, -1, 1]); mat4.translate(proj, proj, [0, 0, elevation]); mat4.rotateZ(proj, proj, rotation); mat4.invert(invProj, proj); return Frustum.fromInvProjectionMatrix(invProj, 1.0, 0.0); }