lambder 4.2.3 → 4.3.1

package/Readme.md

@@ -2,6 +2,10 @@
 
 Lambder is a highly opinionated dynamic serverless framework designed to facilitate the management and implementation of routes and APIs within AWS Lambda functions, specifically tailored for TypeScript projects. It provides a streamlined approach to handling HTTP requests, managing sessions, and defining API routes, making serverless application development more intuitive and structured.
 
+**New in 4.3:**
+
+- **Compressed sessions**: `session.data` is stored Brotli-compressed by default, as `dataBr` + `dataBytes` on the record, the same scheme LambderDdbCache and LambderDdbIdempotency use (one shared implementation). A session that caches roles, permissions or product lists shrinks 2-3x and stays within one DynamoDB read unit for longer. `session.compression` is `true` by default (the same as `{ minBytes: 0 }`: every record compressed); `false` turns it off and `{ minBytes }` compresses only from that JSON size. Records written under either setting read back, so it can be switched on or off on a live table.
+
 **New in 4.2:**
 
 - **Rate-limit budgets**: a policy's `budget` is `"perApi"` (default: each referencing API gets its own counter, so the numbers are a per-API ceiling and three APIs on a 60/min policy allow one IP 180/min in total) or `"perPolicy"` (one counter shared by every API referencing the policy). The policy is the group, and two separate shared budgets are two policies.
