Skip to content

CDF-26312: GenericClient: add wrapSttpBackend argument #904

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

CDF-26312: GenericClient: add wrapSttpBackend argument #904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1838048
CDF-26312: GenericClient: add wrapSttpBackend argument
dmivankov Nov 27, 2025
b0828a2
Merge branch 'master' into CDF-26312
dmivankov Dec 1, 2025
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
2 changes: 1 addition & 1 deletion build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ lazy val commonSettings = Seq(
organization := "com.cognite",
organizationName := "Cognite",
organizationHomepage := Some(url("https://cognite.com")),
version := "2.34." + patchVersion,
version := "2.35." + patchVersion,
isSnapshot := patchVersion.endsWith("-SNAPSHOT"),
scalaVersion := scala213, // use 2.13 by default
// handle cross plugin https://github.com/stringbean/sbt-dependency-lock/issues/13
Expand Down
32 changes: 24 additions & 8 deletions src/main/scala/com/cognite/sdk/scala/v1/GenericClient.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ class GenericClient[F[_]: Trace](
apiVersion: Option[String],
clientTag: Option[String],
cdfVersion: Option[String],
sttpBackend: SttpBackend[F, Any]
sttpBackend: SttpBackend[F, Any],
wrapSttpBackend: SttpBackend[F, Any] => SttpBackend[F, Any]
)(implicit monad: CMonadError[F, Throwable]) {
def this(
applicationName: String,
Expand All @@ -44,7 +45,8 @@ class GenericClient[F[_]: Trace](
apiVersion: Option[String] = None,
clientTag: Option[String] = None,
cdfVersion: Option[String] = None,
sttpBackend: SttpBackend[F, Any]
sttpBackend: SttpBackend[F, Any],
wrapSttpBackend: SttpBackend[F, Any] => SttpBackend[F, Any] = identity[SttpBackend[F, Any]](_)
)(implicit monad: CMonadError[F, Throwable]) =
this(
applicationName,
Expand All @@ -54,7 +56,8 @@ class GenericClient[F[_]: Trace](
apiVersion,
clientTag,
cdfVersion,
sttpBackend
sttpBackend,
wrapSttpBackend
)

import GenericClient._
Expand All @@ -66,12 +69,15 @@ class GenericClient[F[_]: Trace](
applicationName,
uri"$uri/api/${apiVersion.getOrElse("v1")}/projects/$projectName",
sttpBackend,
wrapSttpBackend,
authProvider,
clientTag,
cdfVersion
)
lazy val token =
new Token[F](RequestSession(applicationName, uri, sttpBackend, authProvider, clientTag))
new Token[F](
RequestSession(applicationName, uri, sttpBackend, wrapSttpBackend, authProvider, clientTag)
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The RequestSession created for token is missing the cdfVersion parameter. This means that requests made by the token instance (e.g., token.inspect()) will not include the cdf-version header, which could lead to incorrect request routing in multi-cluster environments. Please add cdfVersion to the RequestSession constructor call to ensure consistent behavior with other API requests.

Suggested change
RequestSession(applicationName, uri, sttpBackend, wrapSttpBackend, authProvider, clientTag)
RequestSession(applicationName, uri, sttpBackend, wrapSttpBackend, authProvider, clientTag, cdfVersion)

Copy link
Contributor Author

@dmivankov dmivankov Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will look into it separately

)
lazy val assets = new Assets[F](requestSession.withResourceType(ASSETS))
lazy val events = new Events[F](requestSession.withResourceType(EVENTS))
lazy val files = new Files[F](requestSession.withResourceType(FILES))
Expand Down Expand Up @@ -175,9 +181,17 @@ object GenericClient {
projectName: String,
baseUrl: String,
auth: Auth,
sttpBackend: SttpBackend[F, Any]
sttpBackend: SttpBackend[F, Any],
wrapSttpBackend: SttpBackend[F, Any] => SttpBackend[F, Any] = identity[SttpBackend[F, Any]](_)
)(implicit F: CMonadError[F, Throwable]): GenericClient[F] =
new GenericClient(applicationName, projectName, baseUrl, auth, sttpBackend = sttpBackend)
new GenericClient(
applicationName,
projectName,
baseUrl,
auth,
sttpBackend = sttpBackend,
wrapSttpBackend = wrapSttpBackend
)

def parseBaseUrlOrThrow(baseUrl: String): Uri =
try {
Expand Down Expand Up @@ -235,7 +249,8 @@ object GenericClient {
apiVersion: Option[String] = None,
clientTag: Option[String] = None,
cdfVersion: Option[String] = None,
sttpBackend: SttpBackend[F, Any]
sttpBackend: SttpBackend[F, Any],
wrapSttpBackend: SttpBackend[F, Any] => SttpBackend[F, Any] = identity[SttpBackend[F, Any]](_)
)(implicit F: CMonadError[F, Throwable]): F[GenericClient[F]] =
if (projectName.isEmpty) {
F.raiseError(InvalidAuthentication())
Expand All @@ -249,7 +264,8 @@ object GenericClient {
apiVersion,
clientTag,
cdfVersion,
sttpBackend
sttpBackend,
wrapSttpBackend
)
)
}
Expand Down
3 changes: 2 additions & 1 deletion src/main/scala/com/cognite/sdk/scala/v1/RequestSession.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ final case class RequestSession[F[_]: Trace](
applicationName: String,
baseUrl: Uri,
baseSttpBackend: SttpBackend[F, _],
wrapSttpBackend: SttpBackend[F, Any] => SttpBackend[F, Any],
auth: AuthProvider[F],
clientTag: Option[String] = None,
cdfVersion: Option[String] = None,
Expand All @@ -39,7 +40,7 @@ final case class RequestSession[F[_]: Trace](
this.copy(tags = this.tags + (GenericClient.RESOURCE_TYPE_TAG -> resourceType))

val sttpBackend: SttpBackend[F, _] =
new AuthSttpBackend(new TraceSttpBackend(baseSttpBackend), auth)
wrapSttpBackend(new AuthSttpBackend(new TraceSttpBackend(baseSttpBackend), auth))

def send[R](
r: RequestT[Empty, Either[String, String], Any] => RequestT[Id, R, Any]
Expand Down
1 change: 1 addition & 0 deletions src/test/scala/com/cognite/sdk/scala/common/OAuth2ClientCredentialsTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ class OAuth2ClientCredentialsTest extends AnyFlatSpec with Matchers with OptionV
clientTag = None,
cdfVersion = None,
sttpBackend = sttpBackend,
wrapSttpBackend = identity[SttpBackend[IO, Any]],
)

noException shouldBe thrownBy {
Expand Down
2 changes: 1 addition & 1 deletion src/test/scala/com/cognite/sdk/scala/common/TokenTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class TokenTest extends SdkTestSpec with OptionValues {

val token =
new Token(RequestSession[IO]("CogniteScalaSDK-OAuth-Test", uri"${baseUrl}", sttpBackend,
authProvider))
identity, authProvider))
val status = token.inspect().unsafeRunTimed(10.seconds).value
assert(status.subject !== "")
}
Expand Down
3 changes: 2 additions & 1 deletion src/test/scala/com/cognite/sdk/scala/v1/CommonDataModelTestHelper.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ trait CommonDataModelTestHelper extends AnyFlatSpec with Matchers {
None,
None,
Some("alpha"),
new RetryingBackend[IO, Any](implicitly)
implicitly[SttpBackend[IO, Any]],
new RetryingBackend[IO, Any](_: SttpBackend[IO, Any]),
)
}
4 changes: 3 additions & 1 deletion src/test/scala/com/cognite/sdk/scala/v1/TransformationsTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import cats.effect.unsafe.implicits.global
import com.cognite.sdk.scala.common.OAuth2.ClientCredentials
import com.cognite.sdk.scala.common._
import io.circe.syntax.EncoderOps
import sttp.client3.SttpBackend
import sttp.model.Uri

import java.time.temporal.ChronoUnit
Expand All @@ -28,7 +29,8 @@ class TransformationsTest extends CommonDataModelTestHelper with RetryWhile {
None,
None,
None,
sttpBackendAuth
sttpBackendAuth,
identity[SttpBackend[IO, Any]](_),
)

def shortRandomUUID(): String = UUID.randomUUID().toString.substring(0, 8)
Expand Down