-
Notifications
You must be signed in to change notification settings - Fork 528
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into ndom91/macos-e2e-docker-image
- Loading branch information
Showing
10 changed files
with
262 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,123 @@ | ||
| use std::{fs, path::PathBuf}; | ||
|
|
||
| use anyhow::{bail, Context, Result}; | ||
| use gitbutler_command_context::CommandContext; | ||
| use gitbutler_reference::ReferenceName; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| /// The reference the app will checkout when the workspace is open | ||
| pub const INTEGRATION_BRANCH_REF: &str = "refs/heads/gitbutler/integration"; | ||
| /// The reference the app will checkout when in edit mode | ||
| pub const EDIT_BRANCH_REF: &str = "refs/heads/gitbutler/edit"; | ||
|
|
||
| fn edit_mode_metadata_path(ctx: &CommandContext) -> PathBuf { | ||
| ctx.project().gb_dir().join("edit_mode_metadata.toml") | ||
| } | ||
|
|
||
| #[doc(hidden)] | ||
| pub fn read_edit_mode_metadata(ctx: &CommandContext) -> Result<EditModeMetadata> { | ||
| let edit_mode_metadata = fs::read_to_string(edit_mode_metadata_path(ctx).as_path()) | ||
| .context("Failed to read edit mode metadata")?; | ||
|
|
||
| toml::from_str(&edit_mode_metadata).context("Failed to parse edit mode metadata") | ||
| } | ||
|
|
||
| /// Operating Modes: | ||
| /// Gitbutler currently has two main operating modes: | ||
| /// - `in workspace mode`: When the app is on the gitbutler/integration branch. | ||
| /// This is when normal operations can be performed. | ||
| /// - `outside workspace mode`: When the user has left the gitbutler/integration | ||
| /// branch to perform regular git commands. | ||
| #[doc(hidden)] | ||
| pub fn write_edit_mode_metadata( | ||
| ctx: &CommandContext, | ||
| edit_mode_metadata: &EditModeMetadata, | ||
| ) -> Result<()> { | ||
| let serialized_edit_mode_metadata = | ||
| toml::to_string(edit_mode_metadata).context("Failed to serialize edit mode metadata")?; | ||
| gitbutler_fs::write( | ||
| edit_mode_metadata_path(ctx).as_path(), | ||
| serialized_edit_mode_metadata, | ||
| ) | ||
| .context("Failed to write edit mode metadata")?; | ||
|
|
||
| const INTEGRATION_BRANCH_REF: &str = "refs/heads/gitbutler/integration"; | ||
| Ok(()) | ||
| } | ||
|
|
||
| pub fn in_open_workspace_mode(ctx: &CommandContext) -> Result<bool> { | ||
| let head_ref = ctx.repository().head().context("failed to get head")?; | ||
| let head_ref_name = head_ref.name().context("failed to get head name")?; | ||
| /// Holds relevant state required to switch to and from edit mode | ||
| #[derive(Debug, Serialize, Deserialize, PartialEq)] | ||
| pub struct EditModeMetadata { | ||
| /// The sha of the commit getting edited. | ||
| #[serde(with = "gitbutler_serde::oid")] | ||
| pub editee_commit_sha: git2::Oid, | ||
| /// The ref of the vbranch which owns this commit. | ||
| pub editee_branch: ReferenceName, | ||
| } | ||
|
|
||
| Ok(head_ref_name == INTEGRATION_BRANCH_REF) | ||
| #[derive(PartialEq)] | ||
| pub enum OperatingMode { | ||
| /// The typical app state when its on the gitbutler/integration branch | ||
| OpenWorkspace, | ||
| /// When the user has chosen to leave the gitbutler/integration branch | ||
| OutsideWorkspace, | ||
| /// When the app is off of gitbutler/integration and in edit mode | ||
| Edit(EditModeMetadata), | ||
| } | ||
|
|
||
| pub fn operating_mode(ctx: &CommandContext) -> OperatingMode { | ||
| let Ok(head_ref) = ctx.repository().head() else { | ||
| return OperatingMode::OutsideWorkspace; | ||
| }; | ||
|
|
||
| let Some(head_ref_name) = head_ref.name() else { | ||
| return OperatingMode::OutsideWorkspace; | ||
| }; | ||
|
|
||
| if head_ref_name == INTEGRATION_BRANCH_REF { | ||
| OperatingMode::OpenWorkspace | ||
| } else if head_ref_name == EDIT_BRANCH_REF { | ||
| let edit_mode_metadata = read_edit_mode_metadata(ctx); | ||
|
|
||
| match edit_mode_metadata { | ||
| Ok(edit_mode_metadata) => OperatingMode::Edit(edit_mode_metadata), | ||
| Err(error) => { | ||
| tracing::warn!( | ||
| "Failed to open in edit mode, falling back to outside workspace {}", | ||
| error | ||
| ); | ||
| OperatingMode::OutsideWorkspace | ||
| } | ||
| } | ||
| } else { | ||
| OperatingMode::OutsideWorkspace | ||
| } | ||
| } | ||
|
|
||
| pub fn in_open_workspace_mode(ctx: &CommandContext) -> bool { | ||
| operating_mode(ctx) == OperatingMode::OpenWorkspace | ||
| } | ||
|
|
||
| pub fn assure_open_workspace_mode(ctx: &CommandContext) -> Result<()> { | ||
| if in_open_workspace_mode(ctx)? { | ||
| if in_open_workspace_mode(ctx) { | ||
| Ok(()) | ||
| } else { | ||
| bail!("Unexpected state: cannot perform operation on non-integration branch") | ||
| bail!("Expected to be in open workspace mode") | ||
| } | ||
| } | ||
|
|
||
| pub fn in_edit_mode(ctx: &CommandContext) -> bool { | ||
| matches!(operating_mode(ctx), OperatingMode::Edit(_)) | ||
| } | ||
|
|
||
| pub fn assure_edit_mode(ctx: &CommandContext) -> Result<EditModeMetadata> { | ||
| match operating_mode(ctx) { | ||
| OperatingMode::Edit(edit_mode_metadata) => Ok(edit_mode_metadata), | ||
| _ => bail!("Expected to be in edit mode"), | ||
| } | ||
| } | ||
|
|
||
| pub fn in_outside_workspace_mode(ctx: &CommandContext) -> Result<bool> { | ||
| in_open_workspace_mode(ctx).map(|open_mode| !open_mode) | ||
| pub fn in_outside_workspace_mode(ctx: &CommandContext) -> bool { | ||
| operating_mode(ctx) == OperatingMode::OutsideWorkspace | ||
| } | ||
|
|
||
| pub fn assure_outside_workspace_mode(ctx: &CommandContext) -> Result<()> { | ||
| if in_outside_workspace_mode(ctx)? { | ||
| if in_outside_workspace_mode(ctx) { | ||
| Ok(()) | ||
| } else { | ||
| bail!("Unexpected state: cannot perform operation on integration branch") | ||
| bail!("Expected to be in outside workspace mode") | ||
| } | ||
| } |
Oops, something went wrong.