9018341672

Committed 09 May 2024 01:53PM UTC coverage: 89.82%. Remained the same

Build # 9018341672

Build Type

Pull #8856

github

Committed by

web-flow

Commit Message

Merge 202cce7d6 into 86f3f84f4

Pull Request Pull Request #8856: Carto: fetchMap to support custom basemaps

Run Details

6335 of 6975 branches covered (90.82%)

Branch coverage included in aggregate %.

155 of 173 new or added lines in 5 files covered. (89.6%)

22 existing lines in 1 file now uncovered.

52215 of 58211 relevant lines covered (89.7%)

6618.42 hits per line

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

94.85

/modules/carto/src/basemap.ts

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

export const cartoBasemapsBaseUrl = 'https://basemaps.cartocdn.com/gl';

const baseUrl = `${cartoBasemapsBaseUrl}/{basemap}-gl-style/style.json`;

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 visibleFilters = STYLE_LAYER_GROUPS.filter(lg => visibleLayerGroups[lg.slug]).map(
    lg => lg.filter
  );

  const filteredLayers = style.layers.filter(layer => visibleFilters.some(match => match(layer)));

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

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

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

export async function getBasemapStyle({
  styleType,
  visibleLayerGroups,
  errorContext
}: {
  styleType: string;
  visibleLayerGroups?: Record<StyleLayerGroupSlug, boolean>;
  errorContext?: APIErrorContext;
}) {
  /* global fetch */
  const styleUrl = getStyleUrl(styleType);
  let style = styleUrl;

  if (visibleLayerGroups && someLayerGroupsDisabled(visibleLayerGroups)) {
    let response: Response | undefined;
    const originalStyle = await fetch(styleUrl, {
      mode: 'cors',
      credentials: 'omit'
    })
      .then(res => {
        response = res;
        return res.json();
      })
      .catch(error => {
        throw new CartoAPIError(error, {...errorContext, requestType: 'Basemap style'}, response);
      });
    style = applyLayerGroupFilters(originalStyle, visibleLayerGroups);
  }
  return style;
}

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

visgl / deck.gl / 9018341672

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