Smithy4s #67
Smithy4s #67
Conversation
this is a step towards Scala 3 support
| } yield tagSecurableString(bytes) | ||
| case s => tagSecurableString(s).pure[F] | ||
| } | ||
| def SecureReader[F[_] : Async : Compression](awsEnv: AwsEnvironment[F]): Resource[F, ConfigReader[F[SecurableString]]] = |
There was a problem hiding this comment.
The Smithy4s documentation recommends against "treating Smithy4s-generated code as publishable library-material." However, this interface doesn't expose the generated KMS classes in any way; rather it accepts an AwsEnvironment[F] (something published by smithy4s) and returns a ConfigReader[F[SecurableString]], where SecurableString is defined by this library. As such I think for MiMa purposes we can treat the code in com.amazonaws.kms as private to this library, meaning we shouldn't need to worry about its binary compatibility.
(It would be better to move this has been addressed)com.amazonaws.kms to another package, e.g. com.dwolla.aws.kms or something like that, to minimize the chances of a clash with another library or generated code using com.amazonaws.kms. See the TODO in build.sbt.
bpholt
force-pushed
the
smithy4s
branch
2 times, most recently
from
685585b to
6d4df7d
Compare
bpholt
force-pushed
the
smithy4s
branch
3 times, most recently
from
cd47bde to
95f1fae
Compare
…access to the generated code
| ThisBuild / startYear := Option(2018) | ||
| ThisBuild / tlBaseVersion := "0.4" | ||
| ThisBuild / tlJdkRelease := Some(8) | ||
| ThisBuild / githubWorkflowBuild := List(Sbt(List("compile", "test"))) |
There was a problem hiding this comment.
Adding the extra compile step here ensures that sbt recompiles the code after it's modified by Scalafix. When the test task is executed after the explicit compile step, sbt will see that the code has changed since the compile step and recompile it.
| |""".stripMargin) | ||
| } | ||
|
|
||
| test("we don't have access to the generated KMS objects in the shaded package") { |
There was a problem hiding this comment.
If this test is attempted without the extra compile step (i.e. sbt clean ++2.13 test), it will fail. If the code as-modified-by-Scalafix is compiled, the test should succeed.
The test is broken up into Scala 2 and Scala 3 variants because the compiler messages are different coming out of the different compilers. This is probably a little brittle but it should work for now.
I think this demonstrates how to include a smithy4s reference in a library while being able to maintain binary compatibility.