Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
fix(map): clean up failed WebGL layers before leaving map
johnnyjoygh305310cdd183
diff --git a/web/src/components/map/BasemapLayer.tsx b/web/src/components/map/BasemapLayer.tsxindex 83ab9e5ff..7ddb02996 100644--- a/web/src/components/map/BasemapLayer.tsx+++ b/web/src/components/map/BasemapLayer.tsx@@ -50,8 +50,8 @@ export function BasemapLayer({ onTileError }: Props) {layer = createPositronLayer(basemapStyle(darkRef.current));layer.addTo(map);} catch {- // The bridge cannot tear down a layer whose WebGL map never constructed, so drop its container here.- layer?.getContainer()?.remove();+ // Unregister the failed layer as well as removing its container.+ layer?.remove();layer = undefined;fail();return;diff --git a/web/src/components/map/positron.ts b/web/src/components/map/positron.tsindex f92dc40b2..39c204776 100644--- a/web/src/components/map/positron.ts+++ b/web/src/components/map/positron.ts@@ -1,12 +1,25 @@-import { maplibreGL } from "@maplibre/maplibre-gl-leaflet";+import { MaplibreGL } from "@maplibre/maplibre-gl-leaflet";+import type { Map as LeafletMap } from "leaflet";import { setWorkerUrl } from "maplibre-gl";import workerUrl from "maplibre-gl/dist/maplibre-gl-worker.mjs?worker&url";import "maplibre-gl/dist/maplibre-gl.css";setWorkerUrl(workerUrl);+class PositronLayer extends MaplibreGL {+ onRemove(map: LeafletMap) {+ // Leaflet registers the layer before WebGL initializes. The bridge's cleanup+ // assumes a renderer exists, so handle failed construction before unregistering.+ if (!this.getMaplibreMap()) {+ this.getContainer()?.remove();+ return this;+ }+ return super.onRemove(map);+ }+}+export function createPositronLayer(style: string) {- return maplibreGL({+ return new PositronLayer({style,minZoom: -1,attributionControl: {diff --git a/web/tests/basemap-layer-lifecycle.test.tsx b/web/tests/basemap-layer-lifecycle.test.tsxnew file mode 100644index 000000000..4db0eea5a--- /dev/null+++ b/web/tests/basemap-layer-lifecycle.test.tsx@@ -0,0 +1,31 @@+import { MaplibreGL } from "@maplibre/maplibre-gl-leaflet";+import { render, waitFor } from "@testing-library/react";+import L from "leaflet";+import { createRef } from "react";+import { MapContainer } from "react-leaflet";+import { expect, it, vi } from "vitest";+import { BasemapLayer } from "@/components/map/BasemapLayer";++vi.mock("@/hooks/useResolvedTheme", () => ({ useResolvedTheme: () => "default" }));++it("unregisters a failed WebGL layer before leaving the fallback map", async () => {+ const getContext = vi.spyOn(HTMLCanvasElement.prototype, "getContext").mockReturnValue(null);+ const mapRef = createRef<L.Map>();+ const view = render(+ // jsdom does not provide Leaflet's CSS transition proxy.+ <MapContainer ref={mapRef} center={[0, 0]} zoom={2} zoomAnimation={false}>+ <BasemapLayer />+ </MapContainer>,+ );+ const map = mapRef.current!;++ await waitFor(() => {+ expect(getContext).toHaveBeenCalledWith("webgl2", expect.any(Object));+ const layers: L.Layer[] = [];+ map.eachLayer((layer) => layers.push(layer));+ expect(layers.some((layer) => layer instanceof L.TileLayer)).toBe(true);+ expect(layers.some((layer) => layer instanceof MaplibreGL)).toBe(false);+ });+ expect(view.container.querySelector(".leaflet-gl-layer")).toBeNull();+ expect(() => view.unmount()).not.toThrow();+});diff --git a/web/tests/basemap-layer.test.tsx b/web/tests/basemap-layer.test.tsxindex ebc7a1ade..705253f5e 100644--- a/web/tests/basemap-layer.test.tsx+++ b/web/tests/basemap-layer.test.tsx@@ -62,11 +62,13 @@ describe("BasemapLayer", () => {});it("falls back when WebGL initialization throws", async () => {+ layer.getMaplibreMap.mockReturnValue(undefined);layer.addTo.mockImplementation(() => {throw new Error("WebGL unavailable");});- render(<BasemapLayer />);+ const view = render(<BasemapLayer />);expect(await screen.findByText("OSM fallback")).toBeInTheDocument();+ view.unmount();expect(layer.remove).toHaveBeenCalledOnce();});