Skip to main content
An input refused when absent is present afterwards | ESSAn Optional input reads as its value type in a branch only ever taken with the input present, so it fills a required field without a conversion.ESShow-toesshow-toadopterdevelopertry-spec-driven-developmentspecify

An input refused when absent is present afterwards

From source ess/16, an Optional<T> input reads as T in a branch that is only ever taken with the input present. There are two such branches:

  • the default branch, written with no when:, when a sibling refuses exactly the input's absence with error: — when: not defined(x) or when: missing(x);
  • a branch whose own guard requires the input: when: defined(x), or an all: with it as a member.
commands:
  - name: demo.notes.SubmitNote
    input:
      - {name: account_id, type: Optional<demo.notes.AccountId>}
      - {name: text, type: String}
    outcomes:
      - name: account-missing
        when: not defined(account_id)
        error: demo.notes.AccountMissing
      - name: submitted                       # the default: the account is present here
        creates: demo.notes.Note
        instance: note_id
        sets: {account_id: input.account_id, text: input.text}
        emits: [demo.notes.NoteSubmitted]
        payload:
          demo.notes.NoteSubmitted: {note_id: {generated: true}, account_id: input.account_id, text: input.text}

input.account_id fills the required account_id fields with no conversions: entry. A conversion from Optional<AccountId> to AccountId would admit the same copy on every command, whether anything refuses the absence first or not. Narrowing does not depend on the order outcomes are declared in. It applies to input.<x> in payload:, in sets: and in a leaf of a nested mapping, and only to a top-level input.

Nothing else narrows. A refusal of the absence and something else, such as {all: ["not defined(x)", "kind == Draft"]}, leaves some absent requests to the default branch. A sibling that succeeds when x is absent refuses nothing. A guarded branch other than the default can match a request the refusal also matches. That includes a branch written when: true: it is a guard that always holds, not the default, and a runtime that tries branches in declared order would take it before a refusal declared after it. Write the default with no when:.

The synthesized suite checks the narrowing: the refusal's scenario sends no account_id and requires account-missing, and the success scenario sends one. Below ess/16 the copy is refused as a type_mismatch, as it always has been. Design.

From ess/27: what a branch's own guard establishes​

From source ess/27 a value reads at its present type wherever its own branch's guard proves it present (beyond10x/ess#556):

- name: no-customer                 # an absent customer_id selects no when_related branch
  when_related: {via: input.customer_id, exists: false}
  error: ledger.NoSuchCustomer
  payload: {ledger.NoSuchCustomer: {customer_id: input.customer_id}}
- name: sealed
  when_subject: {predicate: defined(approved_by)}
  error: ledger.IncidentLocked
  payload: {ledger.IncidentLocked: {approved_by: {subject: approved_by}}}

{related: {via, field}} reads at its present type under when_related: {predicate: defined(field)} over the same via. A refusal guarded by a related row the addressed record's stored reference names, when_related: {via: incident_id, …}, reads that record's stored fields with {subject: …} (beyond10x/ess#555): the record was read to follow the reference. The suite asserts each value in the error. The generated Rust and Go behaviours keep such a command an obligation, named by the read. Below ess/27 each read keeps its refusal, the hint naming ess/27.