@basemaps/lambda-tiler 7.15.0 → 8.0.0

package/dist/node_modules/.package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@basemaps/lambda-tiler",
-  "version": "7.15.0",
+  "version": "8.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
@@ -94,9 +94,9 @@
       }
     },
     "node_modules/detect-libc": {
-      "version": "2.0.3",
-      "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.3.tgz",
-      "integrity": "sha512-bwy0MGW55bG41VqxxypOsdSdGqLwXPI/focwgTYCFMbdUiBAxLg9CFzG08sz2aqzknwiX7Hkl0bQENjg8iLByw==",
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.4.tgz",
+      "integrity": "sha512-3UDv+G9CsCKO1WKMGw9fwq/SWJYbI0c5Y7LU1AXYoDdbhE2AHQ6N6Nb34sG8Fj7T5APy8qXDCKuuIHd1BR0tVA==",
       "license": "Apache-2.0",
       "engines": {
         "node": ">=8"

package/dist/node_modules/detect-libc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "detect-libc",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Node.js module to detect the C standard library (libc) implementation family and version",
   "main": "lib/detect-libc.js",
   "files": [
@@ -36,5 +36,6 @@
   },
   "engines": {
     "node": ">=8"
-  }
+  },
+  "types": "index.d.ts"
 }

package/dist/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@basemaps/lambda-tiler",
-  "version": "7.15.0",
+  "version": "8.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@basemaps/lambda-tiler",
-      "version": "7.15.0",
+      "version": "8.0.0",
       "license": "MIT",
       "dependencies": {
         "lerc": "4.0.4",
@@ -518,9 +518,9 @@
       }
     },
     "node_modules/detect-libc": {
-      "version": "2.0.3",
-      "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.3.tgz",
-      "integrity": "sha512-bwy0MGW55bG41VqxxypOsdSdGqLwXPI/focwgTYCFMbdUiBAxLg9CFzG08sz2aqzknwiX7Hkl0bQENjg8iLByw==",
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.4.tgz",
+      "integrity": "sha512-3UDv+G9CsCKO1WKMGw9fwq/SWJYbI0c5Y7LU1AXYoDdbhE2AHQ6N6Nb34sG8Fj7T5APy8qXDCKuuIHd1BR0tVA==",
       "license": "Apache-2.0",
       "engines": {
         "node": ">=8"

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basemaps/lambda-tiler",
-  "version": "7.15.0",
+  "version": "8.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/linz/basemaps.git",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basemaps/lambda-tiler",
-  "version": "7.15.0",
+  "version": "8.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/linz/basemaps.git",
@@ -22,13 +22,13 @@
   "types": "./build/index.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@basemaps/config": "^7.15.0",
-    "@basemaps/config-loader": "^7.15.0",
-    "@basemaps/geo": "^7.15.0",
-    "@basemaps/shared": "^7.15.0",
-    "@basemaps/tiler": "^7.15.0",
-    "@basemaps/tiler-sharp": "^7.15.0",
-    "@linzjs/geojson": "^7.10.0",
+    "@basemaps/config": "^8.0.0",
+    "@basemaps/config-loader": "^8.0.0",
+    "@basemaps/geo": "^8.0.0",
+    "@basemaps/shared": "^8.0.0",
+    "@basemaps/tiler": "^8.0.0",
+    "@basemaps/tiler-sharp": "^8.0.0",
+    "@linzjs/geojson": "^8.0.0",
     "@linzjs/lambda": "^4.0.0",
     "@mapbox/vector-tile": "^2.0.3",
     "p-limit": "^4.0.0",
@@ -50,11 +50,11 @@
     "bundle": "./bundle.sh"
   },
   "devDependencies": {
-    "@basemaps/attribution": "^7.15.0",
+    "@basemaps/attribution": "^8.0.0",
     "@chunkd/fs": "^11.2.0",
     "@types/aws-lambda": "^8.10.75",
     "@types/pixelmatch": "^5.0.0",
     "pretty-json-log": "^1.0.0"
   },
-  "gitHead": "a2fa0faa57e5591a50900fd469dbb9637b7d9c8e"
+  "gitHead": "852c7c8bcbe06d065de732f23a6ebc2dd6a19cfc"
 }

