fix(template): correctly serialize JSON for the commit fields (#1145)

ognis1205 · web-flow · commit e981e1d1b27a · 2025-05-15T12:01:42.000+03:00
* fix: JSON serialization issue in Commit::parse

Signed-off-by: Shingo OKAWA &lt;shingo.okawa.g.h.c@gmail.com&gt;

* test: add unittests for Commit::parse

Signed-off-by: Shingo OKAWA &lt;shingo.okawa.g.h.c@gmail.com&gt;

* test: add unittests for Commit::parse

Signed-off-by: Shingo OKAWA &lt;shingo.okawa.g.h.c@gmail.com&gt;

---------

Signed-off-by: Shingo OKAWA &lt;shingo.okawa.g.h.c@gmail.com&gt;
diff --git a/git-cliff-core/src/commit.rs b/git-cliff-core/src/commit.rs
@@ -335,16 +335,24 @@ impl Commit<'_> {
 				let value = if field_name == "body" {
 					body.clone()
 				} else {
-					tera::dotted_pointer(&lookup_context, field_name)
-						.map(|v| v.to_string())
+					tera::dotted_pointer(&lookup_context, field_name).and_then(|v| {
+						match &v {
+							Value::String(s) => Some(s.clone()),
+							Value::Number(_) | Value::Bool(_) | Value::Null => {
+								Some(v.to_string())
+							}
+							_ => None,
+						}
+					})
 				};
 				match value {
 					Some(value) => {
 						regex_checks.push((pattern_regex, value));
 					}
 					None => {
 						return Err(AppError::FieldError(format!(
-							"field {field_name} does not have a value",
+							"field '{field_name}' is missing or has unsupported \
+							 type (expected String, Number, Bool, or Null)",
 						)));
 					}
 				}
@@ -709,7 +717,7 @@ mod test {
 	}
 
 	#[test]
-	fn parse_commit_field() -> Result<()> {
+	fn parse_commit_fields() -> Result<()> {
 		let mut commit = Commit::new(
 			String::from("8f55e69eba6e6ce811ace32bd84cc82215673cb6"),
 			String::from("feat: do something"),
@@ -721,7 +729,15 @@ mod test {
 			timestamp: 0x0,
 		};
 
-		let parsed_commit = commit.parse(
+		commit.remote = Some(crate::contributor::RemoteContributor {
+			username:      None,
+			pr_title:      Some("feat: do something".to_string()),
+			pr_number:     None,
+			pr_labels:     Vec::new(),
+			is_first_time: true,
+		});
+
+		let parsed_commit = commit.clone().parse(
 			&[CommitParser {
 				sha:           None,
 				message:       None,
@@ -739,6 +755,49 @@ mod test {
 		)?;
 
 		assert_eq!(Some(String::from("Test group")), parsed_commit.group);
+
+		let parsed_commit = commit.clone().parse(
+			&[CommitParser {
+				sha:           None,
+				message:       None,
+				body:          None,
+				footer:        None,
+				group:         Some(String::from("Test group")),
+				default_scope: None,
+				scope:         None,
+				skip:          None,
+				field:         Some(String::from("remote.pr_title")),
+				pattern:       Regex::new("^feat").ok(),
+			}],
+			false,
+			false,
+		)?;
+
+		assert_eq!(Some(String::from("Test group")), parsed_commit.group);
+
+		let parse_result = commit.clone().parse(
+			&[CommitParser {
+				sha:           None,
+				message:       None,
+				body:          None,
+				footer:        None,
+				group:         Some(String::from("Invalid group")),
+				default_scope: None,
+				scope:         None,
+				skip:          None,
+				field:         Some(String::from("remote.pr_labels")),
+				pattern:       Regex::new(".*").ok(),
+			}],
+			false,
+			false,
+		);
+
+		assert!(
+			parse_result.is_err(),
+			"Expected error when using unsupported field `remote.pr_labels`, but \
+			 got Ok"
+		);
+
 		Ok(())
 	}
 
