chiitiler 1.12.5 → 1.12.7

package/README.md

@@ -102,6 +102,7 @@ you can pass server options via environment variables
 | CHIITILER_S3CACHE_BUCKET           |          | s3cache bucket name                            |
 | CHIITILER_S3_REGION                | us-east1 | s3 bucket region for caching/fetching          |
 | CHIITILER_S3_ENDPOINT              |          | s3 endpoint for caching/fetching               |
+| CHIITILER_S3_FORCE_PATH_STYLE      | false    | force path style for s3, needed for minio      |
 
 ### Local
 
@@ -263,6 +264,7 @@ const s3Cache = ChiitilerCache.s3Cache({
     region: 'ap-northeast-1',
     endpoint: null,
 });
+// credentials are loaded from environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
 
 const tileBuf = await getRenderedTileBuffer({
     stylejson: 'https://example.com/style.json', // or StyleSpecification object

package/dist/cache/s3.d.ts

@@ -2,7 +2,8 @@ import { type Cache } from './index.js';
 type S3CacheOptions = {
     bucket: string;
     region: string;
-    endpoint: string | null;
+    endpoint?: string;
+    forcePathStyle?: boolean;
 };
 declare function s3Cache(options: S3CacheOptions): Cache;
 export { s3Cache };

package/dist/cache/s3.js

@@ -4,6 +4,7 @@ function s3Cache(options) {
     const s3Client = getS3Client({
         region: options.region,
         endpoint: options.endpoint,
+        forcePathStyle: options.forcePathStyle,
     });
     return {
         name: 's3',

package/dist/cli.js

@@ -19,6 +19,7 @@ function parseCacheStrategy(method, options) {
             bucket: options.s3CacheBucket,
             region: options.s3Region,
             endpoint: options.s3Endpoint,
+            forcePathStyle: options.s3ForcePathStyle,
         });
     // command-line is not specified -> try to read from env
     const cacheEnv = process.env.CHIITILER_CACHE_METHOD;
@@ -36,7 +37,8 @@ function parseCacheStrategy(method, options) {
         return caches.s3Cache({
             bucket: process.env.CHIITILER_S3CACHE_BUCKET ?? '',
             region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-            endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+            endpoint: process.env.CHIITILER_S3_ENDPOINT,
+            forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
         });
     // undefined or invalid
     return caches.noneCache();
@@ -74,6 +76,7 @@ export function createProgram() {
         .option('-s3r --s3-region <region-name>', 's3 bucket region for get/put', 'us-east1')
         .option('-s3b --s3-cache-bucket <bucket-name>', 's3 cache bucket name', '')
         .option('-s3e --s3-endpoint <url>', 's3 endpoint url', '')
+        .option('-3p --s3-force-path-style', 's3 force path style', '')
         .option('-p --port <port>', 'port number')
         .option('-D --debug', 'debug mode')
         .action((options) => {
@@ -85,6 +88,7 @@ export function createProgram() {
                 s3CacheBucket: options.s3CacheBucket,
                 s3Region: options.s3Region,
                 s3Endpoint: options.s3Endpoint,
+                s3ForcePathStyle: options.s3ForcePathStyle === 'true',
             }),
             port: parsePort(options.port),
             debug: parseDebug(options.debug),

package/dist/s3.d.ts

@@ -1,6 +1,7 @@
 import { S3Client } from '@aws-sdk/client-s3';
-declare const getS3Client: ({ region, endpoint, }: {
+declare const getS3Client: ({ region, endpoint, forcePathStyle, }: {
     region: string;
-    endpoint: string | null;
+    endpoint?: string | undefined;
+    forcePathStyle?: boolean | undefined;
 }) => S3Client;
 export { getS3Client };

package/dist/s3.js

@@ -1,23 +1,13 @@
 import { S3Client } from '@aws-sdk/client-s3';
 let s3Client; // singleton
-const getS3Client = function ({ region, endpoint, }) {
+const getS3Client = function ({ region, endpoint, forcePathStyle, }) {
     if (s3Client !== undefined)
         return s3Client;
-    let s3ClientConfig = {
+    const s3ClientConfig = {
         region,
-        endpoint: endpoint ?? undefined,
+        endpoint,
+        forcePathStyle,
     };
-    if (process.env.NODE_ENV === 'development') {
-        s3ClientConfig = {
-            region,
-            credentials: {
-                accessKeyId: 'minioadmin',
-                secretAccessKey: 'minioadmin',
-            },
-            forcePathStyle: true,
-            endpoint: 'http://minio:9000',
-        };
-    }
     s3Client = new S3Client(s3ClientConfig);
     return s3Client;
 };

package/dist/source/pmtiles.js

@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 import { PMTiles } from 'pmtiles';
-import { GetObjectCommand } from '@aws-sdk/client-s3';
+import { GetObjectCommand, } from '@aws-sdk/client-s3';
 import { LRUCache } from 'lru-cache';
 import { getS3Client } from '../s3.js';
 import { noneCache } from '../cache/index.js';
@@ -32,30 +32,39 @@ class S3Source {
         this.key = key;
         this.s3Client = getS3Client({
             region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-            endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+            endpoint: process.env.CHIITILER_S3_ENDPOINT,
+            forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
         });
     }
     getKey() {
         return `s3://${this.bucket}/${this.key}`;
     }
-    async getBytes(offset, length) {
-        const cmd = new GetObjectCommand({
-            Bucket: this.bucket,
-            Key: this.key,
-            Range: `bytes=${offset}-${offset + length - 1}`,
-        });
+    async getBytes(offset, length, signal, etag) {
+        let resp;
         try {
-            const obj = await this.s3Client.send(cmd);
-            if (obj.Body === undefined)
-                return { data: Buffer.alloc(0).buffer };
-            const buf = Buffer.from(await obj.Body.transformToByteArray());
-            return { data: buf.buffer };
+            resp = await this.s3Client.send(new GetObjectCommand({
+                Bucket: this.bucket,
+                Key: this.key,
+                Range: 'bytes=' + offset + '-' + (offset + length - 1),
+                IfMatch: etag,
+            }));
         }
         catch (e) {
-            if (e.name !== 'NoSuchKey')
-                console.log(e);
-            return { data: Buffer.alloc(0).buffer };
+            if (e instanceof Error &&
+                e.name === 'PreconditionFailed') {
+                throw new Error('etag mismatch');
+            }
+            throw e;
         }
+        const arr = await resp.Body?.transformToByteArray();
+        if (!arr)
+            throw Error('Failed to read S3 response body');
+        return {
+            data: arr.buffer,
+            etag: resp.ETag,
+            expires: resp.Expires?.toISOString(),
+            cacheControl: resp.CacheControl,
+        };
     }
 }
 /**

package/dist/source/s3.js

@@ -3,7 +3,8 @@ import { getS3Client } from '../s3.js';
 async function getS3Source(uri) {
     const s3Client = getS3Client({
         region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-        endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+        endpoint: process.env.CHIITILER_S3_ENDPOINT,
+        forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
     });
     const bucket = uri.replace('s3://', '').split('/')[0];
     const key = uri.replace(`s3://${bucket}/`, '');

package/package.json

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