chiitiler 1.23.0 → 1.23.3

package/README.md

@@ -121,8 +121,11 @@ All options can be set via CLI flag or environment variable.
 | `--port <n>` | `CHIITILER_PORT` | `3000` |
 | `--debug` | `CHIITILER_DEBUG` | `false` |
 | `--user-agent <ua>` | `CHIITILER_USER_AGENT` | (none) |
+| `--prewarm` | `CHIITILER_PREWARM` | `false` |
 | — | `CHIITILER_PROCESSES` | `1` (set `0` for all CPUs) |
 
+With prewarm enabled, one tile is rendered at startup **before** the server starts listening, so renderer initialization (GL context, sharp/libvips, JIT) doesn't hit the first request. On AWS Lambda with Lambda Web Adapter, the readiness check keeps this inside the INIT phase, which runs with a full CPU boost.
+
 ### Cache
 
 | Flag | Env | Default |

package/dist/cli.js

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 import { initServer } from './server/index.js';
 import * as caches from './cache/index.js';
 import { setUserAgent } from './source/userAgent.js';
+import { prewarm } from './render/warmup.js';
 function parseCacheStrategy(method, options) {
     // command-line option
     if (method === 'memory')
@@ -71,6 +72,10 @@ function parsePort(port) {
     // undefined or invalid
     return 3000;
 }
+function parsePrewarm(prewarmFlag) {
+    // command-line option, then env
+    return prewarmFlag === true || process.env.CHIITILER_PREWARM === 'true';
+}
 function parseDebug(debug) {
     // command-line option
     if (debug)
@@ -101,8 +106,9 @@ export function createProgram() {
         .option('--gcs-api-endpoint <api-endpoint>', 'gcs api endpoint', '')
         .option('-p, --port <port>', 'port number')
         .option('--user-agent <user-agent>', 'User-Agent header for outbound HTTP requests')
+        .option('--prewarm', 'render one tile at startup before listening, to warm up the renderer')
         .option('-D, --debug', 'debug mode')
-        .action((options) => {
+        .action(async (options) => {
         // env fallback (CHIITILER_USER_AGENT) is handled in userAgent.ts
         if (options.userAgent !== undefined)
             setUserAgent(options.userAgent);
@@ -130,6 +136,20 @@ export function createProgram() {
             console.log(`debug page: http://localhost:${serverOptions.port}/debug`);
             console.log(`editor page: http://localhost:${serverOptions.port}/editor`);
         }
+        // warm up BEFORE listening: Lambda Web Adapter polls the
+        // readiness check until the port opens, so work done here
+        // stays inside the INIT phase (full CPU boost)
+        if (parsePrewarm(options.prewarm)) {
+            const startedAt = Date.now();
+            try {
+                await prewarm(serverOptions.cache);
+                console.log(`prewarm done in ${Date.now() - startedAt}ms`);
+            }
+            catch (err) {
+                // 温まらないだけでサーバとしては動けるので起動は続行する
+                console.warn(`prewarm failed: ${err}`);
+            }
+        }
         const { start } = initServer(serverOptions);
         start();
     });

package/dist/render/warmup.d.ts

@@ -0,0 +1,9 @@
+import type { Cache } from '../cache/index.js';
+/**
+ * Render one z0 tile ahead of the first request so that renderer
+ * initialization happens at startup — on AWS Lambda (with Lambda Web
+ * Adapter's readiness check) this moves the work into the INIT phase,
+ * which runs with a full CPU boost.
+ */
+declare function prewarm(cache: Cache): Promise<void>;
+export { prewarm };

package/dist/render/warmup.js

@@ -0,0 +1,35 @@
+import { getRenderedTile } from './index.js';
+// スタイル固有のリソース(タイル/glyphs/sprite)は温まらないが、
+// EGL/GLコンテキスト・Xvfb接続・sharp(libvips)・JITの初期化は共通で効く。
+const MINIMAL_STYLE = {
+    version: 8,
+    sources: {},
+    layers: [
+        {
+            id: 'background',
+            type: 'background',
+            paint: { 'background-color': '#ffffff' },
+        },
+    ],
+};
+/**
+ * Render one z0 tile ahead of the first request so that renderer
+ * initialization happens at startup — on AWS Lambda (with Lambda Web
+ * Adapter's readiness check) this moves the work into the INIT phase,
+ * which runs with a full CPU boost.
+ */
+async function prewarm(cache) {
+    const sharp = await getRenderedTile({
+        stylejson: MINIMAL_STYLE,
+        z: 0,
+        x: 0,
+        y: 0,
+        tileSize: 512,
+        cache,
+        margin: 0,
+        ext: 'png',
+        quality: 100,
+    });
+    await sharp.toBuffer(); // force the actual encode
+}
+export { prewarm };

package/dist/source/fs.js

@@ -1,24 +1,10 @@
 import fs from 'node:fs/promises';
+import { loadWithDecodedPathFallback } from './path.js';
 async function getFilesystemSource(uri) {
     const path = uri.replace('file://', '');
-    const data = await fs.readFile(path).catch(() => null);
+    const data = await loadWithDecodedPathFallback(path, (candidate) => fs.readFile(candidate).catch(() => null));
     if (data !== null)
         return data;
-    // maplibre-gl-native percent-encodes {fontstack} in glyphs URLs
-    // (e.g. "Noto Sans Regular" -> "Noto%20Sans%20Regular"),
-    // so retry with the percent-decoded path
-    let decodedPath;
-    try {
-        decodedPath = decodeURIComponent(path);
-    }
-    catch {
-        decodedPath = path;
-    }
-    if (decodedPath !== path) {
-        const decodedData = await fs.readFile(decodedPath).catch(() => null);
-        if (decodedData !== null)
-            return decodedData;
-    }
     console.error(`[ERROR]: failed to read ${path}`);
     return null;
 }

package/dist/source/gcs.js

@@ -1,4 +1,5 @@
 import { getStorageClient } from '../gcs.js';
+import { loadWithDecodedPathFallback } from './path.js';
 async function getGCSSource(uri) {
     const storageClient = getStorageClient({
         projectId: process.env.CHIITILER_GCS_PROJECT_ID,
@@ -7,18 +8,20 @@ async function getGCSSource(uri) {
     });
     const bucket = uri.replace('gs://', '').split('/')[0];
     const path = uri.replace(`gs://${bucket}/`, '');
-    try {
-        const file = storageClient.bucket(bucket).file(path);
-        const [buffer] = await file.download();
-        return buffer;
-    }
-    catch (e) {
-        // 404: オブジェクトが存在しない。空タイルとして扱わせる
-        if (e.code === 404)
-            return null;
-        // それ以外は有無が不明なのでthrowしてレンダリングを失敗させる
-        console.log(e);
-        throw e;
-    }
+    return loadWithDecodedPathFallback(path, async (candidate) => {
+        try {
+            const file = storageClient.bucket(bucket).file(candidate);
+            const [buffer] = await file.download();
+            return buffer;
+        }
+        catch (e) {
+            // 404: オブジェクトが存在しない。空タイルとして扱わせる
+            if (e.code === 404)
+                return null;
+            // それ以外は有無が不明なのでthrowしてレンダリングを失敗させる
+            console.log(e);
+            throw e;
+        }
+    });
 }
 export { getGCSSource };

package/dist/source/path.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Load a percent-decoded path first, then retry its literal form when the
+ * resource is absent. MapLibre Native encodes glyph font stacks before passing
+ * their URLs to the source resolver, while object stores treat keys literally.
+ */
+declare function loadWithDecodedPathFallback<T>(path: string, load: (path: string) => Promise<T | null>): Promise<T | null>;
+export { loadWithDecodedPathFallback };

package/dist/source/path.js

@@ -0,0 +1,21 @@
+/**
+ * Load a percent-decoded path first, then retry its literal form when the
+ * resource is absent. MapLibre Native encodes glyph font stacks before passing
+ * their URLs to the source resolver, while object stores treat keys literally.
+ */
+async function loadWithDecodedPathFallback(path, load) {
+    let decodedPath;
+    try {
+        decodedPath = decodeURIComponent(path);
+    }
+    catch {
+        return load(path);
+    }
+    if (decodedPath === path)
+        return load(path);
+    const decodedData = await load(decodedPath);
+    if (decodedData !== null)
+        return decodedData;
+    return load(path);
+}
+export { loadWithDecodedPathFallback };

package/dist/source/s3.js

@@ -1,5 +1,6 @@
 import { GetObjectCommand } from '@aws-sdk/client-s3';
 import { getS3Client } from '../s3.js';
+import { loadWithDecodedPathFallback } from './path.js';
 async function getS3Source(uri) {
     const s3Client = getS3Client({
         region: process.env.CHIITILER_S3_REGION ?? 'us-east-1',
@@ -8,25 +9,26 @@ async function getS3Source(uri) {
     });
     const bucket = uri.replace('s3://', '').split('/')[0];
     const key = uri.replace(`s3://${bucket}/`, '');
-    const cmd = new GetObjectCommand({
-        Bucket: bucket,
-        Key: key,
+    return loadWithDecodedPathFallback(key, async (candidate) => {
+        const cmd = new GetObjectCommand({
+            Bucket: bucket,
+            Key: candidate,
+        });
+        try {
+            const obj = await s3Client.send(cmd);
+            if (obj.Body === undefined)
+                return null;
+            return Buffer.from(await obj.Body.transformToByteArray());
+        }
+        catch (e) {
+            // NoSuchKey: オブジェクトが存在しない。空タイルとして扱わせる
+            if (e.name === 'NoSuchKey')
+                return null;
+            // それ以外(スロットリング・ネットワークエラー等)は有無が不明なので
+            // throwしてレンダリングを失敗させる
+            console.log(e);
+            throw e;
+        }
     });
-    try {
-        const obj = await s3Client.send(cmd);
-        if (obj.Body === undefined)
-            return null;
-        const buf = Buffer.from(await obj.Body.transformToByteArray());
-        return buf;
-    }
-    catch (e) {
-        // NoSuchKey: オブジェクトが存在しない。空タイルとして扱わせる
-        if (e.name === 'NoSuchKey')
-            return null;
-        // それ以外(スロットリング・ネットワークエラー等)は有無が不明なので
-        // throwしてレンダリングを失敗させる
-        console.log(e);
-        throw e;
-    }
 }
 export { getS3Source };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.23.0",
+  "version": "1.23.3",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",