feat: Add JSON de- and serialization of patches

src/main/kotlin/app/revanced/library/Options.kt

@@ -9,6 +9,7 @@ import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import java.io.File
 import java.util.logging.Logger
 
+@Suppress("unused")
 object Options {
     private val logger = Logger.getLogger(Options::class.java.name)
 

src/main/kotlin/app/revanced/library/PatchUtils.kt

@@ -1,7 +1,12 @@
 package app.revanced.library
 
+import app.revanced.patcher.PatchClass
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.options.PatchOption
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import java.io.InputStream
+import java.io.OutputStream
 
 typealias PackageName = String
 typealias Version = String
@@ -90,4 +95,104 @@ object PatchUtils {
                         .associate { it.key to it.value } as VersionMap
             }
         }
+
+    object Json {
+        private val mapper = jacksonObjectMapper()
+
+        /**
+         * Serializes a set of [Patch]es to a JSON string and writes it to an output stream.
+         *
+         * @param patches The set of [Patch]es to serialize.
+         * @param transform A function to transform the [Patch]es to [JsonPatch]es.
+         * @param prettyPrint Whether to pretty print the JSON.
+         * @param outputStream The output stream to write the JSON to.
+         */
+        fun serialize(
+            patches: PatchSet,
+            transform: (Patch<*>) -> JsonPatch = { patch -> FullJsonPatch.fromPatch(patch) },
+            prettyPrint: Boolean = false,
+            outputStream: OutputStream,
+        ) {
+            patches.map(transform).let { transformed ->
+                if (prettyPrint) {
+                    mapper.writerWithDefaultPrettyPrinter().writeValue(outputStream, transformed)
+                } else {
+                    mapper.writeValue(outputStream, transformed)
+                }
+            }
+        }
+
+        /**
+         * Deserializes a JSON string to a set of [FullJsonPatch]es from an input stream.
+         *
+         * @param inputStream The input stream to read the JSON from.
+         * @param jsonPatchElementClass The class of the [JsonPatch]es to deserialize.
+         * @return A set of [JsonPatch]es.
+         * @see FullJsonPatch
+         */
+        fun <T : JsonPatch> deserialize(
+            inputStream: InputStream,
+            jsonPatchElementClass: Class<T>,
+        ): Set<T> =
+            mapper.readValue(
+                inputStream,
+                mapper.typeFactory.constructCollectionType(Set::class.java, jsonPatchElementClass),
+            )
+
+        interface JsonPatch
+
+        /**
+         * A JSON representation of a [Patch].
+         * @see Patch
+         */
+        class FullJsonPatch internal constructor(
+            val name: String?,
+            val description: String?,
+            val compatiblePackages: Set<Patch.CompatiblePackage>?,
+            val dependencies: Set<PatchClass>?,
+            val use: Boolean,
+            var requiresIntegrations: Boolean,
+            val options: Map<String, FullJsonPatchOption<*>>,
+        ) : JsonPatch {
+            companion object {
+                fun fromPatch(patch: Patch<*>) =
+                    FullJsonPatch(
+                        patch.name,
+                        patch.description,
+                        patch.compatiblePackages,
+                        patch.dependencies,
+                        patch.use,
+                        patch.requiresIntegrations,
+                        patch.options.mapValues { FullJsonPatchOption.fromPatchOption(it.value) },
+                    )
+            }
+
+            /**
+             * A JSON representation of a [PatchOption].
+             * @see PatchOption
+             */
+            class FullJsonPatchOption<T> internal constructor(
+                val key: String,
+                val default: T?,
+                val values: Map<String, T?>?,
+                val title: String?,
+                val description: String?,
+                val required: Boolean,
+                val valueType: String,
+            ) {
+                companion object {
+                    fun fromPatchOption(option: PatchOption<*>) =
+                        FullJsonPatchOption(
+                            option.key,
+                            option.default,
+                            option.values,
+                            option.title,
+                            option.description,
+                            option.required,
+                            option.valueType,
+                        )
+                }
+            }
+        }
+    }
 }

src/test/kotlin/app/revanced/library/PatchUtilsTest.kt

@@ -3,19 +3,25 @@ package app.revanced.library
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.booleanPatchOption
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.intArrayPatchOption
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.stringPatchOption
 import org.junit.jupiter.api.Test
+import java.io.ByteArrayInputStream
+import java.io.ByteArrayOutputStream
 import kotlin.test.assertEquals
 
 internal object PatchUtilsTest {
     private val patches =
         arrayOf(
-            newPatch("some.package", setOf("a")),
+            newPatch("some.package", setOf("a")) { stringPatchOption("string", "value") },
             newPatch("some.package", setOf("a", "b"), use = false),
             newPatch("some.package", setOf("a", "b", "c"), use = false),
             newPatch("some.other.package", setOf("b"), use = false),
-            newPatch("some.other.package", setOf("b", "c")),
+            newPatch("some.other.package", setOf("b", "c")) { booleanPatchOption("bool", true) },
             newPatch("some.other.package", setOf("b", "c", "d")),
-            newPatch("some.other.other.package"),
+            newPatch("some.other.other.package") { intArrayPatchOption("intArray", arrayOf(1, 2, 3)) },
             newPatch("some.other.other.package", setOf("a")),
             newPatch("some.other.other.package", setOf("b")),
             newPatch("some.other.other.other.package", use = false),
@@ -135,6 +141,20 @@ internal object PatchUtilsTest {
         assertEqualsVersion(null, patches, "other.package")
     }
 
+    @Test
+    fun `serializes to and deserializes from JSON string correctly`() {
+        val out = ByteArrayOutputStream()
+        PatchUtils.Json.serialize(patches, outputStream = out)
+
+        val deserialized =
+            PatchUtils.Json.deserialize(
+                ByteArrayInputStream(out.toByteArray()),
+                PatchUtils.Json.FullJsonPatch::class.java,
+            )
+
+        assert(patches.size == deserialized.size)
+    }
+
     private fun assertEqualsVersions(
         expected: PackageNameMap,
         patches: PatchSet,
@@ -169,10 +189,16 @@ internal object PatchUtilsTest {
         packageName: String,
         versions: Set<String>? = null,
         use: Boolean = true,
+        options: Patch<*>.() -> Unit = {},
     ) = object : BytecodePatch(
+        name = "test",
         compatiblePackages = setOf(CompatiblePackage(packageName, versions?.toSet())),
         use = use,
     ) {
+        init {
+            options()
+        }
+
         override fun execute(context: BytecodeContext) {}
 
         // Needed to make the patches unique.