refactor: Refactor into services and repositories

Author: oSumAtrIX

build.gradle.kts

@@ -11,21 +11,11 @@ tasks {
         expand("projectVersion" to project.version)
     }
 
-    /*
-    Dummy task to hack gradle-semantic-release-plugin to release this project.
-
-    Explanation:
-    SemVer is a standard for versioning libraries.
-    For that reason the semantic-release plugin uses the "publish" task to publish libraries.
-    However, this subproject is not a library, and the "publish" task is not available for this subproject.
-    Because semantic-release is not designed to handle this case, we need to hack it.
-
-    RE: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
-     */
+    // Needed by gradle-semantic-release-plugin.
+    // Tracking: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
     register<DefaultTask>("publish") {
         group = "publishing"
-        description = "Dummy task to hack gradle-semantic-release-plugin to release ReVanced API"
-        dependsOn(startShadowScripts)
+        dependsOn(shadowJar)
     }
 }
 
@@ -42,8 +32,15 @@ ktor {
 repositories {
     mavenCentral()
     google()
-    maven { url = uri("https://jitpack.io") }
     mavenLocal()
+    maven {
+        // A repository must be specified for some reason. "registry" is a dummy.
+        url = uri("https://maven.pkg.github.com/revanced/registry")
+        credentials {
+            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
+            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+        }
+    }
 }
 
 dependencies {
@@ -78,8 +75,4 @@ dependencies {
     implementation(libs.revanced.patcher)
     implementation(libs.revanced.library)
     implementation(libs.caffeine)
-
-    testImplementation(libs.mockk)
-    testImplementation(libs.ktor.server.tests)
-    testImplementation(libs.kotlin.test.junit)
 }

gradle/libs.versions.toml

@@ -1,17 +1,16 @@
 [versions]
-kotlin = "1.9.22"
+kotlin = "2.0.0"
 logback = "1.4.14"
 exposed = "0.41.1"
 h2 = "2.2.224"
 koin = "3.5.3"
 dotenv = "6.4.1"
 ktor = "2.3.7"
 ktoml = "0.5.1"
-picocli = "4.7.3"
+picocli = "4.7.5"
 datetime = "0.5.0"
-mockk = "1.13.9"
-revanced-patcher = "19.2.0"
-revanced-library = "1.5.0"
+revanced-patcher = "19.3.1"
+revanced-library = "2.3.0"
 caffeine = "3.1.8"
 
 [libraries]
@@ -39,13 +38,10 @@ exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "e
 exposed-dao = { module = "org.jetbrains.exposed:exposed-dao", version.ref = "exposed" }
 exposed-kotlin-datetime = { module = "org.jetbrains.exposed:exposed-kotlin-datetime", version.ref = "exposed" }
 dotenv-kotlin = { module = "io.github.cdimascio:dotenv-kotlin", version.ref = "dotenv" }
-ktor-server-tests = { module = "io.ktor:ktor-server-tests" }
-kotlin-test-junit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kotlin" }
 ktoml-core = { module = "com.akuleshov7:ktoml-core", version.ref = "ktoml" }
 ktoml-file = { module = "com.akuleshov7:ktoml-file", version.ref = "ktoml" }
 picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
 kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime", version.ref = "datetime" }
-mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 revanced-patcher = { module = "app.revanced:revanced-patcher", version.ref = "revanced-patcher" }
 revanced-library = { module = "app.revanced:revanced-library", version.ref = "revanced-library" }
 caffeine = { module = "com.github.ben-manes.caffeine:caffeine", version.ref = "caffeine" }

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,8 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+distributionSha256Sum=a4b4158601f8636cdeeab09bd76afb640030bb5b144aafe261a5e8af027dc612
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +41,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

gradlew.bat

@@ -1,6 +1,7 @@
 package app.revanced.api.command
 
-import app.revanced.api.modules.*
+import app.revanced.api.configuration.*
+import app.revanced.api.configuration.routing.configureRouting
 import io.ktor.server.engine.*
 import io.ktor.server.netty.*
 import picocli.CommandLine
@@ -27,7 +28,7 @@ internal object StartAPICommand : Runnable {
     override fun run() {
         embeddedServer(Netty, port, host) {
             configureDependencies()
-            configureHTTP()
+            configureHTTP(allowedHost = host)
             configureSerialization()
             configureSecurity()
             configureRouting()

src/main/kotlin/app/revanced/api/command/StartAPICommand.kt

@@ -0,0 +1,83 @@
+package app.revanced.api.configuration
+
+import app.revanced.api.repository.AnnouncementRepository
+import app.revanced.api.repository.ConfigurationRepository
+import app.revanced.api.repository.backend.BackendRepository
+import app.revanced.api.repository.backend.github.GitHubBackendRepository
+import app.revanced.api.services.AnnouncementService
+import app.revanced.api.services.ApiService
+import app.revanced.api.services.AuthService
+import app.revanced.api.services.PatchesService
+import com.akuleshov7.ktoml.Toml
+import com.akuleshov7.ktoml.source.decodeFromStream
+import io.github.cdimascio.dotenv.Dotenv
+import io.ktor.server.application.*
+import org.jetbrains.exposed.sql.Database
+import org.koin.core.module.dsl.singleOf
+import org.koin.dsl.bind
+import org.koin.dsl.module
+import org.koin.ktor.plugin.Koin
+import java.io.File
+
+fun Application.configureDependencies() {
+    val globalModule = module {
+        single {
+            Dotenv.configure()
+                .systemProperties()
+                .load()
+        }
+    }
+
+    val repositoryModule = module {
+        single {
+            val dotenv = get<Dotenv>()
+
+            Database.connect(
+                url = dotenv["DB_URL"],
+                user = dotenv["DB_USER"],
+                password = dotenv["DB_PASSWORD"],
+                driver = "org.h2.Driver",
+            )
+        }
+
+        single {
+            val configFilePath = get<Dotenv>()["CONFIG_FILE_PATH"]
+            val configFile = File(configFilePath).inputStream()
+
+            Toml.decodeFromStream<ConfigurationRepository>(configFile)
+        }
+
+        singleOf(::AnnouncementRepository)
+    }
+
+    val serviceModule = module {
+        single {
+            val dotenv = get<Dotenv>()
+
+            val jwtSecret = dotenv["JWT_SECRET"]
+            val issuer = dotenv["JWT_ISSUER"]
+            val validityInMin = dotenv["JWT_VALIDITY_IN_MIN"].toInt()
+
+            val basicUsername = dotenv["BASIC_USERNAME"]
+            val basicPassword = dotenv["BASIC_PASSWORD"]
+
+            AuthService(issuer, validityInMin, jwtSecret, basicUsername, basicPassword)
+        }
+        single {
+            val token = get<Dotenv>()["GITHUB_TOKEN"]
+
+            GitHubBackendRepository(token)
+        } bind BackendRepository::class
+        singleOf(::AnnouncementService)
+        singleOf(::PatchesService)
+        singleOf(::ApiService)
+    }
+
+    install(Koin) {
+        modules(
+            globalModule,
+            repositoryModule,
+            serviceModule,
+        )
+    }
+}

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

@@ -1,4 +1,4 @@
-package app.revanced.api.modules
+package app.revanced.api.configuration
 
 import io.ktor.http.*
 import io.ktor.http.content.*
@@ -8,15 +8,17 @@ import io.ktor.server.plugins.conditionalheaders.*
 import io.ktor.server.plugins.cors.routing.*
 import kotlin.time.Duration.Companion.minutes
 
-fun Application.configureHTTP() {
+fun Application.configureHTTP(
+    allowedHost: String,
+) {
     install(ConditionalHeaders)
     install(CORS) {
         allowMethod(HttpMethod.Options)
         allowMethod(HttpMethod.Put)
         allowMethod(HttpMethod.Delete)
         allowMethod(HttpMethod.Patch)
         allowHeader(HttpHeaders.Authorization)
-        anyHost() // @TODO: Don't do this in production if possible. Try to limit it.
+        allowHost(allowedHost)
     }
     install(CachingHeaders) {
         options { _, _ -> CachingOptions(CacheControl.MaxAge(maxAgeSeconds = 5.minutes.inWholeSeconds.toInt())) }