Add mandatory SLULA license acceptance flag (close #405)

Since introducing a new license we need to explicitly check if the user
has accepted the terms. Therefore a new flag is added.
By default it is set to false but can be overrided by either:
- setting `license.accept = true` in the config file
- setting `env ACCEPT_LIMITED_USE_LICENSE=true`
- appending `-Dlicense.accept=true`

.github/workflows/integration_tests/telemetry/sender_config/config.hocon

@@ -1,5 +1,6 @@
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  license { accept = true }
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = "9292"

.github/workflows/integration_tests/telemetry/sender_config/config_disabled.hocon

@@ -1,5 +1,6 @@
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  license { accept = true }
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = "10292"

.github/workflows/ssc-collector-config/config.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = 0.0.0.0
   port = 12345
 

core/src/main/resources/reference.conf

@@ -1,4 +1,9 @@
 {
+  license {
+    accept = false
+    accept = ${?ACCEPT_LIMITED_USE_LICENSE}
+  }
+
   paths {}
 
   p3p {

core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/Config.scala

@@ -37,7 +37,8 @@ case class Config[+SinkConfig](
   networking: Config.Networking,
   enableDefaultRedirect: Boolean,
   redirectDomains: Set[String],
-  preTerminationPeriod: FiniteDuration
+  preTerminationPeriod: FiniteDuration,
+  license: Config.License
 )
 
 object Config {
@@ -152,7 +153,22 @@ object Config {
     idleTimeout: FiniteDuration
   )
 
+  case class FlexBoolean(value: Boolean)
+  object FlexBoolean {
+    implicit def toBoolean(b: FlexBoolean): Boolean = b.value
+  }
+  object License {
+    def apply(accept: Boolean): License = License(FlexBoolean(accept))
+  }
+  case class License(
+    accept: FlexBoolean
+  )
+
   implicit def decoder[SinkConfig: Decoder]: Decoder[Config[SinkConfig]] = {
+    implicit val flexBooleanDecoder: Decoder[FlexBoolean] = {
+      val truthy = Set("true", "yes", "on", "1")
+      Decoder.decodeBoolean.map(s => FlexBoolean(s)).or(Decoder.decodeString.map(s => FlexBoolean(truthy(s))))
+    }
     implicit val p3p         = deriveDecoder[P3P]
     implicit val crossDomain = deriveDecoder[CrossDomain]
     implicit val sameSite: Decoder[SameSite] = Decoder.instance { cur =>
@@ -177,6 +193,7 @@ object Config {
     implicit val ssl              = deriveDecoder[SSL]
     implicit val telemetry        = deriveDecoder[Telemetry]
     implicit val networking       = deriveDecoder[Networking]
+    implicit val license          = deriveDecoder[License]
     implicit val sinkConfig       = newDecoder[SinkConfig].or(legacyDecoder[SinkConfig])
     implicit val streams          = deriveDecoder[Streams[SinkConfig]]
 

core/src/main/scala/com.snowplowanalytics.snowplow.collector.core/Run.scala

@@ -54,15 +54,24 @@ object Run {
     telemetryInfo: TelemetryInfo[F, SinkConfig],
     path: Option[Path]
   ): F[ExitCode] = {
+    val licenseNotAccepted = ExitCode(2)
     val eitherT = for {
       config <- ConfigParser.fromPath[F, SinkConfig](path)
+      _      <- EitherT.cond[F](config.license.accept.value == true, ExitCode.Success, licenseNotAccepted)
       _      <- EitherT.right[ExitCode](fromConfig(appInfo, mkSinks, telemetryInfo, config))
     } yield ExitCode.Success
 
-    eitherT.merge.handleErrorWith { e =>
-      Logger[F].error(e)("Exiting") >>
-        prettyLogException(e).as(ExitCode.Error)
-    }
+    eitherT
+      .merge
+      .ensure(
+        new RuntimeException(
+          "License not accepted. Configure license acceptance to continue. See docs for more details."
+        )
+      )(_ != licenseNotAccepted)
+      .handleErrorWith { e =>
+        Logger[F].error(e)("Exiting") >>
+          prettyLogException(e).as(ExitCode.Error)
+      }
   }
 
   private def fromConfig[F[_]: Async: Tracking, SinkConfig](

core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/ConfigParserSpec.scala

@@ -52,7 +52,8 @@ class ConfigParserSpec extends Specification with CatsEffect {
       .copy[SinkConfig](
         paths   = Map.empty[String, String],
         streams = expectedStreams,
-        ssl     = TestUtils.testConfig.ssl.copy(enable = true)
+        ssl     = TestUtils.testConfig.ssl.copy(enable = true),
+        license = Config.License(false)
       )
 
     ConfigParser.fromPath[IO, SinkConfig](Some(path)).value.map(_ should beRight(expected))

core/src/test/scala/com.snowplowanalytics.snowplow.collector.core/TestUtils.scala

@@ -131,6 +131,7 @@ object TestUtils {
       moduleVersion   = None,
       instanceId      = None,
       autoGeneratedId = None
-    )
+    ),
+    license = License(accept = true)
   )
 }

examples/config.kafka.extended.hocon

@@ -12,6 +12,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.kafka.minimal.hocon

@@ -1,4 +1,8 @@
 collector {
+  license {
+    accept = true
+  }
+
   interface = "0.0.0.0"
   port = 8080
 

examples/config.kinesis.extended.hocon

@@ -12,6 +12,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.kinesis.minimal.hocon

@@ -1,4 +1,8 @@
 collector {
+  license {
+    accept = true
+  }
+
   interface = "0.0.0.0"
   port = 8080
 

examples/config.nsq.extended.hocon

@@ -12,6 +12,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.nsq.minimal.hocon

@@ -1,13 +1,16 @@
 collector {
+  license {
+    accept = true
+  }
   interface = "0.0.0.0"
   port = 8080
 
   streams {
     good {
       name = "good"
       host = "nsqHost"
-    }   
-    
+    }
+
     bad {
       name = "bad"
       host = "nsqHost"

examples/config.pubsub.extended.hocon

@@ -12,6 +12,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.pubsub.minimal.hocon

@@ -1,4 +1,8 @@
 collector {
+  license {
+    accept = true
+  }
+
   interface = "0.0.0.0"
   port = 8080
 

examples/config.sqs.extended.hocon

@@ -7,6 +7,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.sqs.minimal.hocon

@@ -1,4 +1,7 @@
 collector {
+  license {
+    accept = true
+  }
   interface = "0.0.0.0"
   port = 8080
 

examples/config.stdout.extended.hocon

@@ -12,6 +12,11 @@
 
 # 'collector' contains configuration options for the main Scala collector.
 collector {
+  # Full license text available in LICENSE.md
+  license {
+    accept = true
+  }
+
   # The collector runs as a web service specified on the following interface and port.
   interface = "0.0.0.0"
   port = 8080

examples/config.stdout.minimal.hocon

@@ -1,4 +1,7 @@
 collector {
+  license {
+    accept = true
+  }
   interface = "0.0.0.0"
   port = 8080
 

kafka/src/it/resources/collector.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kafka/src/test/scala/com.snowplowanalytics.snowplow.collectors.scalastream/KafkaConfigSpec.scala

@@ -156,6 +156,7 @@ object KafkaConfigSpec {
     networking = Config.Networking(
       maxConnections = 1024,
       idleTimeout    = 610.seconds
-    )
+    ),
+    license = Config.License(accept = true)
   )
 }

kinesis/src/it/resources/collector-cookie-anonymous.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-cookie-attributes-1.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-cookie-attributes-2.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-cookie-domain.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-cookie-fallback.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-cookie-no-domain.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-custom-paths.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-doNotTrackCookie-disabled.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector-doNotTrackCookie-enabled.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/it/resources/collector.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

kinesis/src/test/scala/com.snowplowanalytics.snowplow.collectors.scalastream/sinks/KinesisConfigSpec.scala

@@ -184,7 +184,8 @@ object KinesisConfigSpec {
       moduleVersion   = None,
       instanceId      = None,
       autoGeneratedId = None
-    )
+    ),
+    license = Config.License(accept = true)
   )
 
 }

nsq/src/test/scala/com.snowplowanalytics.snowplow.collectors.scalastream/NsqConfigSpec.scala

@@ -155,6 +155,7 @@ object NsqConfigSpec {
     networking = Config.Networking(
       maxConnections = 1024,
       idleTimeout    = 610.seconds
-    )
+    ),
+    license = Config.License(accept = true)
   )
 }

pubsub/src/it/resources/collector.hocon

@@ -1,4 +1,5 @@
 collector {
+  license { accept = true }
   interface = "0.0.0.0"
   port = ${PORT}
 

pubsub/src/test/scala/com.snowplowanalytics.snowplow.collectors.scalastream/ConfigSpec.scala

@@ -176,7 +176,8 @@ object ConfigSpec {
       moduleVersion   = None,
       instanceId      = None,
       autoGeneratedId = None
-    )
+    ),
+    license = Config.License(accept = true)
   )
 
 }

sqs/src/test/scala/com.snowplowanalytics.snowplow.collectors.scalastream/SqsConfigSpec.scala

@@ -164,7 +164,8 @@ object SqsConfigSpec {
       moduleVersion   = None,
       instanceId      = None,
       autoGeneratedId = None
-    )
+    ),
+    license = Config.License(accept = true)
   )
 
 }