mirror of
https://github.com/protomaps/PMTiles.git
synced 2026-02-04 02:41:09 +00:00
369 lines
10 KiB
TypeScript
369 lines
10 KiB
TypeScript
import { test } from "node:test";
|
|
import assert from "node:assert";
|
|
import fs from "fs";
|
|
|
|
import {
|
|
Entry,
|
|
zxyToTileId,
|
|
tileIdToZxy,
|
|
findTile,
|
|
readVarint,
|
|
SharedPromiseCache,
|
|
BufferPosition,
|
|
Source,
|
|
RangeResponse,
|
|
EtagMismatch,
|
|
PMTiles,
|
|
getUint64,
|
|
} from "../index";
|
|
|
|
test("varint", () => {
|
|
let b: BufferPosition = {
|
|
buf: new Uint8Array([0, 1, 127, 0xe5, 0x8e, 0x26]),
|
|
pos: 0,
|
|
};
|
|
assert.strictEqual(readVarint(b), 0);
|
|
assert.strictEqual(readVarint(b), 1);
|
|
assert.strictEqual(readVarint(b), 127);
|
|
assert.strictEqual(readVarint(b), 624485);
|
|
b = {
|
|
buf: new Uint8Array([0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x0f]),
|
|
pos: 0,
|
|
};
|
|
assert.strictEqual(readVarint(b), 9007199254740991);
|
|
});
|
|
|
|
test("zxy to tile id", () => {
|
|
assert.strictEqual(zxyToTileId(0, 0, 0), 0);
|
|
assert.strictEqual(zxyToTileId(1, 0, 0), 1);
|
|
assert.strictEqual(zxyToTileId(1, 0, 1), 2);
|
|
assert.strictEqual(zxyToTileId(1, 1, 1), 3);
|
|
assert.strictEqual(zxyToTileId(1, 1, 0), 4);
|
|
assert.strictEqual(zxyToTileId(2, 0, 0), 5);
|
|
});
|
|
|
|
test("tile id to zxy", () => {
|
|
assert.deepEqual(tileIdToZxy(0), [0, 0, 0]);
|
|
assert.deepEqual(tileIdToZxy(1), [1, 0, 0]);
|
|
assert.deepEqual(tileIdToZxy(2), [1, 0, 1]);
|
|
assert.deepEqual(tileIdToZxy(3), [1, 1, 1]);
|
|
assert.deepEqual(tileIdToZxy(4), [1, 1, 0]);
|
|
assert.deepEqual(tileIdToZxy(5), [2, 0, 0]);
|
|
});
|
|
|
|
test("a lot of tiles", () => {
|
|
for (let z = 0; z < 9; z++) {
|
|
for (let x = 0; x < 1 << z; x++) {
|
|
for (let y = 0; y < 1 << z; y++) {
|
|
const result = tileIdToZxy(zxyToTileId(z, x, y));
|
|
if (result[0] !== z || result[1] !== x || result[2] !== y) {
|
|
assert.fail("roundtrip failed");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
test("tile search for missing entry", () => {
|
|
const entries: Entry[] = [];
|
|
assert.strictEqual(findTile(entries, 101), null);
|
|
});
|
|
|
|
test("tile search for first entry == id", () => {
|
|
const entries: Entry[] = [
|
|
{ tileId: 100, offset: 1, length: 1, runLength: 1 },
|
|
];
|
|
const entry = findTile(entries, 100)!;
|
|
assert.strictEqual(entry.offset, 1);
|
|
assert.strictEqual(entry.length, 1);
|
|
assert.strictEqual(findTile(entries, 101), null);
|
|
});
|
|
|
|
test("tile search with multiple tile entries", () => {
|
|
let entries: Entry[] = [{ tileId: 100, offset: 1, length: 1, runLength: 2 }];
|
|
let entry = findTile(entries, 101)!;
|
|
assert.strictEqual(entry.offset, 1);
|
|
assert.strictEqual(entry.length, 1);
|
|
|
|
entries = [
|
|
{ tileId: 100, offset: 1, length: 1, runLength: 1 },
|
|
{ tileId: 150, offset: 2, length: 2, runLength: 2 },
|
|
];
|
|
entry = findTile(entries, 151)!;
|
|
assert.strictEqual(entry.offset, 2);
|
|
assert.strictEqual(entry.length, 2);
|
|
|
|
entries = [
|
|
{ tileId: 50, offset: 1, length: 1, runLength: 2 },
|
|
{ tileId: 100, offset: 2, length: 2, runLength: 1 },
|
|
{ tileId: 150, offset: 3, length: 3, runLength: 1 },
|
|
];
|
|
entry = findTile(entries, 51)!;
|
|
assert.strictEqual(entry.offset, 1);
|
|
assert.strictEqual(entry.length, 1);
|
|
});
|
|
|
|
test("leaf search", () => {
|
|
const entries: Entry[] = [
|
|
{ tileId: 100, offset: 1, length: 1, runLength: 0 },
|
|
];
|
|
const entry = findTile(entries, 150);
|
|
assert.strictEqual(entry!.offset, 1);
|
|
assert.strictEqual(entry!.length, 1);
|
|
});
|
|
|
|
// inefficient method only for testing
|
|
class TestNodeFileSource implements Source {
|
|
buffer: ArrayBuffer;
|
|
path: string;
|
|
key: string;
|
|
etag?: string;
|
|
|
|
constructor(path: string, key: string) {
|
|
this.path = path;
|
|
this.buffer = fs.readFileSync(path);
|
|
this.key = key;
|
|
}
|
|
|
|
getKey() {
|
|
return this.key;
|
|
}
|
|
|
|
replaceData(path: string) {
|
|
this.path = path;
|
|
this.buffer = fs.readFileSync(path);
|
|
}
|
|
|
|
async getBytes(offset: number, length: number): Promise<RangeResponse> {
|
|
const slice = new Uint8Array(this.buffer.slice(offset, offset + length))
|
|
.buffer;
|
|
return { data: slice, etag: this.etag };
|
|
}
|
|
}
|
|
|
|
// echo '{"type":"Polygon","coordinates":[[[0,0],[0,1],[1,1],[1,0],[0,0]]]}' | ./tippecanoe -zg -o test_fixture_1.pmtiles
|
|
test("cache getHeader", async () => {
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
const cache = new SharedPromiseCache();
|
|
const header = await cache.getHeader(source);
|
|
assert.strictEqual(header.rootDirectoryOffset, 127);
|
|
assert.strictEqual(header.rootDirectoryLength, 25);
|
|
assert.strictEqual(header.jsonMetadataOffset, 152);
|
|
assert.strictEqual(header.jsonMetadataLength, 247);
|
|
assert.strictEqual(header.leafDirectoryOffset, 0);
|
|
assert.strictEqual(header.leafDirectoryLength, 0);
|
|
assert.strictEqual(header.tileDataOffset, 399);
|
|
assert.strictEqual(header.tileDataLength, 69);
|
|
assert.strictEqual(header.numAddressedTiles, 1);
|
|
assert.strictEqual(header.numTileEntries, 1);
|
|
assert.strictEqual(header.numTileContents, 1);
|
|
assert.strictEqual(header.clustered, false);
|
|
assert.strictEqual(header.internalCompression, 2);
|
|
assert.strictEqual(header.tileCompression, 2);
|
|
assert.strictEqual(header.tileType, 1);
|
|
assert.strictEqual(header.minZoom, 0);
|
|
assert.strictEqual(header.maxZoom, 0);
|
|
assert.strictEqual(header.minLon, 0);
|
|
assert.strictEqual(header.minLat, 0);
|
|
// assert.strictEqual(header.maxLon,1); // TODO fix me
|
|
assert.strictEqual(header.maxLat, 1);
|
|
});
|
|
|
|
test("getUint64", async () => {
|
|
const view = new DataView(new ArrayBuffer(8));
|
|
view.setBigUint64(0, 0n, true);
|
|
assert.strictEqual(getUint64(view, 0), 0);
|
|
view.setBigUint64(0, 1n, true);
|
|
assert.strictEqual(getUint64(view, 0), 1);
|
|
view.setBigUint64(0, 9007199254740991n, true);
|
|
assert.strictEqual(getUint64(view, 0), 9007199254740991);
|
|
});
|
|
|
|
test("cache check against empty", async () => {
|
|
const source = new TestNodeFileSource("test/data/empty.pmtiles", "1");
|
|
const cache = new SharedPromiseCache();
|
|
try {
|
|
await cache.getHeader(source);
|
|
assert.fail("Should have thrown");
|
|
} catch (e) {
|
|
assert.ok(e instanceof Error);
|
|
}
|
|
});
|
|
|
|
test("cache check magic number", async () => {
|
|
const source = new TestNodeFileSource("test/data/invalid.pmtiles", "1");
|
|
const cache = new SharedPromiseCache();
|
|
try {
|
|
await cache.getHeader(source);
|
|
assert.fail("Should have thrown");
|
|
} catch (e) {
|
|
assert.ok(e instanceof Error);
|
|
}
|
|
});
|
|
|
|
test("cache check future spec version", async () => {
|
|
const source = new TestNodeFileSource("test/data/invalid_v4.pmtiles", "1");
|
|
const cache = new SharedPromiseCache();
|
|
try {
|
|
await cache.getHeader(source);
|
|
assert.fail("Should have thrown");
|
|
} catch (e) {
|
|
assert.ok(e instanceof Error);
|
|
}
|
|
});
|
|
|
|
test("cache getDirectory", async () => {
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
|
|
let cache = new SharedPromiseCache(6400, false);
|
|
let header = await cache.getHeader(source);
|
|
assert.strictEqual(cache.cache.size, 1);
|
|
|
|
cache = new SharedPromiseCache(6400, true);
|
|
header = await cache.getHeader(source);
|
|
|
|
// prepopulates the root directory
|
|
assert.strictEqual(cache.cache.size, 2);
|
|
|
|
const directory = await cache.getDirectory(
|
|
source,
|
|
header.rootDirectoryOffset,
|
|
header.rootDirectoryLength,
|
|
header
|
|
);
|
|
assert.strictEqual(directory.length, 1);
|
|
assert.strictEqual(directory[0].tileId, 0);
|
|
assert.strictEqual(directory[0].offset, 0);
|
|
assert.strictEqual(directory[0].length, 69);
|
|
assert.strictEqual(directory[0].runLength, 1);
|
|
|
|
for (const v of cache.cache.values()) {
|
|
assert.ok(v.lastUsed > 0);
|
|
}
|
|
});
|
|
|
|
test("multiple sources in a single cache", async () => {
|
|
const cache = new SharedPromiseCache();
|
|
const source1 = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
const source2 = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"2"
|
|
);
|
|
await cache.getHeader(source1);
|
|
assert.strictEqual(cache.cache.size, 2);
|
|
await cache.getHeader(source2);
|
|
assert.strictEqual(cache.cache.size, 4);
|
|
});
|
|
|
|
test("etags are part of key", async () => {
|
|
const cache = new SharedPromiseCache(6400, false);
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
source.etag = "etag_1";
|
|
let header = await cache.getHeader(source);
|
|
assert.strictEqual(header.etag, "etag_1");
|
|
|
|
source.etag = "etag_2";
|
|
|
|
try {
|
|
await cache.getDirectory(
|
|
source,
|
|
header.rootDirectoryOffset,
|
|
header.rootDirectoryLength,
|
|
header
|
|
);
|
|
assert.fail("Should have thrown");
|
|
} catch (e) {
|
|
assert.ok(e instanceof EtagMismatch);
|
|
}
|
|
cache.invalidate(source, "etag_2");
|
|
header = await cache.getHeader(source);
|
|
assert.ok(
|
|
await cache.getDirectory(
|
|
source,
|
|
header.rootDirectoryOffset,
|
|
header.rootDirectoryLength,
|
|
header
|
|
)
|
|
);
|
|
});
|
|
|
|
test("soft failure on etag weirdness", async () => {
|
|
const cache = new SharedPromiseCache(6400, false);
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
source.etag = "etag_1";
|
|
let header = await cache.getHeader(source);
|
|
assert.strictEqual(header.etag, "etag_1");
|
|
|
|
source.etag = "etag_2";
|
|
|
|
try {
|
|
await cache.getDirectory(
|
|
source,
|
|
header.rootDirectoryOffset,
|
|
header.rootDirectoryLength,
|
|
header
|
|
);
|
|
assert.fail("Should have thrown");
|
|
} catch (e) {
|
|
assert.ok(e instanceof EtagMismatch);
|
|
}
|
|
|
|
source.etag = "etag_1";
|
|
cache.invalidate(source, "etag_2");
|
|
|
|
header = await cache.getHeader(source);
|
|
assert.strictEqual(header.etag, undefined);
|
|
});
|
|
|
|
test("cache pruning by byte size", async () => {
|
|
const cache = new SharedPromiseCache(2, false);
|
|
cache.cache.set("0", { lastUsed: 0, data: Promise.resolve([]) });
|
|
cache.cache.set("1", { lastUsed: 1, data: Promise.resolve([]) });
|
|
cache.cache.set("2", { lastUsed: 2, data: Promise.resolve([]) });
|
|
cache.prune();
|
|
assert.strictEqual(cache.cache.size, 2);
|
|
assert.ok(cache.cache.get("2"));
|
|
assert.ok(cache.cache.get("1"));
|
|
assert.ok(!cache.cache.get("0"));
|
|
});
|
|
|
|
test("pmtiles get metadata", async () => {
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
const p = new PMTiles(source);
|
|
const metadata = await p.getMetadata();
|
|
assert.ok(metadata.name);
|
|
});
|
|
|
|
// echo '{"type":"Polygon","coordinates":[[[0,0],[0,1],[1,0],[0,0]]]}' | ./tippecanoe -zg -o test_fixture_2.pmtiles
|
|
test("pmtiles handle retries", async () => {
|
|
const source = new TestNodeFileSource(
|
|
"test/data/test_fixture_1.pmtiles",
|
|
"1"
|
|
);
|
|
source.etag = "1";
|
|
const p = new PMTiles(source);
|
|
const metadata = await p.getMetadata();
|
|
assert.ok(metadata.name);
|
|
source.etag = "2";
|
|
source.replaceData("test/data/test_fixture_2.pmtiles");
|
|
assert.ok(await p.getZxy(0, 0, 0));
|
|
});
|