chore: Release v1.4.0-dev.6 [skip ci]

# [1.4.0-dev.6](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.5...v1.4.0-dev.6) (2024-11-06)

### Features

* Allow versioning by arbitrary path string ([814d3c9](814d3c946e))
* Remove deprecated routes and old API ([eca40a6](eca40a6979))

CHANGELOG.md

@@ -1,3 +1,11 @@
+# [1.4.0-dev.6](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.5...v1.4.0-dev.6) (2024-11-06)
+
+
+### Features
+
+* Allow versioning by arbitrary path string ([814d3c9](https://github.com/ReVanced/revanced-api/commit/814d3c946e31068e12e3886aa8beb3238ef126ae))
+* Remove deprecated routes and old API ([eca40a6](https://github.com/ReVanced/revanced-api/commit/eca40a69799240f7803aa8851eb3ee961937e4d6))
+
 # [1.4.0-dev.5](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.4...v1.4.0-dev.5) (2024-11-05)
 
 # [1.4.0-dev.4](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.3...v1.4.0-dev.4) (2024-11-01)

README.md

@@ -81,7 +81,6 @@ Some of the features ReVanced API include:
   and links of the hoster of ReVanced API
 - 🧩 **Patches**: Get the latest updates of ReVanced Patches, directly from ReVanced API
 - 👥 **Contributors**: List all contributors involved in the project
-- 🔄 **Backwards compatibility**: Proxy an old API for migration purposes and backwards compatibility
 
 ## 🚀 How to get started
 

configuration.example.toml

@@ -1,10 +1,9 @@
-api-version = 1
+api-version = "v1"
 cors-allowed-hosts = [
     "revanced.app",
     "*.revanced.app"
 ]
 endpoint = "https://api.revanced.app"
-old-api-endpoint = "https://old-api.revanced.app"
 static-files-path = "static/root"
 versioned-static-files-path = "static/versioned"
 backend-service-name = "GitHub"

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 1.4.0-dev.5
+version = 1.4.0-dev.6

src/main/kotlin/app/revanced/api/configuration/APISchema.kt

@@ -1,4 +1,4 @@
-package app.revanced.api.configuration.schema
+package app.revanced.api.configuration
 
 import kotlinx.datetime.LocalDateTime
 import kotlinx.serialization.Serializable

src/main/kotlin/app/revanced/api/configuration/Dependencies.kt

@@ -51,7 +51,6 @@ fun Application.configureDependencies(
 
             AuthenticationService(issuer, validityInMin, jwtSecret, authSHA256DigestString)
         }
-        singleOf(::OldApiService)
         singleOf(::AnnouncementService)
         singleOf(::SignatureService)
         singleOf(::PatchesService)

src/main/kotlin/app/revanced/api/configuration/Routing.kt

@@ -4,7 +4,6 @@ import app.revanced.api.configuration.repository.ConfigurationRepository
 import app.revanced.api.configuration.routes.*
 import app.revanced.api.configuration.routes.announcementsRoute
 import app.revanced.api.configuration.routes.apiRoute
-import app.revanced.api.configuration.routes.oldApiRoute
 import app.revanced.api.configuration.routes.patchesRoute
 import io.bkbn.kompendium.core.routes.redoc
 import io.bkbn.kompendium.core.routes.swagger
@@ -19,7 +18,7 @@ internal fun Application.configureRouting() = routing {
 
     installCache(5.minutes)
 
-    route("/v${configuration.apiVersion}") {
+    route("/${configuration.apiVersion}") {
         announcementsRoute()
         patchesRoute()
         managerRoute()
@@ -55,7 +54,4 @@ internal fun Application.configureRouting() = routing {
 
     swagger(pageTitle = "ReVanced API", path = "/")
     redoc(pageTitle = "ReVanced API", path = "/redoc")
-
-    // TODO: Remove, once migration period from v2 API is over (In 1-2 years).
-    oldApiRoute()
 }

src/main/kotlin/app/revanced/api/configuration/repository/AnnouncementRepository.kt

@@ -1,9 +1,9 @@
 package app.revanced.api.configuration.repository
 
-import app.revanced.api.configuration.schema.ApiAnnouncement
+import app.revanced.api.configuration.ApiAnnouncement
-import app.revanced.api.configuration.schema.ApiAnnouncementTag
+import app.revanced.api.configuration.ApiAnnouncementTag
-import app.revanced.api.configuration.schema.ApiResponseAnnouncement
+import app.revanced.api.configuration.ApiResponseAnnouncement
-import app.revanced.api.configuration.schema.ApiResponseAnnouncementId
+import app.revanced.api.configuration.ApiResponseAnnouncementId
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.runBlocking
 import org.jetbrains.exposed.dao.IntEntity

src/main/kotlin/app/revanced/api/configuration/repository/ConfigurationRepository.kt

@@ -1,6 +1,6 @@
 package app.revanced.api.configuration.repository
 
-import app.revanced.api.configuration.schema.APIAbout
+import app.revanced.api.configuration.APIAbout
 import app.revanced.api.configuration.services.ManagerService
 import app.revanced.api.configuration.services.PatchesService
 import kotlinx.serialization.ExperimentalSerializationApi
@@ -30,7 +30,6 @@ import kotlin.io.path.createDirectories
  * @property apiVersion The version to use for the API.
  * @property corsAllowedHosts The hosts allowed to make requests to the API.
  * @property endpoint The endpoint of the API.
- * @property oldApiEndpoint The endpoint of the old API to proxy requests to.
  * @property staticFilesPath The path to the static files to be served under the root path.
  * @property versionedStaticFilesPath The path to the static files to be served under a versioned path.
  * @property about The path to the json file deserialized to [APIAbout]
@@ -46,12 +45,10 @@ internal class ConfigurationRepository(
     @SerialName("backend-service-name")
     val backendServiceName: String,
     @SerialName("api-version")
-    val apiVersion: Int = 1,
+    val apiVersion: String = "v1",
     @SerialName("cors-allowed-hosts")
     val corsAllowedHosts: Set<String>,
     val endpoint: String,
-    @SerialName("old-api-endpoint")
-    val oldApiEndpoint: String,
     @Serializable(with = PathSerializer::class)
     @SerialName("static-files-path")
     val staticFilesPath: Path,

src/main/kotlin/app/revanced/api/configuration/routes/Announcements.kt

@@ -1,12 +1,12 @@
 package app.revanced.api.configuration.routes
 
+import app.revanced.api.configuration.ApiAnnouncement
+import app.revanced.api.configuration.ApiResponseAnnouncement
+import app.revanced.api.configuration.ApiResponseAnnouncementId
 import app.revanced.api.configuration.canRespondUnauthorized
 import app.revanced.api.configuration.installCache
 import app.revanced.api.configuration.installNotarizedRoute
 import app.revanced.api.configuration.respondOrNotFound
-import app.revanced.api.configuration.schema.ApiAnnouncement
-import app.revanced.api.configuration.schema.ApiResponseAnnouncement
-import app.revanced.api.configuration.schema.ApiResponseAnnouncementId
 import app.revanced.api.configuration.services.AnnouncementService
 import io.bkbn.kompendium.core.metadata.DeleteInfo
 import io.bkbn.kompendium.core.metadata.GetInfo

src/main/kotlin/app/revanced/api/configuration/routes/ApiRoute.kt

@@ -6,7 +6,6 @@ import app.revanced.api.configuration.installNoCache
 import app.revanced.api.configuration.installNotarizedRoute
 import app.revanced.api.configuration.repository.ConfigurationRepository
 import app.revanced.api.configuration.respondOrNotFound
-import app.revanced.api.configuration.schema.*
 import app.revanced.api.configuration.services.ApiService
 import app.revanced.api.configuration.services.AuthenticationService
 import io.bkbn.kompendium.core.metadata.*
@@ -184,7 +183,7 @@ private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
                             "username=\"ReVanced\", " +
                             "realm=\"ReVanced\", " +
                             "nonce=\"abc123\", " +
-                            "uri=\"/v${configuration.apiVersion}/token\", " +
+                            "uri=\"/${configuration.apiVersion}/token\", " +
                             "algorithm=SHA-256, " +
                             "response=\"yxz456\"",
                     ),

src/main/kotlin/app/revanced/api/configuration/routes/ManagerRoute.kt

@@ -1,8 +1,8 @@
 package app.revanced.api.configuration.routes
 
+import app.revanced.api.configuration.ApiRelease
+import app.revanced.api.configuration.ApiReleaseVersion
 import app.revanced.api.configuration.installNotarizedRoute
-import app.revanced.api.configuration.schema.ApiRelease
-import app.revanced.api.configuration.schema.ApiReleaseVersion
 import app.revanced.api.configuration.services.ManagerService
 import io.bkbn.kompendium.core.metadata.GetInfo
 import io.ktor.http.*
@@ -13,18 +13,9 @@ import io.ktor.server.routing.*
 import org.koin.ktor.ext.get as koinGet
 
 internal fun Route.managerRoute() = route("manager") {
-    configure()
-
-    // TODO: Remove this deprecated route eventually.
-    route("latest") {
-        configure(deprecated = true)
-    }
-}
-
-private fun Route.configure(deprecated: Boolean = false) {
     val managerService = koinGet<ManagerService>()
 
-    installManagerRouteDocumentation(deprecated)
+    installManagerRouteDocumentation()
 
     rateLimit(RateLimitName("weak")) {
         get {
@@ -32,7 +23,7 @@ private fun Route.configure(deprecated: Boolean = false) {
         }
 
         route("version") {
-            installManagerVersionRouteDocumentation(deprecated)
+            installManagerVersionRouteDocumentation()
 
             get {
                 call.respond(managerService.latestVersion())
@@ -41,11 +32,10 @@ private fun Route.configure(deprecated: Boolean = false) {
     }
 }
 
-private fun Route.installManagerRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installManagerRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Manager")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the current manager release")
         summary("Get current manager release")
         response {
@@ -57,11 +47,10 @@ private fun Route.installManagerRouteDocumentation(deprecated: Boolean) = instal
     }
 }
 
-private fun Route.installManagerVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installManagerVersionRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Manager")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the current manager release version")
         summary("Get current manager release version")
         response {

src/main/kotlin/app/revanced/api/configuration/routes/OldApi.kt

@@ -1,19 +0,0 @@
-package app.revanced.api.configuration.routes
-
-import app.revanced.api.configuration.services.OldApiService
-import io.ktor.server.application.*
-import io.ktor.server.plugins.ratelimit.*
-import io.ktor.server.routing.*
-import org.koin.ktor.ext.get
-
-internal fun Route.oldApiRoute() {
-    val oldApiService = get<OldApiService>()
-
-    rateLimit(RateLimitName("weak")) {
-        route(Regex("/(v2|tools|contributors).*")) {
-            handle {
-                oldApiService.proxy(call)
-            }
-        }
-    }
-}

src/main/kotlin/app/revanced/api/configuration/routes/PatchesRoute.kt

@@ -1,10 +1,10 @@
 package app.revanced.api.configuration.routes
 
+import app.revanced.api.configuration.ApiAssetPublicKey
+import app.revanced.api.configuration.ApiRelease
+import app.revanced.api.configuration.ApiReleaseVersion
 import app.revanced.api.configuration.installCache
 import app.revanced.api.configuration.installNotarizedRoute
-import app.revanced.api.configuration.schema.ApiAssetPublicKey
-import app.revanced.api.configuration.schema.ApiRelease
-import app.revanced.api.configuration.schema.ApiReleaseVersion
 import app.revanced.api.configuration.services.PatchesService
 import io.bkbn.kompendium.core.metadata.GetInfo
 import io.ktor.http.*
@@ -16,18 +16,9 @@ import kotlin.time.Duration.Companion.days
 import org.koin.ktor.ext.get as koinGet
 
 internal fun Route.patchesRoute() = route("patches") {
-    configure()
-
-    // TODO: Remove this deprecated route eventually.
-    route("latest") {
-        configure(deprecated = true)
-    }
-}
-
-private fun Route.configure(deprecated: Boolean = false) {
     val patchesService = koinGet<PatchesService>()
 
-    installPatchesRouteDocumentation(deprecated)
+    installPatchesRouteDocumentation()
 
     rateLimit(RateLimitName("weak")) {
         get {
@@ -35,7 +26,7 @@ private fun Route.configure(deprecated: Boolean = false) {
         }
 
         route("version") {
-            installPatchesVersionRouteDocumentation(deprecated)
+            installPatchesVersionRouteDocumentation()
 
             get {
                 call.respond(patchesService.latestVersion())
@@ -45,7 +36,7 @@ private fun Route.configure(deprecated: Boolean = false) {
 
     rateLimit(RateLimitName("strong")) {
         route("list") {
-            installPatchesListRouteDocumentation(deprecated)
+            installPatchesListRouteDocumentation()
 
             get {
                 call.respondBytes(ContentType.Application.Json) { patchesService.list() }
@@ -57,7 +48,7 @@ private fun Route.configure(deprecated: Boolean = false) {
         route("keys") {
             installCache(356.days)
 
-            installPatchesPublicKeyRouteDocumentation(deprecated)
+            installPatchesPublicKeyRouteDocumentation()
 
             get {
                 call.respond(patchesService.publicKey())
@@ -66,11 +57,10 @@ private fun Route.configure(deprecated: Boolean = false) {
     }
 }
 
-private fun Route.installPatchesRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installPatchesRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the current patches release")
         summary("Get current patches release")
         response {
@@ -82,11 +72,10 @@ private fun Route.installPatchesRouteDocumentation(deprecated: Boolean) = instal
     }
 }
 
-private fun Route.installPatchesVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installPatchesVersionRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the current patches release version")
         summary("Get current patches release version")
         response {
@@ -98,11 +87,10 @@ private fun Route.installPatchesVersionRouteDocumentation(deprecated: Boolean) =
     }
 }
 
-private fun Route.installPatchesListRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installPatchesListRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the list of patches from the current patches release")
         summary("Get list of patches from current patches release")
         response {
@@ -114,11 +102,10 @@ private fun Route.installPatchesListRouteDocumentation(deprecated: Boolean) = in
     }
 }
 
-private fun Route.installPatchesPublicKeyRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
+private fun Route.installPatchesPublicKeyRouteDocumentation() = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
-        if (deprecated) isDeprecated()
         description("Get the public keys for verifying patches assets")
         summary("Get patches public keys")
         response {

src/main/kotlin/app/revanced/api/configuration/services/AnnouncementService.kt

@@ -1,7 +1,7 @@
 package app.revanced.api.configuration.services
 
+import app.revanced.api.configuration.ApiAnnouncement
 import app.revanced.api.configuration.repository.AnnouncementRepository
-import app.revanced.api.configuration.schema.ApiAnnouncement
 
 internal class AnnouncementService(
     private val announcementRepository: AnnouncementRepository,

src/main/kotlin/app/revanced/api/configuration/services/ApiService.kt

@@ -1,8 +1,8 @@
 package app.revanced.api.configuration.services
 
+import app.revanced.api.configuration.*
 import app.revanced.api.configuration.repository.BackendRepository
 import app.revanced.api.configuration.repository.ConfigurationRepository
-import app.revanced.api.configuration.schema.*
 import io.ktor.http.*
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async

src/main/kotlin/app/revanced/api/configuration/services/AuthenticationService.kt

@@ -1,6 +1,6 @@
 package app.revanced.api.configuration.services
 
-import app.revanced.api.configuration.schema.ApiToken
+import app.revanced.api.configuration.ApiToken
 import com.auth0.jwt.JWT
 import com.auth0.jwt.algorithms.Algorithm
 import io.ktor.server.auth.*

src/main/kotlin/app/revanced/api/configuration/services/ManagerService.kt

@@ -1,10 +1,10 @@
 package app.revanced.api.configuration.services
 
+import app.revanced.api.configuration.ApiRelease
+import app.revanced.api.configuration.ApiReleaseVersion
 import app.revanced.api.configuration.repository.BackendRepository
 import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
 import app.revanced.api.configuration.repository.ConfigurationRepository
-import app.revanced.api.configuration.schema.ApiRelease
-import app.revanced.api.configuration.schema.ApiReleaseVersion
 
 internal class ManagerService(
     private val backendRepository: BackendRepository,

src/main/kotlin/app/revanced/api/configuration/services/OldApiService.kt

@@ -1,76 +0,0 @@
-package app.revanced.api.configuration.services
-
-import app.revanced.api.configuration.repository.ConfigurationRepository
-import io.ktor.client.*
-import io.ktor.client.engine.okhttp.*
-import io.ktor.client.plugins.*
-import io.ktor.client.request.*
-import io.ktor.client.statement.*
-import io.ktor.http.*
-import io.ktor.http.content.*
-import io.ktor.server.application.*
-import io.ktor.server.request.*
-import io.ktor.server.response.*
-import io.ktor.util.*
-import io.ktor.utils.io.*
-
-internal class OldApiService(configurationRepository: ConfigurationRepository) {
-    private val client = HttpClient(OkHttp) {
-        defaultRequest { url(configurationRepository.oldApiEndpoint) }
-    }
-
-    @OptIn(InternalAPI::class)
-    suspend fun proxy(call: ApplicationCall) {
-        val channel = call.request.receiveChannel()
-        val size = channel.availableForRead
-        val byteArray = ByteArray(size)
-        channel.readFully(byteArray)
-
-        val response: HttpResponse = client.request(call.request.uri) {
-            method = call.request.httpMethod
-
-            headers {
-                appendAll(
-                    call.request.headers.filter { key, _ ->
-                        !(
-                            key.equals(HttpHeaders.ContentType, ignoreCase = true) ||
-                                key.equals(HttpHeaders.ContentLength, ignoreCase = true) ||
-                                key.equals(HttpHeaders.Host, ignoreCase = true)
-                            )
-                    },
-                )
-            }
-
-            when (call.request.httpMethod) {
-                HttpMethod.Post,
-                HttpMethod.Put,
-                HttpMethod.Patch,
-                HttpMethod.Delete,
-                -> body = ByteArrayContent(byteArray, call.request.contentType())
-            }
-        }
-
-        val headers = response.headers
-
-        call.respond(object : OutgoingContent.WriteChannelContent() {
-            override val contentLength: Long? = headers[HttpHeaders.ContentLength]?.toLong()
-            override val contentType = headers[HttpHeaders.ContentType]?.let { ContentType.parse(it) }
-            override val headers: Headers = Headers.build {
-                appendAll(
-                    headers.filter { key, _ ->
-                        !key.equals(
-                            HttpHeaders.ContentType,
-                            ignoreCase = true,
-                        ) &&
-                            !key.equals(HttpHeaders.ContentLength, ignoreCase = true)
-                    },
-                )
-            }
-            override val status = response.status
-
-            override suspend fun writeTo(channel: ByteWriteChannel) {
-                response.content.copyAndClose(channel)
-            }
-        })
-    }
-}

src/main/kotlin/app/revanced/api/configuration/services/PatchesService.kt

@@ -1,11 +1,11 @@
 package app.revanced.api.configuration.services
 
+import app.revanced.api.configuration.ApiAssetPublicKey
+import app.revanced.api.configuration.ApiRelease
+import app.revanced.api.configuration.ApiReleaseVersion
 import app.revanced.api.configuration.repository.BackendRepository
 import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
 import app.revanced.api.configuration.repository.ConfigurationRepository
-import app.revanced.api.configuration.schema.ApiAssetPublicKey
-import app.revanced.api.configuration.schema.ApiRelease
-import app.revanced.api.configuration.schema.ApiReleaseVersion
 import app.revanced.library.serializeTo
 import app.revanced.patcher.patch.loadPatchesFromJar
 import com.github.benmanes.caffeine.cache.Caffeine

src/test/kotlin/app/revanced/api/configuration/services/AnnouncementServiceTest.kt

@@ -1,7 +1,7 @@
 package app.revanced.api.configuration.services
 
+import app.revanced.api.configuration.ApiAnnouncement
 import app.revanced.api.configuration.repository.AnnouncementRepository
-import app.revanced.api.configuration.schema.ApiAnnouncement
 import kotlinx.coroutines.runBlocking
 import kotlinx.datetime.toKotlinLocalDateTime
 import org.jetbrains.exposed.sql.Database