OpenFn / OpenFn/lightning

sandboxes: show audit trail for merging

Open
#4,650 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

sandboxes and sync Sandboxes v2
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

Merging sandboxes can be complex? the algorithm makes a number of decisions about what is and is not merged.

When a merge goes wrong - or just if you're not sure what happened in a merge and you want some reassurance - there's no information to tell you. No logging, no details.

it might be useful to have a key-by-key account of what is happening during merge in a text log somewhere Maybe a running log, or maybe just a report of what keys were assignedn

If merging works perfectly every time then this isn't needed. And exposing it is perhaps a sign of weak confidence.

Issue applies to CLI as well as app, so may need duplicating out.

The CLI at least uses a lot of spreads so we'd have to refactor to something a bit more intentional. Likely similar in the app too

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 sandbox merge logic used by the CLI and app, then trace how merge decisions and assigned keys are made. The issue does not name files or tests, so first map the relevant entry points and decide whether a running log or a merge report is appropriate. Done means users can inspect a key-by-key account of what the merge did.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.