Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • 18:26
    codecov[bot] commented #1335
  • 18:25
    codecov[bot] commented #1335
  • 18:24
    codecov[bot] commented #1335
  • 18:24
    codecov[bot] commented #1335
  • 18:23
    codecov[bot] commented #1335
  • 18:22
    codecov[bot] commented #1335
  • 18:21
    codecov[bot] commented #1335
  • 18:14
    github-actions[bot] labeled #1335
  • 18:14
    github-actions[bot] labeled #1335
  • 18:01
    scala-steward opened #1335
  • 05:46
    codecov[bot] commented #1334
  • 05:46
    codecov[bot] commented #1334
  • 05:44
    codecov[bot] commented #1334
  • 05:44
    codecov[bot] commented #1334
  • 05:44
    codecov[bot] commented #1334
  • 05:39
    github-actions[bot] labeled #1334
  • 05:28
    scala-steward opened #1334
  • Dec 04 23:46
    codecov[bot] commented #1333
  • Dec 04 23:43
    codecov[bot] commented #1333
  • Dec 04 23:43
    codecov[bot] commented #1333
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
kelnos Each module tracks commits that roll up to it, based on a file prefix filter. If you finalize the draft release for scala-http4s, it'll just release that one module. The next time a depending module is released, it'll pick up the most recent version of that module from the git tags and use that published artifact
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
I think the thing that would knit everything together would be a github action that just goes "release everything", where it knows about the reverse dependencies of the modules and bubbles everything back up to the main guardrail release
but it was great to see this actually work. I have a test repo here: https://github.com/blast-hardcheese/multi-release-drafter-test/releases
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
(also, aggravatingly, github doesn't permit on: release triggers to be filtered in any way, so my initial assumption about that being clean are also invalid. Gonna have to refactor that to avoid spam in the Actions tab)
but other than that, it does seem to be working. Releasing core now.
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
do'h. Everything worked, except of course the dependsOn versions ended up pulling their git desc version numbers instead of real versions.
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
OK, that time it worked.
kelnos
@kelnos:matrix.org
[m]
nice!
kelnos
@kelnos:matrix.org
[m]
blast_hardcheese: sbt-version-policy? better than mima?
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
I believe mima is used under the hood
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
Yeah, it does kelnos
kelnos
@kelnos:matrix.org
[m]
ah, cool
Ondra Pelech
@sideeffffect

Hello, is guardrail supposed to support specifying multiple response types?
As in https://swagger.io/docs/specification/describing-responses/#media-types

          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayOfUsers'
            application/xml:
              schema:
                $ref: '#/components/schemas/ArrayOfUsers'

https://spec.openapis.org/oas/v3.1.0#parameterContent
When I did that with guardrail, the generated code contained only the last defined

kelnos
@kelnos:matrix.org
[m]
@sideeffffect: java or scala? which framework?
Ondra Pelech
@sideeffffect
Scala, http4s in particular
Ondra Pelech
@sideeffffect
To clarify my use-case -- I would need to have different schema based on the Accepted header, like
          content:
            application/json:
              schema:
                type: object
            application/x-protobuf:
              schema:
                type: string
                format: binary
                x-scala-type: fs2.Chunk[Byte]
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
@sideeffffect: We only generate handlers for content-types that are known by guardrail internals. Without any changes, you can combine manually handled routes with the guardrail generated ones, reusing any guardrail-generated support classes where applicable
blast_hardcheese
@blast_hardcheese:matrix.org
[m]

So an interesting side effect of the module system that I hadn't considered, when a release-drafter release is cut, the tag is minted immediately. This has the effect of all subsequent runs compiling against the ABI exposed by the compiled modules in the source trees, but publishing POMs that refer to the tagged module versions.

The implications of this are that so long as you click release on the various drafts in the reverse-depends order, you can just release everything at once, and as the modules trickle up to bintray, they'll all be pointing at the right versions of stuff

the downside is that this isn't obvious, so if core's ABI breaks but it isn't released, then something that depends on core is released, it will be compiled against the new ABI but depend on the previous ABI.
The upside is that this all still happens at compile-time, not at runtime, so any goofs here manifest as inconveniences for the users, not runtime incidents.
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
kelnos Holy moly. The classloader stuff was annoying to work around. Much more so than I anticipated due to the strictness of classloading block members. I needed an indirection class in order to get it to work at all, but what I ended up with ends up with all the core deps being included in sbt-guardrail and friends, but by default if you try to use anything, you end up getting
sbt:guardrail-sample-http4s> compile
Missing dependency: guardrail-scala-http4s
[error] (Compile / guardrail) dev.guardrail.sbt.CodegenFailedException
[error] Total time: 0 s, completed Oct 14, 2021 6:31:52 PM

If I then stick

libraryDependencies += "dev.guardrail" %% "guardrail-scala-http4s" % "0.65.3-8-ga447b33-SNAPSHOT"

into project/plugins.sbt, it runs and generates sources, compiling successfully

Can you think of anything at a high level that I'm blundering into here, or does this still make sense enough to you that I'm not going to just crash this whole thing into the ground?
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
I did some analysis to track how classes were split into the various modules, as well as repackaging, as well as inner classes being moved to new objects: https://gist.github.com/blast-hardcheese/1c4dcfe2151510dfc87ec8e384d87cd1
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
Snapshots of the above have been published, things look good so far.
// Stick this in your project/guardrail.sbt or project/plugins.sbt, wherever you currently have the guardrail addSbtPlugin
resolvers += "Sonatype OSS Snapshots" at "https://s01.oss.sonatype.org/content/repositories/snapshots"
addSbtPlugin("dev.guardrail" % "sbt-guardrail" % "0.65.4+4-8fd0a0c5+20211015-1748-SNAPSHOT")

// stick these alongside the addSbtPlugin in whatever file you ended up using above
libraryDependencies += "dev.guardrail" %% "guardrail" % "0.65.4-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-cli" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-core" % "0.65.3-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-java-async-http" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-java-dropwizard" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-java-spring-mvc" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-java-support" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-scala-akka-http" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-scala-dropwizard" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-scala-endpoints" % "0.65.1-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-scala-http4s" % "0.65.3-31-g5de1766-SNAPSHOT"
libraryDependencies += "dev.guardrail" %% "guardrail-scala-support" % "0.65.1-31-g5de1766-SNAPSHOT"
Start with just the plugin, then add whichever the plugin tells you that you need
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
guardrail-dev/guardrail#1300 starting to make it easier for iterating on a single module. Might be useful to .aggregate(dependents % "test") when working on a module to ensure related modules' tests also get run
kelnos
@kelnos:matrix.org
[m]
blast_hardcheese: sorry i've been MIA for a bit... this all seems reasonable from an implementation perspective (the indirection classes are kinda ugly, but not sure there's a way around that). my main concern is that now the build/plugin configuration is significantly more complicated for the user.
kelnos
@kelnos:matrix.org
[m]
mmm, true
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
OK. I've done another pass at the provided switchup, I think it's more stable now. The last time I tried publishing it introduced ABI incompatibilities, after a bit of back and forth I convinced SBT to use explicitly published jars when building release artifacts, which should make everything more stable overall.
Ondra Pelech
@sideeffffect
Currently, we use Guardrail to generate both Server and Client part, but the generated code ends up in separate *.server and *.client packages. Is there a way to generate only the shared data structures -- so that we could create shared functionality for them, like validators, etc -- that would be used by both Server and Client?
kelnos
@kelnos:matrix.org
[m]
@sideeffffect: pretty sure the package names are coming from your configuration, not anything hard-coded in guardrail itself
Ondra Pelech
@sideeffffect
But won't there be a conflict if I try to generate both Server and Client to the same package? Also, if I want to have a JAR with the shared data-structures that is to be then depended upon by both Server and Client, how do I do that?
kelnos
@kelnos:matrix.org
[m]
we're generally very careful to not generate the same class names in clients and servers. the only thing that will get generated twice is the stuff under definitions, but, given the same spec, they will always be the same between clients and servers
Ondra Pelech
@sideeffffect
I see -- so the solution is to generate both Server and Client to the same package and thus there will be just one set of shared Data structures. Rigth?
kelnos
@kelnos:matrix.org
[m]

