refactor(lambda-tiler): adjust implementation to adhere to best pract…

…ices
linz · Oct 3, 2024 · 9306566 · 9306566
1 parent 26dc285
commit 9306566
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 32 deletions.
diff --git a/packages/lambda-tiler/src/routes/__tests__/link.test.ts b/packages/lambda-tiler/src/routes/__tests__/link.test.ts
@@ -1,25 +1,17 @@
 import { strictEqual } from 'node:assert';
-import { afterEach, before, describe, test } from 'node:test';
+import { afterEach, describe, it } from 'node:test';
 
 import { ConfigProviderMemory } from '@basemaps/config';
 import { Epsg } from '@basemaps/geo';
-import { createSandbox } from 'sinon';
 
 import { FakeData, Imagery3857 } from '../../__tests__/config.data.js';
 import { mockRequest } from '../../__tests__/xyz.util.js';
 import { handler } from '../../index.js';
 import { ConfigLoader } from '../../util/config.loader.js';
 
-const NAME = 'tileset';
-const PATH = `/v1/link/${NAME}`;
-
 describe('/v1/link/:tileSet', () => {
+  const FakeTileSetName = 'tileset';
   const config = new ConfigProviderMemory();
-  const sandbox = createSandbox();
-
-  before(() => {
-    sandbox.stub(ConfigLoader, 'getDefaultConfig').resolves(config);
-  });
 
   afterEach(() => {
     config.objects.clear();
@@ -29,12 +21,14 @@ describe('/v1/link/:tileSet', () => {
    * 3xx status responses
    */
 
-  // tileset found, has one layer, has '3857' entry, imagery found > 302 response
-  test('success: redirect to pre-zoomed imagery', async () => {
-    config.put(FakeData.tileSetRaster(NAME));
+  // tileset found, is raster type, has one layer, has '3857' entry, imagery found > 302 response
+  it('success: redirect to pre-zoomed imagery', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    config.put(FakeData.tileSetRaster(FakeTileSetName));
     config.put(Imagery3857);
 
-    const req = mockRequest(PATH);
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
     const res = await handler.router.handle(req);
 
     strictEqual(res.status, 302);
@@ -46,51 +40,72 @@ describe('/v1/link/:tileSet', () => {
    */
 
   // tileset not found > 404 response
-  test('failure: tileset not found', async () => {
-    const req = mockRequest(PATH);
+  it('failure: tileset not found', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
     const res = await handler.router.handle(req);
 
     strictEqual(res.status, 404);
     strictEqual(res.statusDescription, 'Tileset not found');
   });
 
-  // tileset found, has more than one layer > 400 response
-  test('failure: too many layers', async () => {
-    const tileSet = FakeData.tileSetRaster(NAME);
+  // tileset found, not raster type > 400 response
+  it('failure: tileset must be raster type', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    config.put(FakeData.tileSetVector(FakeTileSetName));
+
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
+    const res = await handler.router.handle(req);
+
+    strictEqual(res.status, 400);
+    strictEqual(res.statusDescription, 'Tileset must be raster type');
+  });
+
+  // tileset found, is raster type, has more than one layer > 400 response
+  it('failure: too many layers', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    const tileSet = FakeData.tileSetRaster(FakeTileSetName);
 
     // add another layer
     tileSet.layers.push(tileSet.layers[0]);
 
     config.put(tileSet);
 
-    const req = mockRequest(PATH);
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
     const res = await handler.router.handle(req);
 
     strictEqual(res.status, 400);
     strictEqual(res.statusDescription, 'Too many layers');
   });
 
-  // tileset found, has one layer, no '3857' entry > 400 response
-  test("failure: no imagery for '3857' projection", async () => {
-    const tileSet = FakeData.tileSetRaster(NAME);
+  // tileset found, is raster type, has one layer, no '3857' entry > 400 response
+  it("failure: no imagery for '3857' projection", async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    const tileSet = FakeData.tileSetRaster(FakeTileSetName);
 
     // delete '3857' entry
     delete tileSet.layers[0][Epsg.Google.code];
 
     config.put(tileSet);
 
-    const req = mockRequest(PATH);
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
     const res = await handler.router.handle(req);
 
     strictEqual(res.status, 400);
     strictEqual(res.statusDescription, "No imagery for '3857' projection");
   });
 
-  // tileset found, has one layer, has '3857' entry, imagery not found > 400 response
-  test('failure: imagery not found', async () => {
-    config.put(FakeData.tileSetRaster(NAME));
+  // tileset found, is raster type, has one layer, has '3857' entry, imagery not found > 400 response
+  it('failure: imagery not found', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    config.put(FakeData.tileSetRaster(FakeTileSetName));
 
-    const req = mockRequest(PATH);
+    const req = mockRequest(`/v1/link/${FakeTileSetName}`);
     const res = await handler.router.handle(req);
 
     strictEqual(res.status, 400);

diff --git a/packages/lambda-tiler/src/routes/link.ts b/packages/lambda-tiler/src/routes/link.ts
@@ -1,3 +1,4 @@
+import { TileSetType } from '@basemaps/config';
 import { Epsg } from '@basemaps/geo';
 import { getPreviewUrl } from '@basemaps/shared';
 import { LambdaHttpRequest, LambdaHttpResponse } from '@linzjs/lambda';
@@ -11,11 +12,14 @@ export interface LinkGet {
 }
 
 /**
- * Given a tileset, this function redirects the client to a Basemaps URL that is already zoomed to
- * the extent of the tileset's imagery. Otherwise, this function returns an 4xx status and message.
+ * Redirect the client to a Basemaps URL that is already zoomed to the extent of the tileset's imagery.
  *
- * @param tileSet - The id of the tileset.
- * @example "ashburton-2023-0.1m"
+ * /v1/link/:tileSet
+ *
+ * @example
+ * '/v1/link/ashburton-2023-0.1m'
+ *
+ * @returns on success, 302 redirect response. on failure, 4xx status code response.
  */
 export async function linkGet(req: LambdaHttpRequest<LinkGet>): Promise<LambdaHttpResponse> {
   const config = await ConfigLoader.load(req);
@@ -27,6 +31,10 @@ export async function linkGet(req: LambdaHttpRequest<LinkGet>): Promise<LambdaHt
   req.timer.end('tileset:load');
 
   if (tileSet == null) return new LambdaHttpResponse(404, 'Tileset not found');
+
+  if (tileSet.type !== TileSetType.Raster) return new LambdaHttpResponse(400, 'Tileset must be raster type');
+
+  // TODO: add support for 'aerial' and 'elevation' multi-layer tilesets
   if (tileSet.layers.length !== 1) return new LambdaHttpResponse(400, 'Too many layers');
 
   // get imagery