@command and @query annotations should be provided by tapiro

[giuscri]

Asking users to implement them via

import scala.annotations.StaticAnnotation
class query extends StaticAnnotation

means they have to define them in random files of their package. They can't put the definitions at the top of each trait Controller because they'll clash as soon as the package has >= 2 controllers.

Why not defining them in a library such that users can import them as many times they need?

[gabro]

I agree in principle, although it's a bit strange to have a library dependency for two lines of code. @calippo what do you think?

[gabro]

Another idea we can explore is not to require annotations, but use comments instead, as in

trait MyController[F[_], AuthToken] {
  // tapiro:query
  def myGet(): F[Error, String]

  // tapiro:command
  def myPost(): F[Error, String]
}

[calippo]

Need to think more about this.

I don't love comments. I think we can write a small library for this, it might include also a tapiro auth token with deserialization

import sttp.tapir._
import sttp.tapir.Codec._

case class CustomAuth(token: String)

def decodeAuth(s: String): DecodeResult[CustomAuth] = {
  val TokenPattern = "Token token=(.+)".r
  s match {
    case TokenPattern(token) => DecodeResult.Value(CustomAuth(token))
    case _                   => DecodeResult.Error(s, new Exception("token not found"))
  }
}

def encodeAuth(auth: CustomAuth): String = auth.token

implicit val authCodec: PlainCodec[CustomAuth] = Codec.stringPlainCodecUtf8
  .mapDecode(decodeAuth)(encodeAuth)

[gabro]

Partially related: should tapiro define an AuthToken? I would start thinking to move it to toctoc

[calippo]

I don't think there's a way to completely decouple the authentication from an HTTP library. I think it's fine to embrace it to a certain extent.

To me it is ok having a lightweight "token handling module" in tapiro.