Also, if I want to have a JAR with the shared data-structures that is to be then depended upon by both Server and Client, how do I do that?

you more or less can't, at least not without some gymnastics. you could generate in models mode (as opposed to client or server) in one module, and that will give you definitions. then in the other modules you depend on that, and generate in client or server mode. but that will still generate a duplicate definitions package, so you'll have to figure out how to delete them after generation

that's not really the way most people use guardrail; the general idea is not to ship binaries based on the openapi spec at all. you ship the openapi spec, and your users generate the client themselves, using whatever tool/framework/whatever they prefer. but i do understand that some people want to ship fully-functional clients as a jar. it's just not as common, and it's a little more difficult to do properly. also not sure why you need the separate jar for the definitions, since the server will usually not use the client, and you usually don't need to ship a server. but i figure there are likely use cases i haven't thought of...
(or rather, i should say, shipping a client jar isn't difficult if you just include the definitions and client in the same module/jar)
blast_hardcheese
@blast_hardcheese:matrix.org
[m]
@sideeffffect: If you're using http4s, up until 0.68.0 there was a name collision between server and client generated members, though that was resolved in https://github.com/guardrail-dev/guardrail/releases/tag/scala-http4s-v0.68.0
Ondra Pelech
@sideeffffect
Good to know! Thanks