OpenFn / OpenFn/lightning

Update demo script to properly create snapshots

Open
#1,964 0 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

The PR #1946 introduces snapshots, but the demo setup script used in Lightning.Demo.reset_demo doesn't use the new save_workflow functions properly, leaving blank snapshots.

When we introduce the linkage between runs and specific workflow snapshots, this will lead to some confusing behaviour on the demo site when users think that run 1 was executed against a blank workflow snapshot, even though they see that it's clearly been run properly against some workflow version.

  • Update the demo scripts so that they build proper snapshots.
  • Update the tests to prove that the snapshots are built properly after the reset_demo scripts are called.

This issue should be fixed before we merge in the next PR related to snapshotting #1826 , which associates runs with specific snapshots.

(cc @stuartc )

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 at Lightning.Demo.reset_demo and inspect how the demo setup calls the new save_workflow functions. Then find the existing reset_demo tests and verify that running the reset creates populated workflow snapshots rather than blank ones.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.