@gscdump/lakehouse 4.2.0 → 4.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,12 +13,14 @@ export interface CatalogCache {
13
13
  /** Optional warning sink for best-effort cache driver failures. */
14
14
  onError?: (operation: 'get' | 'set' | 'remove', key: string, error: unknown) => void;
15
15
  }
16
+ /** Outcome of one cache read, including misses that still permit a fresh load. */
17
+ export type CatalogCacheGetOutcome = 'hit' | 'miss' | 'expired' | 'invalid' | 'error';
16
18
  /**
17
19
  * Read a cached value. Returns `undefined` on a miss, an expired entry, a
18
20
  * malformed box, or any driver error (the cache is best-effort: a read failure
19
21
  * degrades to a fresh load, never to an error).
20
22
  */
21
- export declare function cacheGet<T>(cache: CatalogCache, key: string, now: number): Promise<T | undefined>;
23
+ export declare function cacheGet<T>(cache: CatalogCache, key: string, now: number, onOutcome?: (outcome: CatalogCacheGetOutcome) => void): Promise<T | undefined>;
22
24
  /**
23
25
  * Write a cached value with an embedded expiry and a forwarded driver TTL.
24
26
  *
@@ -6,12 +6,37 @@ function reportCatalogCacheError(cache, operation, key, error) {
6
6
  console.warn(`[gscdump/lakehouse] cache error reporter failed during ${operation} for ${key}`, reportError);
7
7
  }
8
8
  }
9
- async function cacheGet(cache, key, now) {
10
- const boxed = await cache.storage.getItem(key).catch((error) => {
9
+ async function cacheGet(cache, key, now, onOutcome) {
10
+ const reportOutcome = (outcome) => {
11
+ try {
12
+ onOutcome?.(outcome);
13
+ } catch {}
14
+ };
15
+ const read = await cache.storage.getItem(key).then((boxed) => ({
16
+ _tag: "Ok",
17
+ boxed
18
+ }), (error) => {
11
19
  reportCatalogCacheError(cache, "get", key, error);
12
- return null;
20
+ return { _tag: "Error" };
13
21
  });
14
- if (!boxed || typeof boxed.exp !== "number" || boxed.exp <= now) return void 0;
22
+ if (read._tag === "Error") {
23
+ reportOutcome("error");
24
+ return;
25
+ }
26
+ const { boxed } = read;
27
+ if (!boxed) {
28
+ reportOutcome("miss");
29
+ return;
30
+ }
31
+ if (typeof boxed.exp !== "number" || boxed.v === void 0) {
32
+ reportOutcome("invalid");
33
+ return;
34
+ }
35
+ if (boxed.exp <= now) {
36
+ reportOutcome("expired");
37
+ return;
38
+ }
39
+ reportOutcome("hit");
15
40
  return boxed.v;
16
41
  }
17
42
  function cachePut(cache, key, value, ttlMs, now) {
@@ -93,6 +93,8 @@ export interface ConnectIcebergOptions {
93
93
  cache?: CatalogCache;
94
94
  /** Injectable clock for the cache TTL. Defaults to `Date.now`. */
95
95
  clock?: () => number;
96
+ /** Optional connection-stage timings. Spans carry no catalog coordinates. */
97
+ profiler?: QueryProfiler;
96
98
  }
97
99
  /**
98
100
  * Connect to the R2 Data Catalog: a REST catalog context + a signed S3
package/dist/catalog.mjs CHANGED
@@ -35,6 +35,20 @@ function manifestReadCacheFor(conn, namespace, table, metadata) {
35
35
  }
36
36
  return cache;
37
37
  }
38
+ function startConnectSpan(profiler, name) {
39
+ if (!profiler) return void 0;
40
+ try {
41
+ const end = profiler.start(name);
42
+ if (!end) return void 0;
43
+ return (meta) => {
44
+ try {
45
+ end(meta);
46
+ } catch {}
47
+ };
48
+ } catch {
49
+ return;
50
+ }
51
+ }
38
52
  let icebirdWriteModule;
39
53
  function useIcebirdWriteModule() {
40
54
  icebirdWriteModule ??= import("./_virtual/node_modules/.pnpm/icebird@0.8.30_patch_hash=a400e343a199b1ca18601f96348011745ac6518fc07ffa71d5adfdd2ccc7d14f/node_modules/icebird/src/write/write.mjs");
@@ -49,7 +63,12 @@ async function connectIcebergCatalog(config, opts = {}) {
49
63
  const requestInit = { headers: { Authorization: `Bearer ${config.catalogToken}` } };
50
64
  let catalog;
51
65
  if (opts.cache) {
52
- const cached = await cacheGet(opts.cache, catalogConfigKey(config), now);
66
+ const endCache = startConnectSpan(opts.profiler, "catalog.config.cache");
67
+ const cacheRead = { outcome: "miss" };
68
+ const cached = await cacheGet(opts.cache, catalogConfigKey(config), now, (outcome) => {
69
+ cacheRead.outcome = outcome;
70
+ });
71
+ endCache?.({ outcome: cacheRead.outcome === "hit" && !cached ? "invalid" : cacheRead.outcome });
53
72
  if (cached) catalog = Object.freeze({
54
73
  type: "rest",
55
74
  url: cached.url,
@@ -60,11 +79,18 @@ async function connectIcebergCatalog(config, opts = {}) {
60
79
  });
61
80
  }
62
81
  if (!catalog) {
63
- catalog = await restCatalogConnect({
64
- url: config.catalogUri,
65
- warehouse: config.warehouse,
66
- requestInit
67
- });
82
+ const endRest = startConnectSpan(opts.profiler, "catalog.config.rest");
83
+ let restOutcome = "error";
84
+ try {
85
+ catalog = await restCatalogConnect({
86
+ url: config.catalogUri,
87
+ warehouse: config.warehouse,
88
+ requestInit
89
+ });
90
+ restOutcome = "ok";
91
+ } finally {
92
+ endRest?.({ outcome: restOutcome });
93
+ }
68
94
  if (opts.cache) {
69
95
  const toCache = {
70
96
  url: catalog.url,
@@ -72,7 +98,12 @@ async function connectIcebergCatalog(config, opts = {}) {
72
98
  defaults: catalog.defaults,
73
99
  overrides: catalog.overrides
74
100
  };
75
- await cachePut(opts.cache, catalogConfigKey(config), toCache, CATALOG_CONFIG_TTL_MS, now);
101
+ const endWrite = startConnectSpan(opts.profiler, "catalog.config.write");
102
+ try {
103
+ await cachePut(opts.cache, catalogConfigKey(config), toCache, CATALOG_CONFIG_TTL_MS, now);
104
+ } finally {
105
+ endWrite?.({ deferred: opts.cache.defer != null });
106
+ }
76
107
  }
77
108
  }
78
109
  const cacheScope = catalogCacheScope(config);
@@ -11,13 +11,9 @@ export type ManifestPartitionFilter = (partitions: IcebergFieldSummary[] | undef
11
11
  /**
12
12
  * One identity/dims value to prune an `identity`-transform partition field by.
13
13
  *
14
- * `'int32'`-encoded fields are deliberately NOT pruned here (mirrors the
15
- * original engine behavior): an INT column's bound bytes are a 4-byte int, but
16
- * per-team catalogs are single-tenant, so identity pruning on them saves ~nothing
17
- * — the per-file partition check in the resolver remains the authoritative
18
- * correctness filter. Only `'string'`-encoded identity fields are pruned by
19
- * lexicographic UTF-8 bound comparison (the truncated-string-stats case R2 SQL
20
- * needs the workaround for).
14
+ * Identity summaries use the declared field encoding: UTF-8 for strings and
15
+ * four-byte little-endian for INT. Unknown bounds keep the manifest. The
16
+ * per-file partition check remains the authoritative correctness filter.
21
17
  */
