feat: implementation for custom protocols #23
Conversation
Deploying svelte-maplibre-gl with
|
| Latest commit: |
9f567e5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6e625712.svelte-maplibre-gl.pages.dev |
| Branch Preview URL: | https://feat-protocols.svelte-maplibre-gl.pages.dev |
WalkthroughThe pull request introduces several changes to the Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (6)
src/content/examples/Index.svelte (1)
18-18: Consider using a more descriptive link textWhile the implementation is correct, consider making the link text more descriptive to better indicate the purpose of this example, such as "Custom Protocols" or "Protocol Handlers". This would maintain consistency with other descriptive example names in the list.
- <li><a href="/examples/protocols">Protocols</a></li> + <li><a href="/examples/protocols">Custom Protocol Handlers</a></li>src/content/examples/protocols/Protocols.svelte (4)
10-10: Prefix unused parameter with underscoreThe second parameter is unused and should be prefixed with underscore to indicate intent.
-myprotocol: async (params, _) => { +myprotocol: async (params, _unused) => {🧰 Tools
🪛 eslint (1.23.1)
[error] 10-10: '_' is defined but never used.
(@typescript-eslint/no-unused-vars)
14-32: Consider error handling for canvas operationsThe canvas operations could fail in certain environments (e.g., no 2D context available). Consider adding error handling:
const png = await new Promise((resolve) => { const canvas = document.createElement('canvas'); canvas.width = 256; canvas.height = 256; - const context = canvas.getContext('2d')!; + const context = canvas.getContext('2d'); + if (!context) { + throw new Error('Failed to get 2D context'); + } // checkered pattern context.fillStyle = (z + x - y) % 2 === 0 ? 'rgba(255, 255, 255, 0.5)' : 'rgba(0, 0, 0, 0.5)'; context.fillRect(0, 0, canvas.width, canvas.height); // canvas to blob (png) to buffer canvas.toBlob(async (blob) => { + if (!blob) { + throw new Error('Failed to create blob'); + } const buf = await blob!.arrayBuffer(); resolve(buf); }); });
43-44: Document the default map positionConsider adding a comment explaining why these specific coordinates (lng: 140.09085, lat: 37.3) and zoom level (6) were chosen as defaults.
50-52: Consider using theme-appropriate colorsThe current hardcoded colors (red for transportation, blue for water) might be too simplistic. Consider:
- Using more subtle colors appropriate for a map theme
- Making colors configurable via props
Also applies to: 56-58
src/lib/maplibre/map/MapLibre.svelte (1)
31-32: Enhance property documentationThe comment could be more descriptive to better explain the purpose and usage of the protocols property.
- // for addProtocol() + // Optional map of custom protocols to register with MapLibre GL JS. + // Each protocol is a function that implements custom data loading behavior. + // Example: { "myprotocol": (params) => { return { cancel: () => {} }; } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (5)
package.json(1 hunks)src/content/examples/Index.svelte(1 hunks)src/content/examples/protocols/Protocols.svelte(1 hunks)src/content/examples/protocols/content.svelte.md(1 hunks)src/lib/maplibre/map/MapLibre.svelte(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/content/examples/protocols/content.svelte.md
🧰 Additional context used
🪛 eslint (1.23.1)
src/content/examples/protocols/Protocols.svelte
[error] 4-4: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.
(@typescript-eslint/ban-ts-comment)
[error] 8-8: 'maplibregl' is not defined.
(no-undef)
[error] 10-10: '_' is defined but never used.
(@typescript-eslint/no-unused-vars)
🔇 Additional comments (4)
src/content/examples/protocols/Protocols.svelte (1)
1-64: Consider architectural improvements
Great implementation of custom protocols! Consider these architectural improvements:
- Move protocol definitions to a separate service file for better maintainability
- Add error boundaries around the map component to handle protocol failures gracefully
- Add unit tests for protocol handlers, especially the custom checkered pattern generator
- Consider adding TypeScript interfaces for protocol responses
Let's check if there are any existing protocol-related tests:
🧰 Tools
🪛 eslint (1.23.1)
[error] 4-4: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.
(@typescript-eslint/ban-ts-comment)
[error] 8-8: 'maplibregl' is not defined.
(no-undef)
[error] 10-10: '_' is defined but never used.
(@typescript-eslint/no-unused-vars)
package.json (1)
62-62: Verify pmtiles version compatibility
Let's check the latest stable version of pmtiles and verify its compatibility with maplibre-gl v5.0.0-pre.6
✅ Verification successful
pmtiles version is up-to-date and compatible
The specified pmtiles version (3.2.1) in package.json is the latest stable version available on npm. Since pmtiles doesn't declare any peer dependencies and maplibre-gl doesn't list it as a dependency, there are no version compatibility constraints to consider. The version can be safely used.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check latest version and compatibility of pmtiles
# Check latest version on npm
echo "Latest pmtiles version:"
npm view pmtiles version
# Check if pmtiles has maplibre-gl as a peer dependency
echo -e "\nPeer dependencies of pmtiles:"
npm view pmtiles peerDependencies
# Check if pmtiles is listed in maplibre-gl dependencies
echo -e "\nDependencies of maplibre-gl that might include pmtiles:"
npm view maplibre-gl dependencies
Length of output: 1171
src/lib/maplibre/map/MapLibre.svelte (2)
111-112: LGTM!
The protocols property is correctly destructured and follows the established pattern for optional properties.
156-159: Consider cleanup of registered protocols
The protocols remain registered even after the component is destroyed. Consider implementing cleanup logic in the onDestroy hook to prevent potential memory leaks or conflicts.
Let's verify if MapLibre GL JS provides a method to remove protocols:
If no built-in cleanup method exists, consider tracking registered protocols and warning users about potential conflicts:
<script lang="ts">
+ // Track registered protocols for cleanup warnings
+ const registeredProtocols = new Set<string>();
+
// ... existing code ...
Object.entries(protocols ?? {}).forEach(([protocol, fn]) => {
+ registeredProtocols.add(protocol);
maplibregl.addProtocol(protocol, fn);
});
onDestroy(() => {
mapCtx.map = null;
map?.remove();
map = undefined;
+ // Warn about protocols that remain registered
+ if (registeredProtocols.size > 0) {
+ console.warn(
+ 'The following protocols remain registered after component destruction:',
+ Array.from(registeredProtocols),
+ 'This may cause conflicts if the protocols are re-registered.'
+ );
+ }
});
</script>| import { Protocol } from 'pmtiles'; | ||
| const pmtilesProtocol = new Protocol(); | ||
|
|
||
| const protocols: Record<string, maplibregl.AddProtocolAction> = { |
There was a problem hiding this comment.
Add missing maplibregl type import
The maplibregl type needs to be imported to resolve the type error.
+import type maplibregl from 'maplibre-gl';📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const protocols: Record<string, maplibregl.AddProtocolAction> = { | |
| import type maplibregl from 'maplibre-gl'; | |
| const protocols: Record<string, maplibregl.AddProtocolAction> = { |
🧰 Tools
🪛 eslint (1.23.1)
[error] 8-8: 'maplibregl' is not defined.
(no-undef)
| <script lang="ts"> | ||
| import { MapLibre, RasterTileSource, VectorTileSource, RasterLayer, LineLayer, FillLayer } from 'svelte-maplibre-gl'; | ||
|
|
||
| // @ts-ignore |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace @ts-ignore with @ts-expect-error
Using @ts-expect-error is preferred as it will fail if the type error is fixed, preventing stale type suppressions.
-// @ts-ignore
+// @ts-expect-error pmtiles types not available📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // @ts-ignore | |
| // @ts-expect-error pmtiles types not available |
🧰 Tools
🪛 eslint (1.23.1)
[error] 4-4: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.
(@typescript-eslint/ban-ts-comment)
| @@ -59,6 +59,7 @@ | |||
| "maplibre-gl": "5.0.0-pre.6", | |||
| "mdsvex": "^0.12.3", | |||
| "mode-watcher": "^0.5.0", | |||
| "pmtiles": "^3.2.1", | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider moving pmtiles to peerDependencies
Since pmtiles is used for implementing custom protocols functionality, it should be a peer dependency rather than a dev dependency. This ensures that applications using your library with custom protocols will have the required dependency available in production.
Apply this diff:
- "pmtiles": "^3.2.1",And add to the peerDependencies section:
"peerDependencies": {
"maplibre-gl": "^4.0.0 || ^5.0.0 || ^5.0.0-pre",
- "svelte": "^5.0.0"
+ "svelte": "^5.0.0",
+ "pmtiles": "^3.2.1"
},Committable suggestion skipped: line range outside the PR's diff.
| // set protocols to maplibregl | ||
| Object.entries(protocols ?? {}).forEach(([protocol, fn]) => { | ||
| maplibregl.addProtocol(protocol, fn); | ||
| }); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling for protocol registration
The current implementation doesn't handle potential errors during protocol registration. Consider wrapping the registration in a try-catch block to gracefully handle failures.
// set protocols to maplibregl
Object.entries(protocols ?? {}).forEach(([protocol, fn]) => {
+ try {
maplibregl.addProtocol(protocol, fn);
+ } catch (error) {
+ console.error(`Failed to register protocol '${protocol}':`, error);
+ // Optionally trigger the onerror callback if defined
+ onerror?.(new ErrorEvent('error', {
+ error,
+ message: `Protocol registration failed: ${error.message}`
+ }));
+ }
});📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // set protocols to maplibregl | |
| Object.entries(protocols ?? {}).forEach(([protocol, fn]) => { | |
| maplibregl.addProtocol(protocol, fn); | |
| }); | |
| // set protocols to maplibregl | |
| Object.entries(protocols ?? {}).forEach(([protocol, fn]) => { | |
| try { | |
| maplibregl.addProtocol(protocol, fn); | |
| } catch (error) { | |
| console.error(`Failed to register protocol '${protocol}':`, error); | |
| // Optionally trigger the onerror callback if defined | |
| onerror?.(new ErrorEvent('error', { | |
| error, | |
| message: `Protocol registration failed: ${error.message}` | |
| })); | |
| } | |
| }); |
|
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
src/content/examples/protocols/Protocols.svelte (3)
10-10: Prefix unused parameter with underscoreThe unused parameter should be prefixed with underscore to indicate it's intentionally unused.
- myprotocol: async (params, _) => { + myprotocol: async (params, _unused) => {🧰 Tools
🪛 eslint (1.23.1)
[error] 10-10: '_' is defined but never used.
(@typescript-eslint/no-unused-vars)
20-22: Improve readability of checkered pattern logicThe pattern calculation could be more readable with a descriptive variable name.
- context.fillStyle = (z + x - y) % 2 === 0 ? 'rgba(255, 255, 255, 0.5)' : 'rgba(0, 0, 0, 0.5)'; + const isLightSquare = (z + x - y) % 2 === 0; + context.fillStyle = isLightSquare ? 'rgba(255, 255, 255, 0.5)' : 'rgba(0, 0, 0, 0.5)';
47-60: Consider extracting style values to constantsThe hardcoded style values could be moved to constants for better maintainability.
+<script lang="ts"> + const TRANSPORTATION_STYLE = { + 'line-color': 'red' + }; + const WATER_STYLE = { + 'fill-color': 'blue' + }; +</script> <VectorTileSource url="pmtiles://https://tile.openstreetmap.jp/static/planet.pmtiles"> <LineLayer sourceLayer="transportation" - paint={{ - 'line-color': 'red' - }} + paint={TRANSPORTATION_STYLE} /> <FillLayer sourceLayer="water" - paint={{ - 'fill-color': 'blue' - }} + paint={WATER_STYLE} />
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/content/examples/protocols/Protocols.svelte(1 hunks)
🧰 Additional context used
🪛 eslint (1.23.1)
src/content/examples/protocols/Protocols.svelte
[error] 4-4: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.
(@typescript-eslint/ban-ts-comment)
[error] 8-8: 'maplibregl' is not defined.
(no-undef)
[error] 10-10: '_' is defined but never used.
(@typescript-eslint/no-unused-vars)
🔇 Additional comments (2)
src/content/examples/protocols/Protocols.svelte (2)
6-6: LGTM: Protocol initialization is correct
The pmtiles Protocol is properly instantiated.
61-61: Verify the tile URL format
The tile URL template should be validated to ensure it matches the expected format.
✅ Verification successful
Based on the search results from the first script, I can generate the final response as we have sufficient evidence about tile URL patterns in the codebase.
The tile URL format is consistent with other examples in the codebase
The format myprotocol://{z}/{x}/{y} follows the same pattern as other tile URLs used throughout the codebase, which all use the {z}/{x}/{y} template structure. This includes various production examples like MapLibre demo tiles, elevation tiles, and other services. The custom protocol usage is valid as long as it's properly handled by the application.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the tile URL template follows the standard format
# Expected format: protocol://{z}/{x}/{y}
rg -g '*.{ts,js,svelte}' '\{[zxy]\}' --no-filename --no-line-number
Length of output: 937
Script:
#!/bin/bash
# Let's check the RasterTileSource component implementation to understand the accepted tile URL formats
ast-grep --pattern 'class RasterTileSource {
$$$
}'
# Also search for any documentation or type definitions related to tile URL formats
rg -g '*.{ts,js,svelte}' -i "tileurl|tile.*format" -B2 -A2
Length of output: 116
| const context = canvas.getContext('2d')!; | ||
|
|
There was a problem hiding this comment.
Add null checks for canvas context and blob
The code uses force unwrap operators (!) which could cause runtime errors if the canvas context or blob is null.
- const context = canvas.getContext('2d')!;
+ const context = canvas.getContext('2d');
+ if (!context) {
+ throw new Error('Failed to get canvas context');
+ }
- const buf = await blob!.arrayBuffer();
+ if (!blob) {
+ throw new Error('Failed to create blob from canvas');
+ }
+ const buf = await blob.arrayBuffer();Also applies to: 25-27
| const zxy = params.url.replace('myprotocol://', ''); | ||
| const [z, x, y] = zxy.split('/').map((v) => parseInt(v, 10)); |
There was a problem hiding this comment.
Add error handling for URL parsing
The URL parsing could fail if the format is incorrect. Consider adding validation and error handling.
- const zxy = params.url.replace('myprotocol://', '');
- const [z, x, y] = zxy.split('/').map((v) => parseInt(v, 10));
+ const zxy = params.url.replace('myprotocol://', '');
+ const parts = zxy.split('/');
+ if (parts.length !== 3) {
+ throw new Error('Invalid tile URL format');
+ }
+ const [z, x, y] = parts.map((v) => {
+ const num = parseInt(v, 10);
+ if (isNaN(num)) {
+ throw new Error('Invalid tile coordinates');
+ }
+ return num;
+ });📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const zxy = params.url.replace('myprotocol://', ''); | |
| const [z, x, y] = zxy.split('/').map((v) => parseInt(v, 10)); | |
| const zxy = params.url.replace('myprotocol://', ''); | |
| const parts = zxy.split('/'); | |
| if (parts.length !== 3) { | |
| throw new Error('Invalid tile URL format'); | |
| } | |
| const [z, x, y] = parts.map((v) => { | |
| const num = parseInt(v, 10); | |
| if (isNaN(num)) { | |
| throw new Error('Invalid tile coordinates'); | |
| } | |
| return num; | |
| }); |
related close #8
What I did
maplibregl.addProtocol().Notes
Summary by CodeRabbit
Release Notes
New Features
Enhancements
pmtilesfor improved functionality.These updates improve usability and expand functionality for users working with map interfaces.