fix: implement custom serialization for Extension.minimum_coco_version (#1010)

SteveLauC · web-flow · commit 65a48efdde7a · 2025-12-16T15:29:36.000+08:00
Coco's version string does not adhere to semver's spec, so we had to
write a custom deserialization impl to do the conversion:

```
0.9.1-SNPASHOT-2560 =&gt; 0.9.1-SNAPSHOT.2560
```

But we forget to serialize versions to Coco's format when writing
extensions to disk. When Coco reads extension from disk, it sees
valid semantic versions, which are not expected:

```
[WAR] [third_party:167] invalid extension: [base64-converter]:
  field [minimum_coco_version] has invalid version:
    failed to parse build number 'SNAPSHOT.2560'', caused by: ['invalid digit found in string']
```

This commit provides a custom serialization impl to fix the issue.
diff --git a/docs/content.en/docs/release-notes/_index.md b/docs/content.en/docs/release-notes/_index.md
@@ -16,6 +16,7 @@ Information about release notes of Coco App is provided here.
 ### 🐛 Bug fix
 
 - fix: fix the abnormal input height issue #1006
+- fix: implement custom serialization for Extension.minimum_coco_version #1010
 
 ### ✈️ Improvements
 
diff --git a/src-tauri/src/extension/mod.rs b/src-tauri/src/extension/mod.rs
@@ -135,7 +135,9 @@ pub struct Extension {
     /// It is only for third-party extensions. Built-in extensions should always
     /// set this field to `None`.
     #[serde(deserialize_with = "deserialize_coco_semver")]
-    #[serde(default)] // None if this field is missing
+    #[serde(serialize_with = "serialize_coco_semver")]
+    // None if this field is missing, required as we use custom deserilize method.
+    #[serde(default)]
     minimum_coco_version: Option<SemVer>,
 
     /*
@@ -419,6 +421,37 @@ where
     Ok(Some(semver))
 }
 
+/// Serialize Coco SemVer to a string.
+///
+/// For a `SemVer`, there are 2 possible input cases, guarded by `to_semver()`:
+///
+/// 1. "x.y.z" => "x.y.z"
+/// 2. "x.y.z-SNAPSHOT.2560" => "x.y.z-SNAPSHOT-2560"
+fn serialize_coco_semver<S>(version: &Option<SemVer>, serializer: S) -> Result<S::Ok, S::Error>
+where
+    S: serde::Serializer,
+{
+    match version {
+        Some(v) => {
+            assert!(v.build.is_empty());
+
+            let s = if v.pre.is_empty() {
+                format!("{}.{}.{}", v.major, v.minor, v.patch)
+            } else {
+                format!(
+                    "{}.{}.{}-{}",
+                    v.major,
+                    v.minor,
+                    v.patch,
+                    v.pre.as_str().replace('.', "-")
+                )
+            };
+            serializer.serialize_str(&s)
+        }
+        None => serializer.serialize_none(),
+    }
+}
+
 #[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
 pub(crate) struct CommandAction {
     pub(crate) exec: String,
@@ -2150,4 +2183,31 @@ mod tests {
         let deserialized: FileSystemAccess = serde_json::from_str(&serialized).unwrap();
         assert_eq!(original, deserialized);
     }
+
+    #[test]
+    fn test_serialize_coco_semver_none() {
+        let version: Option<SemVer> = None;
+        let mut serializer = serde_json::Serializer::new(Vec::new());
+        serialize_coco_semver(&version, &mut serializer).unwrap();
+        let serialized = String::from_utf8(serializer.into_inner()).unwrap();
+        assert_eq!(serialized, "null");
+    }
+
+    #[test]
+    fn test_serialize_coco_semver_simple() {
+        let version: Option<SemVer> = Some(SemVer::parse("1.2.3").unwrap());
+        let mut serializer = serde_json::Serializer::new(Vec::new());
+        serialize_coco_semver(&version, &mut serializer).unwrap();
+        let serialized = String::from_utf8(serializer.into_inner()).unwrap();
+        assert_eq!(serialized, "\"1.2.3\"");
+    }
+
+    #[test]
+    fn test_serialize_coco_semver_with_pre() {
+        let version: Option<SemVer> = Some(SemVer::parse("1.2.3-SNAPSHOT.1234").unwrap());
+        let mut serializer = serde_json::Serializer::new(Vec::new());
+        serialize_coco_semver(&version, &mut serializer).unwrap();
+        let serialized = String::from_utf8(serializer.into_inner()).unwrap();
+        assert_eq!(serialized, "\"1.2.3-SNAPSHOT-1234\"");
+    }
 }