22
18
  export interface PartitionValueMatch {
23
19
  /** Partition field name as declared in the partition spec (e.g. `'site_id'`). */
@@ -7,11 +7,12 @@ function decodeString(bytes) {
7
7
  const u = toUint8(bytes);
8
8
  return u == null ? null : UTF8_DECODER.decode(u);
9
9
  }
10
- function decodeMonthInt(bytes) {
10
+ function decodeInt32(bytes) {
11
11
  const u = toUint8(bytes);
12
- if (u == null) return null;
12
+ if (u?.byteLength !== 4) return null;
13
13
  return new DataView(u.buffer, u.byteOffset, u.byteLength).getInt32(0, true);
14
14
  }
15
+ const decodeMonthInt = decodeInt32;
15
16
  function buildManifestPartitionFilter(partitionSpec, matches, wantedMonths) {
16
17
  const fieldIndex = (name) => partitionSpec.findIndex((f) => f.name === name || f.sourceColumn === name);
17
18
  const monthFieldIndex = partitionSpec.findIndex((f) => f.transform === "month");
@@ -23,6 +24,14 @@ function buildManifestPartitionFilter(partitionSpec, matches, wantedMonths) {
23
24
  value: String(match.value)
24
25
  }];
25
26
  });
27
+ const intMatches = matches.flatMap((match) => {
28
+ if (match.encoding !== "int32" || typeof match.value !== "number" || !Number.isInteger(match.value) || match.value < -2147483648 || match.value > 2147483647) return [];
29
+ const index = fieldIndex(match.field);
30
+ return index < 0 || partitionSpec[index]?.transform !== "identity" ? [] : [{
31
+ index,
32
+ value: match.value
33
+ }];
34
+ });
26
35
  const wantedMonthValues = wantedMonths ? [...wantedMonths].filter(Number.isFinite).sort((a, b) => a - b) : [];
27
36
  const hasWantedMonthInRange = (lo, hi) => {
28
37
  let left = 0;
@@ -43,6 +52,13 @@ function buildManifestPartitionFilter(partitionSpec, matches, wantedMonths) {
43
52
  const hi = decodeString(summary.upper_bound);
44
53
  if (lo != null && hi != null && (match.value < lo || match.value > hi)) return false;
45
54
  }
55
+ for (const match of intMatches) {
56
+ const summary = partitions[match.index];
57
+ if (!summary || summary.lower_bound == null || summary.upper_bound == null) continue;
58
+ const lo = decodeInt32(summary.lower_bound);
59
+ const hi = decodeInt32(summary.upper_bound);
60
+ if (lo != null && hi != null && lo <= hi && (match.value < lo || match.value > hi)) return false;
61
+ }
46
62
  if (wantedMonthValues.length > 0 && monthFieldIndex >= 0) {
47
63
  const monthSummary = partitions[monthFieldIndex];
48
64
  if (monthSummary && (monthSummary.lower_bound != null || monthSummary.upper_bound != null)) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/lakehouse",
3
3
  "type": "module",
4
- "version": "4.2.0",
4
+ "version": "4.2.2",
5
5
  "description": "Dataset-agnostic Iceberg lakehouse layer + dataset registry for R2 Data Catalog producers (ADR-0021).",
6
6
  "author": {
7
7
  "name": "Harlan Wilton",