feat: add endpoint for maps plugin to get info about custom map #898
Conversation
achou11
force-pushed
the
maps-plugin-refactor
branch
from
abcd13e to
fa6b4a2
Compare
achou11
force-pushed
the
ac/custom-map-info-endpoint
branch
from
6d4341c to
9475a8b
Compare
src/fastify-plugins/maps.js
Outdated
| const style = await ( | ||
| await fetch(new URL(`${CUSTOM_MAP_PREFIX}/style.json`, baseUrl)) | ||
| ).json() |
There was a problem hiding this comment.
maybe check the response first and pass-through a 404 error.
src/fastify-plugins/maps.js
Outdated
| await fetch(new URL(`${CUSTOM_MAP_PREFIX}/style.json`, baseUrl)) | ||
| ).json() | ||
|
|
||
| const stats = await fs.stat(customMapPath) |
There was a problem hiding this comment.
should catch an error and if EOENT then 404 maybe? Shouldn't happen because the route above would 404 before here, but for completeness...
| const styleJsonName = | ||
| typeof style === 'object' && | ||
| style && | ||
| 'name' in style && |
There was a problem hiding this comment.
I have this kind of check in so many places in my code and I blame typescript, I can't see any way that it's actually necessary (not saying you shouldn't have it here, just venting!)
test/fastify-plugins/maps.js
Outdated
| url: `/${CUSTOM_MAP_PREFIX}/info`, | ||
| }) | ||
|
|
||
| assert.equal(response.statusCode, 500, 'returns server error status code') |
There was a problem hiding this comment.
helpful maybe to distinguish "custom map file does not exist" (404) from "custom map file is invalid" (500), since at some point we will probably want different UX for each type, and before then we might want to report actual 500 errors to Sentry, but not 404.
test/fastify-plugins/maps.js
Outdated
| assert.deepEqual(info, { | ||
| created: '2024-10-09T17:41:16.103Z', | ||
| size: 2815018, | ||
| name: 'MapLibre', | ||
| }) |
There was a problem hiding this comment.
any thoughts on the best approach for this assertion? seems like created field is different each time github actions run so it always seems to fail (maybe that's expected??)
There was a problem hiding this comment.
Stat the file in the test that you are passing to the server, and check the value from the server is the same as what you get from the file.
There was a problem hiding this comment.
Stat the file in the test that you are passing to the server, and check the value from the server is the same as what you get from the file.
Closes #827
Stacked on #896
<prefix>/custom/infoto provide the name, size, and creation time of the custom map file if it exists