feat!: simplify fastify maps plugin and add support for styled map packages #896

achou11 · 2024-10-08T22:21:24Z

Towards #827

Paired on much of this with @gmaclennan

Leaving as a draft because tests will fail, as the changes rely on publishing a new version of styled-map-package.

Important notes:

removes the StaticMapPlugin in favor of using the StyledMapPackage plugin to handle serving a local custom map
removes the OfflineFallbackMapPlugin in favor of using the StyledMapPackage plugin to handle serving the SMP provided by @comapeo/fallback-smp
simplifies implementation of the MapeoMapsPlugin due to the removal of the the other plugins.
- one consequence of this is handling the registration of the plugin within the MapeoManager instance, as opposed to doing it externally. due to this change, a few options are added to the MapeoManager constructor, all of which are optional:
  - customMapPath: file path to a local SMP file used for the local custom map
  - fallbackMapPath: file path to a local SMP file used for the offline fallback map
  - defaultOnlineStyleUrl: url to online-hosted StyleJSON

awana-lockfile-bot · 2024-10-08T22:21:38Z

`package-lock.json` changes

Summary

Status	Count
	74
	9

Click to toggle table visibility

Name	Previous	Current
`@comapeo/fallback-smp`	-	1.0.0
`@fastify/static`	7.0.3	7.0.4
`@mapbox/jsonlint-lines-primitives`	-	2.0.2
`@mapbox/sphericalmercator`	-	1.2.0
`@mapbox/unitbezier`	-	0.0.1
`@maplibre/maplibre-gl-style-spec`	-	20.3.1
`@placemarkio/check-geojson`	-	0.1.12
`@turf/bbox`	-	7.1.0
`@turf/helpers`	-	7.1.0
`@turf/meta`	-	7.1.0
`@types/geojson`	-	7946.0.14
`ansi-diff`	-	1.2.0
`ansi-split`	-	1.0.1
`archiver-utils`	-	5.0.2
`archiver`	-	7.0.1
`arr-union`	-	3.1.0
`assign-symbols`	-	1.0.0
`async`	-	3.2.6
`buffer-peek-stream`	-	1.1.0
`bundle-name`	-	4.1.0
`bytewise-core`	-	1.2.3
`bytewise`	-	1.1.0
`cli-spinners`	-	2.9.2
`compress-commons`	-	6.0.2
`core-util-is`	-	1.0.3
`crc-32`	-	1.2.2
`crc32-stream`	-	6.0.0
`default-browser-id`	-	5.0.0
`default-browser`	-	5.2.1
`defaults`	-	1.0.4
`define-lazy-prop`	-	3.0.0
`extend-shallow`	-	2.0.1
`fastify`	4.26.2	4.28.1
`filter-obj`	-	6.1.0
`get-east-asian-width`	-	1.2.0
`get-value`	-	2.0.6
`into-stream`	-	8.0.1
`is-docker`	-	3.0.0
`is-extendable`	-	0.1.1
`is-inside-container`	-	1.0.0
`is-interactive`	-	2.0.0
`is-plain-object`	-	2.0.4
`is-unicode-supported`	-	2.1.0
`is-wsl`	-	3.1.0
`isobject`	-	3.0.1
`json-stringify-pretty-compact`	-	4.0.0
`ky`	-	1.7.2
`lazystream`	-	1.0.1
`log-symbols`	-	7.0.0
`mimic-function`	-	5.0.1
`minimist`	1.2.7	1.2.8
`normalize-path`	-	3.0.0
`open`	-	10.1.0
`ora`	-	8.1.0
`package-json-from-dist`	-	1.0.1
`parse-ms`	-	4.0.0
`pino-abstract-transport`	1.1.0	1.2.0
`pino-std-serializers`	6.2.2	7.0.0
`pino`	8.20.0	9.4.0
`pretty-bytes`	-	6.1.1
`pretty-ms`	-	9.1.0
`process-nextick-args`	-	2.0.1
`quickselect`	-	2.0.0
`readdir-glob`	-	1.1.3
`run-applescript`	-	7.0.0
`rw`	-	1.3.3
`safe-stable-stringify`	2.4.3	2.5.0
`set-value`	-	2.0.1
`sonic-boom`	3.8.1	4.1.0
`sort-asc`	-	0.2.0
`sort-desc`	-	0.2.0
`sort-object`	-	3.0.3
`split-string`	-	3.1.0
`stdin-discarder`	-	0.2.2
`styled-map-package`	-	1.0.1
`thread-stream`	2.4.1	3.1.0
`tinyqueue`	-	3.0.0
`typewise-core`	-	1.2.0
`typewise`	-	1.0.3
`union-value`	-	1.0.1
`wcwidth`	-	1.0.1
`yoctocolors`	-	2.1.1
`zip-stream`	-	6.0.1

gmaclennan

Looks good to me, let's merge once tests are passing.

I do agree with the original intention of keeping the plugin outside of MapeoManager, for the sake of separation of concerns, however in practice that would mean more of a tangle to expose getMapStyleJsonUrl() to the client. We're going to swap this out anyway for MapManager in the future, so I think it's more practical to take the easy route (e.g. code in this PR) for now, and deal with separation of concerns once we have the map manager.

awana-lockfile-bot · 2024-10-09T17:24:35Z

`package-lock.json` changes

Summary

Status	Count
	74
	9

Click to toggle table visibility

Name	Previous	Current
`@comapeo/fallback-smp`	-	1.0.0
`@fastify/static`	7.0.3	7.0.4
`@mapbox/jsonlint-lines-primitives`	-	2.0.2
`@mapbox/sphericalmercator`	-	1.2.0
`@mapbox/unitbezier`	-	0.0.1
`@maplibre/maplibre-gl-style-spec`	-	20.3.1
`@placemarkio/check-geojson`	-	0.1.12
`@turf/bbox`	-	7.1.0
`@turf/helpers`	-	7.1.0
`@turf/meta`	-	7.1.0
`@types/geojson`	-	7946.0.14
`ansi-diff`	-	1.2.0
`ansi-split`	-	1.0.1
`archiver-utils`	-	5.0.2
`archiver`	-	7.0.1
`arr-union`	-	3.1.0
`assign-symbols`	-	1.0.0
`async`	-	3.2.6
`buffer-peek-stream`	-	1.1.0
`bundle-name`	-	4.1.0
`bytewise-core`	-	1.2.3
`bytewise`	-	1.1.0
`cli-spinners`	-	2.9.2
`compress-commons`	-	6.0.2
`core-util-is`	-	1.0.3
`crc-32`	-	1.2.2
`crc32-stream`	-	6.0.0
`default-browser-id`	-	5.0.0
`default-browser`	-	5.2.1
`defaults`	-	1.0.4
`define-lazy-prop`	-	3.0.0
`extend-shallow`	-	2.0.1
`fastify`	4.26.2	4.28.1
`filter-obj`	-	6.1.0
`get-east-asian-width`	-	1.2.0
`get-value`	-	2.0.6
`into-stream`	-	8.0.1
`is-docker`	-	3.0.0
`is-extendable`	-	0.1.1
`is-inside-container`	-	1.0.0
`is-interactive`	-	2.0.0
`is-plain-object`	-	2.0.4
`is-unicode-supported`	-	2.1.0
`is-wsl`	-	3.1.0
`isobject`	-	3.0.1
`json-stringify-pretty-compact`	-	4.0.0
`ky`	-	1.7.2
`lazystream`	-	1.0.1
`log-symbols`	-	7.0.0
`mimic-function`	-	5.0.1
`minimist`	1.2.7	1.2.8
`normalize-path`	-	3.0.0
`open`	-	10.1.0
`ora`	-	8.1.0
`package-json-from-dist`	-	1.0.1
`parse-ms`	-	4.0.0
`pino-abstract-transport`	1.1.0	1.2.0
`pino-std-serializers`	6.2.2	7.0.0
`pino`	8.20.0	9.4.0
`pretty-bytes`	-	6.1.1
`pretty-ms`	-	9.1.0
`process-nextick-args`	-	2.0.1
`quickselect`	-	2.0.0
`readdir-glob`	-	1.1.3
`run-applescript`	-	7.0.0
`rw`	-	1.3.3
`safe-stable-stringify`	2.4.3	2.5.0
`set-value`	-	2.0.1
`sonic-boom`	3.8.1	4.1.0
`sort-asc`	-	0.2.0
`sort-desc`	-	0.2.0
`sort-object`	-	3.0.3
`split-string`	-	3.1.0
`stdin-discarder`	-	0.2.2
`styled-map-package`	-	1.1.0
`thread-stream`	2.4.1	3.1.0
`tinyqueue`	-	3.0.0
`typewise-core`	-	1.2.0
`typewise`	-	1.0.3
`union-value`	-	1.0.1
`wcwidth`	-	1.0.1
`yoctocolors`	-	2.1.1
`zip-stream`	-	6.0.1

awana-lockfile-bot · 2024-10-09T17:25:56Z

`package-lock.json` changes

Summary

Status	Count
	74
	9

Click to toggle table visibility

Name	Previous	Current
`@comapeo/fallback-smp`	-	1.0.0
`@fastify/static`	7.0.3	7.0.4
`@mapbox/jsonlint-lines-primitives`	-	2.0.2
`@mapbox/sphericalmercator`	-	1.2.0
`@mapbox/unitbezier`	-	0.0.1
`@maplibre/maplibre-gl-style-spec`	-	20.3.1
`@placemarkio/check-geojson`	-	0.1.12
`@turf/bbox`	-	7.1.0
`@turf/helpers`	-	7.1.0
`@turf/meta`	-	7.1.0
`@types/geojson`	-	7946.0.14
`ansi-diff`	-	1.2.0
`ansi-split`	-	1.0.1
`archiver-utils`	-	5.0.2
`archiver`	-	7.0.1
`arr-union`	-	3.1.0
`assign-symbols`	-	1.0.0
`async`	-	3.2.6
`buffer-peek-stream`	-	1.1.0
`bundle-name`	-	4.1.0
`bytewise-core`	-	1.2.3
`bytewise`	-	1.1.0
`cli-spinners`	-	2.9.2
`compress-commons`	-	6.0.2
`core-util-is`	-	1.0.3
`crc-32`	-	1.2.2
`crc32-stream`	-	6.0.0
`default-browser-id`	-	5.0.0
`default-browser`	-	5.2.1
`defaults`	-	1.0.4
`define-lazy-prop`	-	3.0.0
`extend-shallow`	-	2.0.1
`fastify`	4.26.2	4.28.1
`filter-obj`	-	6.1.0
`get-east-asian-width`	-	1.2.0
`get-value`	-	2.0.6
`into-stream`	-	8.0.1
`is-docker`	-	3.0.0
`is-extendable`	-	0.1.1
`is-inside-container`	-	1.0.0
`is-interactive`	-	2.0.0
`is-plain-object`	-	2.0.4
`is-unicode-supported`	-	2.1.0
`is-wsl`	-	3.1.0
`isobject`	-	3.0.1
`json-stringify-pretty-compact`	-	4.0.0
`ky`	-	1.7.2
`lazystream`	-	1.0.1
`log-symbols`	-	7.0.0
`mimic-function`	-	5.0.1
`minimist`	1.2.7	1.2.8
`normalize-path`	-	3.0.0
`open`	-	10.1.0
`ora`	-	8.1.0
`package-json-from-dist`	-	1.0.1
`parse-ms`	-	4.0.0
`pino-abstract-transport`	1.1.0	1.2.0
`pino-std-serializers`	6.2.2	7.0.0
`pino`	8.20.0	9.4.0
`pretty-bytes`	-	6.1.1
`pretty-ms`	-	9.1.0
`process-nextick-args`	-	2.0.1
`quickselect`	-	2.0.0
`readdir-glob`	-	1.1.3
`run-applescript`	-	7.0.0
`rw`	-	1.3.3
`safe-stable-stringify`	2.4.3	2.5.0
`set-value`	-	2.0.1
`sonic-boom`	3.8.1	4.1.0
`sort-asc`	-	0.2.0
`sort-desc`	-	0.2.0
`sort-object`	-	3.0.3
`split-string`	-	3.1.0
`stdin-discarder`	-	0.2.2
`styled-map-package`	-	1.1.0
`thread-stream`	2.4.1	3.1.0
`tinyqueue`	-	3.0.0
`typewise-core`	-	1.2.0
`typewise`	-	1.0.3
`union-value`	-	1.0.1
`wcwidth`	-	1.0.1
`yoctocolors`	-	2.1.1
`zip-stream`	-	6.0.1

awana-lockfile-bot · 2024-10-09T17:26:28Z

`package-lock.json` changes

Summary

Status	Count
	74
	9

Click to toggle table visibility

Name	Previous	Current
`@comapeo/fallback-smp`	-	1.0.0
`@fastify/static`	7.0.3	7.0.4
`@mapbox/jsonlint-lines-primitives`	-	2.0.2
`@mapbox/sphericalmercator`	-	1.2.0
`@mapbox/unitbezier`	-	0.0.1
`@maplibre/maplibre-gl-style-spec`	-	20.3.1
`@placemarkio/check-geojson`	-	0.1.12
`@turf/bbox`	-	7.1.0
`@turf/helpers`	-	7.1.0
`@turf/meta`	-	7.1.0
`@types/geojson`	-	7946.0.14
`ansi-diff`	-	1.2.0
`ansi-split`	-	1.0.1
`archiver-utils`	-	5.0.2
`archiver`	-	7.0.1
`arr-union`	-	3.1.0
`assign-symbols`	-	1.0.0
`async`	-	3.2.6
`buffer-peek-stream`	-	1.1.0
`bundle-name`	-	4.1.0
`bytewise-core`	-	1.2.3
`bytewise`	-	1.1.0
`cli-spinners`	-	2.9.2
`compress-commons`	-	6.0.2
`core-util-is`	-	1.0.3
`crc-32`	-	1.2.2
`crc32-stream`	-	6.0.0
`default-browser-id`	-	5.0.0
`default-browser`	-	5.2.1
`defaults`	-	1.0.4
`define-lazy-prop`	-	3.0.0
`extend-shallow`	-	2.0.1
`fastify`	4.26.2	4.28.1
`filter-obj`	-	6.1.0
`get-east-asian-width`	-	1.2.0
`get-value`	-	2.0.6
`into-stream`	-	8.0.1
`is-docker`	-	3.0.0
`is-extendable`	-	0.1.1
`is-inside-container`	-	1.0.0
`is-interactive`	-	2.0.0
`is-plain-object`	-	2.0.4
`is-unicode-supported`	-	2.1.0
`is-wsl`	-	3.1.0
`isobject`	-	3.0.1
`json-stringify-pretty-compact`	-	4.0.0
`ky`	-	1.7.2
`lazystream`	-	1.0.1
`log-symbols`	-	7.0.0
`mimic-function`	-	5.0.1
`minimist`	1.2.7	1.2.8
`normalize-path`	-	3.0.0
`open`	-	10.1.0
`ora`	-	8.1.0
`package-json-from-dist`	-	1.0.1
`parse-ms`	-	4.0.0
`pino-abstract-transport`	1.1.0	1.2.0
`pino-std-serializers`	6.2.2	7.0.0
`pino`	8.20.0	9.4.0
`pretty-bytes`	-	6.1.1
`pretty-ms`	-	9.1.0
`process-nextick-args`	-	2.0.1
`quickselect`	-	2.0.0
`readdir-glob`	-	1.1.3
`run-applescript`	-	7.0.0
`rw`	-	1.3.3
`safe-stable-stringify`	2.4.3	2.5.0
`set-value`	-	2.0.1
`sonic-boom`	3.8.1	4.1.0
`sort-asc`	-	0.2.0
`sort-desc`	-	0.2.0
`sort-object`	-	3.0.3
`split-string`	-	3.1.0
`stdin-discarder`	-	0.2.2
`styled-map-package`	-	1.1.0
`thread-stream`	2.4.1	3.1.0
`tinyqueue`	-	3.0.0
`typewise-core`	-	1.2.0
`typewise`	-	1.0.3
`union-value`	-	1.0.1
`wcwidth`	-	1.0.1
`yoctocolors`	-	2.1.1
`zip-stream`	-	6.0.1

awana-lockfile-bot · 2024-10-09T17:34:27Z

`package-lock.json` changes

Summary

Status	Count
	74
	9
	1

Click to toggle table visibility

Name	Previous	Current
`@comapeo/fallback-smp`	-	1.0.0
`@electron/asar`	3.2.9	-
`@fastify/static`	7.0.3	7.0.4
`@mapbox/jsonlint-lines-primitives`	-	2.0.2
`@mapbox/sphericalmercator`	-	1.2.0
`@mapbox/unitbezier`	-	0.0.1
`@maplibre/maplibre-gl-style-spec`	-	20.3.1
`@placemarkio/check-geojson`	-	0.1.12
`@turf/bbox`	-	7.1.0
`@turf/helpers`	-	7.1.0
`@turf/meta`	-	7.1.0
`@types/geojson`	-	7946.0.14
`ansi-diff`	-	1.2.0
`ansi-split`	-	1.0.1
`archiver-utils`	-	5.0.2
`archiver`	-	7.0.1
`arr-union`	-	3.1.0
`assign-symbols`	-	1.0.0
`async`	-	3.2.6
`buffer-peek-stream`	-	1.1.0
`bundle-name`	-	4.1.0
`bytewise-core`	-	1.2.3
`bytewise`	-	1.1.0
`cli-spinners`	-	2.9.2
`compress-commons`	-	6.0.2
`core-util-is`	-	1.0.3
`crc-32`	-	1.2.2
`crc32-stream`	-	6.0.0
`default-browser-id`	-	5.0.0
`default-browser`	-	5.2.1
`defaults`	-	1.0.4
`define-lazy-prop`	-	3.0.0
`extend-shallow`	-	2.0.1
`fastify`	4.26.2	4.28.1
`filter-obj`	-	6.1.0
`get-east-asian-width`	-	1.2.0
`get-value`	-	2.0.6
`into-stream`	-	8.0.1
`is-docker`	-	3.0.0
`is-extendable`	-	0.1.1
`is-inside-container`	-	1.0.0
`is-interactive`	-	2.0.0
`is-plain-object`	-	2.0.4
`is-unicode-supported`	-	2.1.0
`is-wsl`	-	3.1.0
`isobject`	-	3.0.1
`json-stringify-pretty-compact`	-	4.0.0
`ky`	-	1.7.2
`lazystream`	-	1.0.1
`log-symbols`	-	7.0.0
`mimic-function`	-	5.0.1
`minimist`	1.2.7	1.2.8
`normalize-path`	-	3.0.0
`open`	-	10.1.0
`ora`	-	8.1.0
`package-json-from-dist`	-	1.0.1
`parse-ms`	-	4.0.0
`pino-abstract-transport`	1.1.0	1.2.0
`pino-std-serializers`	6.2.2	7.0.0
`pino`	8.20.0	9.4.0
`pretty-bytes`	-	6.1.1
`pretty-ms`	-	9.1.0
`process-nextick-args`	-	2.0.1
`quickselect`	-	2.0.0
`readdir-glob`	-	1.1.3
`run-applescript`	-	7.0.0
`rw`	-	1.3.3
`safe-stable-stringify`	2.4.3	2.5.0
`set-value`	-	2.0.1
`sonic-boom`	3.8.1	4.1.0
`sort-asc`	-	0.2.0
`sort-desc`	-	0.2.0
`sort-object`	-	3.0.3
`split-string`	-	3.1.0
`stdin-discarder`	-	0.2.2
`styled-map-package`	-	1.1.0
`thread-stream`	2.4.1	3.1.0
`tinyqueue`	-	3.0.0
`typewise-core`	-	1.2.0
`typewise`	-	1.0.3
`union-value`	-	1.0.1
`wcwidth`	-	1.0.1
`yoctocolors`	-	2.1.1
`zip-stream`	-	6.0.1

gmaclennan approved these changes Oct 9, 2024

View reviewed changes

achou11 mentioned this pull request Oct 9, 2024

feat: add endpoint for maps plugin to get info about custom map #898

Merged

achou11 marked this pull request as ready for review October 9, 2024 17:25

achou11 added 3 commits October 9, 2024 13:26

initial implementation

c66653b

update styled-map-package

2559c61

remove stray only test

fa6b4a2

achou11 force-pushed the maps-plugin-refactor branch from abcd13e to fa6b4a2 Compare October 9, 2024 17:26

remove unused deps

a0f3284

achou11 merged commit f21a675 into main Oct 9, 2024
8 checks passed

achou11 deleted the maps-plugin-refactor branch October 9, 2024 17:41

achou11 mentioned this pull request Oct 9, 2024

chore: remove unnecessary map fixtures #899

Merged

optic-release-automation bot mentioned this pull request Oct 15, 2024

[OPTIC-RELEASE-AUTOMATION] release/v2.0.0 #902

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: simplify fastify maps plugin and add support for styled map packages #896

feat!: simplify fastify maps plugin and add support for styled map packages #896

achou11 commented Oct 8, 2024 •

edited

Loading

awana-lockfile-bot bot commented Oct 8, 2024

gmaclennan left a comment

awana-lockfile-bot bot commented Oct 9, 2024

awana-lockfile-bot bot commented Oct 9, 2024

awana-lockfile-bot bot commented Oct 9, 2024

awana-lockfile-bot bot commented Oct 9, 2024

feat!: simplify fastify maps plugin and add support for styled map packages #896

feat!: simplify fastify maps plugin and add support for styled map packages #896

Conversation

achou11 commented Oct 8, 2024 • edited Loading

awana-lockfile-bot bot commented Oct 8, 2024

package-lock.json changes

Summary

gmaclennan left a comment

Choose a reason for hiding this comment

awana-lockfile-bot bot commented Oct 9, 2024

package-lock.json changes

Summary

awana-lockfile-bot bot commented Oct 9, 2024

package-lock.json changes

Summary

awana-lockfile-bot bot commented Oct 9, 2024

package-lock.json changes

Summary

awana-lockfile-bot bot commented Oct 9, 2024

package-lock.json changes

Summary

achou11 commented Oct 8, 2024 •

edited

Loading

`package-lock.json` changes

`package-lock.json` changes

`package-lock.json` changes

`package-lock.json` changes

`package-lock.json` changes