OpenFn / OpenFn/kit

Runtime: use step names when reporting validation errors

Open
#754 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

When the runtime validates an invalid step, it'll log an error using the step id

R/T {
  "message": "Cannot find job: 37117057-2919-4a37-aa51-5a51afa875fe",
  "name": "ValidationError"
}

But we humans probably don't know what the step id is, especially if it's come from lightning.

We may have to restucture the edges to include name id or something, because at this point I suspect we don't have the step name

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the runtime validation path and trace how step IDs become validation-error messages, including steps received from Lightning. Inspect how edges currently carry step information and determine what is needed for errors to report human-readable step names. Done means invalid-step errors identify the step by name rather than only by UUID.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.