8181063532

Committed 07 Mar 2024 12:48AM UTC coverage: 73.699% (+0.008%) from 73.691%

Build # 8181063532

Build Type

Pull #8548

github

Committed by

web-flow

Commit Message

Merge d895e4275 into e76b1c48e

Pull Request Pull Request #8548: fix(mapbox) warn and fail when WebGL1 detected

Run Details

3676 of 4373 branches covered (84.06%)

Branch coverage included in aggregate %.

4 of 17 new or added lines in 3 files covered. (23.53%)

64 existing lines in 3 files now uncovered.

41758 of 57275 relevant lines covered (72.91%)

308.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

50.77

/modules/mapbox/src/mapbox-layer.ts

import {getDeckInstance, addLayer, removeLayer, updateLayer, drawLayer} from './deck-utils';
import type {Map, CustomLayerInterface} from 'mapbox-gl';
import {log} from '@deck.gl/core';
import type {Deck, Layer} from '@deck.gl/core';

export type MapboxLayerProps<LayerT extends Layer> = Partial<LayerT['props']> & {
  id: string;
  renderingMode?: '2d' | '3d';
  deck?: Deck;
};

export default class MapboxLayer<LayerT extends Layer> implements CustomLayerInterface {
  id: string;
  type: 'custom';
  renderingMode: '2d' | '3d';
  map: Map | null;
  deck: Deck | null;
  props: MapboxLayerProps<LayerT>;

  /* eslint-disable no-this-before-super */
  constructor(props: MapboxLayerProps<LayerT>) {
    if (!props.id) {
      throw new Error('Layer must have an unique id');
    }

    this.id = props.id;
    this.type = 'custom';
    this.renderingMode = props.renderingMode || '3d';
    this.map = null;
    this.deck = null;
    this.props = props;
  }

  /* Mapbox custom layer methods */

  onAdd(map: Map, gl: WebGLRenderingContext | WebGL2RenderingContext): void {
    if (gl instanceof WebGLRenderingContext) {
      log.warn('Use useWebGL2:true in mapboxgl.Map()')();
      return;
    }
    this.map = map;
    this.deck = getDeckInstance({map, gl, deck: this.props.deck});
    addLayer(this.deck, this);
  }

  onRemove(): void {
    if (this.deck) {
      removeLayer(this.deck, this);
    }
  }

  setProps(props: MapboxLayerProps<LayerT>) {
    // id cannot be changed
    Object.assign(this.props, props, {id: this.id});
    // safe guard in case setProps is called before onAdd
    if (this.deck) {
      updateLayer(this.deck, this);
    }
  }

  render() {
    drawLayer(this.deck!, this.map, this);
  }
}

1	import {getDeckInstance, addLayer, removeLayer, updateLayer, drawLayer} from './deck-utils';	1✔
2	import type {Map, CustomLayerInterface} from 'mapbox-gl';	1✔
3	import {log} from '@deck.gl/core';	1✔
4	import type {Deck, Layer} from '@deck.gl/core';	1✔
5		1✔
6	export type MapboxLayerProps<LayerT extends Layer> = Partial<LayerT['props']> & {	1✔
7	id: string;	1✔
8	renderingMode?: '2d' \| '3d';	1✔
9	deck?: Deck;	1✔
10	};	1✔
11		1✔
12	export default class MapboxLayer<LayerT extends Layer> implements CustomLayerInterface {	1✔
13	id: string;	1✔
14	type: 'custom';	1✔
15	renderingMode: '2d' \| '3d';	1✔
16	map: Map \| null;	1✔
17	deck: Deck \| null;	1✔
18	props: MapboxLayerProps<LayerT>;	1✔
19		1✔
20	/* eslint-disable no-this-before-super */	1✔
21	constructor(props: MapboxLayerProps<LayerT>) {	1✔
22	if (!props.id) {	×
23	throw new Error('Layer must have an unique id');	×
24	}	×
25		×
26	this.id = props.id;	×
27	this.type = 'custom';	×
28	this.renderingMode = props.renderingMode \|\| '3d';	×
29	this.map = null;	×
30	this.deck = null;	×
31	this.props = props;	×
32	}	×
33		1✔
34	/* Mapbox custom layer methods */	1✔
35		1✔
36	onAdd(map: Map, gl: WebGLRenderingContext \| WebGL2RenderingContext): void {	1✔
37	if (gl instanceof WebGLRenderingContext) {	×
NEW 38	log.warn('Use useWebGL2:true in mapboxgl.Map()')();	×
NEW 39	return;	×
NEW 40	}	×
41	this.map = map;	×
42	this.deck = getDeckInstance({map, gl, deck: this.props.deck});	×
43	addLayer(this.deck, this);	×
44	}	×
45		1✔
46	onRemove(): void {	1✔
UNCOV 47	if (this.deck) {	×
UNCOV 48	removeLayer(this.deck, this);	×
49	}	×
50	}	×
51		1✔
52	setProps(props: MapboxLayerProps<LayerT>) {	1✔
UNCOV 53	// id cannot be changed	×
UNCOV 54	Object.assign(this.props, props, {id: this.id});	×
55	// safe guard in case setProps is called before onAdd	×
56	if (this.deck) {	×
57	updateLayer(this.deck, this);	×
58	}	×
59	}	×
60		1✔
61	render() {	1✔
UNCOV 62	drawLayer(this.deck!, this.map, this);	×
UNCOV 63	}	×
64	}	1✔

visgl / deck.gl / 8181063532

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous