@di-framework/pglite-component 0.0.0-stage → 6.0.9

package/README.md

@@ -1,3 +1,145 @@
-# Temporary Holding Version
+# di-framework:pglite — embedded PostgreSQL over WIT
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The provider bundles the PGlite PostgreSQL 17.5 engine into a WebAssembly
+component. SQL calls cross WIT and WebAssembly memory. There is no TCP listener,
+network client, native sidecar, or separate database service.
+
+```text
+app.wasm → di-framework:pglite/database → bundled PostgreSQL engine
+                                                ↓
+                                          WASI filesystem
+                                                ↓
+                                       persistent /data mount
+```
+
+`open("/data/orders", none)` opens a persistent database root. An empty path
+selects `/data/pglite`. Missing or read-only storage fails; the provider never
+silently substitutes an in-memory database. This replaces the old TCP client:
+`PGHOST`, `PGPORT`, and connection-target strings are no longer used.
+
+## Build and verify
+
+```sh
+make tools
+make build
+make smoke
+bun test
+```
+
+Use the pinned Rust toolchain through rustup, Python 3, and the installed
+`wasm-tools`/`wac`. Preparing the engine from source also needs a Linux Docker
+or Podman daemon, Git, curl, and several GB of build storage. The engine build
+is cached under `target/engine`. Containers are build tools only; deployment
+runs the resulting `.wasm` directly. For a remote Podman daemon, set the task's
+`DOCKER_CONTEXT=podman`.
+
+The build embeds the support filesystem, adapts the engine's WASI Preview 1
+imports to Preview 2, and composes the engine with the Rust database provider.
+It fails if the final artifact imports sockets or leaves the engine unresolved.
+Ship `dist/di-framework-pglite.wasm` together with `THIRD-PARTY-NOTICES.txt`.
+Build provenance and checksums are in `dist/BUILD-INFO.txt` and `SHA256SUMS`.
+
+`make smoke` composes a real WIT consumer, runs it without network access, and
+checks typed parameters/results, SQL errors and recovery, transactions,
+rollback on close/drop, exclusive connection ownership, durability settings,
+and persistence across separate runtime processes. It also exits a runtime
+with an open transaction and verifies that committed rows survive and the
+uncommitted row is absent after restart. No scripted database server is used.
+
+## Use from an application
+
+The application imports `di-framework:pglite/database@0.1.0`. For a JavaScript
+component built with the framework's component toolchain:
+
+```ts
+import { open } from 'di-framework:pglite/database@0.1.0';
+
+const db = open('/data/orders', undefined);
+try {
+  db.exec('CREATE TABLE IF NOT EXISTS orders (id bigint PRIMARY KEY, title text)');
+  db.run('INSERT INTO orders VALUES ($1, $2)', [
+    { tag: 'integer', val: 1n },
+    { tag: 'text', val: 'First order' },
+  ]);
+  const row = db.first('SELECT title FROM orders WHERE id = $1', [
+    { tag: 'integer', val: 1n },
+  ]);
+} finally {
+  db.close();
+}
+```
+
+Compose the application with the provider:
+
+```sh
+make compose APP=path/to/app.wasm OUT=path/to/app.composed.wasm
+mkdir -p ./data
+wasmtime run --dir ./data::/data path/to/app.composed.wasm
+```
+
+That invocation is for a command component; serve HTTP components using your
+normal host while granting the same filesystem preopen. The final component
+requires WASI filesystem, clocks, streams, CLI and randomness interfaces, plus
+standardized WebAssembly exception handling for PostgreSQL error recovery.
+
+The public interface retains `exec`, `run`, `query`, `first`, transactions,
+savepoints, `rows-affected`, `close`, and `server-version`. PostgreSQL parameters
+use `$1`, `$2`, etc. `server-version()` reports the bundled engine without
+opening a database. Only the `template1` database is currently supported;
+other `open-options.database` values are rejected. Requests must fit the engine's
+input buffer; each serialized result is limited to 64 MiB and stays in memory.
+Larger results return a PostgreSQL program-limit error. Signal-based statement
+timeouts are unavailable in this WASI engine: nonzero `statement-timeout-ms`
+options fail explicitly. Use host execution limits for runaway queries.
+
+## Persistence and ownership
+
+For an `open("/data/orders", ...)` call:
+
+- `/data/orders/data/` is PGDATA (catalogs, tables, WAL and configuration).
+- `/data/orders/runtime/` contains bundled initialization/support files.
+- Bootstrap and shared-memory scratch files also stay beneath `/data/orders`.
+
+Mount the entire root on persistent storage and reuse it after restarts.
+Initialization creates the cluster once; later starts reuse it. Incomplete
+clusters or an incompatible PostgreSQL major version are rejected.
+`fsync`, `synchronous_commit`, and `full_page_writes` are enabled before the
+backend starts. The host filesystem must honor WASI sync operations; a local
+restart test is not a power-loss durability certification.
+
+**Give each database directory one component owner at a time.** The provider
+rejects a second simultaneous connection within its component instance. Close
+or drop rolls back uncommitted work, resets session settings, and allows the
+same root to be reopened. A component instance stays bound to its first root;
+use another instance for a different database.
+
+There is no cross-instance filesystem lock in this WASI implementation. The
+host must serialize access to each directory, including request instances and
+rolling replacements. A single replica alone does not prevent concurrent
+request instances from sharing files. Do not mount one root into overlapping
+instances or replicas. Fatal engine traps require a new component instance.
+
+For the framework's platform-managed storage, annotate the WorkloadDeployment:
+
+```yaml
+metadata:
+  annotations:
+    di-framework.dev/persistent-storage: "true"
+    di-framework.dev/storage-mount: /data
+```
+
+The platform controller mounts the workload's persistent directory and grants
+its components the matching WASI preopen. Use a stable workload identity on
+redeploy and configure exclusive execution for this database. These
+annotations provide storage; they do not enforce database ownership.
+
+## Implementation
+
+- `src/lib.rs`: public WIT resources and connection lifecycle.
+- `src/pgwire.rs`: PostgreSQL message encoding and typed rows, over memory.
+- `src/engine.rs`: persistent filesystem setup and exclusive engine access.
+- `engine/bridge.wat`: private canonical ABI bridge to the core engine.
+- `scripts/prepare-engine.ts`: pinned engine preparation and componentization (all build scripts are Bun TypeScript; see `scripts/`).
+- `wit/deps/pglite-engine/engine.wit`: internal interface, composed away at build.
+
+Engine provenance and modifications are described in `engine/NOTICE`.

package/dist/BUILD-INFO.txt

@@ -0,0 +1,13 @@
+component:       di-framework:pglite@0.1.0
+profile:         release
+built:           2026-10-11T16:07:09Z
+rustc:           rustc 1.97.1 (8bab26f4f 2026-07-14)
+target:          wasm32-wasip2
+wasm-tools:      wasm-tools 1.258.0 (5c6d31c78 2026-08-24)
+wit-bindgen:     0.61.1
+md5:             0.7.0
+engine:          PostgreSQL 17.5, persistent WASI filesystem
+engine-source:   https://github.com/moznion/wasipg/tree/fa290be67946c0d3c4540bd1400b11e193d874e1
+adapter-sha256:  e51dd61669a20daca34befe7fdadf1ac84e4795a2c84a8400818ee1de5373ccc
+engine-sha256:   42d46914c081e0e14db55e077aa5a358c40a9d2ac63025571ff47895efc0f0d4
+size:            17991975 bytes

package/dist/SHA256SUMS

@@ -0,0 +1,3 @@
+19b23dbd0286a68488437880c91583bc174bc9545ad7107a215d179f50914313  di-framework-pglite.wasm
+36b6039274ecf82f8820008be93eae19a06b8535b33dddf5ab335be7afe88dba  di-framework-pglite.wit
+0b8bbbe8aa2898431d20371148a445c9b1ecdecb2ca81d3c98d43256f650590e  THIRD-PARTY-NOTICES.txt

package/dist/THIRD-PARTY-NOTICES.txt

