refactor!: move tileset list from HTTP API to JS API (#126)

This is the next step in [a larger refactor][0] where we replace the HTTP API with a JS one. [0]: #111 BREAKING CHANGE: `GET /tilesets` replaced with `listTilesets()`
digidem · Mar 4, 2024 · 7048b4d · 7048b4d
1 parent 399d38c
commit 7048b4d
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 57 deletions.
diff --git a/API.md b/API.md
@@ -109,10 +109,6 @@ This endpoint goes through the following steps to determine what to respond with
 
 ## Tilesets
 
-### `GET /tilesets`
-
-Retrieve a list of all tilesets. Each tileset adheres to the [TileJSON spec](https://github.com/mapbox/tilejson-spec) with a guarantee of an `id` field.
-
 ### `GET /tilesets/:tilesetId`
 
 - Params

diff --git a/src/map-server.ts b/src/map-server.ts
@@ -10,8 +10,10 @@ import createApi, { type Api } from './api'
 import { convertActiveToError as convertActiveImportsToErrorImports } from './lib/imports'
 import { migrate } from './lib/migrations'
 import { UpstreamRequestsManager } from './lib/upstream_requests_manager'
+import type { IdResource } from './api/index'
 import type { ImportRecord } from './lib/imports'
 import type { PortMessage } from './lib/mbtiles_import_worker.d.ts'
+import type { TileJSON } from './lib/tilejson'
 import { SDF_STATIC_DIR } from './lib/glyphs'
 import * as routes from './routes'
 
@@ -65,6 +67,13 @@ export default class MapServer {
     return this.#api.getImportProgress(importId)
   }
 
+  /**
+   * Get all tilesets.
+   */
+  listTilesets(baseApiUrl: string): Array<TileJSON & IdResource> {
+    return this.#api.listTilesets(baseApiUrl)
+  }
+
   listen(port: number | string, host?: string): Promise<string> {
     return this.fastifyInstance.listen(port, host)
   }

diff --git a/src/routes/tilesets.ts b/src/routes/tilesets.ts
@@ -50,20 +50,6 @@ const ImportMBTilesResponseBodySchema = T.Object({
 })
 
 const tilesets: FastifyPluginAsync = async function (fastify) {
-  fastify.get(
-    '/',
-    {
-      schema: {
-        response: {
-          200: T.Array(TileJSONSchema),
-        },
-      },
-    },
-    async function (request) {
-      return this.api.listTilesets(getBaseApiUrl(request))
-    }
-  )
-
   fastify.get<{
     Params: Static<typeof GetTilesetParamsSchema>
     Querystring: Static<typeof GetTilesetQuerystringSchema>

diff --git a/test/e2e/tilesets-crud.test.js b/test/e2e/tilesets-crud.test.js
@@ -7,9 +7,7 @@ const {
 } = require('../../dist/lib/stylejson')
 
 const { DUMMY_MB_ACCESS_TOKEN } = require('../test-helpers/constants')
-const {
-  createFastifyServer: createServer,
-} = require('../test-helpers/create-server')
+const { createServer } = require('../test-helpers/create-server')
 const sampleTileJSON = require('../fixtures/good-tilejson/mapbox_raster_tilejson.json')
 const {
   defaultMockHeaders,
@@ -21,33 +19,24 @@ const {
  * /tilesets tests
  */
 
-test('GET /tilesets when no tilesets exist returns an empty array', async (t) => {
+test('listTilesets() returns an empty array when no tilesets exist', async (t) => {
   const server = createServer(t)
 
-  const response = await server.inject({ method: 'GET', url: '/tilesets' })
-
-  t.equal(response.statusCode, 200)
-
-  t.equal(
-    response.headers['content-type'],
-    'application/json; charset=utf-8',
-    'returns correct content-type header'
-  )
-
-  t.same(response.json(), [])
+  t.deepEqual(server.listTilesets('https://example.com'), [])
 })
 
-test('GET /tilesets when tilesets exist returns an array of the tilesets', async (t) => {
+test('listTilesets() returns an array of tilesets when tilesets exist', async (t) => {
   const server = createServer(t)
+  const { fastifyInstance } = server
 
-  await server.inject({
+  await fastifyInstance.inject({
     method: 'POST',
     url: '/tilesets',
     payload: sampleTileJSON,
   })
 
   const expectedId = '23z3tmtw49abd8b4ycah9x94ykjhedam'
-  const expectedTileUrl = `http://localhost:80/tilesets/${expectedId}/{z}/{x}/{y}`
+  const expectedTileUrl = `https://example.com/tilesets/${expectedId}/{z}/{x}/{y}`
   const expectedResponse = [
     {
       ...sampleTileJSON,
@@ -56,13 +45,11 @@ test('GET /tilesets when tilesets exist returns an array of the tilesets', async
     },
   ]
 
-  const response = await server.inject({ method: 'GET', url: '/tilesets' })
-
-  t.same(response.json(), expectedResponse)
+  t.deepEqual(server.listTilesets('https://example.com'), expectedResponse)
 })
 
 test('POST /tilesets when tileset does not exist creates a tileset and returns it', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const expectedId = '23z3tmtw49abd8b4ycah9x94ykjhedam'
   const expectedTileUrl = `http://localhost:80/tilesets/${expectedId}/{z}/{x}/{y}`
@@ -82,15 +69,14 @@ test('POST /tilesets when tileset does not exist creates a tileset and returns i
 
   const responseGet = await server.inject({
     method: 'GET',
-    url: '/tilesets',
-    payload: { tilesetId: expectedId },
+    url: `/tilesets/${expectedId}`,
   })
 
   t.equal(responseGet.statusCode, 200)
 })
 
 test('POST /tilesets creates a style for the raster tileset', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const responseTilesetsPost = await server.inject({
     method: 'POST',
@@ -139,7 +125,7 @@ test('POST /tilesets creates a style for the raster tileset', async (t) => {
 })
 
 test('PUT /tilesets when tileset exists returns the updated tileset', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const initialResponse = await server.inject({
     method: 'POST',
@@ -165,7 +151,7 @@ test('PUT /tilesets when tileset exists returns the updated tileset', async (t)
 })
 
 test('PUT /tilesets when providing an incorrect id returns 400 status code', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const response = await server.inject({
     method: 'PUT',
@@ -177,7 +163,7 @@ test('PUT /tilesets when providing an incorrect id returns 400 status code', asy
 })
 
 test('PUT /tilesets when tileset does not exist returns 404 status code', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const response = await server.inject({
     method: 'PUT',
@@ -193,7 +179,7 @@ test('PUT /tilesets when tileset does not exist returns 404 status code', async
  */
 
 test('GET /tile before tileset is created returns 404 status code', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const response = await server.inject({
     method: 'GET',
@@ -204,7 +190,7 @@ test('GET /tile before tileset is created returns 404 status code', async (t) =>
 })
 
 test('GET /tile of png format returns a tile image', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   // Create initial tileset
   const initialResponse = await server.inject({
@@ -238,7 +224,7 @@ test('GET /tile of png format returns a tile image', async (t) => {
 })
 
 test('GET /tile returns 404 response when upstream returns a 4XX error', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const initialResponse = await server.inject({
     method: 'POST',
@@ -305,7 +291,7 @@ test('GET /tile returns 404 response when upstream returns a 4XX error', async (
 })
 
 test('GET /tile returns 404 error when upstream returns a 5XX error', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const initialResponse = await server.inject({
     method: 'POST',
@@ -344,7 +330,7 @@ test('GET /tile returns 404 error when upstream returns a 5XX error', async (t)
 })
 
 test('GET /tile returns 404 error when internet connection is unavailable', async (t) => {
-  const server = createServer(t)
+  const server = createServer(t).fastifyInstance
 
   const initialResponse = await server.inject({
     method: 'POST',

diff --git a/test/e2e/tilesets-import.test.js b/test/e2e/tilesets-import.test.js
@@ -356,12 +356,14 @@ test('POST /tilesets/import subsequent imports do not affect storage calculation
 })
 
 test('POST /tilesets/import fails when providing invalid mbtiles, no tilesets or styles created', async (t) => {
-  const server = createServer(t).fastifyInstance
+  const server = createServer(t)
+  const { fastifyInstance } = server
+
   const badMbTilesPath = path.join(
     fixturesPath,
     'bad-mbtiles/missing-tiles-table.mbtiles'
   )
-  const importResponse = await server.inject({
+  const importResponse = await fastifyInstance.inject({
     method: 'POST',
     url: '/tilesets/import',
     payload: { filePath: badMbTilesPath },
@@ -370,11 +372,16 @@ test('POST /tilesets/import fails when providing invalid mbtiles, no tilesets or
   t.equal(importResponse.statusCode, 400)
   t.equal(importResponse.json().code, 'FST_MBTILES_CANNOT_READ')
 
-  const tilesetsRes = await server.inject({ method: 'GET', url: '/tilesets' })
-  t.equal(tilesetsRes.statusCode, 200)
-  t.same(tilesetsRes.json(), [], 'no tilesets created')
+  t.deepEqual(
+    server.listTilesets('https://example.com'),
+    [],
+    'no tilesets created'
+  )
 
-  const stylesRes = await server.inject({ method: 'GET', url: '/styles' })
+  const stylesRes = await fastifyInstance.inject({
+    method: 'GET',
+    url: '/styles',
+  })
   t.equal(stylesRes.statusCode, 200)
   t.same(stylesRes.json(), [], 'no styles created')
 })