OpenFn / OpenFn/lightning

Refactor namespacing to better fit our current design

Open
#496 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

Details

Since we introduced the WorkOrder module, the existence of Invocation doesn't fit anymore.
If anything, I propose the follow models are moved under WorkOrder.

  • Run
  • Step
  • StepRun
  • Dataclip (maybe?)
  • ...

This implies the removal of the Invocation module afterwards.

Implementation notes

I also think we should revert the spelling of WorkOrder to Workorder, the underscore variable naming is tedious and used in so many places that it's visually unnecessary.

Release notes
User acceptance criteria

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 locating the WorkOrder and Invocation modules and the Run, Step, StepRun, and Dataclip models. Clarify which models should move, whether Workorder spelling should be restored, and the intended scope before changing anything. Done means the agreed namespace and naming design is implemented consistently and Invocation is removed if no longer needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.