@basemaps/server 6.24.2 → 6.27.0

package/CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.27.0](https://github.com/linz/basemaps/compare/v6.26.0...v6.27.0) (2022-05-29)
+
+
+### Features
+
+* **config:** add configuration parser and bundler ([#2200](https://github.com/linz/basemaps/issues/2200)) ([795e3f2](https://github.com/linz/basemaps/commit/795e3f224ee0b4cd1e66a242d05a1fd5357cae3a))
+* **lambda-cog:** New lambda Cog for import api. ([#2207](https://github.com/linz/basemaps/issues/2207)) ([79f4ae7](https://github.com/linz/basemaps/commit/79f4ae70ea3fc16a37dd575b843a0b60a1365df4))
+* **server:** use a bundled `@basemaps/landing` to serve static assets ([#2202](https://github.com/linz/basemaps/issues/2202)) ([c60f518](https://github.com/linz/basemaps/commit/c60f518893fe037a03f8bfd489c84d8427481678))
+
+
+
+
+
+# [6.26.0](https://github.com/linz/basemaps/compare/v6.25.0...v6.26.0) (2022-05-12)
+
+**Note:** Version bump only for package @basemaps/server
+
+
+
+
+
+# [6.25.0](https://github.com/linz/basemaps/compare/v6.24.2...v6.25.0) (2022-05-11)
+
+**Note:** Version bump only for package @basemaps/server
+
+
+
+
+
 ## [6.24.2](https://github.com/linz/basemaps/compare/v6.24.1...v6.24.2) (2022-04-20)
 
 

package/README.md

@@ -33,3 +33,15 @@ For example given a structure where there are two folders full of tiffs
 ```
 
 running `basemaps-server --config /images` will create two tile sets one for each folder `gebco_2021...` and `geographx_nz_t...` and then also create a combined layer in the order the tiffs are found.
+
+
+## Developing
+
+When running the `@basemaps/server` in development mode, ensure `@basemaps/landing` page has been bundled
+
+```bash
+cd packages/landing
+yarn bundle
+```
+
+This will package all the static assets into `landing/dist` and will be served from `http://localhost:3000`

package/build/cli.d.ts

@@ -6,9 +6,10 @@ export declare class BasemapsServerCommand extends Command {
         port: import("@oclif/parser/lib/flags").IOptionFlag<number>;
         dynamo: flags.IOptionFlag<string | undefined>;
         config: flags.IOptionFlag<string | undefined>;
+        files: flags.IOptionFlag<string | undefined>;
     };
     static args: never[];
-    loadFromPath(configPath: string, serverUrl: string): Promise<void>;
+    loadTiffs(tiffPath: string, serverUrl: string): Promise<void>;
     run(): Promise<void>;
 }
 //# sourceMappingURL=cli.d.ts.map

package/build/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAkBhD,qBAAa,qBAAsB,SAAQ,OAAO;IAChD,MAAM,CAAC,WAAW,SAAuD;IACzE,MAAM,CAAC,KAAK;;;;;MAKV;IAEF,MAAM,CAAC,IAAI,UAAM;IAEX,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA+ClE,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAsB3B"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAkBhD,qBAAa,qBAAsB,SAAQ,OAAO;IAChD,MAAM,CAAC,WAAW,SAAuD;IACzE,MAAM,CAAC,KAAK;;;;;;MAMV;IAEF,MAAM,CAAC,IAAI,UAAM;IAEX,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B7D,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAoC3B"}

package/build/cli.js

@@ -1,12 +1,10 @@
-// Configure the logging before importing everything
-import { ConfigPrefix, ConfigProviderDynamo, ConfigProviderMemory, parseRgba } from '@basemaps/config';
+import { ConfigJson, ConfigProviderDynamo, ConfigProviderMemory } from '@basemaps/config';
 import { TileSetLocal } from '@basemaps/lambda-tiler/build/cli/tile.set.local.js';
 import { TileSets } from '@basemaps/lambda-tiler/build/tile.set.cache.js';
-import { Config, Env, LogConfig } from '@basemaps/shared';
-import { fsa } from '@linzjs/s3fs';
+import { Config, Env, fsa, LogConfig } from '@basemaps/shared';
 import { Command, flags } from '@oclif/command';
 import { basename, dirname } from 'path';
-import { BasemapsServer } from './server.js';
+import { createServer } from './server.js';
 const logger = LogConfig.get();
 const BaseProvider = {
     id: 'pv_linz',
@@ -20,11 +18,11 @@ const BaseProvider = {
     },
 };
 export class BasemapsServerCommand extends Command {
-    async loadFromPath(configPath, serverUrl) {
+    async loadTiffs(tiffPath, serverUrl) {
         const config = new ConfigProviderMemory();
         Config.setConfigProvider(config);
         const tifSets = new Map();
-        for await (const file of fsa.listDetails(configPath)) {
+        for await (const file of fsa.details(tiffPath)) {
             const lowerPath = file.path.toLowerCase();
             if (lowerPath.endsWith('.tiff') || lowerPath.endsWith('.tif')) {
                 const tiffPath = dirname(file.path);
@@ -40,27 +38,6 @@ export class BasemapsServerCommand extends Command {
                 if (!config.objects.has('pv_linz'))
                     config.put(BaseProvider);
             }
-            if (!lowerPath.endsWith('.json'))
-                continue;
-            logger.trace({ path: file.path, size: file.size }, 'Config:Load');
-            const jsonData = await fsa.read(file.path).then((c) => JSON.parse(c.toString()));
-            if (jsonData.id == null) {
-                logger.warn({ path: file.path }, 'Config:Invalid Missing "id"');
-                continue;
-            }
-            // Last modified now, make sure its considered fresh
-            jsonData.updatedAt = Date.now();
-            // TODO we should really use something like zod to validate this
-            config.put(jsonData);
-            if (!Config.TileSet.is(jsonData) || !Config.isTileSetRaster(jsonData))
-                continue;
-            if (typeof jsonData.background === 'string')
-                jsonData.background = parseRgba(jsonData.background);
-            const tileSet = Config.unprefix(ConfigPrefix.TileSet, jsonData.id);
-            if (jsonData.name == null)
-                jsonData.name = tileSet;
-            const wmtsUrl = `${serverUrl}/v1/tiles/${tileSet}/WMTSCapabilities.xml`;
-            logger.info({ tileSetId: jsonData.id, wmtsUrl }, 'TileSet:Loaded');
         }
     }
     async run() {
@@ -70,19 +47,34 @@ export class BasemapsServerCommand extends Command {
             logger.level = 'debug';
         const ServerUrl = `http://localhost:${flags.port}`;
         if (flags.config != null) {
-            logger.info({ path: flags.config }, 'Starting Server');
-            await this.loadFromPath(flags.config, ServerUrl);
+            // Load configuration from a collection of JSON files
+            logger.info({ path: flags.config, mode: 'config' }, 'Starting Server');
+            if (flags.config.endsWith('.json')) {
+                const configJson = await fsa.read(flags.config);
+                const mem = ConfigProviderMemory.fromJson(JSON.parse(configJson.toString()));
+                Config.setConfigProvider(mem);
+            }
+            else {
+                const cj = await ConfigJson.fromPath(flags.config, logger);
+                Config.setConfigProvider(cj.mem);
+            }
         }
         else if (flags.dynamo != null) {
-            logger.info({ dynamo: flags.dynamo }, 'Starting Server');
+            // Load configuration from a dynamodb table
+            logger.info({ dynamo: flags.dynamo, mode: 'dynamo' }, 'Starting Server');
             Config.setConfigProvider(new ConfigProviderDynamo(flags.dynamo));
         }
+        else if (flags.files != null) {
+            // Generate configuration form a collection of tiff files
+            logger.info({ path: flags.files, mode: 'files' }, 'Starting Server');
+            await this.loadTiffs(flags.files, ServerUrl);
+        }
         else {
-            throw new Error('Either a configuration path or dynamodb table name must be supplied');
+            throw new Error('Either a --config, --tiff or --dynamodb must be supplied');
         }
         // Force a default url base so WMTS requests know their relative url
         process.env[Env.PublicUrlBase] = (_a = process.env[Env.PublicUrlBase]) !== null && _a !== void 0 ? _a : `http://localhost:${flags.port}`;
-        BasemapsServer.listen(flags.port, () => {
+        createServer(logger).listen(flags.port, () => {
             logger.info({ url: ServerUrl }, 'ServerStarted');
         });
     }
@@ -93,5 +85,6 @@ BasemapsServerCommand.flags = {
     port: flags.integer({ default: 5000 }),
     dynamo: flags.string({ description: 'Dynamodb table', required: false }),
     config: flags.string({ description: 'Configuration path', required: false }),
+    files: flags.string({ description: 'Use folders of tiffs as the configuration', required: false }),
 };
 BasemapsServerCommand.args = [];

package/build/index.d.ts

@@ -1,2 +1,2 @@
-export { BasemapsServer } from './server.js';
+export { createServer } from './server.js';
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/build/index.js

@@ -1 +1 @@
-export { BasemapsServer } from './server.js';
+export { createServer } from './server.js';

package/build/server.d.ts

@@ -1,3 +1,4 @@
-/// <reference types="node" />
-export declare const BasemapsServer: import("fastify").FastifyInstance<import("http").Server, import("http").IncomingMessage, import("http").ServerResponse, import("fastify").FastifyLoggerInstance> & PromiseLike<import("fastify").FastifyInstance<import("http").Server, import("http").IncomingMessage, import("http").ServerResponse, import("fastify").FastifyLoggerInstance>>;
+import { LogType } from '@basemaps/shared';
+import { FastifyInstance } from 'fastify';
+export declare function createServer(logger: LogType): FastifyInstance;
 //# sourceMappingURL=server.d.ts.map

package/build/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":";AAMA,eAAO,MAAM,cAAc,kVAAY,CAAC"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,OAAgB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAcnD,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,eAAe,CAyC7D"}

package/build/server.js

@@ -1,8 +1,11 @@
 import { handler } from '@basemaps/lambda-tiler';
+import fastifyStatic from '@fastify/static';
 import { lf } from '@linzjs/lambda';
 import fastify from 'fastify';
+import { createRequire } from 'module';
+import path from 'path';
 import ulid from 'ulid';
-export const BasemapsServer = fastify();
+import { URL } from 'url';
 function isAlbResult(r) {
     if (typeof r !== 'object')
         return false;
@@ -11,31 +14,46 @@ function isAlbResult(r) {
     return 'statusCode' in r;
 }
 const instanceId = ulid.ulid();
-BasemapsServer.get('/v1/*', async (req, res) => {
-    const event = {
-        httpMethod: 'GET',
-        requestContext: { elb: { targetGroupArn: 'arn:fake' } },
-        path: req.url,
-        headers: req.headers,
-        queryStringParameters: req.query,
-        body: null,
-        isBase64Encoded: false,
-    };
-    if (req.query.api == null)
-        req.query.api = 'c' + instanceId;
-    handler(event, {}, (err, r) => {
-        var _a;
-        if (err || !isAlbResult(r)) {
-            lf.Logger.fatal({ err }, 'RequestFailed');
-            res.send(err);
-            return;
-        }
-        res.status(r.statusCode);
-        for (const [key, value] of Object.entries((_a = r.headers) !== null && _a !== void 0 ? _a : {}))
-            res.header(key, String(value));
-        if (r.body)
-            res.send(Buffer.from(r.body, r.isBase64Encoded ? 'base64' : 'utf8'));
-        else
-            res.send('Not found');
+export function createServer(logger) {
+    const BasemapsServer = fastify();
+    const require = createRequire(import.meta.url);
+    const landingLocation = require.resolve('@basemaps/landing');
+    if (landingLocation == null) {
+        logger.warn('Server:Landing:Failed');
+    }
+    else {
+        const root = path.join(path.dirname(landingLocation), '..', 'dist');
+        logger.info({ path: root }, 'Server:Landing');
+        BasemapsServer.register(fastifyStatic, { root });
+    }
+    BasemapsServer.get('/v1/*', async (req, res) => {
+        const url = new URL(`${req.protocol}://${req.hostname}${req.url}`);
+        const event = {
+            httpMethod: 'GET',
+            requestContext: { elb: { targetGroupArn: 'arn:fake' } },
+            path: url.pathname,
+            headers: req.headers,
+            queryStringParameters: req.query,
+            body: null,
+            isBase64Encoded: false,
+        };
+        if (req.query.api == null)
+            req.query.api = 'c' + instanceId;
+        handler(event, {}, (err, r) => {
+            var _a;
+            if (err || !isAlbResult(r)) {
+                lf.Logger.fatal({ err }, 'RequestFailed');
+                res.send(err);
+                return;
+            }
+            res.status(r.statusCode);
+            for (const [key, value] of Object.entries((_a = r.headers) !== null && _a !== void 0 ? _a : {}))
+                res.header(key, String(value));
+            if (r.body)
+                res.send(Buffer.from(r.body, r.isBase64Encoded ? 'base64' : 'utf8'));
+            else
+                res.send('Not found');
+        });
     });
-});
+    return BasemapsServer;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basemaps/server",
-  "version": "6.24.2",
+  "version": "6.27.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/linz/basemaps.git",
@@ -32,14 +32,16 @@
     "bin/"
   ],
   "dependencies": {
-    "@basemaps/config": "^6.24.2",
-    "@basemaps/geo": "^6.24.2",
-    "@basemaps/lambda-tiler": "^6.24.2",
-    "@basemaps/shared": "^6.24.2",
-    "@linzjs/lambda": "^2.0.0",
+    "@basemaps/config": "^6.27.0",
+    "@basemaps/geo": "^6.26.0",
+    "@basemaps/lambda-tiler": "^6.27.0",
+    "@basemaps/landing": "^6.27.0",
+    "@basemaps/shared": "^6.27.0",
+    "@fastify/static": "^5.0.2",
+    "@linzjs/lambda": "^3.0.1",
     "@oclif/command": "^1.8.0",
     "fastify": "^3.27.4",
     "pretty-json-log": "^1.0.0"
   },
-  "gitHead": "12826558ede6a4e6ecdc0c250afc9a784b9cb40e"
+  "gitHead": "c6aa61c20503cbc7f04cf31927f4e2b95aed34cb"
 }