-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* wip * fallback for missing distant style file * Add logic for tracking failed distant style loads * detecting faulty style URL * Adding logic to detect CORS errors
- Loading branch information
1 parent
8c8943f
commit b2d083c
Showing
6 changed files
with
227 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,130 @@ | ||
| import { validateStyleMin } from "@maplibre/maplibre-gl-style-spec"; | ||
| import { MapStyle, ReferenceMapStyle, MapStyleVariant, mapStylePresetList, expandMapStyle } from "@maptiler/client"; | ||
|
|
||
| export function styleToStyle( | ||
| style: string | ReferenceMapStyle | MapStyleVariant | maplibregl.StyleSpecification | null | undefined, | ||
| ): string | maplibregl.StyleSpecification { | ||
| ): { style: string | maplibregl.StyleSpecification; requiresUrlMonitoring: boolean; isFallback: boolean } { | ||
| if (!style) { | ||
| return MapStyle[mapStylePresetList[0].referenceStyleID as keyof typeof MapStyle] | ||
| .getDefaultVariant() | ||
| .getExpandedStyleURL(); | ||
| return { | ||
| style: MapStyle[mapStylePresetList[0].referenceStyleID as keyof typeof MapStyle] | ||
| .getDefaultVariant() | ||
| .getExpandedStyleURL(), | ||
| requiresUrlMonitoring: false, // default styles don't require URL monitoring | ||
| isFallback: true, | ||
| }; | ||
| } | ||
|
|
||
| // If the provided style is a shorthand (eg. "streets-v2") or a full style URL | ||
| if (typeof style === "string" || style instanceof String) { | ||
| if (!style.startsWith("http") && style.toLowerCase().includes(".json")) { | ||
| // If a style does not start by http but still contains the extension ".json" | ||
| // we assume it's a relative path to a style json file | ||
| return style as string; | ||
| if (typeof style === "string") { | ||
| // The string could be a JSON valid style spec | ||
| const styleValidationReport = convertToStyleSpecificationString(style); | ||
|
|
||
| // The string is a valid JSON style that validates against the StyleSpecification spec: | ||
| // Let's use this style | ||
| if (styleValidationReport.isValidStyle) { | ||
| return { | ||
| style: styleValidationReport.styleObject as maplibregl.StyleSpecification, | ||
| requiresUrlMonitoring: false, | ||
| isFallback: false, | ||
| }; | ||
| } | ||
|
|
||
| // The string is a valid JSON but not of an object that validates the StyleSpecification spec: | ||
| // Fallback to the default style | ||
| if (styleValidationReport.isValidJSON) { | ||
| return { | ||
| style: MapStyle[mapStylePresetList[0].referenceStyleID as keyof typeof MapStyle] | ||
| .getDefaultVariant() | ||
| .getExpandedStyleURL(), | ||
| requiresUrlMonitoring: false, // default styles don't require URL monitoring | ||
| isFallback: true, | ||
| }; | ||
| } | ||
|
|
||
| // The style is an absolute URL | ||
| if (style.startsWith("http")) { | ||
| return { style: style, requiresUrlMonitoring: true, isFallback: false }; | ||
| } | ||
|
|
||
| return expandMapStyle(style); | ||
| // The style is a relative URL | ||
| if (style.toLowerCase().includes(".json")) { | ||
| return { style: urlToAbsoluteUrl(style), requiresUrlMonitoring: true, isFallback: false }; | ||
| } | ||
|
|
||
| // The style is a shorthand like "streets-v2" or a MapTiler Style ID (UUID) | ||
| return { style: expandMapStyle(style), requiresUrlMonitoring: true, isFallback: false }; | ||
| } | ||
|
|
||
| if (style instanceof MapStyleVariant) { | ||
| return style.getExpandedStyleURL(); | ||
| // Built-in style variants don't require URL monitoring | ||
| return { style: style.getExpandedStyleURL(), requiresUrlMonitoring: false, isFallback: false }; | ||
| } | ||
|
|
||
| if (style instanceof ReferenceMapStyle) { | ||
| return (style.getDefaultVariant() as MapStyleVariant).getExpandedStyleURL(); | ||
| // Built-in reference map styles don't require URL monitoring | ||
| return { | ||
| style: (style.getDefaultVariant() as MapStyleVariant).getExpandedStyleURL(), | ||
| requiresUrlMonitoring: false, | ||
| isFallback: false, | ||
| }; | ||
| } | ||
|
|
||
| // If the style validates as a StyleSpecification object, we use it | ||
| if (validateStyleMin(style).length === 0) { | ||
| return { | ||
| style: style as maplibregl.StyleSpecification, | ||
| requiresUrlMonitoring: false, | ||
| isFallback: false, | ||
| }; | ||
| } | ||
|
|
||
| return style as maplibregl.StyleSpecification; | ||
| // If none of the previous attempts to detect a valid style failed => fallback to default style | ||
| const fallbackStyle = MapStyle[mapStylePresetList[0].referenceStyleID as keyof typeof MapStyle].getDefaultVariant(); | ||
| return { | ||
| style: fallbackStyle.getExpandedStyleURL(), | ||
| requiresUrlMonitoring: false, // default styles don't require URL monitoring | ||
| isFallback: true, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * makes sure a URL is absolute | ||
| */ | ||
| export function urlToAbsoluteUrl(url: string): string { | ||
| // Trying to make a URL instance only works with absolute URL or when a base is provided | ||
| try { | ||
| const u = new URL(url); | ||
| return u.href; | ||
| } catch (e) { | ||
| // nothing to raise | ||
| } | ||
|
|
||
| // Absolute URL did not work, we are building it using the current domain | ||
| const u = new URL(url, location.origin); | ||
| return u.href; | ||
| } | ||
|
|
||
| type StyleValidationReport = { | ||
| isValidJSON: boolean; | ||
| isValidStyle: boolean; | ||
| styleObject: maplibregl.StyleSpecification | null; | ||
| }; | ||
|
|
||
| export function convertToStyleSpecificationString(str: string): StyleValidationReport { | ||
| try { | ||
| const styleObj = JSON.parse(str); | ||
| const styleErrs = validateStyleMin(styleObj); | ||
|
|
||
| return { | ||
| isValidJSON: true, | ||
| isValidStyle: styleErrs.length === 0, | ||
| styleObject: styleErrs.length === 0 ? (styleObj as maplibregl.StyleSpecification) : null, | ||
| }; | ||
| } catch (e) { | ||
| return { | ||
| isValidJSON: false, | ||
| isValidStyle: false, | ||
| styleObject: null, | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters