@voltro/plugin-audit 0.26.0 → 0.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +297 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.js +21 -6
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -39,6 +39,303 @@ _Changes staged for the next release accumulate here (rolled up from
|
|
|
39
39
|
|
|
40
40
|
---
|
|
41
41
|
|
|
42
|
+
## [0.27.0] — 2026-08-05
|
|
43
|
+
|
|
44
|
+
### Added
|
|
45
|
+
|
|
46
|
+
- **@voltro/plugin-audit, @voltro/plugin-versioning** — `scope` — the app's own scoping dimension on `_voltro_audit_log` **and** `_voltro_row_history`, supplied by a `resolveScope` option on each plugin.
|
|
47
|
+
|
|
48
|
+
The last thing between a consumer and deleting a 2900-row, 300-call-site hand-rolled audit trail. Their trail and its retention are per-TEAM; a tenant has many teams, so `.with(tenant())` is one level too coarse and every view they render filters by team first. It is the same column `_voltro_webhook_targets.scope` already carries: opaque json in, opaque json out, equality filtering.
|
|
49
|
+
|
|
50
|
+
**Deliberately not `metadata`.** They offered to carry `teamId` there and filter in memory, and were right to dislike it: `metadata` is documented as the app's free-form note — the noun a diff cannot contain — so filtering on it builds a read path against a column whose contract says it is not one. Two columns, two jobs.
|
|
51
|
+
|
|
52
|
+
The app supplies the value, because the framework does not know what a team is — which is the whole reason the column is opaque. `auditPlugin` derives it from the call (`(ctx) => ({ teamId: ctx.subject.metadata?.teamId })`); `versioningPlugin` from the changed ROW (`(row) => ({ teamId: row.teamId })`), because that is what that plugin has and where a per-table dimension lives. Configure both or half of every view is unfiltered.
|
|
53
|
+
|
|
54
|
+
Neither resolver can fail the write it annotates: an underivable scope is `null`, the same answer as not configuring one.
|
|
55
|
+
|
|
56
|
+
codemod: none
|
|
57
|
+
- **@voltro/plugin-notifications** — `notificationsPlugin({ resolveSubjectId })` — the app names its own addressing unit.
|
|
58
|
+
|
|
59
|
+
An inbox belonged to `subject.id`. That is the framework's answer and not always the app's: a shift change, an absence request or a task reminder is addressed to a PERSON, and a person does not necessarily have an auth user. A reporter measured it on 14 670 rows — 4 677 addressable through a user, and **668 live, read rows belonging to four people who have none**.
|
|
60
|
+
|
|
61
|
+
The worse half is what follows a migration without it: every producer resolves person → user and **silently delivers nothing** for anyone missing one. That is the failure this plugin's own docstring warns about, one level up and structural rather than accidental.
|
|
62
|
+
|
|
63
|
+
One function, thirteen call sites — the same seam `auth.resolveScopes` already offers for this shape. Absent keeps `subject.id`, so nothing changes for an app whose units line up. A resolver that returns `undefined`, an empty string, or throws falls back to the subject rather than failing the read: an inbox must not go down because one caller has no employee record, or because a lookup hit a database that was briefly unavailable.
|
|
64
|
+
|
|
65
|
+
**`useEvent` already returns what the same report asked for.** `{ status, missed, lastMiss }`, where `status === 'live'` is the connected flag — the ask was for discoverability, not an API, so the docs now name the case that motivated it: a wall display nobody is standing at keeps rendering the last thing it received, and from across the room stale and current look identical.
|
|
66
|
+
|
|
67
|
+
codemod: none
|
|
68
|
+
- **@voltro/plugin-presence** — The presence tracker gets a perf suite — the last of the four realtime surfaces without pinned numbers — and the four are now documented side by side.
|
|
69
|
+
|
|
70
|
+
The presence figures existed in the docs (a heartbeat, a 10 k roster) and were measured once by hand, which cannot fail. Same gap the event bus had, closed the same way: a `*.perf.test.ts` that prints what it measured and asserts the SHAPE rather than the microseconds.
|
|
71
|
+
|
|
72
|
+
Measured across all four, each asserted by a test:
|
|
73
|
+
|
|
74
|
+
| primitive | operation | cost | scales with | | --- | --- | --- | --- | | Events | `ctx.events.publish` | 4.3 µs (~232 k/s) | nothing | | Events | delivery to a subscriber | 0.027 µs | subscribers, cheaply | | Presence | a heartbeat | 0.16 µs | nothing | | Presence | a roster read, 10 k members | 547 µs | the ROOM | | Records | a live-query re-diff, 5 000 rows | 3 062 µs | the RESULT SET | | Broadcast | cross-replica over real Redis | p50 1.1 ms · p99 11.2 ms | the network |
|
|
75
|
+
|
|
76
|
+
**The comparison is what was missing, not the numbers.** Publishing an event costs about a thousandth of re-diffing a large live query, and that ratio is what should decide between them — a 60 Hz value belongs in an event, because the same value written to a table wakes every subscriber of every query reading it and each pays the full walk.
|
|
77
|
+
|
|
78
|
+
Two of the four are flat and two are not. That is the property the tests assert: the per-member cost of a roster read must not grow with the room, and the per-row cost of a diff must not grow with the result set. Either one growing is the difference between expensive and unusable.
|
|
79
|
+
|
|
80
|
+
codemod: none
|
|
81
|
+
- **@voltro/cli** — A capability matrix for the realtime surface — fifteen things people build, each mapped to the primitive that carries it, each asserted by a test.
|
|
82
|
+
|
|
83
|
+
"Nothing is missing" is not a checkable sentence. This turns it into one: `realtimeCapabilities.test.ts` asserts every row's primitive is still exported, so a capability that loses its primitive to a rename goes red in CI rather than being discovered by whoever tries to build it.
|
|
84
|
+
|
|
85
|
+
It caught one on its first run — the matrix claimed `useUpload` lived in `@voltro/plugin-storage` and it is in `@voltro/client`. A row pointing at the wrong package is exactly what a table in a document does silently.
|
|
86
|
+
|
|
87
|
+
It asserts EXPORTS rather than behaviour on purpose. Behaviour is what the other suites are for, and duplicating them here would make this a slower copy of them. What it catches is the gap between "we support that" and "the thing that supports it still exists".
|
|
88
|
+
|
|
89
|
+
The same table is in the docs, with the three capabilities people usually reach for wrongly called out: a value changing many times a second is an EVENT and not a row (writing it to a table wakes every subscriber of every query reading that table, each paying a full re-diff); "who is online" is presence rather than a table; and "did anything get lost" has a computed answer in `missed`, so nobody needs to build a heartbeat of their own to find out.
|
|
90
|
+
|
|
91
|
+
codemod: none
|
|
92
|
+
- **@voltro/cli** — The ten hard questions a realtime system is judged on, with this framework's answer and — enforced by a test — the proof behind each.
|
|
93
|
+
|
|
94
|
+
`realtimeProperties.test.ts` fails if a row's proof disappears: a property may not be CLAIMED without something in the repository that demonstrates it. Red-verified by re-pointing one row at a test that does not exist.
|
|
95
|
+
|
|
96
|
+
The questions, because they are the deliverable rather than the mechanism: is a missed delivery reported or silently dropped; can a late arrival tell "nothing happened" from "I was not listening"; is a SUBSCRIPTION authorized or only the connection; does a subscription outlive its credential; does the link heal itself after an outage; does a degraded network lose messages or only slow them; does fan-out cost grow with subscribers; are channels typed or strings; is a declared event nobody publishes reported; is cross-replica traffic separated per app by default.
|
|
97
|
+
|
|
98
|
+
**Why this replaces a benchmark against hosted competitors.** A table of our measured numbers beside someone else's published ones is not a comparison, it is two things in a row. Measuring a hosted product honestly needs its accounts, regions, tiers and retry policies, and a wrong number about someone else's product is worse than no number. What decides a choice is not the microseconds anyway — it is whether the system answers these questions at all, and every answer above is checkable against this repository by anyone.
|
|
99
|
+
|
|
100
|
+
codemod: none
|
|
101
|
+
- **@voltro/cli** — A real competitive measurement — against socket.io, on this machine, in the same topology.
|
|
102
|
+
|
|
103
|
+
This was declined twice on the grounds that a benchmark needs the competitor's accounts and regions. That reasoning holds for hosted products and **does not hold for socket.io**, which is an npm package: it can be installed, run and measured here with the same method. Declining it was over-broad.
|
|
104
|
+
|
|
105
|
+
Back to back, two server instances sharing one Redis, client on B, emits on A:
|
|
106
|
+
|
|
107
|
+
| | p50 | p99 | delivered | | --- | --- | --- | --- | | Voltro cross-replica | **1.29 ms** | 6.80 ms | 200/200 | | socket.io + redis-adapter | 1.89 ms | **3.81 ms** | 200/200 |
|
|
108
|
+
|
|
109
|
+
**~32% faster at the median, ~44% worse at the tail.** Both lossless. The p99 is ours to improve and is published rather than omitted, because a benchmark you only show when you win is advertising.
|
|
110
|
+
|
|
111
|
+
**The topology is what makes it a comparison.** The first attempt measured socket.io on a plain localhost websocket with no adapter and came out 3x faster — which proved nothing: that is one hop, ours is two through a broker. It would have flattered socket.io and been dishonest in their favour, which is the same defect as flattering ourselves.
|
|
112
|
+
|
|
113
|
+
Also measured and NOT published as a headline: socket.io's `emit` to 100 subscribers costs 13.7 µs against our 2.7 µs, but at that point ours has already run every listener while socket.io has only enqueued to 100 sockets — zero had arrived when the measurement ended. Two different quantities; comparing them would have been the same mistake in the other direction.
|
|
114
|
+
|
|
115
|
+
`scripts/bench/socketio-cross-replica.mjs` carries the method and the numbers so they can be re-taken. Deliberately a script, not a test: keeping a competitor in the dependency tree to hold a number green is the wrong trade.
|
|
116
|
+
|
|
117
|
+
codemod: none
|
|
118
|
+
- **@voltro/plugin-webhooks** — **A subscription is a SET of events, and the service now has a word for it.**
|
|
119
|
+
|
|
120
|
+
`subscribe({ events: [...] })` creates the rows in one call; a `{ scope }` selector addresses them as a group wherever a target id is accepted — `pauseTarget`, `resumeTarget`, `updateTarget`, `deleteTarget`, `rotateSecret`, `listDeliveries`.
|
|
121
|
+
|
|
122
|
+
A row is one event, but a subscription — as every webhook UI models it, ours included — is one URL with a list of event checkboxes. Without a name for the group, five checkboxes are five rows and every operation a user thinks of as single becomes a fan-out the app writes by hand: N pauses, N updates, N delivery reads merged and re-sorted, and a rotate that is delete + re-subscribe.
|
|
123
|
+
|
|
124
|
+
**The shared secret is why this is correctness and not ergonomics.** The receiver verifies ONE signature for ONE url, so N rows for one endpoint must sign identically — and there was no way to say so. `subscribe` mints a secret per call, `SubscribeResult` surfaces it once, `TargetPatch` cannot set it. So ticking a sixth event meant reading the secret column back out of `_voltro_webhook_targets` through the app's own database handle. That is exactly the coupling `listDeliveries` was added to remove, re-entered through a different door one release later.
|
|
125
|
+
|
|
126
|
+
`subscribe` now mints one secret for the whole set, and `rotateSecret({ scope })` rotates every row to the same new value — which also replaces the delete-and-re-subscribe that minted new target ids and orphaned the delivery history.
|
|
127
|
+
|
|
128
|
+
**`secret` is deliberately still not patchable.** Adding it to `TargetPatch` would close the same gap by making a live credential app-writable, trading a coupling for a weaker invariant. The reporter proposed the constraint and declined that shortcut themselves.
|
|
129
|
+
|
|
130
|
+
A scope matching no row is an error rather than a no-op: "pause the endpoint" that pauses nothing and reports success is the silent shape this selector exists to avoid.
|
|
131
|
+
|
|
132
|
+
codemod: none
|
|
133
|
+
|
|
134
|
+
### Fixed
|
|
135
|
+
|
|
136
|
+
- **@voltro/cli** — Cross-replica delivery is now tested over a network that is not loopback.
|
|
137
|
+
|
|
138
|
+
This closes the one item repeatedly written off as needing external infrastructure — "two real pods over a real network". That was the wrong variable. What a loopback number cannot show is a path with LATENCY, JITTER and a bandwidth ceiling, and injecting those is not only possible in the test stack, it is BETTER than a real network for a test: reproducible, and degradable on purpose.
|
|
139
|
+
|
|
140
|
+
`toxiproxy-test` joins `test/docker-compose.yml` as a degradable path to `redis-test`. Measured through it:
|
|
141
|
+
|
|
142
|
+
| condition | p50 | p99 | delivered | | --- | --- | --- | --- | | 20 ms ± 10 jitter | 26 ms | 89 ms | 200/200 | | + a 50 KB/s ceiling | 188 ms | 354 ms | 200/200 |
|
|
143
|
+
|
|
144
|
+
Seven times slower at the median under the second, and not one envelope lost. That is the property the new suite asserts: **degradation costs latency, never messages.**
|
|
145
|
+
|
|
146
|
+
The latency BUDGET is deliberately left in the healthy-path suite. Asserting it here would produce a test that goes red when the network is bad rather than when the code is — and the second row above is exactly that case.
|
|
147
|
+
|
|
148
|
+
codemod: none
|
|
149
|
+
- **@voltro/plugin-audit, @voltro/cli, @voltro/runtime** — **`@voltro/plugin-audit` could not boot — a release blocker, reported within a day.** 0.26.0 attached `interceptAction` and `interceptQuery` and declared neither scope, so the boot permission audit (`level: fatal`) refused to start EVERY app carrying the plugin, whether or not it had opted into query auditing. The audit inspects the presence of a hook, not what it does, so the identity passthrough counted.
|
|
150
|
+
|
|
151
|
+
The manifest declares both now — and `interceptQuery` is **attached** only when `recordQueries` is on, with its scope declared conditionally the way `store:write` already is. That is the reporter's suggestion and it is the better half of the fix: listing the scope unconditionally clears the boot while making every deployment DECLARE that it intercepts queries when almost none do, and a permission manifest is worth reading only if it describes what the plugin actually touches.
|
|
152
|
+
|
|
153
|
+
Their diagnosis of why it escaped is what the guard is built from: *a plugin's own test suite exercises the plugin, not a boot with the plugin installed*. The same shape as the `gc-snapshots` dialect bug one round earlier — the check that would have caught it is the one nobody ran on the affected path. There is now a test over the WHOLE `packages/plugin-*` set asserting that every hook a plugin ships has its scope named in its source, red-verified by reproducing 0.26.0.
|
|
154
|
+
|
|
155
|
+
**The stale-`source:` warning fired on the framework's own tables.** It resolved against the app's discovered entities, so every table the framework contributes conditionally — `_voltro_agent_messages` / `_voltro_agent_threads` behind a `*.agent.tsx`, and every plugin's `extendSchema.tables` — read as missing. The reporter got two warnings on every boot, for two sources that were correct, about a table the framework itself had created.
|
|
156
|
+
|
|
157
|
+
Their argument for why that is worse than cosmetic is the one that shaped the fix: this warning exists because a stale `source` is otherwise silent, so its entire value is being trusted. Firing on correct rows teaches the reader it is noise, and the next real one arrives into a warning nobody reads.
|
|
158
|
+
|
|
159
|
+
It resolves against the full live set now — app entities + plugin `extendSchema.tables` + framework tables, the same set auto-migrate emits DDL for — which means it runs after that set is assembled rather than inside `loadDiscovered`. Both boot paths do it, pinned by an ordering test.
|
|
160
|
+
|
|
161
|
+
codemod: none
|
|
162
|
+
- **@voltro/plugin-broadcast, @voltro/cli** — The broadcast namespace is normalised silently, and the silence reintroduces the hazard the namespace removes.
|
|
163
|
+
|
|
164
|
+
Found by probing the broadcast surface the way the events and records surfaces were probed. `broadcastPlugin` accepted all nine bad shapes tried — whitespace, a bare `>`, a trailing dot, an empty string, no options at all — and the sanitiser handles every one of them correctly. **No declaration-time refusal is warranted, and that is the finding**, not a gap.
|
|
165
|
+
|
|
166
|
+
What the probe surfaced is one step on: `my app` and `my.app` BOTH resolve to `my-app`. Two deployments configured DIFFERENTLY therefore share a channel, which is precisely what this option exists to prevent — arrived at by way of the option itself. The docs already say that staging and production of one app share a name and only this variable separates them, which is exactly the case where someone types two values believing they differ.
|
|
167
|
+
|
|
168
|
+
Nothing refuses: the resolved value is broker-safe either way, and failing a boot over a dot would be worse than the collapse. Both boot paths log the substitution when it changes what was written, and the message names the COLLAPSE rather than only the substitution — the substitution alone reads as cosmetic. Silent when the value survives unchanged, and silent for the derived app-name default, which is not something an operator can act on.
|
|
169
|
+
|
|
170
|
+
codemod: none
|
|
171
|
+
- **@voltro/plugin-broadcast, @voltro/cli** — **`broadcastPlugin()` with `REDIS_URL` set no longer stays silently on `memory`.** `REDIS_URL` counted for RESOLUTION but not for INFERENCE — it took an explicit `connection` option to be considered — so the plugin fell through to the in-process bus while the branch that would have read the variable sat directly below. Two doc strings promised the fallback ("inferred from … `REDIS_URL`", "falls back to `REDIS_URL`").
|
|
172
|
+
|
|
173
|
+
The asymmetry is what made it expensive rather than merely wrong: cache, kv and ratelimit all follow `<NAME>_REDIS_URL` → `REDIS_URL`, so an operator sets one variable, reads `cache backend resolved: redis` in the boot log, and concludes the bus did the same. A reporter did exactly that, on a single-replica deployment where the difference is unobservable — it appears on scale-up, as "some screens miss some events".
|
|
174
|
+
|
|
175
|
+
The caution the opt-in encoded is obsolete: every channel now carries the app-derived namespace, so attaching to a shared server no longer means two apps read each other's traffic. The test that pinned the old decision is reversed with that reasoning in it rather than deleted.
|
|
176
|
+
|
|
177
|
+
**The producer scan sees a locally bound publisher.** `\.publish\s*\(` misses
|
|
178
|
+
|
|
179
|
+
const publish = ctx.publish if (publish === undefined) return await publish(descriptor, {}, payload)
|
|
180
|
+
|
|
181
|
+
— which is not a corner case but the shape a handler writes when it guards the optional publisher. A reporter spent a quarter hour hunting for a missing publish they had just written, because the warning said their working event was dead. A false negative here is a missed warning; a false POSITIVE is a warning that lies about working code, and that is the expensive direction.
|
|
182
|
+
|
|
183
|
+
A bare `publish(` now counts, but only in a file that mentions `ctx.publish` or `ctx.events` — `publish` is too common a name to accept unqualified, and the qualifier also covers the `async ({ publish })` destructuring the dotted form misses for the same reason. Both directions tested.
|
|
184
|
+
|
|
185
|
+
codemod: none
|
|
186
|
+
- **@voltro/plugin-broadcast** — `broadcastPlugin` refuses a request it cannot honour instead of downgrading it silently.
|
|
187
|
+
|
|
188
|
+
Probed the way the events, records and presence surfaces were: five plausible mistakes, **five accepted**, and every one produced the same outcome — the in-process memory bus with a successful boot.
|
|
189
|
+
|
|
190
|
+
| written | got | said | | --- | --- | --- | | `provider: 'redes'` (typo) | memory | nothing | | `url: 'http://x'` | memory | nothing | | `url: ''` | memory | nothing | | `provider: 'redis'`, no url anywhere | memory | nothing |
|
|
191
|
+
|
|
192
|
+
On one replica each of these is indistinguishable from working. They appear on the second, as "some screens miss some events" — which is the report that led here, and it cost a consumer a deployment.
|
|
193
|
+
|
|
194
|
+
The asymmetry that decides it: **an app that configures nothing has taken a default, and memory is the honest answer. An app that writes `provider: 'redis'` has stated a requirement**, and answering a requirement with a downgrade is the shape removed everywhere else in this codebase.
|
|
195
|
+
|
|
196
|
+
So configuring nothing still takes memory, an explicit `provider: 'memory'` is still honoured — saying it out loud must not be worse than saying nothing — and a bare redis url still resolves without naming the provider. What throws is only the case where the request cannot be met: an unknown name (listing the valid ones, so the fix does not need the docs), a url whose scheme names no provider, and a named provider with no url anywhere (naming the variables that would satisfy it).
|
|
197
|
+
|
|
198
|
+
Red-verified: with the refusal removed, the two tests that assert it go red.
|
|
199
|
+
|
|
200
|
+
codemod: none
|
|
201
|
+
- **@voltro/cli** — Cross-replica delivery is now tested across a broker OUTAGE, not only a healthy or a degraded link.
|
|
202
|
+
|
|
203
|
+
The suites here proved delivery on a working link, and one proved it on a throttled one. None broke the link. That is the failure an operator actually meets — a redis restart, a failover, a partition that heals — and it was the last untested shape in the realtime stack.
|
|
204
|
+
|
|
205
|
+
**The property asserted is recovery, not delivery.** A broker that is down cannot carry messages, and claiming otherwise would be exactly the sort of guarantee this repo keeps removing. What must hold is that the link heals BY ITSELF: after the outage, delivery resumes with no process restart, no app-side retry and no resubscribe. A subscriber that silently stays dead after a blip is the worst realtime failure there is, because the screen keeps rendering and nothing reports it.
|
|
206
|
+
|
|
207
|
+
The test proves the link worked BEFORE it breaks it, so a zero at the end cannot be blamed on a link that never worked. Red-verified: leaving the proxy disabled gives 0 recovered deliveries instead of 10.
|
|
208
|
+
|
|
209
|
+
Also probed, and correct as found: a throwing listener does not kill the publish, does not stop its healthy siblings receiving, and does not leave the bus unusable afterwards. The 5 MB payload the bus accepts is fine — the size gate sits at the public seam (`ctx.events.publish`) and measures the ENCODED wire form, which is the representation that can actually be rejected downstream.
|
|
210
|
+
|
|
211
|
+
codemod: none
|
|
212
|
+
- **@voltro/protocol, @voltro/runtime, @voltro/cli** — **The credential bound covered one auth shape and the sentence did not say so.**
|
|
213
|
+
|
|
214
|
+
We wrote that "an event subscription can no longer outlive the credential that authorized it" and, a release later, that "the bound now covers EVERY realtime primitive". Both were true only for the `voltro:session` cookie: `sessionExpiryFromHeaders` read that cookie and nothing else, so for an app authenticating with Bearer JWTs the bound was always `undefined` — a no-op that reads as a guarantee.
|
|
215
|
+
|
|
216
|
+
A reporter found it by expecting black screens an hour after a deploy and getting none. Their framing is the one to keep: **the guarantee was not false, it was scoped to an auth shape the sentence did not name** — and we had corrected a different sentence in the same release for exactly that reason.
|
|
217
|
+
|
|
218
|
+
There was also no seam to close it with. `StrategyResolution` was `{ matched, subject }`, so the strategy — the only place in the system that verified the token and holds its `exp` — could not report it.
|
|
219
|
+
|
|
220
|
+
It can now: `{ kind: 'matched', subject, credentialExpiresAt? }`, optional, with absent still meaning no bound. The shared JWT strategy reports its verified `exp`, which covers all six catalog providers (auth0, clerk, kinde, oidc, supabase, workos) in one place rather than six near-identical lines that drift.
|
|
221
|
+
|
|
222
|
+
The expiry rides WITH the subject through the chain and is recorded on the per-connection channel that already carries subject overrides, so `ConnectionInfo` reads it instead of re-deriving from headers. Two sites deriving one fact is what let the cookie path and the bearer path disagree. Both boot paths do it, in the same change.
|
|
223
|
+
|
|
224
|
+
Tested for both shapes — including that `resolveScopes`, which rebuilds the subject, does not drop it. That would have reopened the hole for every app using the seam we point people at for this kind of augmentation.
|
|
225
|
+
|
|
226
|
+
codemod: none
|
|
227
|
+
- **@voltro/cli** — **Records and presence are now PROVEN cross-replica, not asserted.**
|
|
228
|
+
|
|
229
|
+
Asking one question across the whole surface — *which primitive is proven cross-replica against a real broker?* — gave an answer no amount of bug-fixing had:
|
|
230
|
+
|
|
231
|
+
| primitive | before | | --- | --- | | events | seven suites: partition, broker outage, degraded network | | records | **none** | | presence | **none** — zero broker use in all three of its suites |
|
|
232
|
+
|
|
233
|
+
"Multi-replica works" was proven for events and asserted for the other two, and they run through different code: events go bus → bridge → subscriber, records go `store.onChange` → broadcast → the peer's `injectExternalChange` → dispatcher → subscription. Only one had been driven end to end.
|
|
234
|
+
|
|
235
|
+
**Presence** now proves what a consumer had to measure by hand with `redis-cli PUBSUB NUMSUB` because the framework was telling them the opposite: a member tracked on A appears in B's roster, opaque `meta` survives the hop, and a leave on A removes it from B. A roster that only ever GROWS across instances is the failure that looks like success.
|
|
236
|
+
|
|
237
|
+
**Records** cost three wrong attempts, and the reason is worth more than the test. Two independent in-memory stores cannot model this: `injectExternalChange` NOTIFIES without persisting — deliberately, because replicas share a DATABASE and the peer re-reads storage they have in common. With separate stores the notification arrives (measured: called exactly once) and the re-read finds nothing, so no delta is emitted. Correct behaviour against an incorrect topology — and reported as a defect it would have sent someone hunting the bus for a bug that is not there. The suite runs one postgres, two stores, two dispatchers.
|
|
238
|
+
|
|
239
|
+
Two harness errors along the way are recorded in the files rather than quietly fixed: `tracker.track()` alone is a LOCAL write (the route calls `announce(track(...))`), and a predicate literal is `{ column, op, value }` — using `kind` instead of `op` matched nothing, so the missing delta was correct. Both would have been reported as framework defects.
|
|
240
|
+
|
|
241
|
+
codemod: none
|
|
242
|
+
- **@voltro/cli** — The `no-consumer` half of the event audit sees sibling apps.
|
|
243
|
+
|
|
244
|
+
It read the API app's own tree, and in a monorepo the `useEvent` calls are not there — they are in the web apps beside it. A reporter had ten declared events, all ten consumed, all ten calls in ONE file in a sibling app, and got ten `no-consumer` warnings. A check that is wrong ten times out of ten carries no signal, and they ranked the two halves themselves: the producer half found them a dead trigger node that had not fired since a migration; the consumer half found nothing and spent the attention the producer half needed.
|
|
245
|
+
|
|
246
|
+
The siblings are not guessed from directory layout. `pnpm-workspace.yaml` declares them, so this reads what the workspace already says — a project outside a workspace costs nothing, which is the common single-app case.
|
|
247
|
+
|
|
248
|
+
Bounded at 4000 files, and LOUDLY: hitting the bound logs that a `no-consumer` line below may mean "we stopped looking" rather than "nothing consumes it". A silently truncated scan is the same false confidence one layer down, which is the defect this whole audit exists to remove.
|
|
249
|
+
|
|
250
|
+
codemod: none
|
|
251
|
+
- **@voltro/protocol** — `defineEvent` refuses four authoring mistakes it used to accept.
|
|
252
|
+
|
|
253
|
+
Found by probing what it lets through rather than by reading it: nine plausible mistakes were tried, nine were accepted. The surface had exactly two refusals, one of which (`latest` + `webhook`) is a model for the rest.
|
|
254
|
+
|
|
255
|
+
**Whitespace in a name is the severe one — a production-only silence.** The name becomes a broker SUBJECT segment, and NATS refuses a subject containing whitespace and delivers nothing, with no error on the publishing side. An app that works on Redis stops working when the transport changes: silently, on one broker only. Refused at declaration, where the author can still see the string, and the message names the dot form to use instead.
|
|
256
|
+
|
|
257
|
+
**`guards: []`** is refused because the enforcement in `bindEvent` runs only for a non-empty list — so it reads at the call site as if the event were protected and secures nothing. That is the declared-and-inert shape this codebase keeps finding; an omitted field is the honest spelling for unguarded.
|
|
258
|
+
|
|
259
|
+
**`webhook.rateLimit.perMinute: 0`** defers every delivery forever, and there is no "unlimited" spelling for the field, so 0 is almost always someone reaching for one. **`webhook.version: 0`** would make a subscriber pinned to 1 read the event as *behind* — the opposite of what a version bump means.
|
|
260
|
+
|
|
261
|
+
Each message says what is wrong, why, and what to write instead; a test asserts that every refusal is more than one line, because a message that only names the rule leaves the reader guessing at the reason, and the reason is usually what they needed.
|
|
262
|
+
|
|
263
|
+
codemod: none
|
|
264
|
+
- **@voltro/database, @voltro/runtime, @voltro/cli, @voltro/plugin-presence** — **`pluginRef` declarations survive `table()` and are readable as `table.appliedPluginRefs`.** They did not, and the consequence reached further than the reporter could see.
|
|
265
|
+
|
|
266
|
+
`pluginRefSpecOf` reads a column BUILDER; `table()` materialises builders into plain field descriptors. So the declaration vanished the instant the table existed, and the column read as an ordinary `text()`.
|
|
267
|
+
|
|
268
|
+
A consumer's CRUD generator and their contract test both derive "which column carries the tenant" from the schema, both asked `type === 'reference'`, and a `pluginRef` column answered no — so generated junction handlers dropped the tenant sub-query and a favourite could point at another tenant's row. Their test missed it for the same reason the generator did: **a checker sharing the assumption of the thing it checks.** They caught it only because they happened to teach discovery about `pluginRef` before the generator; the other order ships the regression.
|
|
269
|
+
|
|
270
|
+
**On our side it was worse and they could not have known.** The framework's own orphan-rule collector walked the column bag asking `pluginRefSpecOf`, got `undefined` every time, and produced ZERO rules on every real schema — so `orphanPolicy: 'delete'` did nothing, for the second release running. Its wiring test stayed green because it asserted the collector was CALLED, never that it returned anything.
|
|
271
|
+
|
|
272
|
+
A test against a real `table()` then found a THIRD defect immediately: the collector read `spec.target().name`, and a table's property is `tableName`, so every target resolved to undefined and the boot refusal fired for every `pluginRef`. The fixtures returned `{ name }` — confirming the wrong assumption rather than testing it.
|
|
273
|
+
|
|
274
|
+
That confusion had spread. The stale-`source:` resolver in BOTH boot paths built its table set the same way, producing an empty set — and `unresolvedSources` returns nothing for an empty set by design, so the warning silently stopped firing. **The fix for one false positive had turned the other into silence.** A narrow source guard now catches the shape; its own first run flagged a correct workflow read, which is recorded in the file, because a guard that opens with a false positive gets muted.
|
|
275
|
+
|
|
276
|
+
**The presence broker warning fires after the bus attaches.** It ran at plugin activation, and the broadcast bus attaches later — the reporter measured 634 ms, then confirmed with `PUBSUB NUMSUB` that presence was cross-instance while the log said otherwise. The check is deferred and re-reads the transport at fire time. This exact warning had just found them a real misconfiguration and then kept reporting the fault after the repair, which is how a warning spends the credibility it earned.
|
|
277
|
+
|
|
278
|
+
codemod: none
|
|
279
|
+
- **@voltro/plugin-presence** — `presencePlugin` refuses a `timeoutMs` that expires members between heartbeats.
|
|
280
|
+
|
|
281
|
+
The presence surface, probed the way events, records and broadcast were: five plausible mistakes tried, five accepted. Zero and a negative are the obvious two; the one worth the rule is a value SMALLER than the client's heartbeat, because that is the mistake with a plausible motive ("expire people quickly") and a silent failure.
|
|
282
|
+
|
|
283
|
+
`timeoutMs` is one half of a contract whose other half lives in the client. A member is online for `timeoutMs` after its last heartbeat, and `usePresence` beats every 15s by default. Below that, every member expires between beats — the roster flaps empty and nothing reports it, because an empty roster is also what "nobody is here" looks like.
|
|
284
|
+
|
|
285
|
+
A consumer wrote that pairing down themselves ("our 10s heartbeat is the other half of the contract"), which is evidence the rule is real AND that it was left to the reader to work out. It is stated in both languages now, and the message names the CLIENT side, since a message naming only the server value sends the reader looking for the number in another package.
|
|
286
|
+
|
|
287
|
+
A long window is still fine — a signage terminal beating once a minute is a real deployment. The rule is a floor, not a range.
|
|
288
|
+
|
|
289
|
+
codemod: none
|
|
290
|
+
- **@voltro/protocol** — `defineQuery` refuses three contradictions it used to accept — the same probe that found four on `defineEvent`, run against the records surface.
|
|
291
|
+
|
|
292
|
+
That symmetry is the point rather than a coincidence. `guards: []` was refused on events an hour after it was accepted on queries, and a rule that holds for one primitive and not another is worse than no rule: the framework's answer then depends on which file the author happened to open.
|
|
293
|
+
|
|
294
|
+
- **`guards: []`** reads at the call site as if the procedure were protected and enforces nothing — the check runs only for a non-empty list. - **An empty `source`** (`''`, `[]`, or a blank entry) declares reactivity and subscribes to nothing: one snapshot, never an update, indistinguishable from "nothing changed". It is worse than a STALE source, which the boot warning can at least name — this one names no table at all, so nothing can report it. - **`internal: true` + `overridesPlugin`** removes the plugin's route and puts something not wire-reachable in its place, so callers get a 404 for something that used to work with no diff that says so. It extends the existing `assertWireSurfaceConsistent` contract rather than adding a second rule beside it.
|
|
295
|
+
|
|
296
|
+
Also settled, by reading the runtime rather than declining again: **`rewind` needs no rule.** It replays the pruned ring on attach — with `each` that is "catch up on what you missed", with `latest` it is "here is the current value". Both are meaningful, so the combination that looked suspicious is fine, and a test now pins that decision so the next reader does not re-open it.
|
|
297
|
+
|
|
298
|
+
codemod: none
|
|
299
|
+
- **@voltro/cli** — The one multi-replica scenario with no test: a replica that goes away, misses traffic, and comes back. The existing suites prove two replicas REACH each other, not what happens when one stops being able to.
|
|
300
|
+
|
|
301
|
+
It covers both directions of the claim that `missed` is COMPUTED and never estimated. **Under-reporting** is the silence this primitive exists to remove. **Over-reporting** is the freshly-started replica announcing a loss for messages it was never owed — measured once at 5000, and the reason every delivery carries `prior`.
|
|
302
|
+
|
|
303
|
+
The accounting identity is the assertion: every envelope owed after the resume point is either replayed or reported, and the two must sum to what was owed.
|
|
304
|
+
|
|
305
|
+
**The first version of that test was vacuous, and the reason is worth recording because it is the fourth instance this session.** It published six envelopes into the default ring of 64, so the ring held everything, `missed` was always 0, and the identity was true by arithmetic for any implementation at all — sabotaging the computation to under-report by one left it green. The ring is now deliberately SMALLER than the traffic (`ringSize: 3`, ten publishes), the non-vacuity assertions come FIRST, and the same sabotage now fails it 8-to-9.
|
|
306
|
+
|
|
307
|
+
`describeIfReachable`, verified both ways: with `REDIS_PORT=1` it reports two named skips rather than returning green having tested nothing.
|
|
308
|
+
|
|
309
|
+
codemod: none
|
|
310
|
+
- **@voltro/runtime** — A resume replay could be **overtaken** by live traffic, delivering serials out of order.
|
|
311
|
+
|
|
312
|
+
Found by testing the case a busy app produces and the reconnect tests do not: a backlog being replayed at the same moment new envelopes are accepted, because a real reconnect does not pause the publisher. Measured — resuming from `n=3` over a ring of 8, with an ordinary re-entrant publish from the listener at `n=6`, delivered `[4, 5, 6, 9, 7, 8]`.
|
|
313
|
+
|
|
314
|
+
The cause is an ordering that is right for a different reason. The listener is registered BEFORE the replay on purpose: it closes the window between reading the ring and going live, so nothing published in between is lost. What it does not do on its own is keep the two streams in sequence — a live delivery reaches the listener immediately and jumps ahead of the entries still queued behind it.
|
|
315
|
+
|
|
316
|
+
Out-of-order is worse than loss for anything that folds state: a display applying an older frame after a newer one shows the past and stays there. And `n` arriving non-monotonically undermines the serial every gap number is computed from.
|
|
317
|
+
|
|
318
|
+
Live deliveries are now buffered for the duration of the replay and flushed after it, in arrival order, synchronously before `subscribe` returns — an async flush would reopen the window the early registration exists to close. Both properties hold: nothing is missed, and nothing overtakes.
|
|
319
|
+
|
|
320
|
+
The new tests also pin two things the quiet reconnect case cannot see: no serial is delivered twice when an envelope is in the ring at the moment of attach, and traffic arriving during a replay is not reported as a gap.
|
|
321
|
+
|
|
322
|
+
codemod: none
|
|
323
|
+
- **@voltro/cli** — The socket.io comparison published one run per side. Both its numbers were noise, and it is corrected here with five runs each.
|
|
324
|
+
|
|
325
|
+
| | p50 median | p50 range | p99 median | p99 range | | --- | --- | --- | --- | --- | | Voltro cross-replica | **0.68 ms** | 0.58–0.86 | 7.01 ms | 4.50–13.36 | | socket.io + redis-adapter | 1.31 ms | 1.16–1.73 | **4.52 ms** | 4.33–7.83 |
|
|
326
|
+
|
|
327
|
+
The earlier table claimed "32% faster at the median, 44% worse at the tail". The median advantage is nearer **2x** — the p50 ranges do not overlap at all — and the tail gap sits INSIDE the overlap, so it is weaker evidence than a single pair of numbers made it look.
|
|
328
|
+
|
|
329
|
+
**A single measurement presented as a fact is the defect this framework spends its time removing, and it was committed in its own benchmark.** The correction is the finding.
|
|
330
|
+
|
|
331
|
+
**Where the tail comes from, measured rather than guessed.** Splitting the publish path: our own code — building the envelope, the Effect fiber per message, the handoff — costs p50 **0.056 ms** / p99 **0.444 ms**. Waiting for Redis to acknowledge costs p50 1.17 ms / p99 6.43 ms.
|
|
332
|
+
|
|
333
|
+
So roughly 0.4 ms of a 7 ms tail is ours and the rest is the broker round-trip, which socket.io pays too. The `Effect.runPromise` per message was the leading hypothesis and the measurement cleared it. There is no code-level tail defect to fix — on this machine the number is dominated by Docker's network stack.
|
|
334
|
+
|
|
335
|
+
codemod: none
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
42
339
|
## [0.26.0] — 2026-08-04
|
|
43
340
|
|
|
44
341
|
### ⚠ BREAKING
|
package/dist/index.d.ts
CHANGED
|
@@ -60,6 +60,9 @@ export declare interface AuditEvent {
|
|
|
60
60
|
* the thing this field exists to prevent.
|
|
61
61
|
*/
|
|
62
62
|
readonly actor?: AuditActor | undefined;
|
|
63
|
+
/** The app's own scoping dimension — opaque, stored verbatim, filterable.
|
|
64
|
+
* `.with(tenant())` is one level too coarse for a per-team trail. */
|
|
65
|
+
readonly scope?: unknown;
|
|
63
66
|
/** The app's own note about what happened. Opaque, never interpreted. */
|
|
64
67
|
readonly metadata?: unknown;
|
|
65
68
|
readonly traceId: string;
|
|
@@ -132,6 +135,25 @@ export declare interface AuditPluginOptions {
|
|
|
132
135
|
* of `@effect/sql`.
|
|
133
136
|
*/
|
|
134
137
|
readonly sink?: 'console' | 'memory' | 'datastore' | AuditSink;
|
|
138
|
+
/**
|
|
139
|
+
* Derive the app's own scoping dimension for each recorded call.
|
|
140
|
+
*
|
|
141
|
+
* The framework cannot guess this: it does not know what a team, a project or
|
|
142
|
+
* a workspace is, which is exactly why the column is opaque. The app knows,
|
|
143
|
+
* and usually from the subject — `(ctx) => ({ teamId: ctx.subject.metadata?.teamId })`.
|
|
144
|
+
*
|
|
145
|
+
* Absent ⇒ `scope` stays null and the column costs nothing. Present ⇒ it is
|
|
146
|
+
* written verbatim and can be filtered on equality, which is the difference
|
|
147
|
+
* between an indexed read path and stuffing `teamId` into `metadata` and
|
|
148
|
+
* scanning — a column documented as a free-form note is not a read path.
|
|
149
|
+
*
|
|
150
|
+
* Throwing here never fails the mutation being recorded: a scope that cannot
|
|
151
|
+
* be derived is null, the same answer as not configuring one.
|
|
152
|
+
*/
|
|
153
|
+
readonly resolveScope?: (ctx: {
|
|
154
|
+
readonly subject: Subject;
|
|
155
|
+
readonly tag: string;
|
|
156
|
+
}) => unknown;
|
|
135
157
|
/**
|
|
136
158
|
* Record QUERIES too.
|
|
137
159
|
*
|
package/dist/index.js
CHANGED
|
@@ -15,6 +15,7 @@ var m = "_voltro_audit_log", h = d(m, {
|
|
|
15
15
|
durationMs: f(),
|
|
16
16
|
subject: s(),
|
|
17
17
|
actor: s().nullable(),
|
|
18
|
+
scope: s().nullable(),
|
|
18
19
|
metadata: s().nullable(),
|
|
19
20
|
input: s(),
|
|
20
21
|
outcome: s(),
|
|
@@ -37,6 +38,7 @@ var m = "_voltro_audit_log", h = d(m, {
|
|
|
37
38
|
durationMs: String(e.outcome.durationMs),
|
|
38
39
|
subject: e.subject,
|
|
39
40
|
actor: e.actor ?? null,
|
|
41
|
+
scope: e.scope ?? null,
|
|
40
42
|
metadata: e.metadata ?? null,
|
|
41
43
|
input: e.input,
|
|
42
44
|
outcome: e.outcome,
|
|
@@ -134,12 +136,19 @@ var m = "_voltro_audit_log", h = d(m, {
|
|
|
134
136
|
...t,
|
|
135
137
|
input: n === "all" ? l : n(t)
|
|
136
138
|
};
|
|
137
|
-
}, f = (e) => s(e) ? a(d(e)) : t.void, p = (
|
|
139
|
+
}, f = (e) => s(e) ? a(d(e)) : t.void, p = (t) => {
|
|
140
|
+
if (e.resolveScope !== void 0) try {
|
|
141
|
+
return e.resolveScope(t);
|
|
142
|
+
} catch {
|
|
143
|
+
return;
|
|
144
|
+
}
|
|
145
|
+
}, h = (e, n) => o(n.tag) ? t.suspend(() => {
|
|
138
146
|
let r = Date.now();
|
|
139
147
|
return e.pipe(t.tap((e) => f({
|
|
140
148
|
ts: r,
|
|
141
149
|
tag: n.tag,
|
|
142
150
|
subject: n.subject,
|
|
151
|
+
...p(n) === void 0 ? {} : { scope: p(n) },
|
|
143
152
|
traceId: n.traceId,
|
|
144
153
|
input: n.input,
|
|
145
154
|
outcome: {
|
|
@@ -151,6 +160,7 @@ var m = "_voltro_audit_log", h = d(m, {
|
|
|
151
160
|
ts: r,
|
|
152
161
|
tag: n.tag,
|
|
153
162
|
subject: n.subject,
|
|
163
|
+
...p(n) === void 0 ? {} : { scope: p(n) },
|
|
154
164
|
traceId: n.traceId,
|
|
155
165
|
input: n.input,
|
|
156
166
|
outcome: {
|
|
@@ -159,20 +169,25 @@ var m = "_voltro_audit_log", h = d(m, {
|
|
|
159
169
|
durationMs: Date.now() - r
|
|
160
170
|
}
|
|
161
171
|
}).pipe(t.catchAllCause(() => t.void))));
|
|
162
|
-
}) : e,
|
|
172
|
+
}) : e, _ = h, v = h, y = h;
|
|
163
173
|
return n({
|
|
164
174
|
name: "@voltro/plugin-audit",
|
|
165
175
|
description: "Records every mutation invocation; ships an audit() schema mixin for row-level metadata.",
|
|
166
|
-
permissions:
|
|
176
|
+
permissions: [
|
|
177
|
+
"rpc:intercept:mutation",
|
|
178
|
+
"rpc:intercept:action",
|
|
179
|
+
...r ? ["store:write"] : [],
|
|
180
|
+
...e.recordQueries === !0 ? ["rpc:intercept:query"] : []
|
|
181
|
+
],
|
|
167
182
|
...r ? {
|
|
168
183
|
extendSchema: { tables: g },
|
|
169
184
|
bindDataStore: (e) => {
|
|
170
185
|
i = x(e);
|
|
171
186
|
}
|
|
172
187
|
} : {},
|
|
173
|
-
interceptMutation:
|
|
174
|
-
interceptAction:
|
|
175
|
-
interceptQuery:
|
|
188
|
+
interceptMutation: _,
|
|
189
|
+
interceptAction: v,
|
|
190
|
+
...e.recordQueries === !0 ? { interceptQuery: y } : {}
|
|
176
191
|
});
|
|
177
192
|
};
|
|
178
193
|
//#endregion
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@voltro/plugin-audit",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.27.0",
|
|
4
4
|
"description": "Audit plugin — ships the `audit()` schema mixin (createdAt/updatedAt/createdBy/updatedBy → Actor) plus an optional mutation interceptor that records every call to a configurable sink (console / memory / custom function).",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"voltro",
|
|
@@ -37,9 +37,9 @@
|
|
|
37
37
|
"node": ">=24.0.0"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@voltro/database": "0.
|
|
41
|
-
"@voltro/logger": "0.
|
|
42
|
-
"@voltro/protocol": "0.
|
|
40
|
+
"@voltro/database": "0.27.0",
|
|
41
|
+
"@voltro/logger": "0.27.0",
|
|
42
|
+
"@voltro/protocol": "0.27.0"
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {
|
|
45
45
|
"effect": "^3.22.0"
|