OpenFn / OpenFn/kit

Worker: maybe tidy step_id and job_id fields

Open
#1,415 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

Some event structures in the worker a bit confusing.

For example, on step start and complete the engine includes step_id and job_id.

But steps and jobs are synonmous!

I suspect what's happening here is that one is the UUID for the run and the other is the id or UUID of the workflow. I'd have to trace carefully through the code to see.

What I'd like to do is:

  • Establish a much clearer internal naming convention. Maybe run_step_uuid for example is a better name. Or even just step_uuid versus step_id
  • Check which field lightning actually uses and maybe only send that one

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 by tracing the worker's event structures for step start and complete, then follow how their step_id and job_id fields are used by lightning. Establish a consistent internal naming convention and verify which field lightning actually consumes; done means the naming is clear and only the required field is sent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.