package/src/__tests__/config.data.ts

@@ -63,6 +63,24 @@ export const TileSetElevation: ConfigTileSetRaster = {
   ],
   outputs: [DefaultTerrainRgbOutput, DefaultColorRampOutput],
 };
+export const TileSetHillshadeElevation: ConfigTileSetRaster = {
+  id: 'ts_hillshade',
+  name: 'hillshade',
+  type: TileSetType.Raster,
+  description: 'hillshade__description',
+  title: 'hillshade Imagery',
+  category: 'hillshade',
+  layers: [
+    {
+      // TODO: create one band imagery to reference
+      2193: 'im_01FYWKAJ86W9P7RWM1VB62KD0H',
+      3857: 'im_01FYWKATAEK2ZTJQ2PX44Y0XNT',
+      title: 'New Zealand 8m Hillshade DEM (2012)',
+      name: 'new-zealand_hillshade_2012_dem_8m',
+    },
+  ],
+  outputs: [DefaultColorRampOutput],
+};
 
 export const Imagery2193: ConfigImagery = {
   id: 'im_01FYWKAJ86W9P7RWM1VB62KD0H',

package/src/routes/__tests__/fonts.test.ts

@@ -8,6 +8,7 @@ import { fsa, FsMemory } from '@chunkd/fs';
 import { Api, mockRequest, mockUrlRequest } from '../../__tests__/xyz.util.js';
 import { handler } from '../../index.js';
 import { CachedConfig } from '../../util/config.cache.js';
+import { ConfigLoader } from '../../util/config.loader.js';
 import { CoSources } from '../../util/source.cache.js';
 import { fontList } from '../fonts.js';
 
@@ -28,12 +29,15 @@ describe('/v1/fonts', () => {
     memory.files.clear();
   });
 
-  it('should return 404 if no font found', async () => {
+  it('should return 404 if no font found', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
     const res = await fontList(mockRequest('/v1/fonts.json'));
     assert.equal(res.status, 404);
   });
 
-  it('should return a list of fonts found', async () => {
+  it('should return a list of fonts found', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
+
     await fsa.write(
       new URL('memory://assets/fonts/fonts.json'),
       Buffer.from(JSON.stringify(['Roboto Black', 'Roboto Thin'])),
@@ -45,7 +49,9 @@ describe('/v1/fonts', () => {
     assert.equal(res._body?.toString(), JSON.stringify(['Roboto Black', 'Roboto Thin']));
   });
 
-  it('should get the correct font', async () => {
+  it('should get the correct font', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
+
     await fsa.write(new URL('memory://assets/fonts/Roboto Thin/0-255.pbf'), Buffer.from(''));
     const res255 = await handler.router.handle(mockRequest('/v1/fonts/Roboto Thin/0-255.pbf'));
     assert.equal(res255.status, 200);
@@ -58,7 +64,9 @@ describe('/v1/fonts', () => {
     assert.equal(res404.status, 404);
   });
 
-  it('should get the correct utf8 font', async () => {
+  it('should get the correct utf8 font', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
+
     await fsa.write(new URL('memory://assets/fonts/🦄 🌈/0-255.pbf'), Buffer.from(''));
     const res255 = await handler.router.handle(mockRequest('/v1/fonts/🦄 🌈/0-255.pbf'));
     assert.equal(res255.status, 200);
@@ -68,7 +76,9 @@ describe('/v1/fonts', () => {
     assert.equal(res255.header('cache-control'), 'public, max-age=604800, stale-while-revalidate=86400');
   });
 
-  it('should return 404 if no asset location set', async () => {
+  it('should return 404 if no asset location set', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
+
     config.assets = undefined;
     const res = await fontList(mockRequest('/v1/fonts.json'));
     assert.equal(res.status, 404);
@@ -76,11 +86,14 @@ describe('/v1/fonts', () => {
 
   it('should get the correct utf8 font with default assets', async () => {
     config.assets = undefined;
+    const configJson = config.toJson();
+    await fsa.write(new URL(`memory://config-${configJson.hash}.json`), JSON.stringify(configJson));
+
     config.objects.set('cb_latest', {
       id: 'cb_latest',
       name: 'latest',
-      path: 'latest',
-      hash: 'hash',
+      path: `memory://config-${configJson.hash}.json`,
+      hash: configJson.hash,
       assets: 'memory://new-location/',
     } as BaseConfig);
 
@@ -93,7 +106,9 @@ describe('/v1/fonts', () => {
     assert.equal(res255.header('cache-control'), 'public, max-age=604800, stale-while-revalidate=86400');
   });
 
-  it('should get the correct utf8 font with config assets', async () => {
+  it('should get the correct utf8 font with config assets', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => config);
+
     const cfgBundle = new ConfigProviderMemory();
     cfgBundle.assets = 'memory://config/assets/';
     await fsa.write(new URL('memory://linz-basemaps/bar.json'), JSON.stringify(cfgBundle.toJson()));

package/src/routes/__tests__/xyz.test.ts

@@ -135,7 +135,10 @@ describe('/v1/tiles', () => {
 
     const elevation = FakeData.tileSetRaster('elevation');
 
-    elevation.outputs = [{ title: 'Terrain RGB', name: 'terrain-rgb' }];
+    elevation.outputs = [
+      { title: 'Terrain RGB', name: 'terrain-rgb' },
+      { title: 'Color Ramp', name: 'color-ramp' },
+    ];
     config.put(elevation);
 
     const request = mockRequest('/v1/tiles/elevation/3857/11/2022/1283.webp', 'get', Api.header);
@@ -145,6 +148,21 @@ describe('/v1/tiles', () => {
     assert.equal(res.status, 404, res.statusDescription);
   });
 
+  it('should default to the pipeline if only one pipeline is defined', async (t) => {
+    t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
+
+    const elevation = FakeData.tileSetRaster('elevation');
+
+    elevation.outputs = [{ title: 'Terrain RGB', name: 'terrain-rgb' }];
+    config.put(elevation);
+
+    const request = mockRequest('/v1/tiles/elevation/3857/11/2022/1283.webp', 'get', Api.header);
+
+    const res = await handler.router.handle(request);
+
+    assert.equal(res.status, 200, res.statusDescription);
+  });
+
   it('should generate a terrain-rgb 11/2022/1283 in webp', async (t) => {
     t.mock.method(ConfigLoader, 'getDefaultConfig', () => Promise.resolve(config));
 

package/src/util/__test__/validate.test.ts

@@ -6,6 +6,24 @@ import { GoogleTms, Nztm2000QuadTms, Nztm2000Tms } from '@basemaps/geo';
 import { mockUrlRequest } from '../../__tests__/xyz.util.js';
 import { Validate } from '../validate.js';
 
+describe('Validate.blockedApiKeys', () => {
+  const validApiKey = 'c01jswmpe1yn3mwne7e0ggtp8vg';
+  it('should disable api keys', () => {
+    const req = mockUrlRequest('/v1/blank', `api=${validApiKey}`);
+    const parsedKey = Validate.apiKey(req);
+    assert.equal(parsedKey, validApiKey);
+  });
+
+  it('should disable api keys', () => {
+    const req = mockUrlRequest('/v1/blank', `api=${validApiKey}`);
+    Validate.blockedApiKeys.add(validApiKey);
+    assert.throws(() => Validate.apiKey(req));
+
+    Validate.blockedApiKeys.delete(validApiKey);
+    assert.equal(Validate.apiKey(req), validApiKey);
+  });
+});
+
 describe('GetImageFormats', () => {
   it('should parse all formats', () => {
     const req = mockUrlRequest('/v1/blank', 'format=png&format=jpeg');

package/src/util/config.loader.ts

@@ -18,13 +18,21 @@ const SafeProtocols = new Set([new URL('s3://foo').protocol, new URL('memory://f
 
 export class ConfigLoader {
   /** Exposed for testing */
-  static async getDefaultConfig(): Promise<BasemapsConfigProvider> {
+  static async getDefaultConfig(req?: LambdaHttpRequest): Promise<BasemapsConfigProvider> {
     const config = getDefaultConfig();
-    if (config.assets == null) {
-      const cb = await config.ConfigBundle.get(config.ConfigBundle.id('latest'));
-      if (cb) config.assets = cb.assets;
-    }
-    return config;
+
+    // Look up the latest config bundle out of dynamodb, then load the config from the provided path
+    const cb = await config.ConfigBundle.get('cb_latest');
+    if (cb == null) return config;
+
+    req?.timer.start('config:load');
+
+    return CachedConfig.get(fsa.toUrl(cb.path)).then((cfg) => {
+      req?.timer.end('config:load');
+      if (cfg == null) throw new LambdaHttpResponse(500, 'Unable to find latest configuration');
+      if (cfg.assets == null) cfg.assets = cb.assets;
+      return cfg;
+    });
   }
 
   /** Lookup the config path from a request and return a standardized location */

package/src/util/validate.ts

@@ -1,6 +1,6 @@
 import { ConfigTileSetRaster, ConfigTileSetRasterOutput } from '@basemaps/config';
 import { ImageFormat, LatLon, Projection, TileMatrixSet, TileMatrixSets } from '@basemaps/geo';
-import { Const, isValidApiKey, truncateApiKey } from '@basemaps/shared';
+import { Const, Env, isValidApiKey, LogConfig, truncateApiKey } from '@basemaps/shared';
 import { getImageFormat } from '@basemaps/tiler';
 import { LambdaHttpRequest, LambdaHttpResponse } from '@linzjs/lambda';
 
@@ -23,7 +23,19 @@ export interface TileMatrixRequest {
   Params: { tileMatrix?: string };
 }
 
+function getBlockedApiKeys(): string[] {
+  try {
+    return JSON.parse(Env.get(Env.BlockedApiKeys) ?? '[]') as string[];
+  } catch (e) {
+    LogConfig.get().error(`"$${Env.BlockedApiKeys}" is invalid`);
+    return [];
+  }
+}
+
 export const Validate = {
+  /** list of API Keys that have been disabled */
+  blockedApiKeys: new Set<string>(getBlockedApiKeys()),
+
   /**
    * Validate that the api key exists and is valid
    *
@@ -36,6 +48,11 @@ export const Validate = {
     if (!valid.valid) throw new LambdaHttpResponse(400, 'API Key Invalid: ' + valid.message);
     // Truncate the API Key so we are not logging the full key
     req.set('api', truncateApiKey(apiKey));
+
+    if (this.blockedApiKeys.has(apiKey as string)) {
+      throw new LambdaHttpResponse(429, 'Too many requests! Please contact basemaps@linz.govt.nz for a developer key');
+    }
+
     return apiKey as string;
   },
 
@@ -125,6 +142,9 @@ export const Validate = {
    * Defaults to standard image format output if no outputs are defined on the tileset
    */
   pipeline(tileSet: ConfigTileSetRaster, tileType: string, pipeline?: string | null): ConfigTileSetRasterOutput | null {
+    // If there is only one pipeline force the use of it
+    if (tileSet.outputs?.length === 1 && pipeline == null) pipeline = tileSet.outputs[0].name;
+
     if (pipeline != null && pipeline !== 'rgba') {
       if (tileSet.outputs == null) throw new LambdaHttpResponse(404, 'TileSet has no pipelines');
       const output = tileSet.outputs.find((f) => f.name === pipeline);
@@ -136,7 +156,8 @@ export const Validate = {
       }
       return output;
     }
-    // If the tileset has pipelines defined the user MUST specify which one
+
+    // If the tileset has multiple pipelines defined the user MUST specify which one
     if (tileSet.outputs) {
       throw new LambdaHttpResponse(404, 'TileSet needs pipeline: ' + tileSet.outputs.map((f) => f.name).join(', '));
     }