Merge pull request #10962 from gitbutlerapp/kv-branch-63

fix(commit): always read CHANGE_ID env or generate UUID by default

Author: krlvi

crates/but-cherry-apply/tests/fixtures/cherry_apply.sh

@@ -13,12 +13,12 @@ git init remote
   git add . && git commit -m "init"
 )
 
-CHANGE_ID=0
+GITBUTLER_CHANGE_ID=0
 function commit_stack() {
   local stack="${1:?}"
   local message="${2:?}"
-  ((CHANGE_ID += 1))
-  CHANGE_ID=$CHANGE_ID $CLI branch commit "$stack" -m "$message"
+  ((GITBUTLER_CHANGE_ID += 1))
+  GITBUTLER_CHANGE_ID=$GITBUTLER_CHANGE_ID $CLI branch commit "$stack" -m "$message"
 }
 
 export GITBUTLER_CLI_DATA_DIR=../user/gitbutler/app-data

crates/but-core/src/commit.rs

@@ -96,9 +96,7 @@ impl Default for HeadersV2 {
         HeadersV2 {
             // Change ID using base16 encoding
             change_id: if cfg!(feature = "testing") {
-                // TODO: remove the CHANGE_ID dependency, but old tests still need it.
-                //       In future, the 'testing' feature alone should be enough.
-                if std::env::var("CHANGE_ID").is_ok() {
+                if std::env::var("GITBUTLER_CHANGE_ID").is_ok() {
                     ChangeId::from_number_for_testing(1)
                 } else {
                     ChangeId::generate()

crates/but-hunk-dependency/tests/fixtures/dependencies.sh

@@ -8,12 +8,12 @@ git init remote
   git add . && git commit -m "init"
 )
 
-CHANGE_ID=0
+GITBUTLER_CHANGE_ID=0
 function commit_stack() {
   local stack="${1:?}"
   local message="${2:?}"
-  ((CHANGE_ID += 1))
-  CHANGE_ID=$CHANGE_ID $CLI branch commit "$stack" -m "$message"
+  ((GITBUTLER_CHANGE_ID += 1))
+  GITBUTLER_CHANGE_ID=$GITBUTLER_CHANGE_ID $CLI branch commit "$stack" -m "$message"
 }
 
 export GITBUTLER_CLI_DATA_DIR=../user/gitbutler/app-data
@@ -499,8 +499,8 @@ add this line
 
   # Update the project.
   git fetch origin
-  ((CHANGE_ID += 1))
-  CHANGE_ID=$CHANGE_ID $CLI integrate-upstream merge
+  ((GITBUTLER_CHANGE_ID += 1))
+  GITBUTLER_CHANGE_ID=$GITBUTLER_CHANGE_ID $CLI integrate-upstream merge
 
   echo "1
 2

crates/but-testsupport/src/lib.rs

@@ -115,7 +115,7 @@ pub fn assure_stable_env() {
         .set("GIT_COMMITTER_DATE", "2000-01-02 00:00:00 +0000")
         .set("GIT_COMMITTER_EMAIL", "[email protected]")
         .set("GIT_COMMITTER_NAME", "committer (From Env)")
-        .set("CHANGE_ID", "change-id");
+        .set("GITBUTLER_CHANGE_ID", "change-id");
     // assure it doesn't get racy.
     std::mem::forget(env);
 }

crates/but-worktrees/tests/fixtures/worktree.sh

@@ -29,7 +29,7 @@ function tick () {
 git clone remote stacked-and-parallel
 (cd stacked-and-parallel
   tick
-  export CHANGE_ID=851ad981-c986-4bb4-8be9-deadbeefeba2
+  export GITBUTLER_CHANGE_ID=851ad981-c986-4bb4-8be9-deadbeefeba2
 
   git config user.name "Author"
   git config user.email "[email protected]"
@@ -63,7 +63,7 @@ git clone remote stacked-and-parallel
 git clone remote stacked-branches
 (cd stacked-branches
   tick
-  export CHANGE_ID=851ad981-c986-4bb4-8be9-deadbeefeba2
+  export GITBUTLER_CHANGE_ID=851ad981-c986-4bb4-8be9-deadbeefeba2
 
   git config user.name "Author"
   git config user.email "[email protected]"
@@ -84,4 +84,4 @@ git clone remote stacked-branches
   $CLI commit -m "feature-b: add line 1" feature-b
   echo "feature-b line 2" > bar.txt
   $CLI commit -m "feature-b: add line 2" feature-b
-)
+)

crates/but/tests/but/utils.rs

@@ -182,7 +182,7 @@ impl Sandbox {
             cmd = cmd
                 .args(shell_words::split(args).expect("statically known args must split correctly"))
         }
-        self.with_updated_env(cmd).env("CHANGE_ID", "42")
+        self.with_updated_env(cmd).env("GITBUTLER_CHANGE_ID", "42")
     }
 
     /// Invoke an isolated `git` with the given `args`, which will be split automatically.

crates/gitbutler-commit/src/commit_headers.rs

@@ -36,17 +36,8 @@ impl Default for CommitHeadersV2 {
     fn default() -> Self {
         CommitHeadersV2 {
             // Change ID using base16 encoding
-            change_id: if cfg!(feature = "testing") {
-                std::env::var("CHANGE_ID").unwrap_or_else(|_| {
-                    eprintln!(
-                        "With 'testing' feature the `CHANGE_ID` \
-environment variable can be set have stable values"
-                    );
-                    Uuid::new_v4().to_string()
-                })
-            } else {
-                Uuid::new_v4().to_string()
-            },
+            change_id: std::env::var("GITBUTLER_CHANGE_ID")
+                .unwrap_or_else(|_| Uuid::new_v4().to_string()),
             conflicted: None,
         }
     }