@stonyx/orm 0.3.2-alpha.62 → 0.3.2-alpha.63

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.
@@ -1,7 +1,7 @@
1
1
  import Orm, { store } from '@stonyx/orm';
2
2
  import OrmRecord from './record.js';
3
3
  import { getGlobalRegistry, getPendingRegistry, getPendingBelongsToRegistry, getBelongsToRegistry, getHasManyRegistry } from './relationships.js';
4
- import { isOrmRecord } from './utils.js';
4
+ import { isOrmRecord, maxNumericId, NO_FREE_ID_ERROR } from './utils.js';
5
5
  const defaultOptions = {
6
6
  isDbRecord: false,
7
7
  serialize: true,
@@ -153,17 +153,58 @@ export function updateRecord(record, rawData, userOptions = {}) {
153
153
  }
154
154
  }
155
155
  /**
156
- * gets the next available id based on last record entry.
156
+ * gets the next available id, based on the HIGHEST id present.
157
157
  *
158
158
  * In MySQL mode with numeric IDs, assigns a temporary pending ID.
159
159
  * MySQL's AUTO_INCREMENT provides the real ID after INSERT.
160
+ *
161
+ * ---------------------------------------------------------------------------
162
+ * WAS: `Array.from(storeMap.values()).at(-1).id + 1` — the LAST INSERTED id,
163
+ * not the maximum (abofs/stonyx-orm#203). The store is a Map, so insertion
164
+ * order stops being ascending the moment a record is deleted and recreated, a
165
+ * db.json is written out of order, a directory-mode store is read back in file
166
+ * order, or a caller POSTs a high id and then a low one. After that, every
167
+ * server-assigned id is one that is ALREADY TAKEN — and `createRecord`'s
168
+ * last-entry-wins branch then overwrites that record IN PLACE and answers 200.
169
+ * No error, no 409, and the store's size does not change. That is the whole
170
+ * defect, and it is reachable from a create with NO id at all, which is the
171
+ * most ordinary write a consumer performs.
172
+ *
173
+ * Covered by test/unit/assign-record-id-test.ts. Note for anyone changing this
174
+ * function: before that file existed, the whole suite scored 951/0 both on the
175
+ * defect and on a naive `Math.max` fix that introduced a second one. A green
176
+ * suite is not evidence here; those assertions are.
177
+ * ---------------------------------------------------------------------------
160
178
  */