@@ -302,6 +306,7 @@ const lambder = initLambder<SessionData>().create({
         tableRegion: "us-east-1",
         sessionSalt: "CHANGE-THIS-TO-A-SECURE-RANDOM-STRING",
         enableSlidingExpiration: true, // Optional: extend session on each access
+        compression: true,             // Optional: Brotli-compress session.data at rest (default true; false to disable, or { minBytes })
         // Optionally customize cookie names (defaults: LMDRSESSIONTKID, LMDRSESSIONCSTK)
         tokenCookieKey: "MY_SESSION_TOKEN",
         csrfCookieKey: "MY_CSRF_TOKEN",
@@ -353,6 +358,21 @@ Semantics:
 - Records created before `dataRefresh` was enabled renew on their first read.
 - `updateSessionData()` marks data fresh (it was just written deliberately); `regenerateSession()` carries the old freshness stamp over.
 
+#### Session data at rest (`compression`)
+
+`session.data` is stored Brotli-compressed by default: the record carries the data's JSON as Brotli bytes in `dataBr` beside its byte length in `dataBytes`, in place of a plain `data` attribute. It is the scheme `LambderDdbCache` and `LambderDdbIdempotency` already use, from one shared implementation, and the byte length both bounds the decompression and verifies it, so a truncated record fails to decode rather than decoding to something else. Session data that caches roles, permissions or product lists typically shrinks 2-3x, which keeps a growing session within one DynamoDB read unit (4KB for the consistent reads sessions use) and one write unit (1KB) for longer.
+
+```typescript
+session: {
+    // ...
+    compression: true, // default: every record compressed, the same as { minBytes: 0 }
+    // compression: { minBytes: 1024 } compresses only records whose JSON is 1KB+
+    // compression: false stores data as a plain attribute
+}
+```
+
+`quality` (Brotli 0-11, default 5) is also accepted. Reads accept both record shapes, so the setting can be switched on or off on a live table: records written under the other setting keep reading, and each is rewritten in the current shape on its next write (a sliding-expiration or `dataRefresh` write included). A compressed record that fails to decode is treated like any malformed record: no session.
+
 #### Session Controller
 
 Access the session controller with `lambder.getSessionController(ctx)`:

package/dist/core/Lambder.d.ts

@@ -5,7 +5,7 @@ import LambderResponseBuilder from "./LambderResponseBuilder.js";
 import { LambderResponse, type LambderHttpResponse } from "./LambderResponse.js";
 import { type ConditionFunction, type LambderRouteMatcher, type PathParamsOf } from "./LambderRouting.js";
 import { type LambderCorsConfig } from "./LambderCors.js";
-import { type LambderSessionDataRefreshConfig } from "../session/LambderSessionManager.js";
+import { type LambderSessionDataRefreshConfig, type LambderSessionCompressionConfig } from "../session/LambderSessionManager.js";
 import LambderSessionController, { type LambderSessionCookieOptions } from "../session/LambderSessionController.js";
 import { type LambderPublicFilesOptions } from "./LambderPublicFiles.js";
 import type { LambderApiGuard, LambderGuardMetaMap, LambderGuardsOption, LambderGuardDataOf, LambderGuardInputsOf } from "../policies/LambderApiGuards.js";
@@ -88,6 +88,14 @@ export type LambderSessionOptions<TSessionData = any> = {
      * semantics.
      */
     dataRefresh?: LambderSessionDataRefreshConfig<TSessionData>;
+    /**
+     * Brotli compression of session.data at rest. `true` (the default)
+     * compresses every record, the same as `{ minBytes: 0 }`; `false` turns
+     * it off; `{ minBytes }` compresses only records whose JSON is at least
+     * that many bytes. Records written under either setting read back, so
+     * it can be switched on or off on a live table.
+     */
+    compression?: boolean | LambderSessionCompressionConfig;
 };
 /**
  * Everything an instance is configured with, in ONE declaration: base

package/dist/core/Lambder.js

@@ -90,6 +90,7 @@ export default class Lambder {
                 enableSlidingExpiration: session.enableSlidingExpiration,
                 slidingWriteIntervalSeconds: session.slidingWriteIntervalSeconds,
                 dataRefresh: session.dataRefresh,
+                compression: session.compression,
             });
             this.sessionCookieOptions = session.cookie ?? {};
             if (session.tokenCookieKey)

package/dist/index.d.ts

@@ -18,7 +18,7 @@ export type { LambderRouteMatcher, LambderCorsConfig, LambderCreateOptions, Lamb
 export { LambderPublicFilesHandler } from "./core/LambderPublicFiles.js";
 export type { LambderPublicFilesOptions } from "./core/LambderPublicFiles.js";
 export type { LambderSessionCookieOptions } from "./session/LambderSessionController.js";
-export type { LambderSessionContext, LambderCreatedSession, LambderSessionDataRefreshConfig } from "./session/LambderSessionManager.js";
+export type { LambderSessionContext, LambderCreatedSession, LambderSessionDataRefreshConfig, LambderSessionCompressionConfig } from "./session/LambderSessionManager.js";
 export { LambderSessionDataRefreshError, LambderSessionReadError } from "./session/LambderSessionManager.js";
 export { LambderDdbCache } from "./stores/LambderDdbCache.js";
 export type { LambderDdbCacheOptions, LambderDdbCacheSetOptions, LambderDdbCacheGetOrSetOptions, } from "./stores/LambderDdbCache.js";

package/dist/session/LambderSessionManager.d.ts

@@ -53,6 +53,23 @@ export type LambderSessionDataRefreshConfig<SessionData = any> = {
      */
     refresh: (session: LambderSessionContext<SessionData>) => Promise<SessionData | null>;
 };
+/**
+ * Brotli compression of session.data at rest. The option is `true` by
+ * default, which equals `{ minBytes: 0 }`: every record compressed. A
+ * compressed record carries the data's JSON as Brotli bytes (`dataBr`)
+ * beside its byte length (`dataBytes`), the scheme LambderDdbCache and
+ * LambderDdbIdempotency use. Below minBytes, or with compression off, the
+ * record keeps a plain `data` attribute. Reads accept both shapes, so the
+ * setting can be switched on or off on a live table: records written under
+ * the other setting keep reading, and each is rewritten in the current
+ * shape on its next write.
+ */
+export type LambderSessionCompressionConfig = {
+    /** JSON byte length from which data is stored compressed. Default: 0 (always). */
+    minBytes?: number;
+    /** Brotli quality (0-11), like LambderDdbCache. Default: 5. */
+    quality?: number;
+};
 /**
  * Wraps errors thrown by the dataRefresh callback so they stay
  * distinguishable from "no session": fetchSessionIfExists() swallows missing
@@ -81,7 +98,8 @@ export default class LambderSessionManager {
     private enableSlidingExpiration;
     private slidingWriteIntervalSeconds;
     private dataRefresh;
-    constructor({ tableName, tableRegion, partitionKey, sortKey, sessionSalt, enableSlidingExpiration, slidingWriteIntervalSeconds, dataRefresh, }: {
+    private compression;
+    constructor({ tableName, tableRegion, partitionKey, sortKey, sessionSalt, enableSlidingExpiration, slidingWriteIntervalSeconds, dataRefresh, compression, }: {
         tableName: string;
         tableRegion: string;
         partitionKey: string;
@@ -90,6 +108,7 @@ export default class LambderSessionManager {
         enableSlidingExpiration?: boolean;
         slidingWriteIntervalSeconds?: number;
         dataRefresh?: LambderSessionDataRefreshConfig;
+        compression?: boolean | LambderSessionCompressionConfig;
     });
     private sessionUserKeyHasher;
     /**
@@ -101,6 +120,12 @@ export default class LambderSessionManager {
     private hashToken;
     private constantTimeCompare;
     private ddbGetItem;
+    /**
+     * Persists a session record. With compression on, `data` is stored as
+     * Brotli bytes (`dataBr`) beside its JSON byte length (`dataBytes`)
+     * once the JSON reaches minBytes; otherwise it stays a plain attribute.
+     * See LambderSessionCompressionConfig.
+     */
     private ddbPutItem;
     private ddbDeleteItem;
     private ddbQueryAllByPartitionKey;

package/dist/session/LambderSessionManager.js

@@ -1,6 +1,7 @@
 import crypto from "crypto";
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import { DynamoDBDocumentClient, QueryCommand, DeleteCommand, PutCommand, GetCommand } from "@aws-sdk/lib-dynamodb";
+import { brotliCompressText, brotliRestoreText } from "../stores/LambderDdbCompression.js";
 /**
  * Wraps errors thrown by the dataRefresh callback so they stay
  * distinguishable from "no session": fetchSessionIfExists() swallows missing
@@ -35,7 +36,8 @@ export default class LambderSessionManager {
     enableSlidingExpiration;
     slidingWriteIntervalSeconds;
     dataRefresh;
-    constructor({ tableName, tableRegion, partitionKey, sortKey, sessionSalt, enableSlidingExpiration = true, slidingWriteIntervalSeconds, dataRefresh, }) {
+    compression;
+    constructor({ tableName, tableRegion, partitionKey, sortKey, sessionSalt, enableSlidingExpiration = true, slidingWriteIntervalSeconds, dataRefresh, compression = true, }) {
         this.tableName = tableName;
         this.sessionSalt = sessionSalt;
         this.partitionKey = partitionKey;
@@ -43,6 +45,19 @@ export default class LambderSessionManager {
         this.enableSlidingExpiration = enableSlidingExpiration;
         this.slidingWriteIntervalSeconds = slidingWriteIntervalSeconds ?? null;
         this.dataRefresh = dataRefresh ?? null;
+        const compressionConfig = compression === true ? {} : compression;
+        this.compression = compressionConfig ? {
+            minBytes: compressionConfig.minBytes ?? 0,
+            quality: compressionConfig.quality ?? 5,
+        } : null;
+        if (this.compression) {
+            if (!Number.isSafeInteger(this.compression.minBytes) || this.compression.minBytes < 0) {
+                throw new Error("compression.minBytes must be a non-negative integer");
+            }
+            if (!Number.isInteger(this.compression.quality) || this.compression.quality < 0 || this.compression.quality > 11) {
+                throw new Error("compression.quality must be an integer from 0 to 11");
+            }
+        }
         const ddbClient = new DynamoDBClient({ region: tableRegion });
         this.ddbDocumentClient = DynamoDBDocumentClient.from(ddbClient);
     }
@@ -74,7 +89,22 @@ export default class LambderSessionManager {
         return null;
     }
     ;
-    async ddbPutItem(item) {
+    /**
+     * Persists a session record. With compression on, `data` is stored as
+     * Brotli bytes (`dataBr`) beside its JSON byte length (`dataBytes`)
+     * once the JSON reaches minBytes; otherwise it stays a plain attribute.
+     * See LambderSessionCompressionConfig.
+     */
+    async ddbPutItem(session) {
+        const { data, ...item } = session;
+        const raw = this.compression && Buffer.from(JSON.stringify(data), "utf8");
+        if (this.compression && raw && raw.byteLength >= this.compression.minBytes) {
+            item.dataBr = await brotliCompressText(raw, this.compression.quality);
+            item.dataBytes = raw.byteLength;
+        }
+        else {
+            item.data = data;
+        }
         return await this.ddbDocumentClient.send(new PutCommand({ TableName: this.tableName, Item: item, }));
     }
     ;
@@ -169,6 +199,14 @@ export default class LambderSessionManager {
         }
         if (!session)
             return null;
+        // A compressed record (see ddbPutItem) decodes back into `data`. One
+        // that fails to decode throws, which the controller treats like any
+        // malformed record: no session.
+        if (session.dataBr) {
+            session.data = JSON.parse(await brotliRestoreText(session.dataBr, session.dataBytes));
+            delete session.dataBr;
+            delete session.dataBytes;
+        }
         if (!session.csrfTokenHash)
             return null;
         if (!session.sessionKey)

package/dist/stores/LambderDdbCache.js

@@ -1,6 +1,6 @@
 import { BatchWriteItemCommand, DeleteItemCommand, DynamoDBClient, GetItemCommand, PutItemCommand, QueryCommand, } from "@aws-sdk/client-dynamodb";
 import { getCrypto } from "../shared/node-polyfills.js";
-import { brotliCompressText, brotliDecompressText } from "./LambderDdbCompression.js";
+import { brotliCompressText, brotliRestoreText } from "./LambderDdbCompression.js";
 import { LRUCache } from "lru-cache";
 const DEFAULT_TTL_SECONDS = 365 * 24 * 60 * 60;
 const DEFAULT_CHUNK_BYTES = 350 * 1024;
@@ -14,7 +14,8 @@ const MAX_BATCH_RETRIES = 8;
 // Node builtins are loaded lazily through node-polyfills so this module can
 // sit in a frontend bundle's import graph (via the package root) without
 // breaking; using the cache at runtime still requires Node. Brotli helpers
-// are shared with LambderDdbIdempotency via ./LambderDdbCompression.js.
+// are shared with LambderDdbIdempotency and LambderSessionManager via
+// ./LambderDdbCompression.js.
 const requireCrypto = async () => {
     const crypto = await getCrypto();
     if (!crypto)
@@ -96,10 +97,7 @@ export class LambderDdbCache {
         const nowSeconds = this.nowSeconds();
         if (cached && cached.expiresAt > nowSeconds) {
             try {
-                const output = await brotliDecompressText(cached.compressed, this.maxValueBytes);
-                if (output.length === cached.uncompressedBytes) {
-                    return JSON.parse(output.toString("utf8"));
-                }
+                return JSON.parse(await brotliRestoreText(cached.compressed, cached.uncompressedBytes));
             }
             catch {
                 // Fall through to DynamoDB; the in-memory copy is disposable.
@@ -119,13 +117,9 @@ export class LambderDdbCache {
             if (await sha256(compressed) !== manifest.checksum) {
                 throw new Error("compressed checksum does not match manifest");
             }
-            const output = await brotliDecompressText(compressed, this.maxValueBytes);
-            if (output.length !== manifest.uncompressedBytes) {
-                throw new Error("uncompressed byte length does not match manifest");
-            }
-            const json = output.toString("utf8");
+            const json = await brotliRestoreText(compressed, manifest.uncompressedBytes);
             const parsed = JSON.parse(json);
-            this.remember(normalizedKey, compressed, output.length, manifest.expiresAt);
+            this.remember(normalizedKey, compressed, manifest.uncompressedBytes, manifest.expiresAt);
             return parsed;
         }
         catch (error) {

package/dist/stores/LambderDdbCompression.d.ts

@@ -1,3 +1,8 @@
 export declare const brotliCompressText: (input: Buffer, quality: number) => Promise<Buffer>;
-/** maxOutputLength bounds decompression so a corrupt record cannot balloon memory. */
-export declare const brotliDecompressText: (input: Buffer, maxOutputLength: number) => Promise<Buffer>;
+/**
+ * Restores text stored as Brotli bytes beside its declared UTF-8 byte length.
+ * The length bounds the decompression and the output must match it exactly,
+ * so a truncated or tampered record fails instead of decoding to something
+ * else.
+ */
+export declare const brotliRestoreText: (compressed: Uint8Array, declaredBytes: number) => Promise<string>;

package/dist/stores/LambderDdbCompression.js

@@ -1,8 +1,11 @@
 import { getZlib } from "../shared/node-polyfills.js";
 // Brotli compression shared by the DynamoDB-backed stores (LambderDdbCache,
-// LambderDdbIdempotency). Values they persist are text (JSON), so TEXT mode;
-// zlib is loaded lazily through node-polyfills so these modules can sit in a
-// frontend bundle's import graph (via the package root) without breaking.
+// LambderDdbIdempotency, LambderSessionManager). Values they persist are text
+// (JSON), so TEXT mode, and they all store it the same way: the Brotli bytes
+// beside the text's original UTF-8 byte length, which bounds the decompression
+// (a corrupt record cannot balloon memory) and verifies it. zlib is loaded
+// lazily through node-polyfills so these modules can sit in a frontend
+// bundle's import graph (via the package root) without breaking.
 const requireZlib = async () => {
     const zlib = await getZlib();
     if (!zlib)
@@ -25,15 +28,27 @@ export const brotliCompressText = async (input, quality) => {
         });
     });
 };
-/** maxOutputLength bounds decompression so a corrupt record cannot balloon memory. */
-export const brotliDecompressText = async (input, maxOutputLength) => {
+/**
+ * Restores text stored as Brotli bytes beside its declared UTF-8 byte length.
+ * The length bounds the decompression and the output must match it exactly,
+ * so a truncated or tampered record fails instead of decoding to something
+ * else.
+ */
+export const brotliRestoreText = async (compressed, declaredBytes) => {
+    if (!Number.isSafeInteger(declaredBytes) || declaredBytes <= 0) {
+        throw new Error("compressed record is missing its byte length");
+    }
     const zlib = await requireZlib();
-    return new Promise((resolve, reject) => {
-        zlib.brotliDecompress(input, { maxOutputLength }, (error, output) => {
+    const output = await new Promise((resolve, reject) => {
+        zlib.brotliDecompress(Buffer.from(compressed), { maxOutputLength: declaredBytes }, (error, result) => {
             if (error)
                 reject(error);
             else
-                resolve(output);
+                resolve(result);
         });
     });
+    if (output.length !== declaredBytes) {
+        throw new Error("decompressed length does not match the record");
+    }
+    return output.toString("utf8");
 };

package/dist/stores/LambderDdbIdempotency.js

@@ -1,6 +1,6 @@
 import crypto from "crypto";
 import { DynamoDBClient, PutItemCommand, GetItemCommand, DeleteItemCommand, } from "@aws-sdk/client-dynamodb";
-import { brotliCompressText, brotliDecompressText } from "./LambderDdbCompression.js";
+import { brotliCompressText, brotliRestoreText } from "./LambderDdbCompression.js";
 /** Bodies at or above this size are stored Brotli-compressed; smaller ones stay plain. */
 const COMPRESS_MIN_BYTES = 1024;
 /**
@@ -67,16 +67,8 @@ export class LambderDdbIdempotency {
     /** A stored item's response body: plain (`body`) or Brotli (`bodyBr` + `bodyBytes`). */
     static async readItemBody(item) {
         const compressed = item.bodyBr?.B;
-        if (compressed) {
-            const declaredBytes = Number(item.bodyBytes?.N ?? 0);
-            if (!declaredBytes)
-                throw new Error("LambderDdbIdempotency: compressed record is missing bodyBytes.");
-            const output = await brotliDecompressText(Buffer.from(compressed), declaredBytes);
-            if (output.length !== declaredBytes) {
-                throw new Error("LambderDdbIdempotency: stored body length does not match its record.");
-            }
-            return output.toString("utf8");
-        }
+        if (compressed)
+            return await brotliRestoreText(compressed, Number(item.bodyBytes?.N ?? 0));
         return item.body?.S ?? "";
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambder",
-  "version": "4.2.3",
+  "version": "4.3.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",