[Upd4ting]

Why

A list route with a non-default pluckMode should leave out a getter that its mode does not list. Today it evaluates every readable getter, so a module author who declares @Listable(["name", "email"]) get fullName() for the default mode gets fullName: "Alice <undefined>" on a detailed route that never plucked email.

Fixes #92

What changes

• listRows (src/index.ts) passes the route's pluck mode to ReadProperties. It passes no mode when the route sets noPluck, which reads every field.
• ReadProperties (src/internal/read-properties.ts) skips a getter when its listable has no own entry for that mode. An entry with no fields, as @Listable([]) writes, still lists the getter.
• The public Query.ReadProperties(obj, meta, dbData, action, onlyList) and the get route behave as before.
• The verify-interface skill now drives issue-92-getter-mode as a passing journey. Its docs no longer say it fails on purpose.

flowchart LR
  R["GET /people/brief<br/>pluckMode: brief"] --> P["pluck fields of 'brief'"]
  P --> RP["ReadProperties(listMode: 'brief')"]
  RP --> G{"getter listable<br/>has 'brief'?"}
  G -- yes --> E["evaluate getter"]
  G -- no --> S["leave it out"]
  N["noPluck route"] --> A["ReadProperties(no listMode)<br/>evaluates every getter"]

Loading

Proof

src/tests/index/list_getter_modes.test.ts (commit af72592). The controller lists fullName and kind (@Listable([])) in the default mode and initial in detailed, with a third route that sets noPluck.

Before the fix (af72592):

  List getters per pluck mode
    1) evaluates a getter in the mode that lists it
    2) leaves out a getter the route's mode does not list
    ✔ evaluates every getter on a route that does not pluck


  1 passing (61ms)
  2 failing

  1) List getters per pluck mode
       evaluates a getter in the mode that lists it:

      AssertionError: expected [ { name: 'Alice', …(4) } ] to deeply equal [ { name: 'Alice', …(3) } ]
      + expected - actual

       [
         {
           "email": "alice@example.com"
           "fullName": "Alice <alice@example.com>"
      -    "initial": "A"
           "kind": "person"
           "name": "Alice"
         }
       ]
      
      at Context.<anonymous> (dist/tests/index/list_getter_modes.test.js:116:42)
      at process.processTicksAndRejections (node:internal/process/task_queues:104:5)

  2) List getters per pluck mode
       leaves out a getter the route's mode does not list:

      AssertionError: expected [ { name: 'Alice', …(3) } ] to deeply equal [ { name: 'Alice', initial: 'A' } ]
      + expected - actual

       [
         {
      -    "fullName": "Alice <undefined>"
           "initial": "A"
      -    "kind": "person"
           "name": "Alice"
         }
       ]
      
      at Context.<anonymous> (dist/tests/index/list_getter_modes.test.js:128:42)
      at process.processTicksAndRejections (node:internal/process/task_queues:104:5)

After the fix (caeb4c6):

  List getters per pluck mode
    ✔ evaluates a getter in the mode that lists it
    ✔ leaves out a getter the route's mode does not list
    ✔ evaluates every getter on a route that does not pluck


  3 passing (100ms)

pnpm run checks at 568eb14: Checks: 8 passed, 0 failed.

The verify-interface skill, run on the packed interface at caeb4c6:

• listing/issue-92-getter-mode passes. GET /people/brief answers {"results":[{"_id":"u1"},{"_id":"u2"},{"_id":"u3"},{"_id":"u4"},{"_id":"u5"}],"total":5,"offset":0,"limit":10}.
• listing/pluck-modes passes. GET /people/list still answers "fullName":"Alice <alice@example.com>" for each row.
• Every other journey passes except issue-90-edit-index (fix(routes): Edit with the index option updates the row whose primary key equals id #90) and issue-93-multi-foreign (fix(foreign): a multi reference answers {} for a missing element and character-index objects with noForeign #93). The skill's README lists both as failing on head for their own issues.

Attention

• A getter with no @Listable is now left out of list routes, as docs/6.listable.md says for any field without the decorator. Before this change, list rows carried it.
• @Listable(false, mode) on a getter still evaluates it in that mode, as before. The metadata stores false and [] the same way, so telling them apart needs a change to setListable. That is out of scope here.
• Pre-existing and unchanged: a getter redeclared in a child controller built with Controller(path, Base) also changes the base controller's routes.