@@ -0,0 +1,345 @@
+di-framework embedded PGlite component
+
+The provider bundles PostgreSQL 17.5 (PGlite WASI), originally maintained by
+ElectricSQL. PostgreSQL's license is reproduced in POSTGRESQL-COPYRIGHT.
+The upstream bindings license and WASI adapter license are reproduced in
+PGLITE-BINDINGS-LICENSE and WASMTIME-LICENSE.
+
+Sources:
+https://github.com/electric-sql/postgres-pglite
+https://github.com/electric-sql/pglite-bindings
+https://github.com/moznion/wasipg
+https://github.com/bytecodealliance/wasmtime/tree/v29.0.1
+
+The engine is compiled with PostgreSQL setjmp/longjmp recovery lowered to
+standardized WebAssembly exceptions. di-framework adds a private canonical
+ABI bridge, uses WASI randomness instead of a /dev/urandom preopen, and keeps
+bootstrap files within the database's persistent filesystem mount. A growable,
+bounded memory buffer replaces socket-file spillover for query replies. Backend
+startup restores application session defaults after bootstrap and enables
+durable writes.
+
+The engine's core module, support files, adapter, and the provider are
+composed into one deployable artifact. Engine code executes in the Wasm
+runtime; no native database process or socket transport is used.
+
+wasipg
+Copyright 2026 Taiki Kawakami (a.k.a moznion) https://moznion.net
+
+This product includes software developed as part of the wasipg project,
+licensed under the Apache License, Version 2.0 (see LICENSE).
+
+The Apache-2.0 grant covers the Go library, the build recipes, and the
+tests in this repository. It does NOT cover the third-party software
+listed below, which is redistributed — in source-patch form here, and in
+binary form in the released bundle artifacts — under its own license.
+
+--------------------------------------------------------------------------
+PostgreSQL
+--------------------------------------------------------------------------
+
+The released artifacts (pglite.wasi, pglite-wasi.tar.xz,
+pgdata-pristine.tar.xz) are builds of PostgreSQL 17.5, taken from the
+electric-sql/postgres-pglite fork (branch REL_17_5_WASM-pglite; the exact
+commit is pinned in build/versions.env). PostgreSQL and that fork are
+distributed under the PostgreSQL License, reproduced in the COPYRIGHT
+file shipped alongside the artifacts and inside pglite-wasi.tar.xz:
+
+    Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
+    Portions Copyright (c) 1994, The Regents of the University of California
+
+The patches under build/patches/ are modifications of that source tree
+and are likewise governed by the PostgreSQL License; see
+build/patches/README.md.
+
+--------------------------------------------------------------------------
+zlib
+--------------------------------------------------------------------------
+
+The PostgreSQL module statically links zlib 1.2.13, distributed under the
+zlib License:
+
+    Copyright (C) 1995-2022 Jean-loup Gailly and Mark Adler
+
+--------------------------------------------------------------------------
+Go module dependencies
+--------------------------------------------------------------------------
+
+The Go library depends on modules fetched at build time by consumers
+(github.com/jackc/pgx/v5 — MIT; github.com/tetratelabs/wazero —
+Apache-2.0; github.com/ulikunitz/xz — BSD-3-Clause). They are not
+redistributed in this repository or in the bundle artifacts; their
+licenses accompany the modules themselves.
+
+--------------------------------------------------------------------------
+wasi-libc / wasi-sdk
+--------------------------------------------------------------------------
+
+The PostgreSQL module and gate/testdata/sjlj.wasm statically link
+wasi-libc from wasi-sdk 33, distributed under
+"Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT". The shadow headers
+under build/hotfix/ are derived from wasi-libc headers.
+PostgreSQL Database Management System
+(formerly known as Postgres, then as Postgres95)
+
+Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
+
+Portions Copyright (c) 1994, The Regents of the University of California
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose, without fee, and without a written agreement
+is hereby granted, provided that the above copyright notice and this
+paragraph and the following two paragraphs appear in all copies.
+
+IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
+DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
+LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
+DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO
+PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+MIT License
+
+Copyright (c) 2024 ElectricSQL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+--- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+