9188177538

Committed 22 May 2024 08:43AM UTC coverage: 89.846% (+0.005%) from 89.841%

Build # 9188177538

Build Type

Pull #8915

github

Committed by

web-flow

Commit Message

Merge f040cf870 into 87ae69562

Pull Request Pull Request #8915: fix(carto): Fix fetchMap visibleLayerGroup filtering to include static layers

Run Details

6340 of 6979 branches covered (90.84%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

52360 of 58355 relevant lines covered (89.73%)

6600.64 hits per line

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

97.37

/modules/carto/src/basemap.ts

import {CartoAPIError} from './api/carto-api-error';
import {APIErrorContext, GoogleBasemapProps} from './api/types';

const cartoStyleUrlTemplate = 'https://basemaps.cartocdn.com/gl/{basemap}-gl-style/style.json';

export const CARTO_MAP_STYLES = ['positron', 'dark-matter', 'voyager'];

export const GOOGLE_BASEMAPS: Record<string, GoogleBasemapProps> = {
  roadmap: {
    mapTypeId: 'roadmap',
    mapId: '3754c817b510f791'
  },
  'google-positron': {
    mapTypeId: 'roadmap',
    mapId: 'ea84ae4203ef21cd'
  },
  'google-dark-matter': {
    mapTypeId: 'roadmap',
    mapId: '2fccc3b36c22a0e2'
  },
  'google-voyager': {
    mapTypeId: 'roadmap',
    mapId: '885caf1e15bb9ef2'
  },
  satellite: {
    mapTypeId: 'satellite'
  },
  hybrid: {
    mapTypeId: 'hybrid'
  },
  terrain: {
    mapTypeId: 'terrain'
  }
};

type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
type StyleLayerGroup = {
  slug: StyleLayerGroupSlug;
  filter: (layer: any) => boolean;
  defaultVisibility: boolean;
};

export const STYLE_LAYER_GROUPS: StyleLayerGroup[] = [
  {
    slug: 'label',
    filter: ({id}: {id: string}) =>
      Boolean(
        id.match(/(?=(label|_label|place-|place_|poi-|poi_|watername_|roadname_|housenumber))/)
      ),
    defaultVisibility: true
  },
  {
    slug: 'road',
    filter: ({id}: {id: string}) =>
      Boolean(id.match(/(?=(road|railway|tunnel|street|bridge))(?!.*label)/)),
    defaultVisibility: true
  },
  {
    slug: 'border',
    filter: ({id}: {id: string}) => Boolean(id.match(/border|boundaries|boundary_/)),
    defaultVisibility: false
  },
  {
    slug: 'building',
    filter: ({id}: {id: string}) => Boolean(id.match(/building/)),
    defaultVisibility: true
  },
  {
    slug: 'water',
    filter: ({id}: {id: string}) => Boolean(id.match(/(?=(water|stream|ferry))/)),
    defaultVisibility: true
  },
  {
    slug: 'land',
    filter: ({id}: {id: string}) =>
      Boolean(id.match(/(?=(parks|landcover|industrial|sand|hillshade|park_))/)),
    defaultVisibility: true
  }
];

export function applyLayerGroupFilters(
  style,
  visibleLayerGroups: Record<StyleLayerGroupSlug, boolean>
) {
  if (!Array.isArray(style?.layers)) {
    return style;
  }

  const removedLayerFilters = STYLE_LAYER_GROUPS.filter(lg => !visibleLayerGroups[lg.slug]).map(
    lg => lg.filter
  );

  const visibleLayers = style.layers.filter(layer =>
    removedLayerFilters.every(match => !match(layer))
  );

  return {
    ...style,
    layers: visibleLayers
  };
}

export function someLayerGroupsDisabled(visibleLayerGroups?: Record<StyleLayerGroupSlug, boolean>) {
  return visibleLayerGroups && Object.values(visibleLayerGroups).every(Boolean) === false;
}

export function getStyleUrl(styleType: string) {
  return cartoStyleUrlTemplate.replace('{basemap}', styleType);
}

export async function fetchStyle({
  styleUrl,
  errorContext
}: {
  styleUrl: string;
  errorContext?: APIErrorContext;
}) {
  /* global fetch */
  let response: Response | undefined;
  return await fetch(styleUrl, {mode: 'cors'})
    .then(res => {
      response = res;
      return res.json();
    })
    .catch(error => {
      throw new CartoAPIError(error, {...errorContext, requestType: 'Basemap style'}, response);
    });
}

export default {
  VOYAGER: getStyleUrl('voyager'),
  POSITRON: getStyleUrl('positron'),
  DARK_MATTER: getStyleUrl('dark-matter'),
  VOYAGER_NOLABELS: getStyleUrl('voyager-nolabels'),
  POSITRON_NOLABELS: getStyleUrl('positron-nolabels'),
  DARK_MATTER_NOLABELS: getStyleUrl('dark-matter-nolabels')
} as const;

1	import {CartoAPIError} from './api/carto-api-error';	1✔
2	import {APIErrorContext, GoogleBasemapProps} from './api/types';	1✔
3		1✔
4	const cartoStyleUrlTemplate = 'https://basemaps.cartocdn.com/gl/{basemap}-gl-style/style.json';	1✔
5		1✔
6	export const CARTO_MAP_STYLES = ['positron', 'dark-matter', 'voyager'];	1✔
7		1✔
8	export const GOOGLE_BASEMAPS: Record<string, GoogleBasemapProps> = {	1✔
9	roadmap: {	1✔
10	mapTypeId: 'roadmap',	1✔
11	mapId: '3754c817b510f791'	1✔
12	},	1✔
13	'google-positron': {	1✔
14	mapTypeId: 'roadmap',	1✔
15	mapId: 'ea84ae4203ef21cd'	1✔
16	},	1✔
17	'google-dark-matter': {	1✔
18	mapTypeId: 'roadmap',	1✔
19	mapId: '2fccc3b36c22a0e2'	1✔
20	},	1✔
21	'google-voyager': {	1✔
22	mapTypeId: 'roadmap',	1✔
23	mapId: '885caf1e15bb9ef2'	1✔
24	},	1✔
25	satellite: {	1✔
26	mapTypeId: 'satellite'	1✔
27	},	1✔
28	hybrid: {	1✔
29	mapTypeId: 'hybrid'	1✔
30	},	1✔
31	terrain: {	1✔
32	mapTypeId: 'terrain'	1✔
33	}	1✔
34	};	1✔
35		1✔
36	type StyleLayerGroupSlug = 'label' \| 'road' \| 'border' \| 'building' \| 'water' \| 'land';	1✔
37	type StyleLayerGroup = {	1✔
38	slug: StyleLayerGroupSlug;	1✔
39	filter: (layer: any) => boolean;	1✔
40	defaultVisibility: boolean;	1✔
41	};	1✔
42		1✔
43	export const STYLE_LAYER_GROUPS: StyleLayerGroup[] = [	1✔
44	{	1✔
45	slug: 'label',	1✔
46	filter: ({id}: {id: string}) =>	1✔
47	Boolean(	5✔
48	id.match(/(?=(label\|_label\|place-\|place_\|poi-\|poi_\|watername_\|roadname_\|housenumber))/)	5✔
49	),	5✔
50	defaultVisibility: true	1✔
51	},	1✔
52	{	1✔
53	slug: 'road',	1✔
54	filter: ({id}: {id: string}) =>	1✔
UNCOV 55	Boolean(id.match(/(?=(road\|railway\|tunnel\|street\|bridge))(?!.*label)/)),	×
56	defaultVisibility: true	1✔
57	},	1✔
58	{	1✔
59	slug: 'border',	1✔
60	filter: ({id}: {id: string}) => Boolean(id.match(/border\|boundaries\|boundary_/)),	1✔
61	defaultVisibility: false	1✔
62	},	1✔
63	{	1✔
64	slug: 'building',	1✔
65	filter: ({id}: {id: string}) => Boolean(id.match(/building/)),	1✔
66	defaultVisibility: true	1✔
67	},	1✔
68	{	1✔
69	slug: 'water',	1✔
70	filter: ({id}: {id: string}) => Boolean(id.match(/(?=(water\|stream\|ferry))/)),	1✔
71	defaultVisibility: true	1✔
72	},	1✔
73	{	1✔
74	slug: 'land',	1✔
75	filter: ({id}: {id: string}) =>	1✔
76	Boolean(id.match(/(?=(parks\|landcover\|industrial\|sand\|hillshade\|park_))/)),	4✔
77	defaultVisibility: true	1✔
78	}	1✔
79	];	1✔
80		1✔
81	export function applyLayerGroupFilters(	1✔
82	style,	1✔
83	visibleLayerGroups: Record<StyleLayerGroupSlug, boolean>	1✔
84	) {	1✔
85	if (!Array.isArray(style?.layers)) {	1!
86	return style;	×
87	}	×
88		1✔
89	const removedLayerFilters = STYLE_LAYER_GROUPS.filter(lg => !visibleLayerGroups[lg.slug]).map(	1✔
90	lg => lg.filter	1✔
91	);	1✔
92		1✔
93	const visibleLayers = style.layers.filter(layer =>	1✔
94	removedLayerFilters.every(match => !match(layer))	5✔
95	);	1✔
96		1✔
97	return {	1✔
98	...style,	1✔
99	layers: visibleLayers	1✔
100	};	1✔
101	}	1✔
102		1✔
103	export function someLayerGroupsDisabled(visibleLayerGroups?: Record<StyleLayerGroupSlug, boolean>) {	1✔
104	return visibleLayerGroups && Object.values(visibleLayerGroups).every(Boolean) === false;	3✔
105	}	3✔
106		1✔
107	export function getStyleUrl(styleType: string) {	1✔
108	return cartoStyleUrlTemplate.replace('{basemap}', styleType);	9✔
109	}	9✔
110		1✔
111	export async function fetchStyle({	2✔
112	styleUrl,	2✔
113	errorContext	2✔
114	}: {	2✔
115	styleUrl: string;	2✔
116	errorContext?: APIErrorContext;	2✔
117	}) {	2✔
118	/* global fetch */	2✔
119	let response: Response \| undefined;	2✔
120	return await fetch(styleUrl, {mode: 'cors'})	2✔
121	.then(res => {	2✔
122	response = res;	1✔
123	return res.json();	1✔
124	})	2✔
125	.catch(error => {	2✔
126	throw new CartoAPIError(error, {...errorContext, requestType: 'Basemap style'}, response);	1✔
127	});	2✔
128	}	2✔
129		1✔
130	export default {	1✔
131	VOYAGER: getStyleUrl('voyager'),	1✔
132	POSITRON: getStyleUrl('positron'),	1✔
133	DARK_MATTER: getStyleUrl('dark-matter'),	1✔
134	VOYAGER_NOLABELS: getStyleUrl('voyager-nolabels'),	1✔
135	POSITRON_NOLABELS: getStyleUrl('positron-nolabels'),	1✔
136	DARK_MATTER_NOLABELS: getStyleUrl('dark-matter-nolabels')	1✔
137	} as const;	1✔

visgl / deck.gl / 9188177538

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