Skip to content

Add guard for map styles in map operations #1445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patricvincit merged 1 commit into from
Jun 17, 2026
Merged

Add guard for map styles in map operations #1445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ui/src/components/map/stop-areas/FunctionalAreaVisualization/FunctionalAreaVisualization.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { FC, useEffect } from 'react';
import { MapInstance, useMap } from 'react-map-gl/maplibre';
import { useAppSelector } from '../../../../hooks';
import { selectSelectedStopAreaId } from '../../../../redux';
import { isMapStyleReady } from '../../../../utils/map';
import { MapStop } from '../../types';
import { CanvasRenderer } from './CanvasRenderer';
import { pixelSize } from './constants';
Expand All @@ -24,7 +25,7 @@ function assertIsCanvasSource(source: unknown): asserts source is CanvasSource {
// so we need to register the source and layer manually.
function useMapSourceAndLayer(map: MapInstance | null) {
useEffect(() => {
if (!map) {
if (!map || !isMapStyleReady(map)) {
return noop();
}

Expand Down
8 changes: 6 additions & 2 deletions ui/src/utils/map/lineFromStopToInfraLink.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ import { MapInstance } from 'react-map-gl/maplibre';
import { ReusableComponentsVehicleModeEnum } from '../../generated/graphql';
import { Point as JorePoint } from '../../types';
import { notNullish } from '../misc';
import { createGeometryLineBetweenPoints, removeLayer } from './mapUtils';
import {
createGeometryLineBetweenPoints,
isMapStyleReady,
removeLayer,
} from './mapUtils';

type LineAndDistance = {
readonly line: LineString;
Expand Down Expand Up @@ -117,7 +121,7 @@ export function addLineFromStopToInfraLink(
map: MapInstance | undefined,
geometry: Geometry,
) {
if (!map) {
if (!map || !isMapStyleReady(map)) {
return;
}

Expand Down
15 changes: 13 additions & 2 deletions ui/src/utils/map/mapUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,15 @@ const imageAssets: ReadonlyArray<ImageAsset> = [
},
];

/*
* Checks if the map style exists and that it has finished loading. This is needed before performing operations on the map, such as adding/manipulating layers or sources.
*/
export function isMapStyleReady(map: MapInstance) {
return !!map?.style && map.isStyleLoaded() === true;
}

export const removeLayer = (map: MapInstance, id: string) => {
if (map.getLayer(id)) {
if (isMapStyleReady(map) && map.getLayer(id)) {
map.removeLayer(id);
}
};
Expand Down Expand Up @@ -68,7 +75,7 @@ export const getInteractiveLayerIds = (mapRef: RefObject<MapRef>) => {
};

export const removeRoute = (map: MapInstance | undefined, id: string) => {
if (!map) {
if (!map || !isMapStyleReady(map)) {
return;
}
if (map.getLayer(id)) {
Expand All @@ -83,6 +90,10 @@ export const removeRoute = (map: MapInstance | undefined, id: string) => {
};

export const addRoute = (map: MapInstance, id: string, geometry: Geometry) => {
if (!isMapStyleReady(map)) {
return;
}

// remove possible existing layers with same id
removeRoute(map, id);
map.addLayer({
Expand Down
Loading