Cleanup and add some tests

jan-tennert · jan-tennert · commit 337b5f1ae35a · 2024-10-31T15:52:56.000+01:00
diff --git a/KSP/README.md b/KSP/README.md
@@ -32,6 +32,7 @@ kotlin {
 }
 
 dependencies {
+    //Add KSP compiler to all targets that need processing
     //Advised to use Gradle Version Catalogs
     add("kspCommonMainMetadata", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
     add("kspJvm", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")
diff --git a/KSP/src/main/kotlin/io/github/jan/supabase/ksp/SelectableSymbolProcessorProvider.kt b/KSP/src/main/kotlin/io/github/jan/supabase/ksp/SelectableSymbolProcessorProvider.kt
@@ -5,7 +5,9 @@ import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
 import com.google.devtools.ksp.processing.SymbolProcessorProvider
 
 class SelectableSymbolProcessorProvider: SymbolProcessorProvider {
+
     override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
         return SelectableSymbolProcessor(environment.codeGenerator, environment.logger, environment.options)
     }
+
 }
diff --git a/KSP/src/main/kotlin/io/github/jan/supabase/ksp/Utils.kt b/KSP/src/main/kotlin/io/github/jan/supabase/ksp/Utils.kt
@@ -1,20 +1,10 @@
 package io.github.jan.supabase.ksp
 
 import com.google.devtools.ksp.symbol.KSAnnotation
-import com.google.devtools.ksp.symbol.KSClassDeclaration
 import com.google.devtools.ksp.symbol.KSDeclaration
 import com.google.devtools.ksp.symbol.KSValueArgument
 import com.google.devtools.ksp.symbol.KSValueParameter
 
-fun Sequence<KSAnnotation>.getAnnotation(target: String): KSAnnotation {
-    return getAnnotationOrNull(target) ?:
-    throw NoSuchElementException("Sequence contains no element matching the predicate.")
-}
-
-fun KSClassDeclaration.anyCompanionObject(): KSClassDeclaration? {
-    return declarations.filterIsInstance<KSClassDeclaration>().firstOrNull { it.isCompanionObject }
-}
-
 fun Sequence<KSAnnotation>.getAnnotationOrNull(target: String): KSAnnotation? {
     for (element in this) if (element.shortName.asString() == target) return element
     return null
@@ -30,6 +20,7 @@ fun <T> List<KSValueArgument>.getParameterValueIfExist(target: String): T? {
     return null
 }
 
+//Note these should never be null for our use case, but we still need to handle it
 val KSValueParameter.nameAsString: String get() = name?.asString() ?: error("Parameter name is null")
 
 val KSDeclaration.qualifiedNameAsString get() = qualifiedKSName.asString()
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/ColumnRegistry.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/ColumnRegistry.kt
@@ -3,6 +3,9 @@ package io.github.jan.supabase.postgrest
 import io.github.jan.supabase.annotations.SupabaseInternal
 import kotlin.reflect.KClass
 
+/**
+ * Registry used to map generated columns to a class
+ */
 @OptIn(ExperimentalSubclassOptIn::class)
 @SupabaseInternal
 @SubclassOptInRequired(SupabaseInternal::class)
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/PostgrestImpl.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/PostgrestImpl.kt
@@ -65,7 +65,7 @@ internal class PostgrestImpl(override val supabaseClient: SupabaseClient, overri
     override suspend fun rpc(function: String, request: RpcRequestBuilder.() -> Unit): PostgrestResult = rpcRequest(function, null, request)
 
     private suspend fun rpcRequest(function: String, body: JsonObject? = null, request: RpcRequestBuilder.() -> Unit): PostgrestResult {
-        val requestBuilder = RpcRequestBuilder(config.defaultSchema, config.propertyConversionMethod, config.columnRegistry).apply(request)
+        val requestBuilder = RpcRequestBuilder(config.defaultSchema, config).apply(request)
         val urlParams = buildMap {
             putAll(requestBuilder.params.mapToFirstValue())
             if(requestBuilder.method != RpcMethod.POST && body != null) {
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestBuilderExtension.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestBuilderExtension.kt
@@ -38,6 +38,6 @@ suspend inline fun <reified T : Any> PostgrestQueryBuilder.select(
  */
 @SupabaseExperimental
 inline fun <reified T : Any> PostgrestRequestBuilder.select() {
-    val columns = columnRegistry.getColumns(T::class)
+    val columns = config.columnRegistry.getColumns(T::class)
     select(Columns.raw(columns))
 }
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestQueryBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestQueryBuilder.kt
@@ -44,8 +44,7 @@ class PostgrestQueryBuilder(
         request: @PostgrestFilterDSL SelectRequestBuilder.() -> Unit = {}
     ): PostgrestResult {
         val requestBuilder = SelectRequestBuilder(
-            postgrest.config.propertyConversionMethod,
-            postgrest.config.columnRegistry
+            postgrest.config
         ).apply {
             request(); params["select"] = listOf(columns.value)
         }
@@ -79,8 +78,7 @@ class PostgrestQueryBuilder(
         request: UpsertRequestBuilder.() -> Unit = {}
     ): PostgrestResult {
         val requestBuilder = UpsertRequestBuilder(
-            postgrest.config.propertyConversionMethod,
-            postgrest.config.columnRegistry
+            postgrest.config
         ).apply(request)
         val body = postgrest.serializer.encodeToJsonElement(values).jsonArray
         val columns = body.map { it.jsonObject.keys }.flatten().distinct()
@@ -136,8 +134,7 @@ class PostgrestQueryBuilder(
         request: InsertRequestBuilder.() -> Unit = {}
     ): PostgrestResult {
         val requestBuilder = InsertRequestBuilder(
-            postgrest.config.propertyConversionMethod,
-            postgrest.config.columnRegistry
+            postgrest.config
         ).apply(request)
         val body = postgrest.serializer.encodeToJsonElement(values).jsonArray
         val columns = body.map { it.jsonObject.keys }.flatten().distinct()
@@ -248,8 +245,7 @@ class PostgrestQueryBuilder(
 
     @PublishedApi
     internal inline fun newRequestBuilder(request: PostgrestRequestBuilder.() -> Unit = {}) = PostgrestRequestBuilder(
-        postgrest.config.propertyConversionMethod,
-        postgrest.config.columnRegistry
+        postgrest.config
     ).apply(request)
 
     companion object {
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestRequestBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/PostgrestRequestBuilder.kt
@@ -3,8 +3,7 @@ package io.github.jan.supabase.postgrest.query
 
 import io.github.jan.supabase.annotations.SupabaseExperimental
 import io.github.jan.supabase.auth.PostgrestFilterDSL
-import io.github.jan.supabase.postgrest.ColumnRegistry
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.filter.PostgrestFilterBuilder
 import io.github.jan.supabase.postgrest.result.PostgrestResult
 import io.ktor.http.HeadersBuilder
@@ -16,8 +15,7 @@ import kotlin.js.JsName
  */
 @PostgrestFilterDSL
 open class PostgrestRequestBuilder(
-    @PublishedApi internal val propertyConversionMethod: PropertyConversionMethod,
-    @PublishedApi internal val columnRegistry: ColumnRegistry
+    @PublishedApi internal val config: Postgrest.Config
 ) {
 
     /**
@@ -160,7 +158,7 @@ open class PostgrestRequestBuilder(
      * @param block The filter block
      */
     inline fun filter(block: @PostgrestFilterDSL PostgrestFilterBuilder.() -> Unit) {
-        val filter = PostgrestFilterBuilder(propertyConversionMethod, params)
+        val filter = PostgrestFilterBuilder(config.propertyConversionMethod, params)
         filter.block()
     }
 
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/InsertRequestBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/InsertRequestBuilder.kt
@@ -1,14 +1,13 @@
 package io.github.jan.supabase.postgrest.query.request
 
-import io.github.jan.supabase.postgrest.ColumnRegistry
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.PostgrestQueryBuilder
 import io.github.jan.supabase.postgrest.query.PostgrestRequestBuilder
 
 /**
  * Request builder for [PostgrestQueryBuilder.insert]
  */
-open class InsertRequestBuilder(propertyConversionMethod: PropertyConversionMethod, columnRegistry: ColumnRegistry): PostgrestRequestBuilder(propertyConversionMethod, columnRegistry) {
+open class InsertRequestBuilder(config: Postgrest.Config): PostgrestRequestBuilder(config) {
 
     /**
      * Make missing fields default to `null`.
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/RpcRequestBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/RpcRequestBuilder.kt
@@ -1,8 +1,6 @@
 package io.github.jan.supabase.postgrest.query.request
 
-import io.github.jan.supabase.postgrest.ColumnRegistry
 import io.github.jan.supabase.postgrest.Postgrest
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
 import io.github.jan.supabase.postgrest.RpcMethod
 import io.github.jan.supabase.postgrest.query.PostgrestRequestBuilder
 
@@ -11,9 +9,8 @@ import io.github.jan.supabase.postgrest.query.PostgrestRequestBuilder
  */
 class RpcRequestBuilder(
     defaultSchema: String,
-    propertyConversionMethod: PropertyConversionMethod,
-    columnRegistry: ColumnRegistry
-): PostgrestRequestBuilder(propertyConversionMethod, columnRegistry) {
+    config: Postgrest.Config
+): PostgrestRequestBuilder(config) {
 
     /**
      * The HTTP method to use. Default is POST
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/SelectRequestBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/SelectRequestBuilder.kt
@@ -1,17 +1,15 @@
 package io.github.jan.supabase.postgrest.query.request
 
-import io.github.jan.supabase.postgrest.ColumnRegistry
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.PostgrestQueryBuilder
 import io.github.jan.supabase.postgrest.query.PostgrestRequestBuilder
 
 /**
  * Request builder for [PostgrestQueryBuilder.select]
  */
 class SelectRequestBuilder(
-    propertyConversionMethod: PropertyConversionMethod,
-    columnRegistry: ColumnRegistry
-): PostgrestRequestBuilder(propertyConversionMethod, columnRegistry) {
+    config: Postgrest.Config
+): PostgrestRequestBuilder(config) {
 
     /**
      * If true, no body will be returned. Useful when using count.
diff --git a/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/UpsertRequestBuilder.kt b/Postgrest/src/commonMain/kotlin/io/github/jan/supabase/postgrest/query/request/UpsertRequestBuilder.kt
@@ -1,16 +1,14 @@
 package io.github.jan.supabase.postgrest.query.request
 
-import io.github.jan.supabase.postgrest.ColumnRegistry
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.PostgrestQueryBuilder
 
 /**
  * Request builder for [PostgrestQueryBuilder.upsert]
  */
 class UpsertRequestBuilder(
-    propertyConversionMethod: PropertyConversionMethod,
-    columnRegistry: ColumnRegistry
-): InsertRequestBuilder(propertyConversionMethod, columnRegistry) {
+    config: Postgrest.Config
+): InsertRequestBuilder(config) {
 
     /**
      * Comma-separated UNIQUE column(s) to specify how
diff --git a/Postgrest/src/commonTest/kotlin/ColumnRegistryTest.kt b/Postgrest/src/commonTest/kotlin/ColumnRegistryTest.kt
@@ -0,0 +1,14 @@
+import io.github.jan.supabase.postgrest.MapColumnRegistry
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ColumnRegistryTest {
+
+    @Test
+    fun testColumnRegistry() {
+        val registry = MapColumnRegistry()
+        registry.registerColumns("Test", "column1, column2")
+        assertEquals("column1, column2", registry.getColumns(Test::class))
+    }
+
+}
diff --git a/Postgrest/src/commonTest/kotlin/PostgrestRequestBuilderTest.kt b/Postgrest/src/commonTest/kotlin/PostgrestRequestBuilderTest.kt
@@ -1,9 +1,13 @@
+import io.github.jan.supabase.postgrest.MapColumnRegistry
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.Count
 import io.github.jan.supabase.postgrest.query.Order
 import io.github.jan.supabase.postgrest.query.Returning
+import io.github.jan.supabase.postgrest.query.select
 import io.ktor.http.HttpHeaders
 import kotlin.test.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertIs
 
 class PostgrestRequestBuilderTest {
 
@@ -23,6 +27,19 @@ class PostgrestRequestBuilderTest {
         assertEquals(Returning.Representation(), request.returning)
     }
 
+    @Test
+    fun testSelectWithSelectable() {
+        val columnRegistry = MapColumnRegistry()
+        columnRegistry.registerColumns("TestType", "column1, column2")
+        val request = postgrestRequest(
+            config = Postgrest.Config(columnRegistry = columnRegistry)
+        ) {
+            select<TestType>()
+        }
+        assertIs<Returning.Representation>(request.returning)
+        assertEquals("column1,column2", (request.returning as Returning.Representation).columns.value)
+    }
+
     @Test
     fun testSingle() {
         val request = postgrestRequest {
diff --git a/Postgrest/src/commonTest/kotlin/PostgrestTest.kt b/Postgrest/src/commonTest/kotlin/PostgrestTest.kt
@@ -7,6 +7,7 @@ import io.github.jan.supabase.postgrest.postgrest
 import io.github.jan.supabase.postgrest.query.Columns
 import io.github.jan.supabase.postgrest.query.request.InsertRequestBuilder
 import io.github.jan.supabase.postgrest.query.request.UpsertRequestBuilder
+import io.github.jan.supabase.postgrest.query.select
 import io.github.jan.supabase.postgrest.result.PostgrestResult
 import io.github.jan.supabase.testing.assertMethodIs
 import io.github.jan.supabase.testing.assertPathIs
@@ -57,6 +58,28 @@ class PostgrestTest {
         )
     }
 
+    @Test
+    fun testSelectWithSelectableType() {
+        testClient(
+            postgrestConfig = {
+                columnRegistry.registerColumns("TestType", "column1,column2")
+            },
+            request = { table ->
+                from(table).select<TestType> {
+                    headers["custom"] = "value"
+                    params["custom"] = listOf("value")
+                }
+            },
+            requestHandler = {
+                assertMethodIs(HttpMethod.Get, it.method)
+                assertEquals("column1,column2", it.url.parameters["select"])
+                assertEquals("value", it.headers["custom"])
+                assertEquals("value", it.url.parameters["custom"])
+                respond("")
+            }
+        )
+    }
+
     @Test
     fun testSelectSchema() {
         val columns = Columns.list("column1", "column2")
@@ -362,11 +385,16 @@ class PostgrestTest {
 
     private fun testClient(
         table: String = "table",
+        postgrestConfig: Postgrest.Config.() -> Unit = {},
         request: suspend SupabaseClient.(table: String) -> PostgrestResult,
         requestHandler: suspend MockRequestHandleScope.(HttpRequestData) -> HttpResponseData = { respond("")},
     ) {
         val supabase = createMockedSupabaseClient(
-            configuration = configureClient
+            configuration = {
+                install(Postgrest) {
+                    postgrestConfig()
+                }
+            }
         ) {
             assertPathIs("/$table", it.url.pathAfterVersion())
             requestHandler(it)
diff --git a/Postgrest/src/commonTest/kotlin/TestType.kt b/Postgrest/src/commonTest/kotlin/TestType.kt
@@ -0,0 +1 @@
+data class TestType(val column1: String, val column2: String)
diff --git a/Postgrest/src/commonTest/kotlin/Utils.kt b/Postgrest/src/commonTest/kotlin/Utils.kt
@@ -1,16 +1,13 @@
 import io.github.jan.supabase.annotations.SupabaseInternal
-import io.github.jan.supabase.postgrest.ColumnRegistry
-import io.github.jan.supabase.postgrest.MapColumnRegistry
-import io.github.jan.supabase.postgrest.PropertyConversionMethod
+import io.github.jan.supabase.postgrest.Postgrest
 import io.github.jan.supabase.postgrest.query.PostgrestRequestBuilder
 
 @SupabaseInternal
 inline fun postgrestRequest(
-    propertyConversionMethod: PropertyConversionMethod = PropertyConversionMethod.CAMEL_CASE_TO_SNAKE_CASE,
-    columnRegistry: ColumnRegistry = MapColumnRegistry(),
+    config: Postgrest.Config = Postgrest.Config(),
     block: PostgrestRequestBuilder.() -> Unit
 ): PostgrestRequestBuilder {
-    val filter = PostgrestRequestBuilder(propertyConversionMethod, columnRegistry)
+    val filter = PostgrestRequestBuilder(config)
     filter.block()
     return filter
 }

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ kotlin {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`dependencies {`
	`35`	`+ //Add KSP compiler to all targets that need processing`
`35`	`36`	`//Advised to use Gradle Version Catalogs`
`36`	`37`	`add("kspCommonMainMetadata", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")`
`37`	`38`	`add("kspJvm", "io.github.jan-tennert.supabase:ksp-compiler:VERSION")`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,9 @@ import com.google.devtools.ksp.processing.SymbolProcessorEnvironment`
`5`	`5`	`import com.google.devtools.ksp.processing.SymbolProcessorProvider`
`6`	`6`
`7`	`7`	`class SelectableSymbolProcessorProvider: SymbolProcessorProvider {`
	`8`	`+`
`8`	`9`	`override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {`
`9`	`10`	`return SelectableSymbolProcessor(environment.codeGenerator, environment.logger, environment.options)`
`10`	`11`	`}`
	`12`	`+`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,6 @@ suspend inline fun <reified T : Any> PostgrestQueryBuilder.select(`
`38`	`38`	`*/`
`39`	`39`	`@SupabaseExperimental`
`40`	`40`	`inline fun <reified T : Any> PostgrestRequestBuilder.select() {`
`41`		`- val columns = columnRegistry.getColumns(T::class)`
	`41`	`+ val columns = config.columnRegistry.getColumns(T::class)`
`42`	`42`	`select(Columns.raw(columns))`
`43`	`43`	`}`