Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Http4s Client with configuration appropriate for common-streams apps #87

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions modules/runtime-common/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
snowplow.defaults: {
http: {
client: {
maxConnectionsPerServer: 4
}
}

statsd: {
port: 8125
tags: {}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Copyright (c) 2023-present Snowplow Analytics Ltd. All rights reserved.
*
* This program is licensed to you under the Snowplow Community License Version 1.0,
* and you may not use this file except in compliance with the Snowplow Community License Version 1.0.
* You may obtain a copy of the Snowplow Community License Version 1.0 at https://docs.snowplow.io/community-license-1.0
*/
package com.snowplowanalytics.snowplow.runtime

import cats.effect.{Async, Resource}
import org.http4s.blaze.client.BlazeClientBuilder
import org.http4s.client.Client
import io.circe._
import io.circe.generic.semiauto._

object HttpClient {
case class Config(
maxConnectionsPerServer: Int
)

object Config {
implicit def telemetryConfigDecoder: Decoder[Config] = deriveDecoder
}

/**
* Provides a http4s Client configured appropriately for a snowplow common-streams app
*
* Blaze option `maxConnectionsPerRequestKey` is set to something small. This is required so we
* can traverse over many schemas in parallel without overwhelming any single Iglu server.
*
* Blaze options `maxTotalConnections` and `maxWaitQueueLimit` are unlimited. This is appropriate
* because common-streams apps are already naturally rate limited by the flow of events. We do not
* want exceptions for exceeding number of requests allowed in a queue.
*/
def resource[F[_]: Async](config: Config): Resource[F, Client[F]] =
BlazeClientBuilder[F]
.withMaxConnectionsPerRequestKey(Function.const(config.maxConnectionsPerServer))
.withMaxTotalConnections(Int.MaxValue)
.withMaxWaitQueueLimit(Int.MaxValue)
.resource
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import io.circe._
import io.circe.syntax._
import io.circe.config.syntax._
import io.circe.generic.semiauto._
import org.http4s.client.{Client => HttpClient}
import org.http4s.client.{Client => Http4sClient}
import org.typelevel.log4cats.Logger
import org.typelevel.log4cats.slf4j.Slf4jLogger

Expand Down Expand Up @@ -52,7 +52,7 @@ object Telemetry {
def stream[F[_]: Async](
config: Config,
appInfo: AppInfo,
httpClient: HttpClient[F]
httpClient: Http4sClient[F]
): Stream[F, Nothing] =
if (config.disable)
Stream.never
Expand All @@ -72,7 +72,7 @@ object Telemetry {
private def initTracker[F[_]: Async](
config: Config,
appName: String,
client: HttpClient[F]
client: Http4sClient[F]
): Resource[F, Tracker[F]] =
for {
implicit0(random: Random[F]) <- Resource.eval(Random.scalaUtilRandom)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ class ConfigParserSpec extends Specification with CatsEffect {
}

def configMissingField = {
val expected = "Cannot resolve config: DecodingFailure at .field41: Missing required field"
val expected = "Cannot resolve config: DecodingFailure at .field4.field41: Missing required field"
val path = Paths.get("src/test/resources/config_parser_test/config_missing_field.hocon")
ConfigParser
.configFromFile[IO, TestConfig](path)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ class MetricsConfigSpec extends Specification {
val result = ConfigFactory.load(ConfigFactory.parseString(input))

result.as[StatsdWrapper] must beLeft.like { case e: DecodingFailure =>
e.show must beEqualTo("DecodingFailure at .prefix: Missing required field")
e.show must beEqualTo("DecodingFailure at .xyz.prefix: Missing required field")
}
}

Expand Down
9 changes: 6 additions & 3 deletions project/Dependencies.scala
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ object Dependencies {
val catsRetry = "3.1.3"
val fs2 = "3.10.0"
val log4cats = "2.6.0"
val http4s = "0.23.26"
val http4s = "0.23.28"
val blaze = "0.23.16"
val decline = "2.4.1"
val circe = "0.14.6"
val circeExtra = "0.14.3"
val circe = "0.14.8"
val circeExtra = "0.14.4"
val circeConfig = "0.10.1"
val betterMonadicFor = "0.3.1"
val kindProjector = "0.13.2"
Expand Down Expand Up @@ -59,6 +60,7 @@ object Dependencies {
val catsRetry = "com.github.cb372" %% "cats-retry" % V.catsRetry
val emberServer = "org.http4s" %% "http4s-ember-server" % V.http4s
val http4sCirce = "org.http4s" %% "http4s-circe" % V.http4s
val blazeClient = "org.http4s" %% "http4s-blaze-client" % V.blaze
val decline = "com.monovore" %% "decline-effect" % V.decline
val circeConfig = "io.circe" %% "circe-config" % V.circeConfig
val circeGeneric = "io.circe" %% "circe-generic" % V.circe
Expand Down Expand Up @@ -164,6 +166,7 @@ object Dependencies {
)

val runtimeCommonDependencies = Seq(
blazeClient,
cats,
catsEffectKernel,
catsRetry,
Expand Down
Loading