@aws-blocks/bb-distributed-data 0.1.0

package/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,243 @@
+# @aws-blocks/bb-distributed-data
+
+Serverless SQL database backed by Amazon Aurora DSQL. Zero-ops, instant provisioning, scale-to-zero, and optionally multi-region active-active writes.
+
+**When to use:** Serverless apps that need to scale without ops overhead, workloads with zero idle cost requirements, multi-region active-active writes, or any SQL app where you don't need FK/RLS/triggers.
+
+**When NOT to use:** If you need foreign keys, Row Level Security, triggers, views, or stored procedures — use `Database` (Aurora). If you need transactions that must not fail at commit under contention — use `Database`. If you're connecting to Supabase — use `Database` with `fromExisting()`.
+
+## Quick Start
+
+```typescript
+import { DistributedDatabase, sql } from '@aws-blocks/bb-distributed-data';
+
+const db = new DistributedDatabase(scope, 'main', {
+  migrationsPath: './aws-blocks/dsql-migrations',
+});
+
+// Same query API as Database — parameterized via sql tagged template
+const users = await db.query<{ id: string; name: string }>(
+  sql`SELECT * FROM users WHERE active = ${true}`
+);
+
+const user = await db.queryOne<{ id: string; name: string }>(
+  sql`SELECT * FROM users WHERE id = ${userId}`
+);
+
+const { rowCount } = await db.execute(
+  sql`INSERT INTO users (id, name, email) VALUES (${id}, ${name}, ${email})`
+);
+```
+
+## Transactions (Optimistic Concurrency Control)
+
+DSQL uses OCC — transactions may fail at commit if another transaction modified the same rows. The callback executes exactly once unless you opt into retry.
+
+```typescript
+// Default: no retry. Throws SerializationFailureException on conflict.
+await db.transaction(async (tx) => {
+  await tx.execute(sql`UPDATE accounts SET balance = balance - ${100} WHERE id = ${fromId}`);
+  await tx.execute(sql`UPDATE accounts SET balance = balance + ${100} WHERE id = ${toId}`);
+});
+
+// Opt-in retry: callback may execute multiple times.
+// ⚠️ Do NOT include external side effects (HTTP calls, emails) inside.
+await db.transaction(async (tx) => {
+  await tx.execute(sql`UPDATE accounts SET balance = balance - ${100} WHERE id = ${fromId}`);
+  await tx.execute(sql`UPDATE accounts SET balance = balance + ${100} WHERE id = ${toId}`);
+}, { retryOnConflict: true, maxRetries: 3 });
+```
+
+The second argument to `transaction()` accepts:
+
+```typescript
+interface TransactionOptions {
+  /** Retry on OCC conflict. Callback may execute multiple times. @default false */
+  retryOnConflict?: boolean;
+  /** Max retry attempts. Only applies when retryOnConflict is true. @default 3 */
+  maxRetries?: number;
+}
+```
+
+## Migrations
+
+One DDL statement per file. DML in separate files. This matches DSQL's transaction constraints.
+
+```
+aws-blocks/dsql-migrations/
+  001_create_users.sql       ← single DDL
+  002_create_posts.sql       ← single DDL
+  003_create_index.sql       ← single DDL (CREATE INDEX ASYNC)
+  004_seed_admin.sql         ← DML only
+```
+
+```sql
+-- 001_create_users.sql
+CREATE TABLE users (
+  id TEXT PRIMARY KEY DEFAULT gen_random_uuid(),
+  email TEXT UNIQUE NOT NULL,
+  name TEXT NOT NULL,
+  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+```
+
+```sql
+-- 003_create_index.sql
+CREATE INDEX ASYNC idx_users_email ON users(email);
+```
+
+Migrations are validated at dev time — unsupported features (FK, SERIAL, TRUNCATE, etc.) are caught before deploy.
+
+## DSQL Limitations
+
+DSQL is a subset of PostgreSQL. The local mock enforces these restrictions so code that works locally also works in production.
+
+| Not Supported | Alternative |
+|---------------|-------------|
+| Foreign keys (`REFERENCES`) | Application-layer validation |
+| JSONB columns | `JSON` type (JSONB available as `::jsonb` runtime cast) |
+| Row Level Security | WHERE clause filtering in app code |
+| Triggers | Event-driven logic (EventBridge, Lambda) |
+| Views | CTEs or application-layer query composition |
+| PL/pgSQL functions | `LANGUAGE SQL` functions or app logic |
+| SERIAL / BIGSERIAL | UUIDs (`gen_random_uuid()`) |
+| TRUNCATE | `DELETE FROM` |
+| Temporary tables | CTEs or subqueries |
+| LISTEN / NOTIFY | AppSync Events, EventBridge, or polling |
+| Extensions | Not available |
+| ADD COLUMN with DEFAULT | Add column without default, handle nulls in app |
+
+### Transaction Constraints
+
+| Constraint | Limit |
+|-----------|-------|
+| Concurrency model | OCC (may conflict at commit) |
+| Isolation level | Fixed: Repeatable Read |
+| Max rows mutated per transaction | 3,000 |
+| Max data per transaction | 10 MiB |
+| Max transaction duration | 5 minutes |
+| DDL per transaction | 1 statement max |
+| DDL + DML mixing | Not allowed |
+
+## Kysely Query Builder
+
+```typescript
+import { createKyselyAdapter } from '@aws-blocks/bb-distributed-data';
+
+interface Schema {
+  users: { id: string; email: string; name: string };
+}
+
+const kysely = createKyselyAdapter<Schema>(db);
+
+const users = await kysely
+  .selectFrom('users')
+  .where('email', '=', 'user@example.com')
+  .selectAll()
+  .execute();
+```
+
+Do not use Kysely's `.addForeignKeyConstraint()` — it will fail on DSQL.
+
+## Error Handling
+
+```typescript
+import { DistributedDatabaseErrors } from '@aws-blocks/bb-distributed-data';
+import { isBlocksError } from '@aws-blocks/core';
+
+try {
+  await db.transaction(async (tx) => { /* ... */ });
+} catch (e: unknown) {
+  if (isBlocksError(e, DistributedDatabaseErrors.SerializationFailure)) {
+    // OCC conflict — transaction was NOT committed. Safe to retry.
+  }
+  if (isBlocksError(e, DistributedDatabaseErrors.UniqueConstraintViolation)) {
+    // Duplicate key
+  }
+  if (isBlocksError(e, DistributedDatabaseErrors.QueryFailed)) {
+    // General query failure
+  }
+  if (isBlocksError(e, DistributedDatabaseErrors.TransactionRowLimitExceeded)) {
+    // More than 3,000 rows mutated in one transaction
+  }
+  if (isBlocksError(e, DistributedDatabaseErrors.ConnectionFailed)) {
+    // Cannot reach the DSQL cluster
+  }
+}
+```
+
+## Testing OCC Conflicts
+
+The mock provides a `simulateConflict()` helper for unit testing:
+
+```typescript
+db.simulateConflict(); // next commit will fail with SerializationFailureException
+
+await expect(db.transaction(fn)).rejects.toThrow('SerializationFailureException');
+```
+
+```typescript
+db.simulateConflict(); // first attempt fails, second succeeds
+const result = await db.transaction(fn, { retryOnConflict: true });
+```
+
+## What It Provisions (AWS)
+
+- **Aurora DSQL Cluster** — Serverless, no VPC required, public endpoint
+- **Migration Lambda** — Runs `.sql` files on deploy via CustomResource with retry
+- **IAM** — `dsql:DbConnect` (app Lambda, DML only), `dsql:DbConnectAdmin` (migration Lambda, DDL)
+- **Environment variables** — `BLOCKS_{name}_ENDPOINT`, `BLOCKS_{name}_REGION`
+
+No VPC, no secrets, no security groups, no proxy. DSQL uses IAM token authentication.
+
+## Local Development
+
+- **Engine:** PGlite (WASM PostgreSQL) wrapped with a DSQL validation layer
+- **Storage:** `.bb-data/{fullId}/` — persists across restarts
+- **Validation:** Unsupported features (FK, triggers, SERIAL, etc.) are rejected at query time
+- **Transaction tracking:** DDL/DML mixing and 3,000-row limit enforced locally
+
+The validation layer ensures code that works locally also works against a real DSQL cluster.
+
+## Configuration
+
+```typescript
+interface DistributedDatabaseOptions {
+  /** Path to directory containing numbered .sql migration files. */
+  migrationsPath?: string;
+  /** Removal policy. @default 'retain' */
+  removalPolicy?: 'destroy' | 'retain';
+}
+```
+
+## Package Export Conditions
+
+```json
+{
+  "exports": {
+    ".": {
+      "cdk": "./dist/index.cdk.js",
+      "aws-runtime": "./dist/index.aws.js",
+      "default": "./dist/index.mock.js"
+    }
+  }
+}
+```
+
+## Differences from Database (Aurora)
+
+| Aspect | `Database` (bb-data) | `DistributedDatabase` (bb-distributed-data) |
+|--------|---------------------|--------------------------|
+| Engine | Aurora Serverless v2 (Data API) | Aurora DSQL (pg + IAM) |
+| PostgreSQL compat | Full | Subset (no FK, RLS, triggers) |
+| Transactions | Pessimistic (exactly-once) | OCC (may conflict at commit) |
+| `withRLS()` | ✅ | ❌ |
+| `fromExisting()` | ✅ | ❌ |
+| `crud()` | ✅ | ❌ |
+| Foreign keys | ✅ | ❌ |
+| Multi-region | ❌ | ✅ Active-active |
+| VPC required | Yes | No |
+| Deploy time | ~10 min | Seconds |
+| Idle cost | $0 (0 ACU) | $0 |
+
+

package/dist/constants.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Shared constants for the bb-distributed-data package.
+ */
+/**
+ * Path where migration .sql files are bundled inside the Lambda deployment package.
+ * Used by both the CDK construct (to set the env var + copy files) and the
+ * migration Lambda handler (to read files at runtime).
+ */
+export declare const LAMBDA_MIGRATIONS_DIR = "/var/task/migrations";
+/**
+ * Migration Lambda timeout. Set to 5 minutes to allow for large migration sets
+ * and DSQL cluster warm-up time on first connection after creation.
+ */
+export declare const MIGRATION_LAMBDA_TIMEOUT_MINUTES = 5;
+/**
+ * Default connection pool size for DSQL. Kept small because Lambda concurrency
+ * means each instance handles few concurrent requests, and DSQL connections
+ * are lightweight (no VPC, no proxy needed).
+ */
+export declare const DEFAULT_POOL_SIZE = 5;
+/**
+ * Default max retry attempts for OCC conflicts when retryOnConflict is enabled.
+ */
+export declare const DEFAULT_MAX_RETRIES = 3;
+export declare const ENV_SANITIZE: RegExp;
+/**
+ * Prefix for the custom database role created for the app Lambda.
+ * The full role name is `blocks_app_{sanitized_id}`.
+ * PostgreSQL role names are case-insensitive and limited to 63 chars (NAMEDATALEN - 1).
+ */
+export declare const DB_ROLE_PREFIX = "blocks_app_";
+/**
+ * Sanitize a block ID into a valid PostgreSQL role name.
+ * Short IDs stay human-readable. If the name would exceed 63 chars,
+ * a sha256 hash of the original ID is used to guarantee uniqueness.
+ */
+export declare const sanitizeDbRoleName: (id: string) => string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,yBAAyB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,gCAAgC,IAAI,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAGrC,eAAO,MAAM,YAAY,QAAkB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAK5C;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,IAAI,MAAM,KAAG,MAM/C,CAAC"}

package/dist/constants.js

@@ -0,0 +1,50 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { createHash } from 'node:crypto';
+/**
+ * Shared constants for the bb-distributed-data package.
+ */
+/**
+ * Path where migration .sql files are bundled inside the Lambda deployment package.
+ * Used by both the CDK construct (to set the env var + copy files) and the
+ * migration Lambda handler (to read files at runtime).
+ */
+export const LAMBDA_MIGRATIONS_DIR = '/var/task/migrations';
+/**
+ * Migration Lambda timeout. Set to 5 minutes to allow for large migration sets
+ * and DSQL cluster warm-up time on first connection after creation.
+ */
+export const MIGRATION_LAMBDA_TIMEOUT_MINUTES = 5;
+/**
+ * Default connection pool size for DSQL. Kept small because Lambda concurrency
+ * means each instance handles few concurrent requests, and DSQL connections
+ * are lightweight (no VPC, no proxy needed).
+ */
+export const DEFAULT_POOL_SIZE = 5;
+/**
+ * Default max retry attempts for OCC conflicts when retryOnConflict is enabled.
+ */
+export const DEFAULT_MAX_RETRIES = 3;
+// Env var names must be [A-Z0-9_]. The fullId may contain hyphens/dots (e.g., "my-app.dsql").
+export const ENV_SANITIZE = /[^a-zA-Z0-9]/g;
+/**
+ * Prefix for the custom database role created for the app Lambda.
+ * The full role name is `blocks_app_{sanitized_id}`.
+ * PostgreSQL role names are case-insensitive and limited to 63 chars (NAMEDATALEN - 1).
+ */
+export const DB_ROLE_PREFIX = 'blocks_app_';
+/** Max PostgreSQL identifier length. */
+const PG_NAME_MAX = 63;
+/**
+ * Sanitize a block ID into a valid PostgreSQL role name.
+ * Short IDs stay human-readable. If the name would exceed 63 chars,
+ * a sha256 hash of the original ID is used to guarantee uniqueness.
+ */
+export const sanitizeDbRoleName = (id) => {
+    const sanitized = `${DB_ROLE_PREFIX}${id.replace(/[^a-z0-9]/gi, '_').toLowerCase()}`;
+    if (sanitized.length <= PG_NAME_MAX)
+        return sanitized;
+    // Long ID — use a hash to avoid collisions from naive truncation
+    const hash = createHash('sha256').update(id).digest('hex').slice(0, 12);
+    return `${DB_ROLE_PREFIX}${hash}`;
+};

package/dist/e2e-mock.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=e2e-mock.test.d.ts.map

package/dist/e2e-mock.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"e2e-mock.test.d.ts","sourceRoot":"","sources":["../src/e2e-mock.test.ts"],"names":[],"mappings":""}