@geonosis/workflows 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,110 @@
+# `@geonosis/workflows`
+
+A workflow engine with one door.
+
+A step is a named unit whose compensation travels with it. A workflow body is a real `async`
+function: a step's output is a real value, an `if` is an `if`, and there is no `transform` because
+there is no graph being built. A run ends in exactly one of four ways, and the write that ends it is
+the same write that queues what it announced.
+
+The run lifecycle, the transactional outbox and the reverse-start unwinding are model-checked. What
+is proven, at which version of which study, and every place this package has since diverged from it,
+is in [`CONTRACT.md`](./CONTRACT.md).
+
+```bash
+pnpm add @geonosis/workflows
+```
+
+## The contract
+
+```ts
+import type { RunJournal } from '@geonosis/workflows'
+```
+
+A host implements `RunJournal` over its own store. Three promises the engine relies on absolutely:
+`insertRun` refuses a held idempotency key by throwing; `recordStep` writes one row per
+`(run, seq, attempt)` and answers with the run's cancellation flag in the same round trip;
+`finishRun` closes the run and queues its events in ONE atomic write, so "completed, audit trail
+lost" is not a state this engine can produce.
+
+`journalConformance` is the executable form of those promises, and every journal — this package's
+in-memory one, and yours — passes the same cases:
+
+```ts
+import { journalConformance } from '@geonosis/workflows'
+
+for (const one of journalConformance(mySubject)) it(one.name, one.run)
+```
+
+## The durable-body law
+
+A durable platform memoises a step by its NAME. This engine numbers repeated uses of one name in
+CALL order — `reserve`, `reserve#2`, `reserve#3` — so a body that walks the same path twice arrives
+at the same names and a replayed step is answered with what it produced the first time. A body that
+does not walk the same path is a body the platform cannot answer for.
+
+Reads are not journalled. So:
+
+> **In a durable body, every value that gates a branch or feeds a step comes from the workflow input
+> or from a step result. A free port read is inline-only. A decision that needs a read is a step, so
+> the decision is memoised with the run.**
+
+The trace, which is a test in this package (`src/durable-body.test.ts`) rather than an argument:
+
+```ts
+const charged = await charge(id)                       // a step: memoised, and it has an undo
+if (store.read() !== 'draft') throw new Refusal(…)     // a FREE read, gating a branch
+await save(withStatus(doc, 'sent'))                    // a step: sets the status the read looks at
+```
+
+Every step succeeds and the instance is then evicted, before the write that would have closed the
+run. The record still says `running`, so the entry guard lets the next invocation through; it
+replays `charge` from its record — registering its undo — reaches the read,
+which now sees `sent` because the first invocation wrote it, and throws. The run unwinds: the charge
+is refunded, and `save` is not undone because this invocation never reached it and so registered no
+undo for it. The record says `compensated`; the invoice is still sent and the customer is still
+refunded. Half a run, reversed.
+
+Move the decision into a step and the replay is handed the answer the first invocation got, takes
+the same branch, and closes `completed` both times — the second half of the same test.
+
+## On Cloudflare
+
+`entrypointFor` is the class a `workflows` binding points at. It dispatches by the name the instance
+was started with, so adding a workflow is adding it to the list; the registry is remembered per env
+because it is pure, and the RUNTIME is built for every run, because a database handle opened in one
+invocation is refused by the next.
+
+```ts
+import { WorkflowEntrypoint } from 'cloudflare:workers'
+import { entrypointFor, handleQueue, handleScheduled } from '@geonosis/workflows'
+
+export class Runs extends entrypointFor<Env, Scope>({
+  base: WorkflowEntrypoint,
+  runtime: (env, params) => runtimeFrom(env).for({ actor: params.actor, tenantId: params.tenantId }),
+  workflows: [shipThing, saveThing],
+}) {}
+
+export default {
+  queue: handleQueue({ onEvent, seen }),
+  scheduled: handleScheduled((env: Env) => runtimeFrom(env)),
+}
+```
+
+`WorkflowEntrypoint` is handed in, never imported: `cloudflare:workers` exists only inside a worker,
+and this package has to be loadable in a test and in Node. Nothing else here imports a binding
+either — a queue, a D1 handle and a Workflows binding all arrive as arguments.
+
+The adapter is proven inside a real workerd, against a real Workflows binding and a real Queue —
+`pnpm test:workerd`, and `pnpm test` at the repo root runs it too. An adapter proven against a mock
+of a platform is proven against the mock.
+
+## Model checking
+
+`formal/` holds the TLA+ specification and its configurations. It is not part of `pnpm verify` and
+needs no Java on a developer's machine:
+
+```sh
+bash foundations/workflows/formal/fetch-tools.sh   # once
+bash foundations/workflows/formal/check.sh         # exits with the number of models that differed
+```