OpenFn / OpenFn/kit

Legacy Deploy: keys change order in state

Open
#1,364 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

GH Sync sync v2
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

When using a v1 deploy and writing a state.json, the order of steps can change, resulting in huge diffs.

For example, here is a commit with a large diff - but the actual change was trivial. Since the key order has changed, it's impossible to compare the two diffs and see what changed.

In state v1 it might make sense to order steps by UUID (so that renaming a step also result in a small diff). Bit unintuitive but state.json isn't human readable so its fine.

I don't think I'll ever fix this. But I do want to be sure that this is stable in v2. Keys in project.yaml files should not change order.

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 legacy v1 deploy code that writes state.json, then compare its key-ordering behavior with the v2 deploy path and project.yaml handling. Reproduce the large-diff case from the linked commit and add coverage for stable ordering; done means repeated deploys preserve the intended order in both state and project configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, devops
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.