Multiple cleanup

.gitignore

@@ -44,6 +44,7 @@ out/
 # generated
 openapi/plantuml/.openapi-generator/
 openapi/openapi.yaml
+doc/generated-snippets
 
 ### Personal directory ###
 perso

api/build.gradle.kts

@@ -57,7 +57,7 @@ tasks.register<Copy>("copySubProjectsOpenAPIFiles") {
             logger.debug("Found project dependency: $it")
             it.name.matches("^cosmotech-[a-zA-Z]+-api$".toRegex())
           }
-          .map { it.dependencyProject.projectDir }
+          .map { project.project(it.path).projectDir }
           .map { file("${it}/src/main/openapi/${it.relativeTo(rootDir)}.yaml") }
           .filter { it.exists() }
           .map { it.absolutePath }

api/src/integrationTest/resources/application-test.yml

@@ -52,8 +52,6 @@ csm:
       base-path: /
       base-url: "http://fake_url:8080"
       version: latest
-    id-generator:
-      type: hashid
     event-publisher:
       type: in_process
     upload:

api/src/main/resources/application.yml

@@ -69,8 +69,6 @@ csm:
       base-path: /
       base-url: "http://cosmotech-api-${csm.platform.api.version}:8080"
       version: latest
-    id-generator:
-      type: hashid
     event-publisher:
       type: in_process
     metrics:

common/src/main/kotlin/com/cosmotech/common/CsmPhoenixService.kt

@@ -4,7 +4,6 @@ package com.cosmotech.common
 
 import com.cosmotech.common.config.CsmPlatformProperties
 import com.cosmotech.common.events.CsmEventPublisher
-import com.cosmotech.common.id.CsmIdGenerator
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Autowired
@@ -16,7 +15,5 @@ abstract class CsmPhoenixService {
 
   @Autowired protected lateinit var csmPlatformProperties: CsmPlatformProperties
 
-  @Autowired protected lateinit var idGenerator: CsmIdGenerator
-
   @Autowired protected lateinit var eventPublisher: CsmEventPublisher
 }

common/src/main/kotlin/com/cosmotech/common/config/CsmPlatformProperties.kt

@@ -11,9 +11,6 @@ data class CsmPlatformProperties(
     /** API Configuration */
     val api: Api,
 
-    /** Id Generator */
-    val idGenerator: IdGenerator,
-
     /** Event Publisher */
     val eventPublisher: EventPublisher,
 
@@ -184,16 +181,6 @@ data class CsmPlatformProperties(
       val basePath: String,
   )
 
-  data class IdGenerator(val type: Type) {
-    enum class Type {
-      /** short unique UIDs */
-      HASHID,
-
-      /** UUIDs */
-      UUID
-    }
-  }
-
   data class EventPublisher(val type: Type) {
     enum class Type {
       /** In-process, via Spring Application Events */

common/src/main/kotlin/com/cosmotech/common/id/CsmIdGenerator.kt

@@ -2,21 +2,26 @@
 // Licensed under the MIT license.
 package com.cosmotech.common.id
 
-interface CsmIdGenerator {
+import java.util.UUID
+import kotlin.math.min
+import org.hashids.Hashids
+import org.hashids.Hashids.MAX_NUMBER
 
-  fun generate(scope: String, prependPrefix: String? = null): String
-}
-
-internal abstract class AbstractCsmIdGenerator : CsmIdGenerator {
+private const val MIN_HASH_LENGTH = 0
+private const val ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789"
 
-  final override fun generate(scope: String, prependPrefix: String?): String {
-    if (scope.isBlank()) {
-      throw IllegalArgumentException("scope must not be blank")
-    }
-
-    val id = this.buildId(scope)
-    return "${prependPrefix ?: "${scope[0].lowercaseChar()}-"}$id"
+fun generateId(scope: String, prependPrefix: String? = null): String {
+  if (scope.isBlank()) {
+    throw IllegalArgumentException("scope must not be blank")
   }
 
-  protected abstract fun buildId(scope: String): String
+  // We do not intend to decode generated IDs afterwards => we can safely generate a unique salt.
+  // This will give us different ids even with equal numbers to encode
+  val id =
+      Hashids("$scope-${UUID.randomUUID()}", MIN_HASH_LENGTH, ALPHABET)
+          .encode(
+              // PROD-8703: encodedElement might be higher than the maximum number supported
+              min(System.nanoTime(), MAX_NUMBER))
+
+  return "${prependPrefix ?: "${scope[0].lowercaseChar()}-"}$id"
 }

common/src/test/kotlin/com/cosmotech/common/id/CsmIdGeneratorTests.kt

@@ -0,0 +1,56 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+package com.cosmotech.common.id
+
+import java.lang.IllegalArgumentException
+import kotlin.test.assertFalse
+import kotlin.test.assertNotEquals
+import kotlin.test.assertTrue
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+
+class CsmIdGeneratorTests {
+  @Test
+  fun `generate with blank scope`() {
+    assertThrows<IllegalArgumentException> { generateId("") }
+    assertThrows<IllegalArgumentException> { generateId("   ") }
+  }
+
+  @Test
+  fun `generate with no prepend prefix`() {
+    val hashid = generateId("fake_scope")
+    assertFalse { hashid.isBlank() }
+    assertTrue { hashid.startsWith("f-", ignoreCase = false) }
+    assertFalse { hashid.substringAfter("f-", missingDelimiterValue = "").isBlank() }
+  }
+
+  @Test
+  fun `generate with custom prepend prefix`() {
+    val hashid = generateId("test_scope", prependPrefix = "my-custom-prefix-")
+    assertFalse { hashid.isBlank() }
+    assertTrue { hashid.startsWith("my-custom-prefix-", ignoreCase = false) }
+    assertFalse { hashid.substringAfter("my-custom-prefix-").isBlank() }
+  }
+
+  @Test
+  fun `2 generations within a same scope do not return the same ID`() {
+    val hashid1 = generateId("test_scope")
+    val hashid2 = generateId("test_scope")
+    assertFalse { hashid1.isBlank() }
+    assertTrue { hashid1.startsWith("t-", ignoreCase = false) }
+    assertFalse { hashid2.isBlank() }
+    assertTrue { hashid2.startsWith("t-", ignoreCase = false) }
+    assertNotEquals(hashid1, hashid2)
+  }
+
+  @Test
+  fun `2 generations within different scopes do not return the same ID`() {
+    val hashid1 = generateId("test scope")
+    val hashid2 = generateId("another scope")
+    assertFalse { hashid1.isBlank() }
+    assertTrue { hashid1.startsWith("t-", ignoreCase = false) }
+    assertFalse { hashid2.isBlank() }
+    assertTrue { hashid2.startsWith("a-", ignoreCase = false) }
+    assertNotEquals(hashid1, hashid2)
+  }
+}

config/application-dev.sample.yml

@@ -49,8 +49,6 @@ csm:
       base-path: /
       base-url: "[fill-this-value]" # e.g for running it locally http://localhost:8080
       version: latest
-    id-generator:
-      type: hashid
     event-publisher:
       type: in_process
       allowedTenants:

dataset/src/integrationTest/resources/application-dataset-test.yml

@@ -62,8 +62,6 @@ csm:
       base-path: /
       base-url: "http://fake_url:8080"
       version: latest
-    id-generator:
-      type: hashid
     event-publisher:
       type: in_process
     upload: