@rowstile/vitest 0.0.0-stage → 0.1.0-alpha.3

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

@@ -1,3 +1,81 @@
-# Temporary Holding Version
+# rowstile for TypeScript
 
-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 SDK for TypeScript apps on a rowstile policy: every transaction signs in as whoever the request
+or the job acts for, refused writes become a 403 with the database's reason, rows the user can't see a 404,
+signed-in reads stay out of Next.js's caches, and the app refuses to start on a connection that skips
+row-level security. It holds no rowstile logic: it calls the `authz.*` functions the policy made, and
+translates their answers.
+
+Next.js with Prisma:
+
+```ts
+// src/db.ts
+import { PrismaPg } from "@prisma/adapter-pg";
+import { authz, signedIn } from "@rowstile/prisma";
+import "@rowstile/next";                         // signed-in reads never land in a cache
+import "./authz.gen";                            // the policy's names (rowstile client)
+
+const adapter = signedIn(new PrismaPg({ connectionString: process.env.DATABASE_URL }),
+                         { user: async () => (await auth())?.user.id });
+export const db = new PrismaClient({ adapter }).$extends(authz());
+```
+
+```ts
+// app/api/folders/[id]/route.ts: no checks; a hidden folder is 404, one the user may not rename 403
+export const PATCH = route(async (req: Request, { params }: { params: Promise<{ id: string }> }) => {
+  await db.folder.update({ where: { id: Number((await params).id) }, data: await req.json() });
+  return Response.json({ ok: true });
+});
+```
+
+| package | what |
+|---|---|
+| `@rowstile/client` | `actingAs(who, fn)`, `job(who, fn)`, `current()`, `Refused`, `NotFound`, `NotSignedIn`, `translate(e)` and `problemResponse(e)` for any driver's error, `errorCode(e)` (rowstile's code: `AZ709`), `calls(queryable)` (the runtime's functions), the `Register` the generated names fill in |
+| `@rowstile/prisma` | `signedIn(adapter, { user })`: every transaction Prisma begins signs in; `authz()`: P2025 as `NotFound` or `Refused` with the reason, refused creates naming the rule, `db.$authz` (`can`, `ids`, `permsOf`, `share`, `check`, ...) |
+| `@rowstile/pg` | `authz(pool, { user })`: `transaction(fn)`, `query()`, the runtime's functions; `changes(pool)` for live updates |
+| `@rowstile/postgres` | `authz(sql, { user })`: `begin(fn)`, the runtime's functions |
+| `@rowstile/drizzle` | `withAuthz(db, { user })`: `transaction(fn)`; `inIds(column, type, perm)` and `ids()` for `where`; `expect(tx, result, ...)` for updates and deletes that changed nothing |
+| `@rowstile/next` | `route(handler)` (403 and 404 problem bodies), `action(fn)` (`{ ok, value }` or `{ ok: false, problem }`), `authzRoutes()` (what the React kit calls), `checkAtStart()` for `instrumentation.ts`; importing it keeps signed-in reads out of caches |
+| `@rowstile/react` | `<AuthzProvider>`, `usePerms(type, ids)` (one call for a list), `<Can>`, `useShares` and a headless `<ShareDialog>`, `useAccessRequest`; kept current over server-sent events |
+| `@rowstile/vitest` | `expect.extend(matchers)`: `toBeRefused(command, reason)`, `toBeNotFound()`; `asUser(who, fn)`; `databasePerWorker(url)`. Vitest 4 or 5 |
+
+Who a transaction acts for: `42` or `"42"` (a user), `["service", 3]` (another principal type of the policy),
+or `null` (nobody: only what `anyone` may see). A plain id is always a user's, whatever it holds: `"service:3"`
+is the user with that id, so an id from outside (a username, an identity provider's subject) can't name a
+service. `parsePrincipal("service:3")` reads back what `describe()` wrote, for text your own code wrote. Whoever the code acts for (`actingAs`, a `job`)
+comes first, else the `user` function, else nobody; a `who` given to one call (`transaction(fn, who)`) comes
+before all, and `null` there is nobody. Every transaction signs in, even as nobody, and nothing uses a
+session-level `SET`, so pools and poolers in transaction mode are safe; the change feed needs its own connection
+to Postgres ([Behind a pooler](../../docs/operations.md#behind-a-pooler)).
+
+Traps it handles:
+
+- **Next.js caching.** Before a transaction signs in as someone, `@rowstile/next` calls Next's `connection()`:
+  the render is dynamic, and a signed-in read inside `"use cache"` or `unstable_cache` fails instead of being
+  cached for the next user. Reads as nobody may be cached.
+- **Prisma answers some calls together.** It dispatches the `findUnique` calls of one tick, and array
+  transactions, from the first caller's context. `authz()` runs each `findUnique` in a transaction of its own,
+  and refuses `$transaction([...])` (use `$transaction(async (tx) => ...)`), so no query runs as someone else.
+  Use the client `$extends(authz())` returns, and only that one: the client it was made from is refused
+  whenever it is used.
+- **Inserts that read the row back** (`RETURNING`, Prisma's `create`) also need the select rule: Postgres's own
+  message comes back as `Refused` naming the select rule.
+- **Prisma's promises are lazy**: `actingAs` and `job` await what they return inside their scope.
+- **A connection that drops.** node-postgres stops the process when a client that is checked out loses its
+  connection and nobody listens: `@rowstile/pg` listens while it holds one, so the transaction fails instead.
+  `changes(pool)` listens again after its connection drops, and tells its subscribers once.
+- **An update that changed nothing** is `NotFound` when the user can't see the row, `Refused` when the database
+  says no, and `NotFound` again when the rule allows it and the statement matched nothing for another reason
+  (a `where` with more than the key).
+- **The answers in the browser are one user's.** Give `<AuthzProvider user={id}>` if the user can change
+  without a page load: the hooks forget what they had and ask again.
+
+The types and permissions of the policy are generated names: with a `@rowstile/*` dependency in
+`package.json`, `rowstile client` writes only the names (`[clients] ts = "src/authz.gen.ts"`), registered with
+the SDK, so `db.$authz.can("note", 1, "edt")` doesn't type-check. Policy changes ship as migrations for your
+tool (`rowstile migrate`, with `tool = "prisma"` or `"drizzle"` in `rowstile.toml`).
+
+The packages are an npm workspace at the repository root (`npm ci`, then `npx tsc -b sdk/typescript`).
+`integrations/nextjs/` is the conformance suite: a small Next.js app on Prisma 7 and Prisma Migrate, and the
+checks every supported stack passes, with pg, postgres.js, Drizzle and the React kit
+(`integrations/nextjs/test.sh`).

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * rowstile with Vitest (and Jest: the matchers are plain functions).
+ *
+ *     // vitest.setup.ts
+ *     import { expect } from "vitest";
+ *     import { matchers } from "@rowstile/vitest";
+ *     expect.extend(matchers);
+ *
+ *     await expect(asUser(bob, () => rename(f.id, "x"))).rejects.toBeRefused("update", "folder.edit");
+ *     await expect(asUser(bob, () => rename(hidden, "x"))).rejects.toBeNotFound();
+ *
+ * A database per worker: databasePerWorker(ownerUrl) copies the migrated test database (with the policy) once
+ * for each worker, so tests that write don't meet each other.
+ */
+import { type Who } from "@rowstile/client";
+/** Runs fn acting for `who`: every transaction it begins signs in as them. */
+export declare function asUser<R>(who: Who, fn: () => R): R;
+interface Result {
+    pass: boolean;
+    message: () => string;
+}
+export declare const matchers: {
+    /** The write was refused; optionally by this command's rule ("update"), and with this in its reason ("folder.edit"). */
+    toBeRefused(received: unknown, command?: string, reason?: string): Result;
+    /** The row isn't there for this user (hidden, or gone). */
+    toBeNotFound(received: unknown): Result;
+};
+declare module "vitest" {
+    interface Matchers {
+        toBeRefused(command?: string, reason?: string): void | Promise<void>;
+        toBeNotFound(): void | Promise<void>;
+    }
+}
+/** This worker's number: Vitest's VITEST_POOL_ID, Jest's JEST_WORKER_ID. */
+export declare function workerId(): string;
+/** A database for this worker, copied from `url`'s (migrated, with the policy): its URL, with the same user.
+ *  The copy is made once per run by a role that may create databases (the owner), while nothing else is
+ *  connected to the original. appUrl: the app role's URL for the copy, if given. */
+export declare function databasePerWorker(url: string, options?: {
+    appUrl?: string;
+    fresh?: boolean;
+}): Promise<{
+    url: string;
+    appUrl?: string;
+}>;
+export {};

package/dist/index.js

@@ -0,0 +1,103 @@
+/**
+ * rowstile with Vitest (and Jest: the matchers are plain functions).
+ *
+ *     // vitest.setup.ts
+ *     import { expect } from "vitest";
+ *     import { matchers } from "@rowstile/vitest";
+ *     expect.extend(matchers);
+ *
+ *     await expect(asUser(bob, () => rename(f.id, "x"))).rejects.toBeRefused("update", "folder.edit");
+ *     await expect(asUser(bob, () => rename(hidden, "x"))).rejects.toBeNotFound();
+ *
+ * A database per worker: databasePerWorker(ownerUrl) copies the migrated test database (with the policy) once
+ * for each worker, so tests that write don't meet each other.
+ */
+import { actingAs, translate, NotFound, Refused } from "@rowstile/client";
+/** Runs fn acting for `who`: every transaction it begins signs in as them. */
+export function asUser(who, fn) {
+    return actingAs(who, fn);
+}
+/** The error as rowstile's, whichever driver raised it. */
+const asAuthz = (received) => translate(received) ?? received;
+export const matchers = {
+    /** The write was refused; optionally by this command's rule ("update"), and with this in its reason ("folder.edit"). */
+    toBeRefused(received, command, reason) {
+        const e = asAuthz(received);
+        if (!(e instanceof Refused)) {
+            return { pass: false, message: () => `expected a refused write, got ${describe(received)}` };
+        }
+        if (command !== undefined && e.command !== command) {
+            return { pass: false, message: () => `expected the ${command} rule to refuse it, but the ${e.command} rule did: ${e.message}` };
+        }
+        if (reason !== undefined && !e.message.includes(reason) && !e.why.some((line) => line.includes(reason))) {
+            return { pass: false, message: () => `expected "${reason}" in the reason, got:\n${[e.message, ...e.why].join("\n")}` };
+        }
+        return { pass: true, message: () => `expected the write not to be refused, but: ${e.message}` };
+    },
+    /** The row isn't there for this user (hidden, or gone). */
+    toBeNotFound(received) {
+        const e = asAuthz(received);
+        return e instanceof NotFound
+            ? { pass: true, message: () => `expected the row to be found, but: ${e.message}` }
+            : { pass: false, message: () => `expected NotFound, got ${describe(received)}` };
+    },
+};
+function describe(x) {
+    if (x instanceof Error)
+        return `${x.name}: ${x.message}`;
+    return JSON.stringify(x) ?? String(x);
+}
+/** This worker's number: Vitest's VITEST_POOL_ID, Jest's JEST_WORKER_ID. */
+export function workerId() {
+    return process.env.VITEST_POOL_ID ?? process.env.VITEST_WORKER_ID ?? process.env.JEST_WORKER_ID ?? "1";
+}
+/** A database for this worker, copied from `url`'s (migrated, with the policy): its URL, with the same user.
+ *  The copy is made once per run by a role that may create databases (the owner), while nothing else is
+ *  connected to the original. appUrl: the app role's URL for the copy, if given. */
+export async function databasePerWorker(url, options = {}) {
+    const { default: pg } = await import("pg");
+    const base = new URL(url);
+    const template = decodeURIComponent(base.pathname.slice(1));
+    const name = `${template}_w${workerId()}`;
+    const admin = new pg.Client({ connectionString: url });
+    await admin.connect();
+    try {
+        const exists = (await admin.query("SELECT 1 FROM pg_database WHERE datname = $1", [name])).rowCount;
+        if (exists && options.fresh === false) {
+            // keep it
+        }
+        else {
+            const q = (s) => '"' + s.replace(/"/g, '""') + '"';
+            if (exists)
+                await admin.query(`DROP DATABASE ${q(name)} WITH (FORCE)`);
+            // CREATE DATABASE ... TEMPLATE needs no one else connected to the original: this connection moves off it
+            await admin.end();
+            const other = new pg.Client({ connectionString: withDatabase(url, "postgres") });
+            await other.connect();
+            try {
+                await other.query(`CREATE DATABASE ${q(name)} TEMPLATE ${q(template)}`);
+            }
+            catch (e) {
+                // 55006: something is connected to the original (Postgres has waited five seconds for it to leave)
+                if (e.code !== "55006")
+                    throw e;
+                throw new Error(`@rowstile/vitest: ${template} can't be copied while anything is connected to it: close ` +
+                    "what holds it (the app, a migration tool, a console). Where the service keeps a connection of its own " +
+                    "for minutes after yours (Neon does), a copy per worker can't be made: use one test database, where " +
+                    "each test rolls back, or a branch for each run", { cause: e });
+            }
+            finally {
+                await other.end();
+            }
+        }
+    }
+    finally {
+        await admin.end().catch(() => undefined);
+    }
+    return { url: withDatabase(url, name), appUrl: options.appUrl ? withDatabase(options.appUrl, name) : undefined };
+}
+function withDatabase(url, db) {
+    const u = new URL(url);
+    u.pathname = "/" + encodeURIComponent(db);
+    return u.toString();
+}

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@rowstile/vitest",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.3",
+  "description": "rowstile with Vitest (and Jest): asUser, toBeRefused, a database per worker",
+  "license": "Apache-2.0",
+  "repository": { "type": "git", "url": "git+https://github.com/rowstile/rowstile.git", "directory": "sdk/typescript/vitest" },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@rowstile/client": "0.1.0-alpha.3"
+  },
+  "peerDependencies": {
+    "vitest": "^4.0.0 || ^5.0.0",
+    "pg": ">=8"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": true
+    },
+    "vitest": {
+      "optional": true
+    }
+  }
+}