Base branch: Safely handle divergence #4899

estib-vega · 2024-09-12T14:51:15Z

☕️ Reasoning

The application doesn't display any kind of information related to base branch divergence.
It should detect this, raise this to the user and present alternative actions to address this.

Scenario

I open a repository on GitButler.
A team-mate of mine makes some changes, and mistakenly pushes a commit with sensitive information.
I merge the changes into the local base branch of GitButler. I can see the mistaken commit.
They decide to force-push the commit away.
I reload the application, but the state is the same as in step 3.

Expected behavior would be to have some information about this and the ability to restore the application to the latest version of the target upstream.

🧢 Changes

Detect whether the base-branch has diverged with its upstream.
Display the information to the user in a way that makes it clear if and which changes will be lost, if any action is taken

Visuals

Local is ahead of upstream

In this state, gitbutler/workspace is ahead of the target upstream.
The information is presented to the user as a heads-up only, as they might want to push the changes,
If they want to reset their local target branch to the current state of the target upstream, they will be prompted with a confirmation modal.

Local has changes ahead and behind upstream

Similar to the previous state, there are some local commits that are not in the remote, but also some remote changes that are not in the local branch.
The information is displayed as a warning.

The options are to hard reset to the fork-point, or force-push.
Both buttons trigger confirmation dialogues.

Confirmation dialogue when resetting to the fork-point

Confirmation dialogue when force-pushing the local changes to the remote

vercel · 2024-09-12T14:51:16Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
gitbutler-web	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 8:23am

Determine whether the local target has diverged from the remote, and return some information about that

If the local target has diverged from the remote target, display that to the user as a warning

In order to make it a bit clearer what the divergence state of the base branch is. reuse the line graphs to display it

If needed, the base branch can be pushed or force pushed

Only display the warnings and confirmation modals when actual changes can get lost (resting to local or remote). Otherwise, display less scary notifications and let the user push if needed

krlvi · 2024-09-16T15:21:07Z

Lets separate out the update of base branch (because we can in the future show exactly what is gonna happen to branches)

…ments

If the base branch has diverged from the upstream, reset the local base branch to the fork-point. This clears the way for merging the upstream changes later on.

The two available options to resolve base branch divergence are now: - Push (with force if needed) your local changes to the upstream - Reset your local base branch to the fork-point That way, the user is able to update their workspace as usual

Caleb-T-Owens · 2024-09-18T09:37:20Z

crates/gitbutler-branch-actions/src/base.rs

+pub(crate) fn realign_base_branch(
+    ctx: &CommandContext,
+    perm: &mut WorktreeWritePermission,
+) -> anyhow::Result<Vec<ReferenceName>> {
+    ctx.assure_resolved()?;
+
+    let target = default_target(&ctx.project().gb_dir())?;
+    let base = target_to_base_branch(ctx, &target)?;
+
+    if !base.diverged {
+        return Ok(Vec::new());
+    }
+
+    let target_commit = ctx
+        .repository()
+        .find_commit(
+            base.diverged_fork_point
+                .context("failed to find fork point")?,
+        )
+        .context("failed to find target commit")?;
+
+    set_base_branch_to_commit(ctx, target_commit, perm)
+}


What is the difference between update_base_branch and realign_base_branch? Can they be made the same function?

update_base_branch:
This resets the local base branch to whatever the tip of its upstream is.

realign_base_branch:
This resets the local base branch to the fork-point it has to its upstream.
This drops any ahead changes in the local base branch.
So it's "aligned" in the sense that it no longer diverts from upstream.

Caleb-T-Owens · 2024-09-18T09:38:09Z

apps/desktop/src/lib/baseBranch/baseBranchService.ts

+	async realignBaseBranch(): Promise<string | undefined> {
+		this.loading.set(true);
+		try {
+			const stashedConflicting = await invoke<string[]>('realign_base_branch', {
+				projectId: this.projectId
+			});
+			await this.fetchFromRemotes();
+			return getStashedConflictingMessage(stashedConflicting);
+		} catch (err: any) {
+			showError('Failed to realign base branch', err);
+			console.error(err);
+		}
+	}


Do we even call this from the frontend? Doing a quick text search I'm not seeing it.

I think it's a large diff that wasn't rendered. At least for me

estib-vega · 2024-09-18T12:11:07Z

apps/desktop/src/lib/components/BaseBranch.svelte

+
+	async function realignBaseBranch() {
+		baseBranchIsUpdating = true;
+		const infoText = await baseBranchService.realignBaseBranch();


@Caleb-T-Owens here :)

estib-vega · 2024-09-19T12:04:46Z

FYI: This PR needs some rework around the way that we want the resolution to work.
We decided to use the new update with rebase/merge UI in order to deal with this kind of situations

github-actions bot added rust Pull requests that update Rust code @gitbutler/desktop labels Sep 12, 2024

vercel bot deployed to Preview September 12, 2024 14:51 View deployment

estib-vega force-pushed the base-branch-improvements branch 2 times, most recently from ba3329e to 901e225 Compare September 13, 2024 08:10

vercel bot deployed to Preview September 13, 2024 08:11 View deployment

github-actions bot added the @gitbutler/ui label Sep 13, 2024

vercel bot deployed to Preview September 13, 2024 09:08 View deployment

