OpenFn / OpenFn/kit

Runtime: take configuration off state

Open
#779 1 comment 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

Stub issue, will be filled in later

  • Change Operation signature to (state, credential) => State
  • Adaptor APIs need updating to the new format
    • Could we automate this? Back port it to old adaptors anyhow?
  • Need some way to determine whether an adaptor uses the new or old API (so some kind of API_VERSION export in the adaptor), and then having back compat (write config to state at the last minute)
  • Runtime accepts state and config as seperate arguments

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 Operation signature, adaptor APIs, and runtime entry point described in the issue. Determine how current adaptors receive configuration and how the runtime passes state and config. Done means the proposed API transition, version detection, and backward-compatibility requirements are resolved and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Refactor
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.