OpenFn / OpenFn/kit

Tool to send jobs to the worker

Open
#889 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I would like a tool in ws-worker which:

  • allows me to specify a workflow in Javascript (with a helper API and multiline strings)
  • Maybe even lets me point to a workflow.json file, including file paths
  • (maybe we could use CLI compile to "import" a workflow .json)
  • Posts the workflow up to the worker directly

We can add dev options to the worker to make this easier. For example we may want to allow the worker to support native workflow.json format (rather than lighting's format)

What about log output? Will the worker freak out if lightning isn't attached? Maybe the tool needs to pretend to be lightning (or even start up the lightning mock), take events from the worker, and console.log them to shell or disk. That would be neat actually

I should be able to do like pnpm run path/to/workflow.{js|json} and it'll just magically do it for me

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 reading the ws-worker tooling and the existing CLI compile flow, then inspect how workflow.json files and worker communication are currently handled. Define the command's supported JavaScript and JSON inputs, direct posting behavior, and log handling before implementation; done means a pnpm run path/to/workflow.{js|json} invocation can submit a workflow and expose worker output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
backend, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.