8181878923

Committed 07 Mar 2024 02:13AM UTC coverage: 73.678% (-0.01%) from 73.689%

Build # 8181878923

Build Type

Pull #8548

github

Committed by

web-flow

Commit Message

Merge 72da4d27e into 1160a91e8

Pull Request Pull Request #8548: fix(core) warn and error when WebGL1 detected

Run Details

3674 of 4371 branches covered (84.05%)

Branch coverage included in aggregate %.

2 of 16 new or added lines in 3 files covered. (12.5%)

8 existing lines in 1 file now uncovered.

41746 of 57276 relevant lines covered (72.89%)

308.57 hits per line

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

49.25

/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(
        'Incompatible basemap library. See: https://deck.gl/docs/api-reference/mapbox/overview#compatibility'
      )();
      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(	×
NEW 39	'Incompatible basemap library. See: https://deck.gl/docs/api-reference/mapbox/overview#compatibility'	×
NEW 40	)();	×
UNCOV 41	return;	×
UNCOV 42	}	×
43	this.map = map;	×
44	this.deck = getDeckInstance({map, gl, deck: this.props.deck});	×
45	addLayer(this.deck, this);	×
46	}	×
47		1✔
48	onRemove(): void {	1✔
49	if (this.deck) {	×
50	removeLayer(this.deck, this);	×
51	}	×
52	}	×
53		1✔
54	setProps(props: MapboxLayerProps<LayerT>) {	1✔
55	// id cannot be changed	×
UNCOV 56	Object.assign(this.props, props, {id: this.id});	×
UNCOV 57	// safe guard in case setProps is called before onAdd	×
58	if (this.deck) {	×
59	updateLayer(this.deck, this);	×
UNCOV 60	}	×
UNCOV 61	}	×
62		1✔
63	render() {	1✔
UNCOV 64	drawLayer(this.deck!, this.map, this);	×
UNCOV 65	}	×
66	}	1✔

visgl / deck.gl / 8181878923

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