161
179
  function assignRecordId(modelName, rawData) {
162
- if (rawData.id)
180
+ // PRESENCE, not truthiness. `0` is a legal value for an `attr('number')` id,
181
+ // and `if (rawData.id) return` silently reassigned it, handing the caller back
182
+ // a different record than the one it named (#203).
183
+ //
184
+ // `''` is deliberately NOT honoured here and this is not an oversight: it is
185
+ // the one string that means "no id". `parseInt('')` is `NaN`, a record CAN be
186
+ // held under the key `NaN`, and orm-request.ts's body-id normalisation relies
187
+ // on `''` staying absent — otherwise `POST {"id":""}` answers 409 against a
188
+ // record it never named.
189
+ //
190
+ // WHAT WIDENING THIS TO `!== undefined` ACTUALLY DOES, measured rather than
191
+ // asserted: `{id: ''}` early-returns, `parseInt('')` NaNs it, and the record
192
+ // lands on the store's `NaN` slot and OVERWRITES whatever is there — #203's
193
+ // own defect class. It does NOT turn access-filter-enforcement-test.ts
194
+ // assertion 44 red; an earlier revision of this comment claimed it did, which
195
+ // converted an unknown into a false assurance. AC6's BOUNDARY assertions are
196
+ // what catch it, and they only do so because they seed the `NaN` slot first.
197
+ if (rawData.id || rawData.id === 0)
163
198
  return;
164
199
  // In SQL mode with numeric IDs, defer to database auto-increment.
165
200
  // Use unique negative integers — they survive the number transform (parseInt preserves negatives)
166
201
  // and avoid NaN store-key collisions that string pending IDs caused.
202
+ //
203
+ // This early return is ABOVE the max computation on purpose: a pending
204
+ // negative must never be a candidate for, or be perturbed by, the max path.
205
+ // Pinned directly (AC5.3) rather than by asserting the max is unaffected —
206
+ // that assertion could not have failed, because nothing negative ever reaches
207
+ // the code below.
167
208
  if (Orm.instance?.sqlDb && !isStringIdModel(modelName)) {
168
209
  rawData.id = -(++pendingIdCounter);
169
210
  rawData.__pendingSqlId = true;
@@ -173,13 +214,197 @@ function assignRecordId(modelName, rawData) {
173
214
  if (!storeMap)
174
215
  throw new Error(`Cannot assign record ID: model "${modelName}" not found in store`);
175
216
  const modelStore = Array.from(storeMap.values()).filter(isOrmRecord);
176
- const lastRecord = modelStore.at(-1);
177
- rawData.id = lastRecord ? lastRecord.id + 1 : 1;
217
+ // ONE COPY of the max-numeric-id reduce, in src/utils.ts. There were three
218
+ // (here, StandaloneDB.create, and the #203 test helper) and `docs/
219
+ // improvements.md`'s WET Code category prescribes the extraction. What that
220
+ // helper must NOT be is `Math.max(...ids)`; the reason is measured and it is
221
+ // documented at the helper rather than duplicated here. Pinned by AC2.
222
+ const maxId = maxNumericId(modelStore);
223
+ // THE OCCUPANCY CHECK RUNS ON THE LANDING KEY, NOT ON THE RAW CANDIDATE, and
224
+ // the difference is a silent data loss rather than a nicety.
225
+ //
226
+ // `createRecord` looks the record up under `rawData.id` (:50) but WRITES it
227
+ // under `record.id` (:69) — the value after the model's declared id transform
228
+ // has run inside `serialize`. When the transform is not the identity those two
229
+ // differ, so a guard written as `storeMap.has(rawData.id)` checks a key the
230
+ // record will never occupy, misses an occupied slot and overwrites it —
231
+ // measured on an `uppercase`-id model: the guard checks `owner-1`, the record
232
+ // lands under `OWNER-1`, store size unchanged, no error. That is
233
+ // abofs/stonyx-orm#205's lookup-key/landing-key divergence reappearing inside
234
+ // #203's own fix, which is why AC4 exists and why `rawData.id` is set to the
235
+ // LANDING key below.
236
+ //
237
+ // THE SCOPE OF THAT CLAIM, stated rather than implied. Setting `rawData.id` to
238
+ // the landing key makes :50 and :69 agree for every IDEMPOTENT id transform —
239
+ // `number`, `float`, `string`, `passthrough`, `uppercase`, `trim`. It does NOT
240
+ // make them agree for `date` or `timestamp`: `transforms.date` returns a NEW
241
+ // object every call and a `Map` keys by identity, so `storeMap.has(landingKey)`
242
+ // is always `false` there and the occupancy check is vacuous. `dev` is broken
243
+ // for those types too — this is not a regression — but no comment here may
244
+ // claim a property it was not measured to have (#212 § AC5).
245
+ //
246
+ // Resolved ONCE, outside the walk: `getIdType` instantiates the model class,
247
+ // so resolving it per candidate would put a model construction on every
248
+ // iteration of a loop that exists to walk past occupied slots.
249
+ const toStoreKey = storeKeyDeriver(modelName);
250
+ // DOES THIS MODEL FILE ITS RECORDS UNDER STRING KEYS? Decided by RUNNING the
251
+ // model's own id transform once, not by matching a type NAME against a list:
252
+ // `Orm.instance.transforms` (main.ts:70) is a public, MUTABLE instance
253
+ // property, so any enumeration of "the string-ish types" written here would be
254
+ // wrong the moment a consumer registers one.
255
+ const stringKeyed = typeof toStoreKey(maxId + 1) === 'string';
256
+ // THE CANDIDATE FOR A STRING-KEYED MODEL IS NOT A BARE NUMBER, and this is
257
+ // abofs/stonyx-orm#209 — which is REOPENED — not aesthetics.
258
+ //
259
+ // `orm-request.ts`'s `coerceId` (:322) resolves a NUMERIC-LOOKING string to a
260
+ // NUMBER on every id-bearing surface, while a model declaring
261
+ // `id = attr('string')` files under the STRING key. So a server-assigned `'1'`
262
+ // produces a record that is created and then NOT ADDRESSABLE. Measured over
263
+ // the route, owner store `{'1': ...}`:
264
+ //
265
+ // GET /owners/1 -> 404 (the record exists)
266
+ // DELETE /owners/1 -> 404
267
+ // GET /owners/owner-1 -> 200
268
+ //
269
+ // and `_withHooks` (:1185) hands an after-`create` hook
270
+ // `context.record === undefined` for the same reason. `dev` assigned `'bob1'`,
271
+ // which is not numeric-looking, so `dev` has neither problem: a bare-number
272
+ // candidate would move #209 from "a caller supplied a numeric-looking id" onto
273
+ // the DEFAULT path for every server-assigned create on every string-id model.
274
+ // Prefixing with the model name keeps #209's population exactly as narrow as
275
+ // it already was, without touching the one shared coercion or the assertion
276
+ // that pins #209 open. Pinned by AC3.
277
+ const toCandidate = stringKeyed
278
+ ? (value) => `${modelName}-${value}`
279
+ : (value) => value;
280
+ // `maxId + 1` is the id AC1 pins: strictly greater than every numeric key
281
+ // present. IT IS NOT ALWAYS AVAILABLE, and that gap was a live denial of
282
+ // service. Float64 has no integer successor at or above 2^53, so
283
+ // `maxId + 1 === maxId` for every `maxId >= 9007199254740992` and `+ 1` inside
284
+ // the walk is a NO-OP there. One record filed under that key — which an
285
+ // unauthenticated `POST {"id":9007199254740992}` puts there, and which reaches
286
+ // even a filter-protected collection through has-many.ts:65 (#207), a channel
287
+ // GATE 0 does not cover — made the walk unable to advance, so it exhausted its
288
+ // budget and threw on EVERY subsequent server-assigned create, permanently,
289
+ // until that record was deleted. Measured over the route: 200, then 500 for
290
+ // every no-id create. `dev` answers 200.
291
+ //
292
+ // So a store holding one adversarial record must not disable its collection.
293
+ // When "above the max" is not a usable strategy the walk RESTARTS FROM 1: the
294
+ // store holds at most `size` keys, so one of `1 .. size + 1` is always free
295
+ // under an injective id transform. Pinned by AC7.
296
+ const start = maxId + 1;
297
+ let landingKey = firstFreeKey(storeMap, toStoreKey, toCandidate, start);
298
+ // THE RESTART, and it is the whole of the ceiling fix. Killing mutation:
299
+ // delete this block -> AC7 goes red (the route answers 409 instead of the
300
+ // created resource).
301
+ if (landingKey === NO_FREE_KEY && start !== 1) {
302
+ landingKey = firstFreeKey(storeMap, toStoreKey, toCandidate, 1);
303
+ }
304
+ if (landingKey === NO_FREE_KEY) {
305
+ // Reachable only with a NON-INJECTIVE id transform — see `firstFreeKey`.
306
+ // `createHandler` matches this message and answers 409 rather than letting it
307
+ // reach express's default handler, which serialises a stack trace with
308
+ // absolute install paths outside NODE_ENV=production (the hazard
309
+ // orm-request.ts:553-558 exists to name). Pinned by AC8.
310
+ throw new Error(`${NO_FREE_ID_ERROR} for model "${modelName}"`);
311
+ }
312
+ rawData.id = landingKey;
178
313
  }
179
- function isStringIdModel(modelName) {
180
- const modelClass = Orm.instance.getRecordClasses(modelName).modelClass;
314
+ // Returned instead of a key so that "no key" cannot be confused with a transform
315
+ // that legitimately produced `undefined` or `null`.
316
+ const NO_FREE_KEY = Symbol('no free store key');
317
+ /**
318
+ * The first store key at or above `start` that no record occupies, walking
319
+ * candidate ids upward, or `NO_FREE_KEY` if the walk cannot reach one.
320
+ */
321
+ function firstFreeKey(storeMap, toStoreKey, toCandidate, start) {
322
+ let candidate = start;
323
+ let landingKey = toStoreKey(toCandidate(candidate));
324
+ let attempts = 0;
325
+ while (storeMap.has(landingKey)) {
326
+ // THE BOUND IS EXACTLY TIGHT, not conservative: this walk tries
327
+ // `storeMap.size + 1` DISTINCT candidates against at most `storeMap.size`
328
+ // occupied keys, so under an injective `toStoreKey` it provably cannot fire.
329
+ // Under a non-injective one it provably terminates — and that is a reachable
330
+ // consumer state rather than a hypothesis: `transforms.boolean`
331
+ // (transforms.ts:4) collapses every candidate onto `true`/`false`, and
332
+ // `Orm.instance.transforms` (main.ts:70) is public and MUTABLE, so a consumer
333
+ // can register an arbitrary non-injective transform and name it as an id
334
+ // type. Without this, a no-id create spins forever inside a synchronous store
335
+ // walk and pins a worker, which is worse than either collision policy. Its
336
+ // EXISTENCE and its THRESHOLD are both pinned by AC8: deleting it makes AC8
337
+ // HANG rather than fail, and weakening it to fire on the first collision
338
+ // makes AC8.1 red.
339
+ if (++attempts > storeMap.size)
340
+ return NO_FREE_KEY;
341
+ // NOTE FOR ANYONE ADDING A SECOND EXIT HERE. A `candidate + 1 === candidate`
342
+ // float-saturation check was written, measured, and REMOVED: with the
343
+ // restart-from-1 above in place, deleting the saturation check leaves the
344
+ // whole suite green, because the budget reaches the same `NO_FREE_KEY` one
345
+ // pass later and the restart still answers. An unkillable guard in a change
346
+ // whose deliverable is falsifiable coverage is exactly what this story exists
347
+ // to stop shipping. `+ 1` being a no-op at 2^53 costs `size` extra `Map.has`
348
+ // calls on that one path and changes no outcome.
349
+ candidate += 1;
350
+ landingKey = toStoreKey(toCandidate(candidate));
351
+ }
352
+ return landingKey;
353
+ }
354
+ /**
355
+ * Returns the derivation that maps an id VALUE to the store KEY a record
356
+ * carrying it will actually be filed under — the model's declared id transform,
357
+ * the same one `serialize` runs at createRecord:68 before the `.set` at :69.
358
+ */
359
+ function storeKeyDeriver(modelName) {
360
+ const idType = getIdType(modelName);
361
+ const transform = idType ? Orm.instance?.transforms?.[idType] : undefined;
362
+ // SURVIVOR, RETAINED, with its reachability condition stated rather than left
363
+ // silent — `docs/project-structure.md` § "unkillable code reads as coverage and
364
+ // is not" is the standing rule and it applies outside orm-request.ts too.
365
+ //
366
+ // No mutation in this repo can kill this branch, and that is STRUCTURAL rather
367
+ // than an untested gap: `Model` declares `id = attr('number')` (model.ts:15) so
368
+ // every registered model has an id type; `ModelProperty` refuses a type with no
369
+ // registered transform (model-property.ts:4) so a declared type always
370
+ // resolves; and `getIdType` can therefore only return `undefined` when
371
+ // `getRecordClasses` yields no `modelClass` — in which case `createRecord`
372
+ // throws at :62 a few lines later regardless, so no record is ever filed
373
+ // through this branch.
374
+ //
375
+ // BECOMES REACHABLE if a model can be declared without an `id` property, if a
376
+ // store map can exist for a model with no registered class, or if
377
+ // `createRecord` stops constructing the model class. Kept rather than deleted
378
+ // because the alternative on that path is a `transform is not a function`
379
+ // TypeError, and because identity is exactly what `createRecord` would file
380
+ // under when no transform exists — the two agree, which is the property AC4 is
381
+ // about.
382
+ if (typeof transform !== 'function')
383
+ return value => value;
384
+ return value => {
385
+ try {
386
+ return transform(value);
387
+ }
388
+ catch {
389
+ // `uppercase` and `trim` (transforms.ts:11-12) call a string method on the
390
+ // value directly, so a NUMERIC candidate throws `value?.toUpperCase is not
391
+ // a function`. On `dev` they never saw one — `lastRecord.id + 1` on a
392
+ // string id is a string — so feeding them a number here would regress a
393
+ // legal, registered id type into an uncaught 500. The retry feeds the
394
+ // string form, which is the shape an id actually arrives in off a JSON body
395
+ // or a URL param. A transform that throws on BOTH shapes still propagates.
396
+ // Pinned by AC9.
397
+ return transform(String(value));
398
+ }
399
+ };
400
+ }
401
+ function getIdType(modelName) {
402
+ const modelClass = Orm.instance?.getRecordClasses(modelName).modelClass;
181
403
  if (!modelClass)
182
- return false;
404
+ return undefined;
183
405
  const model = new modelClass(modelName);
184
- return model.id?.type === 'string';
406
+ return model.id?.type;
407
+ }
408
+ function isStringIdModel(modelName) {
409
+ return getIdType(modelName) === 'string';
185
410
  }
@@ -98,8 +98,8 @@
98
98
  *
99
99
  * PASSING THE CONTEXT MAKES A MODEL-CORRECT ANSWER POSSIBLE. It does not make
100
100
  * the answer model-correct on its own -- the resolved predicate has to READ it.
101
- * Measured against an ARITY-1 predicate, on a request express dispatched to
102
- * `GET /owners/angela`, asked about ANIMALS:
101
+ * Measured against this repo's own shipped access class, on a request express
102
+ * dispatched to `GET /owners/angela`, asked about ANIMALS:
103
103
  *
104
104
  * getAccess('animal')(ownersRequest, { model: 'animal', operation: 'read' })
105
105
  * -> record => record.id !== 'angela' && record.id !== 'restricted'
@@ -110,30 +110,23 @@
110
110
  * `['read', 'create', 'update', 'delete']`, a full CRUD grant. Either way the
111
111
  * context was supplied and the answer is not the animal answer, and it is wrong
112
112
  * in the GRANTING direction, because that predicate is arity-1 and identifies
113
- * its collection from the request. (Asserted on a live dispatch by AC9 in
114
- * test/integration/orm-test.ts, against a deliberately arity-1 predicate.)
115
- *
116
- * This repo's own sample access class has since been MIGRATED to read the
117
- * context (abofs/stonyx-orm#222), so `getAccess('animal')` here now answers
118
- * with the animal filter. That is not true of a consumer tree: an arity-1
119
- * predicate keeps working -- the second argument is additive -- and the caller
120
- * has no supported way to tell which kind it got. The boot-time arity warning
121
- * that surfaces one is abofs/stonyx-orm#221.
113
+ * its collection from the request. (The first of these is asserted on a live
114
+ * dispatch by AC9 in test/integration/orm-test.ts.)
115
+ *
116
+ * Every predicate in this repo and in every consumer tree is arity-1 on the day
117
+ * this ships, and the caller has no supported way to tell which kind it got --
118
+ * the boot-time arity warning that would surface it is abofs/stonyx-orm#213.
122
119
  * So: pass the context, and do not treat a resolved predicate's answer as
123
120
  * model-specific until that predicate has been migrated to read the context.
124
121
  *
125
122
  * ---------------------------------------------------------------------------
126
123
  * DO NOT RECONSTRUCT THE REQUEST PATH INSIDE `access()`.
127
124
  * ---------------------------------------------------------------------------
128
- * You do not have to. `auth()` below hands your predicate the ACCESS CONTEXT as
129
- * argument two, and `context.model` already names the collection -- see the
130
- * contract section above. Argument ONE is still the raw transport artifact, and
131
- * everything from here to the end of this banner is the record of what happened
132
- * when predicates worked the collection out from it. IT IS HISTORY, NOT
133
- * GUIDANCE: do not write any of it into a new predicate. Every attempt to
134
- * identify the collection by parsing the request target has failed OPEN. Five
135
- * distinct variants of the same three-line example have now been found, each
136
- * after the previous was fixed, by five different people:
125
+ * `auth()` below hands your `access(request)` a raw transport artifact and asks
126
+ * you to work out which collection it addresses. Every attempt to do that by
127
+ * parsing the request target has failed OPEN. Five distinct variants of the
128
+ * same three-line example have now been found, each after the previous was
129
+ * fixed, by five different people:
137
130
  *
138
131
  * 1. `request.url` is mount-relative under `RestServer.mountRoute`, so a
139
132
  * prefix match against it is ALWAYS false.
@@ -152,31 +145,22 @@
152
145
  * last, and the record comes back in full. It walks past a hard
153
146
  * `return false` deny the same way.
154
147
  *
155
- * The fix is not a sixth rule, and it is not a better string to match. It is to
156
- * stop identifying the collection at all: read `context.model`.
157
- *
158
- * An intermediate revision of the sample read `request.baseUrl` -- the mount
159
- * Express ACTUALLY MATCHED. That closed all five variants (no query string,
160
- * not mount-relative, unaffected by absolute-form, already carrying the
161
- * configured `ORM_REST_ROUTE` prefix), but it was a transport artifact
162
- * standing in for a structural fact and the sample no longer does it.
163
- * `context.model` IS the structural fact, so all five variants are
164
- * unconstructible against a migrated predicate rather than handled.
165
- *
166
- * ONE READ OF ARGUMENT ONE SURVIVES, AND IT MUST: `request.path`. It is
167
- * mount-relative and query-free, and it is for rules that distinguish SUB-PATHS
168
- * beneath the mount. The context names which model and which verb, NOT which
169
- * route, so the sample's `/archived` deny cannot be expressed from the context
170
- * alone and a context-ONLY rewrite would silently turn that deny into an allow.
171
- * Lower-case it before comparing -- the router matched case-insensitively -- and
172
- * compare record ids at their real case.
148
+ * The fix is not a sixth rule. It is to stop parsing:
149
+ *
150
+ * `request.baseUrl` is the mount Express ACTUALLY MATCHED when it dispatched
151
+ * the request. It carries no query string, it is not mount-relative, it is
152
+ * unaffected by absolute-form, and it already includes the configured
153
+ * `ORM_REST_ROUTE` prefix -- so there is nothing to derive and nothing to
154
+ * join. Compare it lower-cased (the router matched case-insensitively) and
155
+ * fail CLOSED when it is absent. Use `request.path` -- mount-relative and
156
+ * query-free -- if you need to distinguish sub-paths.
173
157
  *
174
158
  * `?? ''` is not a defence. It converts an absent request target into an empty
175
159
  * string, which matches no collection, which falls through to the permission
176
- * array -- a total grant. An input you cannot identify must DENY, and that
177
- * applies to the context too: the sample returns `false` for an absent `model`
178
- * rather than falling through.
160
+ * array -- a total grant. An input you cannot identify must DENY.
179
161
  *
162
+ * THAT IS STILL A STOPGAP. `baseUrl` closes all five variants, but it is a
163
+ * transport artifact being asked to stand in for a structural fact.
180
164
  * THE REAL FIX IS abofs/stonyx-orm#202: `access()` should receive the model,
181
165
  * the operation and the record. Prefer the array shape (`['read']`) or `false`
182
166
  * until #202 lands; the function shape is what requires any matching at all.
@@ -98,8 +98,8 @@
98
98
  *
99
99
  * PASSING THE CONTEXT MAKES A MODEL-CORRECT ANSWER POSSIBLE. It does not make
100
100
  * the answer model-correct on its own -- the resolved predicate has to READ it.
101
- * Measured against an ARITY-1 predicate, on a request express dispatched to
102
- * `GET /owners/angela`, asked about ANIMALS:
101
+ * Measured against this repo's own shipped access class, on a request express
102
+ * dispatched to `GET /owners/angela`, asked about ANIMALS:
103
103
  *
104
104
  * getAccess('animal')(ownersRequest, { model: 'animal', operation: 'read' })
105
105
  * -> record => record.id !== 'angela' && record.id !== 'restricted'
@@ -110,30 +110,23 @@
110
110
  * `['read', 'create', 'update', 'delete']`, a full CRUD grant. Either way the
111
111
  * context was supplied and the answer is not the animal answer, and it is wrong
112
112
  * in the GRANTING direction, because that predicate is arity-1 and identifies
113
- * its collection from the request. (Asserted on a live dispatch by AC9 in
114
- * test/integration/orm-test.ts, against a deliberately arity-1 predicate.)
113
+ * its collection from the request. (The first of these is asserted on a live
114
+ * dispatch by AC9 in test/integration/orm-test.ts.)
115
115
  *
116
- * This repo's own sample access class has since been MIGRATED to read the
117
- * context (abofs/stonyx-orm#222), so `getAccess('animal')` here now answers
118
- * with the animal filter. That is not true of a consumer tree: an arity-1
119
- * predicate keeps working -- the second argument is additive -- and the caller
120
- * has no supported way to tell which kind it got. The boot-time arity warning
121
- * that surfaces one is abofs/stonyx-orm#221.
116
+ * Every predicate in this repo and in every consumer tree is arity-1 on the day
117
+ * this ships, and the caller has no supported way to tell which kind it got --
118
+ * the boot-time arity warning that would surface it is abofs/stonyx-orm#213.
122
119
  * So: pass the context, and do not treat a resolved predicate's answer as
123
120
  * model-specific until that predicate has been migrated to read the context.
124
121
  *
125
122
  * ---------------------------------------------------------------------------
126
123
  * DO NOT RECONSTRUCT THE REQUEST PATH INSIDE `access()`.
127
124
  * ---------------------------------------------------------------------------
128
- * You do not have to. `auth()` below hands your predicate the ACCESS CONTEXT as
129
- * argument two, and `context.model` already names the collection -- see the
130
- * contract section above. Argument ONE is still the raw transport artifact, and
131
- * everything from here to the end of this banner is the record of what happened
132
- * when predicates worked the collection out from it. IT IS HISTORY, NOT
133
- * GUIDANCE: do not write any of it into a new predicate. Every attempt to
134
- * identify the collection by parsing the request target has failed OPEN. Five
135
- * distinct variants of the same three-line example have now been found, each
136
- * after the previous was fixed, by five different people:
125
+ * `auth()` below hands your `access(request)` a raw transport artifact and asks
126
+ * you to work out which collection it addresses. Every attempt to do that by
127
+ * parsing the request target has failed OPEN. Five distinct variants of the
128
+ * same three-line example have now been found, each after the previous was
129
+ * fixed, by five different people:
137
130
  *
138
131
  * 1. `request.url` is mount-relative under `RestServer.mountRoute`, so a
139
132
  * prefix match against it is ALWAYS false.
@@ -152,31 +145,22 @@
152
145
  * last, and the record comes back in full. It walks past a hard
153
146
  * `return false` deny the same way.
154
147
  *
155
- * The fix is not a sixth rule, and it is not a better string to match. It is to
156
- * stop identifying the collection at all: read `context.model`.
148
+ * The fix is not a sixth rule. It is to stop parsing:
157
149
  *
158
- * An intermediate revision of the sample read `request.baseUrl` -- the mount
159
- * Express ACTUALLY MATCHED. That closed all five variants (no query string,
160
- * not mount-relative, unaffected by absolute-form, already carrying the
161
- * configured `ORM_REST_ROUTE` prefix), but it was a transport artifact
162
- * standing in for a structural fact and the sample no longer does it.
163
- * `context.model` IS the structural fact, so all five variants are
164
- * unconstructible against a migrated predicate rather than handled.
165
- *
166
- * ONE READ OF ARGUMENT ONE SURVIVES, AND IT MUST: `request.path`. It is
167
- * mount-relative and query-free, and it is for rules that distinguish SUB-PATHS
168
- * beneath the mount. The context names which model and which verb, NOT which
169
- * route, so the sample's `/archived` deny cannot be expressed from the context
170
- * alone and a context-ONLY rewrite would silently turn that deny into an allow.
171
- * Lower-case it before comparing -- the router matched case-insensitively -- and
172
- * compare record ids at their real case.
150
+ * `request.baseUrl` is the mount Express ACTUALLY MATCHED when it dispatched
151
+ * the request. It carries no query string, it is not mount-relative, it is
152
+ * unaffected by absolute-form, and it already includes the configured
153
+ * `ORM_REST_ROUTE` prefix -- so there is nothing to derive and nothing to
154
+ * join. Compare it lower-cased (the router matched case-insensitively) and
155
+ * fail CLOSED when it is absent. Use `request.path` -- mount-relative and
156
+ * query-free -- if you need to distinguish sub-paths.
173
157
  *
174
158
  * `?? ''` is not a defence. It converts an absent request target into an empty
175
159
  * string, which matches no collection, which falls through to the permission
176
- * array -- a total grant. An input you cannot identify must DENY, and that
177
- * applies to the context too: the sample returns `false` for an absent `model`
178
- * rather than falling through.
160
+ * array -- a total grant. An input you cannot identify must DENY.
179
161
  *
162
+ * THAT IS STILL A STOPGAP. `baseUrl` closes all five variants, but it is a
163
+ * transport artifact being asked to stand in for a structural fact.
180
164
  * THE REAL FIX IS abofs/stonyx-orm#202: `access()` should receive the model,
181
165
  * the operation and the record. Prefer the array shape (`['read']`) or `false`
182
166
  * until #202 lands; the function shape is what requires any matching at all.
@@ -199,7 +183,7 @@ import { getPluralName } from './plural-registry.js';
199
183
  import { getBeforeHooks, getAfterHooks } from './hooks.js';
200
184
  import config from 'stonyx/config';
201
185
  import log from 'stonyx/log';
202
- import { isOrmRecord } from './utils.js';
186
+ import { isOrmRecord, NO_FREE_ID_ERROR } from './utils.js';
203
187
  const methodAccessMap = {
204
188
  GET: 'read',
205
189
  POST: 'create',
@@ -692,7 +676,39 @@ export default class OrmRequest extends Request {
692
676
  // is true for a record the request did not create. The map's size is the
693
677
  // only O(1) signal that distinguishes an insert from an overwrite.
694
678
  const slotsBefore = store.get(model)?.size ?? 0;
695
- const created = createRecord(model, recordAttributes, { serialize: false, _skipAutoPersist: true });
679
+ // THE ONE `createRecord` FAILURE THIS ROUTE ANSWERS RATHER THAN
680
+ // PROPAGATES, and it is narrow on purpose.
681
+ //
682
+ // `assignRecordId` throws when it cannot derive a free store key for a
683
+ // server-assigned id. Unguarded that rejection is auto-forwarded -- there
684
+ // is no catch here, none in @stonyx/rest-server's dispatcher
685
+ // (dist/request.js:41-70), and express 5 hands it to its default error
686
+ // handler, which serialises the STACK, with absolute install paths and the
687
+ // internal module graph, to an unauthenticated caller outside
688
+ // NODE_ENV=production. That is the hazard :553-558 already names in this
689
+ // file, and every sibling refusal in this handler returns an integer
690
+ // status instead. So this one returns 409, matching the client-duplicate
691
+ // refusal at :713: the caller asked for a record and the collection has no
692
+ // id to give it.
693
+ //
694
+ // MATCHED ON THE SHARED PREFIX, not on a literal, and NOT by catching
695
+ // everything: `createRecord` also throws for "ORM is not ready", a
696
+ // read-only view and an unregistered model store, and turning any of those
697
+ // into a 409 would report a configuration fault as a conflict. Anything
698
+ // else is re-thrown unchanged.
699
+ let created;
700
+ try {
701
+ created = createRecord(model, recordAttributes, { serialize: false, _skipAutoPersist: true });
702
+ }
703
+ catch (error) {
704
+ if (!(error instanceof Error) || !error.message.startsWith(NO_FREE_ID_ERROR))
705
+ throw error;
706
+ // Not silently. A collection that can no longer assign an id is a
707
+ // configuration fault (a non-injective id transform), and a bare 409
708
+ // with no diagnostic is indistinguishable from an ordinary duplicate.
709
+ log.error?.(`[@stonyx/orm] ${error.message}`);
710
+ return 409; // Conflict
711
+ }
696
712
  const record = isOrmRecord(created) ? created : null;
697
713
  if (!record)
698
714
  return 500;
@@ -716,11 +732,32 @@ export default class OrmRequest extends Request {
716
732
  //
717
733
  // Both conditions are required and neither implies the other:
718
734
  // createdNewSlot -- the store grew, so this request inserted rather
719
- // than overwrote. Guards `assignRecordId` picking an
720
- // id that is already taken (it returns
721
- // last-INSERTED + 1, not max + 1, so a store whose
722
- // insertion order is not ascending collides) -- see
723
- // abofs/stonyx-orm#203.
735
+ // than overwrote. SURVIVOR AS OF #203, AND THAT IS
736
+ // WHAT THIS NOTE IS FOR. It used to be killable:
737
+ // `assignRecordId` returned last-INSERTED + 1, so a
738
+ // server-assigned id could land on an occupied slot,
739
+ // `createRecord` updated in place, and removing this
740
+ // half turned access-filter-enforcement-test.ts
741
+ // assertion 31 red. #203 closed that: the
742
+ // server-assigned path now walks past occupied keys,
743
+ // so no create reaching here can overwrite. Measured
744
+ // -- delete `createdNewSlot &&` below: `dev` gives
745
+ // 55 pass / 1 fail with assertion 31 RED, this tree
746
+ // gives 56 pass / 0 fail, GREEN.
747
+ // KEPT ANYWAY, AND NOT FOR THE OLD REASON. Without
748
+ // it a denied create becomes `store.remove` on a key
749
+ // the caller may have influenced, which :815-820
750
+ // records as having been an unauthenticated deletion
751
+ // primitive across the whole id space. BECOMES
752
+ // KILLABLE AGAIN the moment any caller-supplied id
753
+ // can reach `createRecord` from this handler --
754
+ // which is exactly what has-many.ts:65 and
755
+ // belongs-to.ts:45 already do for ANOTHER model's
756
+ // store (abofs/stonyx-orm#207), and what a third
757
+ // un-stripped id channel would do for this one
758
+ // (#204). Do not delete it on the strength of #203
759
+ // being closed; that is the reasoning :862-867 warns
760
+ // about, one level up.
724
761
  // identity -- the slot still holds the object we just created,
725
762
  // so nothing between createRecord and here replaced
726
763
  // it. Deleting this half SURVIVES the suite, and it
@@ -7,6 +7,10 @@
7
7
  */
8
8
  import fs from 'fs/promises';
9
9
  import path from 'path';
10
+ // `./utils.js` pulls in `@stonyx/utils/string` and nothing else -- no ORM
11
+ // bootstrap, no `@stonyx/orm` index, no side effects -- so the "no framework
12
+ // dependencies" property above still holds.
13
+ import { maxNumericId } from './utils.js';
10
14
  export default class StandaloneDB {
11
15
  mode;
12
16
  dbPath;
@@ -102,11 +106,19 @@ export default class StandaloneDB {
102
106
  async create(collection, data) {
103
107
  const records = await this.readCollection(collection);
104
108
  if (!data.id) {
105
- const maxId = records.reduce((max, r) => {
106
- const rid = typeof r.id === 'number' ? r.id : 0;
107
- return rid > max ? rid : max;
108
- }, 0);
109
- data.id = maxId + 1;
109
+ // SHARED WITH `assignRecordId` (src/manage-record.ts), which is the other
110
+ // place this repo picks a server-assigned id. It was a second copy of the
111
+ // reduce, and nothing here pointed at it — a maintainer editing this
112
+ // method could not discover the other existed. See `maxNumericId` for why
113
+ // it is not `Math.max` (abofs/stonyx-orm#203).
114
+ //
115
+ // THE TWO ARE NOT THE SAME FUNCTION beyond this line, deliberately.
116
+ // `StandaloneDB` has no model, id-type or transform concept, so `maxId + 1`
117
+ // IS its store key; `assignRecordId` has to map the candidate through the
118
+ // model's declared id transform first, and then walk past occupied keys.
119
+ // Transplanting this method's remaining logic into the ORM reproduces
120
+ // #203's landing-key defect exactly — which is what AC4 pins.
121
+ data.id = maxNumericId(records) + 1;
110
122
  }
111
123
  // Check for duplicate id
112
124
  const existing = records.find(r => r.id === data.id);