add v3-workspace feature toggle.

That way we can already try out bleeding edge features related
to a new implemenation to interpret workspaces.

Author: Byron

apps/desktop/src/lib/config/appSettingsV2.ts

@@ -80,6 +80,8 @@ export type TelemetrySettings = {
 export type FeatureFlags = {
 	/** Enables the v3 design, as well as the purgatory mode (no uncommitted diff ownership assignments). */
 	v3: boolean;
+	/** Enable the usage of the V3 workspace API */
+	ws3: boolean
 };
 
 export type Fetch = {

apps/desktop/src/routes/+layout.svelte

@@ -268,6 +268,10 @@
 		'v 3': () => {
 			settingsService.updateFeatureFlags({ v3: !$settingsStore?.featureFlags.v3 });
 		},
+		// Toggle v3 workspace APIs on/off
+		'w s 3': () => {
+			settingsService.updateFeatureFlags({ ws3: !$settingsStore?.featureFlags.ws3 });
+		},
 		// This is a debug tool to learn about environment variables actually present - only available if the backend is in debug mode.
 		'e n v': async () => {
 			let env = await invoke('env_vars');

crates/but-cli/src/command/mod.rs

@@ -244,7 +244,11 @@ pub mod stacks {
         let project = project_from_path(current_dir)?;
         // Enable v3 feature flags for the command context
         let app_settings = AppSettings {
-            feature_flags: but_settings::app_settings::FeatureFlags { v3: true },
+            feature_flags: but_settings::app_settings::FeatureFlags {
+                v3: true,
+                // Keep this off until it caught up at least.
+                ws3: false,
+            },
             ..AppSettings::default()
         };
 

crates/but-settings/assets/defaults.jsonc

@@ -17,7 +17,9 @@
 	},
 	"featureFlags": {
 		// Enables the v3 design, as well as the purgatory mode (no uncommitted diff ownership assignments).
-		"v3": false
+		"v3": false,
+		/// Enable the usage of V3 workspace APIs.
+		"ws3": false
 	},
 	// Allows for additional "connect-src" hosts to be included. Requires app restart.
 	"extraCsp": {

crates/but-settings/src/api.rs

@@ -16,6 +16,7 @@ pub struct TelemetryUpdate {
 /// Update request for [`crate::app_settings::FeatureFlags`].
 pub struct FeatureFlagsUpdate {
     pub v3: Option<bool>,
+    pub ws3: Option<bool>,
 }
 
 /// Mutation, immediately followed by writing everything to disk.
@@ -40,11 +41,17 @@ impl AppSettingsWithDiskSync {
         settings.save()
     }
 
-    pub fn update_feature_flags(&self, update: FeatureFlagsUpdate) -> Result<()> {
+    pub fn update_feature_flags(
+        &self,
+        FeatureFlagsUpdate { v3, ws3 }: FeatureFlagsUpdate,
+    ) -> Result<()> {
         let mut settings = self.get_mut_enforce_save()?;
-        if let Some(v3) = update.v3 {
+        if let Some(v3) = v3 {
             settings.feature_flags.v3 = v3;
         }
+        if let Some(ws3) = ws3 {
+            settings.feature_flags.ws3 = ws3;
+        }
         settings.save()
     }
 }

crates/but-settings/src/app_settings.rs

@@ -23,6 +23,8 @@ pub struct GitHubOAuthAppSettings {
 pub struct FeatureFlags {
     /// Enables the v3 design, as well as the purgatory mode (no uncommitted diff ownership assignments).
     pub v3: bool,
+    /// Enable the usage of V3 workspace APIs.
+    pub ws3: bool,
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]

crates/gitbutler-tauri/src/workspace.rs

@@ -9,13 +9,13 @@ use but_hunk_dependency::ui::{
 use but_settings::AppSettingsWithDiskSync;
 use but_workspace::commit_engine::StackSegmentId;
 use but_workspace::MoveChangesResult;
-use but_workspace::{commit_engine, ui::StackEntry};
+use but_workspace::{commit_engine, ui::StackEntry, VirtualBranchesTomlMetadata};
 use gitbutler_branch_actions::{update_workspace_commit, BranchManagerExt};
 use gitbutler_command_context::CommandContext;
 use gitbutler_oplog::entry::{OperationKind, SnapshotDetails};
 use gitbutler_oplog::{OplogExt, SnapshotExt};
 use gitbutler_project as projects;
-use gitbutler_project::ProjectId;
+use gitbutler_project::{Project, ProjectId};
 use gitbutler_stack::{StackId, VirtualBranchesHandle};
 use serde::Serialize;
 use tauri::State;
@@ -32,8 +32,13 @@ pub fn stacks(
     let project = projects.get(project_id)?;
     let ctx = CommandContext::open(&project, settings.get()?.clone())?;
     let repo = ctx.gix_repo()?;
-    but_workspace::stacks(&ctx, &project.gb_dir(), &repo, filter.unwrap_or_default())
-        .map_err(Into::into)
+    if ctx.app_settings().feature_flags.ws3 {
+        let meta = ref_metadata_toml(ctx.project())?;
+        but_workspace::stacks_v3(&repo, &meta, filter.unwrap_or_default())
+    } else {
+        but_workspace::stacks(&ctx, &project.gb_dir(), &repo, filter.unwrap_or_default())
+    }
+    .map_err(Into::into)
 }
 
 #[tauri::command(async)]
@@ -46,7 +51,14 @@ pub fn stack_details(
 ) -> Result<but_workspace::ui::StackDetails, Error> {
     let project = projects.get(project_id)?;
     let ctx = CommandContext::open(&project, settings.get()?.clone())?;
-    but_workspace::stack_details(&project.gb_dir(), stack_id, &ctx).map_err(Into::into)
+    if ctx.app_settings().feature_flags.ws3 {
+        let repo = ctx.gix_repo()?;
+        let meta = ref_metadata_toml(ctx.project())?;
+        but_workspace::stack_details_v3(stack_id, &repo, &meta)
+    } else {
+        but_workspace::stack_details(&project.gb_dir(), stack_id, &ctx)
+    }
+    .map_err(Into::into)
 }
 
 #[tauri::command(async)]
@@ -60,7 +72,28 @@ pub fn branch_details(
 ) -> Result<but_workspace::ui::BranchDetails, Error> {
     let project = projects.get(project_id)?;
     let ctx = CommandContext::open(&project, settings.get()?.clone())?;
-    but_workspace::branch_details(&project.gb_dir(), branch_name, remote, &ctx).map_err(Into::into)
+    if ctx.app_settings().feature_flags.ws3 {
+        let repo = ctx.gix_repo()?;
+        let meta = ref_metadata_toml(ctx.project())?;
+        let ref_name: gix::refs::FullName = match remote {
+            None => {
+                format!("refs/heads/{branch_name}")
+            }
+            Some(remote) => {
+                format!("refs/remotes/{remote}/{branch_name}")
+            }
+        }
+        .try_into()
+        .map_err(anyhow::Error::from)?;
+        but_workspace::branch_details_v3(&repo, ref_name.as_ref(), &meta)
+    } else {
+        but_workspace::branch_details(&project.gb_dir(), branch_name, remote, &ctx)
+    }
+    .map_err(Into::into)
+}
+
+fn ref_metadata_toml(project: &Project) -> anyhow::Result<VirtualBranchesTomlMetadata> {
+    VirtualBranchesTomlMetadata::from_path(project.gb_dir().join("virtual_branches.toml"))
 }
 
 /// Retrieve all changes in the workspace and associate them with commits in the Workspace of `project_id`.