fix: gix 0.73 breaking changes

jpgrayson · jpgrayson · commit 41aeda52eb27 · 2025-08-10T23:25:04.000-04:00
The SignatureRef has changed in gix such that parsing of the time field
is now deferred and fallible.

These changes account for that fallibility and use owned Signature
instances in a variety of contexts where SignatureRef can no longer be
used conveniently.
diff --git a/src/cmd/export.rs b/src/cmd/export.rs
@@ -233,7 +233,12 @@ fn run(matches: &clap::ArgMatches) -> Result<()> {
         replacements.insert("authemail", Cow::Borrowed(author.email));
         replacements.insert(
             "authdate",
-            Cow::Owned(author.time.format(gix::date::time::format::ISO8601).into()),
+            Cow::Owned(
+                author
+                    .time()?
+                    .format(gix::date::time::format::ISO8601)
+                    .into(),
+            ),
         );
         let committer = patch_commit.committer()?;
         replacements.insert("commname", Cow::Borrowed(committer.name));
@@ -242,7 +247,7 @@ fn run(matches: &clap::ArgMatches) -> Result<()> {
             "commdate",
             Cow::Owned(
                 committer
-                    .time
+                    .time()?
                     .format(gix::date::time::format::ISO8601)
                     .into(),
             ),
diff --git a/src/cmd/import.rs b/src/cmd/import.rs
@@ -599,10 +599,10 @@ fn create_patch<'repo>(
             gix::actor::Signature {
                 name: BString::from(name),
                 email: BString::from(email),
-                time: default_author.time,
+                time: default_author.time()?,
             }
         } else {
-            default_author.to_owned()
+            default_author.to_owned()?
         }
     };
 
