Use shortname for collector name

Previously we've moved on to using a full name which was incompatible with the old format. Now the name uses the expected short name (`ssc-$VERSION-$SINK`) format.
snowplow · Dec 14, 2023 · 4ea0142 · 4ea0142
1 parent ec5a74f
commit 4ea0142
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/AppInfo.scala b/core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/AppInfo.scala
@@ -13,4 +13,5 @@ trait AppInfo {
   def moduleName: String
   def version: String
   def dockerAlias: String
+  def shortName: String
 }
diff --git a/core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/Service.scala b/core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/Service.scala
@@ -61,7 +61,8 @@ class Service[F[_]: Sync](
 
   val pixelStream = Stream.iterable[F, Byte](Service.pixel)
 
-  private val collector = s"${appInfo.name}:${appInfo.version}"
+  private val collector =
+    s"""${appInfo.shortName}-${appInfo.version}-${sinks.good.getClass.getSimpleName.toLowerCase}"""
 
   private val splitBatch: SplitBatch = SplitBatch(appInfo)
 

diff --git a/core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/ServiceSpec.scala b/core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/ServiceSpec.scala
@@ -242,7 +242,7 @@ class ServiceSpec extends Specification {
         e.schema shouldEqual "iglu:com.snowplowanalytics.snowplow/CollectorPayload/thrift/1-0-0"
         e.ipAddress shouldEqual "192.0.2.3"
         e.encoding shouldEqual "UTF-8"
-        e.collector shouldEqual s"${TestUtils.appName}:${TestUtils.appVersion}"
+        e.collector shouldEqual s"${TestUtils.appInfo.shortName}-${TestUtils.appVersion}-testsink"
         e.querystring shouldEqual "a=b"
         e.body shouldEqual "b"
         e.path shouldEqual "p"
@@ -427,7 +427,7 @@ class ServiceSpec extends Specification {
         e.schema shouldEqual "iglu:com.snowplowanalytics.snowplow/CollectorPayload/thrift/1-0-0"
         e.ipAddress shouldEqual "ip"
         e.encoding shouldEqual "UTF-8"
-        e.collector shouldEqual s"${TestUtils.appName}:${TestUtils.appVersion}"
+        e.collector shouldEqual s"${TestUtils.appInfo.shortName}-${TestUtils.appVersion}-testsink"
         e.querystring shouldEqual "q"
         e.body shouldEqual "b"
         e.path shouldEqual "p"
@@ -456,7 +456,7 @@ class ServiceSpec extends Specification {
         e.schema shouldEqual "iglu:com.snowplowanalytics.snowplow/CollectorPayload/thrift/1-0-0"
         e.ipAddress shouldEqual "ip"
         e.encoding shouldEqual "UTF-8"
-        e.collector shouldEqual s"${TestUtils.appName}:${TestUtils.appVersion}"
+        e.collector shouldEqual s"${TestUtils.appInfo.shortName}-${TestUtils.appVersion}-testsink"
         e.querystring shouldEqual null
         e.body shouldEqual null
         e.path shouldEqual "p"

diff --git a/core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/TestUtils.scala b/core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/TestUtils.scala
@@ -17,6 +17,7 @@ object TestUtils {
     def moduleName  = appName
     def version     = appVersion
     def dockerAlias = "docker run collector"
+    def shortName   = "ssc"
   }
 
   def noopSink[F[_]: Applicative]: Sink[F] = new Sink[F] {

diff --git a/project/BuildSettings.scala b/project/BuildSettings.scala
@@ -121,7 +121,7 @@ object BuildSettings {
       addExampleConfToTestCp
 
   lazy val buildInfoSettings = Seq(
-    buildInfoKeys := Seq[BuildInfoKey](name, moduleName, dockerAlias, version),
+    buildInfoKeys := Seq[BuildInfoKey](name, moduleName, dockerAlias, version, "shortName" -> "ssc"),
     buildInfoOptions += BuildInfoOption.Traits("com.snowplowanalytics.snowplow.collector.core.AppInfo"),
     buildInfoPackage := s"com.snowplowanalytics.snowplow.collectors.scalastream"
   )