@geonosis/db 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/README.md

@@ -0,0 +1,191 @@
+# @geonosis/db
+
+The consumer side of the executor port: a tenant session that Postgres itself enforces.
+
+A domain provider is 90 % domain and 10 % dialect. It writes SQL and ships its own DDL, and it
+takes the database as an injected `Executor` — query in a session, five lines, nothing about
+connections, pools or tenancy:
+
+```ts
+import type { Executor, Statement } from '@geonosis/db'
+
+type Executor = { execute: (statement: Statement) => Promise<QueryAnswer> }
+```
+
+That type has one home so there are not N structurally identical copies of it, and a consumer who
+never installed this package still satisfies it. `rowsOf` — the reader for the two shapes a
+Postgres driver answers with, its rows or a result wrapping them — lives one floor lower, in
+[`@geonosis/conformance`](../conformance), because a provider that reaches this package by TYPE
+only cannot import a function from it.
+
+Everything below is what a consumer runs UNDER that port. Installing it costs almost nothing at
+runtime: the one dependency is that zero-dependency floor, and `pg` is an optional peer that is
+loaded only if you ask for the driver.
+
+## The session seam
+
+One transaction per query, with the tenant named as its FIRST statement, `local` to that
+transaction so a pooled connection carries nothing out of it:
+
+```ts
+import { createSessionSeam } from '@geonosis/db'
+
+const seam = createSessionSeam({
+  opsStatementTimeout: '300000',
+  settings: { opsSetting: 'app.ops', tenantSetting: 'app.tenant' },
+})
+
+await seam.inTenant(connection, tenantId, (tx) => tx.execute(readInvoices))
+await seam.inOps(connection, (tx) => tx.execute(sweepOutbox))
+
+const listInvoices = seam.scoped(async (executor, params: { tenantId: string }) => …)
+const sweep = seam.scopedAsOps(async (executor, params: { since: number }) => …)
+```
+
+`tenantSetting` and `opsSetting` have NO defaults. The name of a session setting is the one thing
+this package cannot pick for you: the seam and the policies must agree on it exactly, and a default
+here would be one repo's name compiled into every other repo's wall. `opsValue` defaults to
+`DEFAULT_OPS_VALUE`; `opsStatementTimeout` is absent unless you set it, because a sweep's budget is
+a fact about one deployment's data.
+
+A session is re-entrant for the SAME scope only. A query already inside its tenant's transaction
+runs on it as it is; a query for a SECOND tenant, or a tenant query reached from an ops sweep, is
+refused naming both — with no tenant named it would run behind the ops policy, which is every
+tenant.
+
+Everything this package refuses, it refuses as a `DbRefusal`. Catch the class rather than matching
+the prose: a bare `Error` cannot be told from a driver that crashed, which is how a conformance case
+reads `TypeError: x is not a function` as "the seam said no".
+
+## The wall
+
+`tenantPolicies` writes the DDL to apply after your migrator runs. Two permissive policies — tenant
+isolation on the tenant setting, ops maintenance on the ops flag — plus ENABLE and FORCE:
+
+```ts
+import { tenantPolicies } from '@geonosis/db'
+
+for (const statement of tenantPolicies('invoices', { settings, tenantColumn: 'tenant_id' })) {
+  await connection.execute({ text: statement })
+}
+```
+
+It is DDL rather than schema-builder calls because FORCE is not sayable in one: drizzle-orm 0.45.2
+offers `enableRLS()` and drizzle-kit 0.31.10 emits `ENABLE ROW LEVEL SECURITY`, and neither package
+contains the string `FORCE ROW LEVEL SECURITY` anywhere (measured 2026-09-02). ENABLE alone exempts
+the table's OWNER, which is the role your migrations and your ops sweeps connect as. Every
+statement is re-runnable; apply the list in one transaction. `schema` qualifies the table, `names`
+renames the policies so this never drops one of yours.
+
+`freeze` is OFF unless you name a register. A restrictive policy is a second predicate every
+statement on the table pays for, and freezing a tenant's rows is a product feature rather than a
+property of tenancy.
+
+## The application role
+
+```ts
+import { appConnectionString, appRoleStatements } from '@geonosis/db'
+
+const statements = appRoleStatements({
+  idleInTransactionTimeout: '5s',
+  password,
+  role: 'acme_app',
+  statementTimeout: '10s',
+})
+const asTheApp = appConnectionString(ownerConnectionString, { password, role: 'acme_app' })
+```
+
+`login nosuperuser nobypassrls` is the point: the policies are the wall, and a superuser or a role
+with BYPASSRLS walks around it without a single query changing. The migrator stays the owner. The
+password never appears in a statement — the SCRAM verifier is computed in this process, so the DDL
+is safe wherever DDL gets logged. `role`, `statementTimeout` and `idleInTransactionTimeout` have no
+defaults; `schema` is `public` unless you say otherwise.
+
+## One handle per invocation
+
+```ts
+import { createConnections, nodePostgresDriver, perStepConnection } from '@geonosis/db'
+
+const records = createConnections({
+  connectionString,
+  driver: await nodePostgresDriver(),
+  open: { poolSize: 5 },
+})
+
+export default {
+  fetch: (request, env, ctx) =>
+    records.withConnection(() => handle(request), (closing) => ctx.waitUntil(closing)),
+}
+```
+
+A serverless invocation hibernates and dies. A handle opened once per process is dead by the second
+request; a handle opened per query is a pool per query. One per invocation is the lifetime that
+matches, and `withConnection` is what makes "this invocation" something the code can ask about
+instead of something every caller threads through. `sessionDb()` resolves the invocation's handle
+and REFUSES outside a frame, where a handle it opened would be closed by nobody — the repo this
+came from returns one there and says so in a comment. `open()` is for a caller who will close it.
+
+`onStatement` reports every statement a handle sends, the transaction's own `begin` and `commit`
+included — a count of round trips that leaves those out is not a count of round trips. It is what
+the statement census reads.
+
+`onIdleError` is how a pooled connection that died while nobody was using it becomes visible. It is
+worth wiring to your logger: `pg` reports such a death by emitting `error` on the pool, and an
+EventEmitter `error` with no listener terminates the process — so this package always attaches one,
+and without an `onIdleError` those deaths are silent. Nothing is waiting on such a connection and
+the pool replaces it by itself; there is nothing to act on, only something to know.
+
+`poolSize` has no default; the driver's own applies. The repo this came from measured fan-outs of
+3, 3, 3-plus-an-unbounded-map and 12 concurrent scoped queries per invocation against a pool of
+five — neither one nor five is "the" number, which is why it is a declared threshold here and not a
+constant.
+
+### A durable workflow
+
+`perStepConnection(connections)` is the `scope.perStep` a workflow engine asks for. A durable run
+hibernates between steps, so the handle its first step opened is dead by the fifth: each step body
+and each undo opens its own, and the engine's own writes — the trail, the closing batch — stay
+outside on the runner's connection.
+
+```ts
+createRuntime({ journal, scope: perStepConnection(records) })
+```
+
+The type is not imported in either direction. `@geonosis/db` and a workflow engine are sibling
+foundations, and what crosses between them is the shape.
+
+## The driver
+
+`nodePostgresDriver` is the one place `pg` is named, and it is loaded on demand: a consumer using
+the executor port with their own database library never resolves it, and one whose runtime needs a
+patched copy passes it in as `pg`. `migrate` applies a folder's `.sql` files in name order, each in
+its own transaction, each recorded in `migrationsTable` so the next run skips it — the smallest
+thing that can apply a folder. A consumer with a migrator of their own implements `Driver` around
+it, which is two methods.
+
+Connection POOLING and caching belong to the deployment, not to this package. A managed pooler in
+front of Postgres is reached the same way any other connection string is; if that pooler caches
+query results, turn the caching OFF — this seam's correctness rests on `set_config` being local to
+the transaction that a cached result never re-enters.
+
+## The exam
+
+The four proofs that made this worth extracting ship as runner-agnostic functions a consumer runs
+against THEIR session — no test framework rides along; a case fails by throwing a
+`ConformanceFailure` from [`@geonosis/conformance`](../conformance):
+
+| Export | What it asks |
+| --- | --- |
+| `tenantIsolationConformance` | what a query with no predicate can still see, and who is a superuser |
+| `statementCensusConformance` | a read in a session is four statements: no savepoint, one `set_config`, and the tenant named before the read |
+| `concurrentTenantsConformance` | eight tenants at once on one pool, and the two refusals |
+| `forcedRowLevelSecurityConformance` | every guarded table forces RLS, so the owner is behind the wall too |
+| `sessionConformance` | all four |
+
+```ts
+for (const { name, run } of sessionConformance(subject)) {
+  it(name, run)
+}
+```
+
+This package sits its own exam over `nodePostgresDriver` against a real Postgres, on both majors.