diff --git a/src/cmd/new.rs b/src/cmd/new.rs
@@ -195,7 +195,7 @@ fn run(matches: &ArgMatches) -> Result<()> {
         .allow_implicit_edit(true)
         .allow_template_save(!is_refreshing)
         .original_patchname(patchname.as_ref())
-        .default_author(repo.get_author()?.override_author(matches))
+        .default_author(repo.get_author()?.override_author(matches)?)
         .override_tree_id(tree_id)
         .override_parent_id(parent_id)
         .edit(&stack, &repo, matches)?
diff --git a/src/cmd/pick.rs b/src/cmd/pick.rs
@@ -314,11 +314,11 @@ fn pick_picks(
         let author = commit.author_strict()?;
         let default_committer = stack.repo.get_committer()?;
         let committer = if matches.get_flag("committer-date-is-author-date") {
-            let mut committer = default_committer.to_owned();
+            let mut committer = default_committer.to_owned()?;
             committer.time = author.time;
             committer
         } else {
-            default_committer.to_owned()
+            default_committer.to_owned()?
         };
         let parent = if let Some(parent) = opt_parent.as_ref() {
             parent.clone()
diff --git a/src/cmd/refresh.rs b/src/cmd/refresh.rs
@@ -180,9 +180,11 @@ fn run(matches: &ArgMatches) -> Result<()> {
     let opt_annotate = matches.get_one::<String>("annotate");
 
     // Make temp patch
+    let overridden_author = repo.get_author()?.override_author(matches)?;
+    let committer = repo.get_committer()?.to_owned()?;
     let temp_commit_id = stack.repo.commit_ex(
-        &repo.get_author()?.override_author(matches),
-        repo.get_committer()?,
+        &overridden_author,
+        &committer,
         &Message::from(format!("Refresh of {patchname}")),
         tree_id,
         [stack.get_branch_head().id],
diff --git a/src/cmd/spill.rs b/src/cmd/spill.rs
@@ -101,11 +101,11 @@ fn run(matches: &ArgMatches) -> Result<()> {
     let author = patch_commit.author_strict()?;
     let default_committer = repo.get_committer()?;
     let committer = if matches.get_flag("committer-date-is-author-date") {
-        let mut committer = default_committer.to_owned();
+        let mut committer = default_committer.to_owned()?;
         committer.time = author.time;
         committer
     } else {
-        default_committer.to_owned()
+        default_committer.to_owned()?
     };
 
     let commit_id = repo.commit_ex(
diff --git a/src/cmd/squash.rs b/src/cmd/squash.rs
@@ -110,7 +110,7 @@ fn run(matches: &ArgMatches) -> Result<()> {
                 .allow_diff_edit(false)
                 .allow_template_save(true)
                 .template_patchname(patchname.as_ref())
-                .default_author(repo.get_author()?.override_author(matches))
+                .default_author(repo.get_author()?.override_author(matches)?)
                 .default_message(prepare_message(&stack, &squash_patchnames)?)
                 .edit(&stack, &repo, matches)?
         {
@@ -271,7 +271,7 @@ fn try_squash(
                 } else {
                     repo.get_author()?
                 }
-                .override_author(matches),
+                .override_author(matches)?,
             )
             .default_message(prepare_message(trans, patchnames)?)
             .edit(trans, repo, matches)?
diff --git a/src/cmd/sync.rs b/src/cmd/sync.rs
@@ -225,11 +225,11 @@ fn run(matches: &clap::ArgMatches) -> Result<()> {
                     let author = commit.author_strict()?;
                     let default_committer = trans.repo().get_committer()?;
                     let committer = if matches.get_flag("committer-date-is-author-date") {
-                        let mut committer = default_committer.to_owned();
+                        let mut committer = default_committer.to_owned()?;
                         committer.time = author.time;
                         committer
                     } else {
-                        default_committer.to_owned()
+                        default_committer.to_owned()?
                     };
                     let commit_id = trans.repo().commit_ex(
                         &author,
diff --git a/src/ext/commit.rs b/src/ext/commit.rs
@@ -53,7 +53,7 @@ impl<'a> CommitExtended<'a> for gix::Commit<'a> {
                 Ok(gix::actor::Signature {
                     name: BString::from(name.as_ref()),
                     email: BString::from(email.as_ref()),
-                    time: sig.time,
+                    time: sig.time()?,
                 })
             } else {
                 Err(anyhow!(
diff --git a/src/ext/repository.rs b/src/ext/repository.rs
@@ -53,10 +53,10 @@ pub(crate) trait RepositoryExtended {
     ///
     /// - Respecting `i18n.commitEncoding` for commit messages.
     /// - Respecting `commit.gpgSign` and creating signed commits when enabled.
-    fn commit_ex<'a>(
+    fn commit_ex(
         &self,
-        author: impl Into<gix::actor::SignatureRef<'a>>,
-        committer: impl Into<gix::actor::SignatureRef<'a>>,
+        author: &gix::actor::Signature,
+        committer: &gix::actor::Signature,
         message: &Message,
         tree_id: gix::ObjectId,
         parent_ids: impl IntoIterator<Item = gix::ObjectId>,
@@ -66,10 +66,10 @@ pub(crate) trait RepositoryExtended {
     ///
     /// The provided [`CommitOptions`] gives finer-grained control versus
     /// [`RepositoryExtended::commit_ex()`].
-    fn commit_with_options<'a>(
+    fn commit_with_options(
         &self,
-        author: impl Into<gix::actor::SignatureRef<'a>>,
-        committer: impl Into<gix::actor::SignatureRef<'a>>,
+        author: &gix::actor::Signature,
+        committer: &gix::actor::Signature,
         message: &Message,
         tree_id: gix::ObjectId,
         parent_ids: impl IntoIterator<Item = gix::ObjectId>,
@@ -195,10 +195,10 @@ impl RepositoryExtended for gix::Repository {
         Ok(())
     }
 
-    fn commit_ex<'a>(
+    fn commit_ex(
         &self,
-        author: impl Into<gix::actor::SignatureRef<'a>>,
-        committer: impl Into<gix::actor::SignatureRef<'a>>,
+        author: &gix::actor::Signature,
+        committer: &gix::actor::Signature,
         message: &Message,
         tree_id: gix::ObjectId,
         parent_ids: impl IntoIterator<Item = gix::ObjectId>,
@@ -219,17 +219,15 @@ impl RepositoryExtended for gix::Repository {
         )
     }
 
-    fn commit_with_options<'a>(
+    fn commit_with_options(
         &self,
-        author: impl Into<gix::actor::SignatureRef<'a>>,
-        committer: impl Into<gix::actor::SignatureRef<'a>>,
+        author: &gix::actor::Signature,
+        committer: &gix::actor::Signature,
         message: &Message,
         tree_id: gix::ObjectId,
         parent_ids: impl IntoIterator<Item = gix::ObjectId>,
         options: &CommitOptions<'_>,
     ) -> Result<gix::ObjectId> {
-        let author = author.into();
-        let committer = committer.into();
         let commit_encoding = match &options.commit_encoding {
             Some(s) => {
                 let encoding = encoding_rs::Encoding::for_label(s)
@@ -256,7 +254,7 @@ impl RepositoryExtended for gix::Repository {
             let commit_id = self.write_object(&gix::objs::Commit {
                 tree: tree_id,
                 parents: parent_ids.into_iter().collect(),
-                author: author.to_owned(),
+                author: author.clone(),
                 committer: committer.to_owned(),
                 encoding: commit_encoding.map(|enc| enc.name().into()),
                 message: message.raw_bytes().into(),
diff --git a/src/ext/signature.rs b/src/ext/signature.rs
@@ -2,6 +2,7 @@
 
 //! Extension trait for [`gix::actor::Signature`].
 
+use anyhow::Result;
 use bstr::BString;
 
 /// Extend [`gix::actor::Signature`] with additional methods.
@@ -13,11 +14,11 @@ pub(crate) trait SignatureExtended {
     ///
     /// The provided `matches` must come from a [`clap::Command`] setup with
     /// [`crate::patch::edit::add_args()`].
-    fn override_author(self, matches: &clap::ArgMatches) -> gix::actor::Signature;
+    fn override_author(self, matches: &clap::ArgMatches) -> Result<gix::actor::Signature>;
 }
 
 impl SignatureExtended for gix::actor::Signature {
-    fn override_author(self, matches: &clap::ArgMatches) -> gix::actor::Signature {
+    fn override_author(self, matches: &clap::ArgMatches) -> Result<gix::actor::Signature> {
         let time = matches
             .get_one::<gix::date::Time>("authdate")
             .copied()
@@ -37,16 +38,16 @@ impl SignatureExtended for gix::actor::Signature {
                     .unwrap_or(self.email);
                 (name, email)
             };
-        gix::actor::Signature { name, email, time }
+        Ok(gix::actor::Signature { name, email, time })
     }
 }
 
 impl SignatureExtended for gix::actor::SignatureRef<'_> {
-    fn override_author(self, matches: &clap::ArgMatches) -> gix::actor::Signature {
+    fn override_author(self, matches: &clap::ArgMatches) -> Result<gix::actor::Signature> {
         let time = matches
             .get_one::<gix::date::Time>("authdate")
             .copied()
-            .unwrap_or(self.time);
+            .map_or_else(|| self.time(), Ok)?;
 
         let (name, email) =
             if let Some((name, email)) = matches.get_one::<(String, String)>("author") {
@@ -62,6 +63,6 @@ impl SignatureExtended for gix::actor::SignatureRef<'_> {
                     .unwrap_or_else(|| self.email.to_owned());
                 (name, email)
             };
-        gix::actor::Signature { name, email, time }
+        Ok(gix::actor::Signature { name, email, time })
     }
 }
diff --git a/src/ext/time.rs b/src/ext/time.rs
@@ -58,15 +58,13 @@ mod tests {
         let time = Time::parse_time("123456 +0600").unwrap();
         assert_eq!(time.seconds, 123456);
         assert_eq!(time.offset, 6 * 60 * 60);
-        assert!(matches!(time.sign, gix::date::time::Sign::Plus));
     }
 
     #[test]
     fn test_parse_raw_notz() {
         let time = Time::parse_time("123456").unwrap();
         assert_eq!(time.seconds, 123456);
         assert_eq!(time.offset, 0);
-        assert!(matches!(time.sign, gix::date::time::Sign::Plus));
     }
 
     #[test]
@@ -101,7 +99,6 @@ mod tests {
         let time = Time::parse_time("123456 -0230").unwrap();
         assert_eq!(time.seconds, 123456);
         assert_eq!(time.offset, -150 * 60);
-        assert!(matches!(time.sign, gix::date::time::Sign::Minus));
     }
 
     #[test]
diff --git a/src/patch/edit/mod.rs b/src/patch/edit/mod.rs
@@ -261,7 +261,7 @@ impl<'a, 'repo> EditBuilder<'a, 'repo> {
         let author = if let Some(Some(author)) = file_author {
             Some(author)
         } else if let Some(overlay_author) = overlay_author {
-            Some(overlay_author.override_author(matches))
+            Some(overlay_author.override_author(matches)?)
         } else {
             // Problem: the patch commit, which may not have been created by StGit,
             // may have mal-encoded author. I.e. the author is not encoded with the
@@ -273,11 +273,12 @@ impl<'a, 'repo> EditBuilder<'a, 'repo> {
             // existing patch commit's author is broken, but only if the author
             // signature has to be derived from that commit.
             let patch_commit = patch_commit.expect("existing patch or author overlay is required");
-            if let Some(args_author) = author_from_args(matches, Some(patch_commit.author()?.time))?
+            if let Some(args_author) =
+                author_from_args(matches, Some(patch_commit.author()?.time()?))?
             {
                 Some(args_author)
             } else {
-                Some(patch_commit.author_strict()?.override_author(matches))
+                Some(patch_commit.author_strict()?.override_author(matches)?)
             }
         };
 
@@ -473,7 +474,7 @@ impl<'a, 'repo> EditBuilder<'a, 'repo> {
                 Some(None) => Some(if let Some(commit) = patch_commit {
                     commit.author_strict()?
                 } else {
-                    repo.get_author()?.to_owned()
+                    repo.get_author()?.to_owned()?
                 }),
                 None => patch_description.author.take(),
             };
@@ -543,11 +544,11 @@ impl<'a, 'repo> EditBuilder<'a, 'repo> {
         };
 
         let committer = if matches.get_flag("committer-date-is-author-date") {
-            let mut committer = default_committer.to_owned();
+            let mut committer = default_committer.to_owned()?;
             committer.time = author.time;
             committer
         } else {
-            default_committer.to_owned()
+            default_committer.to_owned()?
         };
 
         let new_commit_id = if patch_commit
@@ -558,7 +559,7 @@ impl<'a, 'repo> EditBuilder<'a, 'repo> {
                 // N.B.: intentionally not comparing commiter.when()
                 && patch_commit_ref.author().name == author.name
                 && patch_commit_ref.author().email == author.email
-                && patch_commit_ref.author().time == author.time
+                && patch_commit_ref.author().time == author.time.to_string()
                 && patch_commit_ref.message == message.raw_bytes()
                 && patch_commit_ref.tree() == tree_id
                 && patch_commit_ref.parents().next() == Some(parent_id)
diff --git a/src/stack/state.rs b/src/stack/state.rs
@@ -209,8 +209,8 @@ impl<'repo> StackState<'repo> {
             (self.make_tree(repo, None)?, None)
         };
         let config = repo.config_snapshot();
-        let committer = repo.get_committer()?;
-        let author = repo.get_author()?;
+        let committer = repo.get_committer()?.to_owned()?;
+        let author = repo.get_author()?.to_owned()?;
 
         let simplified_parents: Vec<gix::ObjectId> = match &self.prev {
             Some(prev_commit) => {
@@ -231,8 +231,8 @@ impl<'repo> StackState<'repo> {
         };
 
         let simplified_parent_id = repo.commit_with_options(
-            author,
-            committer,
+            &author,
+            &committer,
             &message,
             state_tree_id,
             simplified_parents,
@@ -263,8 +263,8 @@ impl<'repo> StackState<'repo> {
             let parent_group_oids =
                 parent_oids.drain(parent_oids.len() - MAX_PARENTS..parent_oids.len());
             let group_oid = repo.commit_with_options(
-                author,
-                committer,
+                &author,
+                &committer,
                 &Message::from("parent grouping"),
                 state_tree_id,
                 parent_group_oids,
@@ -276,8 +276,8 @@ impl<'repo> StackState<'repo> {
         parent_oids.insert(0, simplified_parent_id);
 
         let commit_oid = repo.commit_with_options(
-            author,
-            committer,
+            &author,
+            &committer,
             &message,
             state_tree_id,
             parent_oids,
diff --git a/src/stack/transaction/mod.rs b/src/stack/transaction/mod.rs
diff --git a/src/stupid/context.rs b/src/stupid/context.rs

Original file line number	Diff line number	Diff line change
`@@ -599,10 +599,10 @@ fn create_patch<'repo>(`
`599`	`599`	`gix::actor::Signature {`
`600`	`600`	`name: BString::from(name),`
`601`	`601`	`email: BString::from(email),`
`602`		`- time: default_author.time,`
	`602`	`+ time: default_author.time()?,`
`603`	`603`	`}`
`604`	`604`	`} else {`
`605`		`- default_author.to_owned()`
	`605`	`+ default_author.to_owned()?`
`606`	`606`	`}`
`607`	`607`	`};`
`608`	`608`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ fn run(matches: &ArgMatches) -> Result<()> {`
`110`	`110`	`.allow_diff_edit(false)`
`111`	`111`	`.allow_template_save(true)`
`112`	`112`	`.template_patchname(patchname.as_ref())`
`113`		`- .default_author(repo.get_author()?.override_author(matches))`
	`113`	`+ .default_author(repo.get_author()?.override_author(matches)?)`
`114`	`114`	`.default_message(prepare_message(&stack, &squash_patchnames)?)`
`115`	`115`	`.edit(&stack, &repo, matches)?`
`116`	`116`	`{`
`@@ -271,7 +271,7 @@ fn try_squash(`
`271`	`271`	`} else {`
`272`	`272`	`repo.get_author()?`
`273`	`273`	`}`
`274`		`- .override_author(matches),`
	`274`	`+ .override_author(matches)?,`
`275`	`275`	`)`
`276`	`276`	`.default_message(prepare_message(trans, patchnames)?)`
`277`	`277`	`.edit(trans, repo, matches)?`