OpenFn / OpenFn/kit

Workflow generator needs to include triggers

Open
#1,089 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hit a bit of a problem

The workflow generator produces nice workflows for us, with nodes and edges.

But they're trigger-agnostic. They don't know what a trigger is, and don't add one.

In lightning state, triggers have special rules. They must exist. A step must have a source_trigger_id.

In order to test the same workflow in CLI and Lightning, we need to add proper trigger support to the workflow generator.

I'm not even sure how we'll do that really. Aside from the syntactic problem, nothing in the kit stack really gives any special provenance to triggers. How will the statefile generator look at a workflow and know to convert a node into a trigger?

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 workflow generator and statefile generator entry points, then read how Lightning represents triggers and how CLI workflows are tested. Determine how trigger provenance can be represented in a generated workflow and how each step receives a source_trigger_id. Done means generated workflows support required triggers and can be tested consistently in CLI and Lightning.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.