estib-vega force-pushed the base-branch-improvements branch from b72085e to 2a4bbef Compare September 13, 2024 10:31

vercel bot deployed to Preview September 13, 2024 10:32 View deployment

estib-vega force-pushed the base-branch-improvements branch from 2a4bbef to 624e5c3 Compare September 13, 2024 10:33

vercel bot deployed to Preview September 13, 2024 10:33 View deployment

estib-vega force-pushed the base-branch-improvements branch from 1ef2625 to 5de527d Compare September 13, 2024 12:58

vercel bot deployed to Preview September 13, 2024 12:59 View deployment

vercel bot deployed to Preview September 13, 2024 13:42 View deployment

estib-vega force-pushed the base-branch-improvements branch from 7755dfd to e08fdd2 Compare September 13, 2024 13:56

vercel bot deployed to Preview September 13, 2024 13:57 View deployment

estib-vega force-pushed the base-branch-improvements branch from e08fdd2 to b3da0b7 Compare September 13, 2024 14:58

estib-vega changed the title ~~base-branch-improvements~~ Base branch: Safely handle divergence Sep 13, 2024

estib-vega added 9 commits September 13, 2024 17:28

BaseBranch: Determine whether the base diverged

59848a7

Determine whether the local target has diverged from the remote, and return some information about that

Display the divergent state in the app

bdee4f4

If the local target has diverged from the remote target, display that to the user as a warning

Only show either the divergence warning or upstream count

a6243d6

BaseBranch: Use runes

417bf8d

Array utils: group items by condition

60f9f1e

BaseBranch: Display the branch graph

b97134e

In order to make it a bit clearer what the divergence state of the base branch is. reuse the line graphs to display it

BaseBranch divergence: Add a confirmation modal

74633ce

Ability to push the base branch

4d2e2c5

If needed, the base branch can be pushed or force pushed

BaseBranch: Don't be scary when pushing

c20240e

Only display the warnings and confirmation modals when actual changes can get lost (resting to local or remote). Otherwise, display less scary notifications and let the user push if needed

estib-vega force-pushed the base-branch-improvements branch from b3da0b7 to 72d0050 Compare September 13, 2024 15:31

vercel bot deployed to Preview September 13, 2024 15:32 View deployment

estib-vega marked this pull request as ready for review September 13, 2024 15:32

estib-vega requested review from Caleb-T-Owens, ndom91 and PavelLaptev September 13, 2024 15:36

estib-vega force-pushed the base-branch-improvements branch from 72d0050 to bb09576 Compare September 15, 2024 07:59

vercel bot deployed to Preview September 15, 2024 08:00 View deployment

Merge remote-tracking branch 'origin/master' into base-branch-improve…

68ab864

…ments

estib-vega force-pushed the base-branch-improvements branch from bd6393e to 935dd4a Compare September 16, 2024 15:46

vercel bot deployed to Preview September 16, 2024 15:47 View deployment

estib-vega added 2 commits September 17, 2024 14:01

Add method to realign the base branch

1c30589

If the base branch has diverged from the upstream, reset the local base branch to the fork-point. This clears the way for merging the upstream changes later on.

estib-vega force-pushed the base-branch-improvements branch from 935dd4a to b20637d Compare September 17, 2024 12:11

vercel bot deployed to Preview September 17, 2024 12:12 View deployment

estib-vega force-pushed the base-branch-improvements branch from b20637d to a20da2f Compare September 18, 2024 08:22

vercel bot deployed to Preview September 18, 2024 08:23 View deployment

Caleb-T-Owens reviewed Sep 18, 2024

View reviewed changes

estib-vega commented Sep 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Base branch: Safely handle divergence #4899

Base branch: Safely handle divergence #4899

estib-vega commented Sep 12, 2024 •

edited

Loading

vercel bot commented Sep 12, 2024 •

edited

Loading

krlvi commented Sep 16, 2024

Caleb-T-Owens Sep 18, 2024

estib-vega Sep 18, 2024

Caleb-T-Owens Sep 18, 2024

estib-vega Sep 18, 2024

estib-vega Sep 18, 2024

estib-vega commented Sep 19, 2024

Base branch: Safely handle divergence #4899

Are you sure you want to change the base?

Base branch: Safely handle divergence #4899

Conversation

estib-vega commented Sep 12, 2024 • edited Loading

☕️ Reasoning

Scenario

🧢 Changes

Visuals

Local is ahead of upstream

Local has changes ahead and behind upstream

Confirmation dialogue when resetting to the fork-point

Confirmation dialogue when force-pushing the local changes to the remote

vercel bot commented Sep 12, 2024 • edited Loading

krlvi commented Sep 16, 2024

Caleb-T-Owens Sep 18, 2024

Choose a reason for hiding this comment

estib-vega Sep 18, 2024

Choose a reason for hiding this comment

Caleb-T-Owens Sep 18, 2024

Choose a reason for hiding this comment

estib-vega Sep 18, 2024

Choose a reason for hiding this comment

estib-vega Sep 18, 2024

Choose a reason for hiding this comment

estib-vega commented Sep 19, 2024

estib-vega commented Sep 12, 2024 •

edited

Loading

vercel bot commented Sep 12, 2024 •

edited

Loading