@niroai/niro 0.17.0 → 0.18.0

package/docs/supported-go.md

@@ -0,0 +1,258 @@
+# Supported in Go
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: catalog/go.json; catalog/go.structure.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page lists the Go libraries, frameworks and build tools Niro was tested against, and whether it recognised each one.
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+The test catalog also holds 9 look-alike cases for Go: code that Niro must NOT take for a route, a call or a store. They test that Niro ignores the look-alike, so they are left out of this page and its counts.
+<!-- source: catalog/go.json and catalog/go.structure.json, rows marked as traps (scripts/gen-supported-docs.js isTrap) -->
+
+## Web frameworks and HTTP servers (the routes your code serves)
+
+19 supported, 0 partly, 9 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| AWS SAM template.yaml | supported | yes: AWS::Serverless::Function (Runtime provided.al2023, Handler bootstrap, Metadata BuildMethod go1.x) with Events Type HttpApi Path and Method; the handler is the package main under CodeUri |
+| encore.dev | not yet | no: //encore:api comment directive above a function |
+| github.com/beego/beego/v2 | supported | yes: web.Router with a controller and 'verb:Method' mapping<br>yes: web.Get functional route with a literal<br>yes: NewNamespace with NSRouter |
+| github.com/cloudwego/hertz | supported | yes: verbs on server.Default() held in `h`<br>yes: Group then verb |
+| github.com/danielgtaylor/huma/v2 | supported | yes: huma.Get(api, path, handler) package helper<br>yes: huma.Register with an Operation literal naming Method and Path |
+| github.com/dapr/go-sdk | not yet | no: service AddServiceInvocationHandler(path, h) |
+| github.com/fasthttp/router | supported | yes: fasthttp/router verbs and Group |
+| github.com/gin-gonic/gin | supported | yes: engine verb methods with a method-value handler<br>yes: inline function literal handler<br>yes: Handle with the verb as a string<br>yes: Any registers every verb<br>yes: route group with a block<br>yes: *gin.RouterGroup passed to a register function in another file |
+| github.com/go-chi/chi/v5 | supported | yes: chi verb methods<br>yes: Route with a function literal, nested twice<br>yes: Method with a verb constant and an http.Handler<br>yes: inline middleware chain before the verb<br>yes: Mount a sub-router returned by a function |
+| github.com/go-kit/kit (transport/http) | not yet | no: go-kit httptransport.NewServer mounted on a gorilla route |
+| github.com/go-kratos/kratos (HTTP transport) | not yet | no: kratos generated *_http.pb.go registering routes |
+| github.com/go-martini/martini | supported | yes: verbs on martini.Classic() held in `m`<br>yes: Group with a function literal |
+| github.com/gobuffalo/buffalo | not yet | no: buffalo app verbs |
+| github.com/gofiber/fiber/v2 | supported | yes: Fiber verb methods<br>yes: Add with a verb constant<br>yes: Group<br>yes: Route with a function literal |
+| github.com/gofiber/fiber/v3 | not yet | no: fiber v3 verbs (handler takes fiber.Ctx interface) |
+| github.com/gorilla/mux | supported | yes: HandleFunc(...).Methods(verb)<br>yes: Handle(path, http.HandlerFunc(m)).Methods(verb)<br>yes: chain starting with Methods, then Path, then HandlerFunc<br>yes: PathPrefix(...).Subrouter() |
+| github.com/julienschmidt/httprouter | supported | yes: httprouter verb methods<br>yes: Handle with a verb constant<br>yes: HandlerFunc with a plain http.HandlerFunc |
+| github.com/kataras/iris/v12 | supported | yes: iris verbs and Party<br>yes: Handle with a verb string |
+| github.com/labstack/echo/v4 | supported | yes: Echo verb methods<br>yes: Add with a verb constant<br>yes: Match with a verb list<br>yes: Group with a prefix |
+| github.com/oapi-codegen/oapi-codegen (generated server) | not yet | no: generated RegisterHandlers: router.GET(baseURL+path, wrapper.X) inside checked-in generated code |
+| github.com/revel/revel | not yet | no: conf/routes file |
+| github.com/uptrace/bunrouter | supported | yes: bunrouter verbs<br>yes: WithGroup with a function literal |
+| github.com/zeromicro/go-zero | supported | yes: AddRoutes with a []rest.Route literal and rest.WithPrefix<br>yes: AddRoute with one rest.Route literal |
+| goa.design/goa/v3 | not yet | no: goa design DSL plus generated server |
+| gofr.dev | supported | yes: gofr app verbs |
+| Netlify Functions (Go, Lambda compatibility) | supported | yes: netlify/functions/<name>/main.go (or <name>.go) with lambda.Start: served at /.netlify/functions/<name>, every verb; a -background suffix makes a background function<br>yes: netlify.toml [[redirects]] from a path to /.netlify/functions/<name> with status 200 gives the function that path too<br>yes: netlify.toml [functions] directory = "<folder>" moves where function folders are read from |
+| Serverless Framework serverless.yml | supported | yes: functions.<name> with handler bootstrap and package.artifact, events httpApi; runtime provided.al2023 |
+| Vercel Functions (Go runtime, /api directory) | supported | yes: api/<name>.go with an exported func(http.ResponseWriter, *http.Request): the file path is the route, every verb<br>yes: api/cards/[id].go: a bracketed file name is a dynamic path segment |
+
+## The language's own HTTP server
+
+0 supported, 2 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| net/http | partly | yes: http.HandleFunc on the default mux, inline func literal handler<br>yes: http.Handle with a type implementing http.Handler (ServeHTTP)<br>yes: ServeMux.HandleFunc with Go 1.22 pattern 'METHOD /path/{wildcard}'<br>yes: ServeMux.Handle with a method pattern and an http.Handler value<br>yes: http.HandlerFunc(fn) adapter passed to Handle<br>yes: Go 1.22 trailing wildcard {name...}<br>yes: Go 1.22 exact-match marker {$}<br>yes: Go 1.22 host-qualified pattern<br>partly: pre-1.22 single path, verb chosen by switch r.Method in the handler<br>yes: second ServeMux mounted under a prefix with http.StripPrefix |
+| net/rpc | partly | yes: rpc.Register + rpc.HandleHTTP: every exported method T.M(args, *reply) error is a procedure<br>yes: rpc.RegisterName with a custom service name<br>no: rpc.NewServer + jsonrpc.NewServerCodec over raw TCP |
+
+## HTTP client libraries (the calls your code makes to other services)
+
+2 supported, 5 partly, 8 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| github.com/carlmjohnson/requests | supported | yes: requests.URL(base).Pathf().ToJSON().Fetch(ctx)<br>yes: BodyJSON().Post().Fetch |
+| github.com/cloudwego/hertz (client) | partly | yes: hertz client.Get(ctx, dst, url)<br>no: protocol.Request SetMethod/SetRequestURI then client Do |
+| github.com/dapr/go-sdk | not yet | no: client.InvokeMethod(ctx, appID, method, verb): service invocation by app name |
+| github.com/dghubble/sling | not yet | no: sling.New().Base(url); New().Get(path).ReceiveSuccess<br>no: Post(path).BodyJSON().ReceiveSuccess |
+| github.com/go-kit/kit (transport/http client) | not yet | no: httptransport.NewClient(verb, url, enc, dec) |
+| github.com/go-resty/resty/v2 | partly | yes: client with SetBaseURL; R().SetPathParam().Get(path)<br>yes: R().SetBody().Post<br>yes: R().SetContext().SetBody().Put<br>no: R().Execute(verb, url)<br>yes: fresh client, full literal URL |
+| github.com/gojek/heimdall/v7 | not yet | no: httpclient.NewClient().Get(url, headers)<br>no: Post(url, body, headers) |
+| github.com/hashicorp/go-cleanhttp | not yet | no: cleanhttp.DefaultPooledClient() returns *http.Client; then Get |
+| github.com/hashicorp/go-retryablehttp | partly | yes: package-level retryablehttp.Get<br>yes: NewClient then Post<br>no: retryablehttp.NewRequest then Do<br>no: StandardClient() gives a plain *http.Client |
+| github.com/imroc/req/v3 | partly | no: req.C().SetBaseURL(); R().SetPathParam().Get<br>no: R().SetBody().Post<br>yes: package-level req.Get with a full URL<br>no: fluent client.Delete(url).Do() |
+| github.com/parnurzeal/gorequest | supported | yes: gorequest.New().Get(url).End()<br>yes: Post(url).Send(json).End() |
+| github.com/valyala/fasthttp (client) | partly | yes: fasthttp.Get(dst, url)<br>no: AcquireRequest, SetRequestURI, SetMethod, Client.Do |
+| github.com/zeromicro/go-zero/rest/httpc | not yet | no: httpc.Do(ctx, verb, url-with-:id, reqStruct) |
+| gopkg.in/h2non/gentleman.v2 | not yet | no: URL, Request, Method, Path, Send |
+| oapi-codegen generated client | not yet | no: generated NewClientWithResponses(server) + GetSupplierWithResponse; generated code calls http.NewRequest |
+
+## The language's own HTTP client
+
+0 supported, 2 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| net/http | partly | yes: http.Get with a literal URL<br>yes: http.Get with literal base plus string concatenation<br>no: http.Get with fmt.Sprintf building the URL<br>yes: http.Post with a base held in a package constant<br>partly: http.PostForm<br>yes: http.Head<br>no: http.NewRequest with a verb constant, then a configured http.Client's Do<br>no: http.NewRequestWithContext with a verb literal, then http.DefaultClient.Do, base from os.Getenv<br>no: url.JoinPath builds the URL, http.Client value's Get<br>yes: *http.Client held on a struct field, base on another field set from config<br>no: net/http/httputil reverse proxy to a fixed target<br>yes: plain http.Get to a grpc-gateway REST mapping |
+| net/rpc | partly | no: rpc.DialHTTP then client.Call("Type.Method", args, &reply)<br>partly: asynchronous client.Go<br>yes: jsonrpc.Dial then Call |
+
+## gRPC
+
+2 supported, 3 partly, 4 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| connectrpc.com/connect (client) | supported | yes: connect-go: {pkg}connect.New{S}Client(http.DefaultClient, baseURL) then client.M(ctx, connect.NewRequest(...)) (plan 8.4)<br>yes: the same client with connect.WithGRPC() |
+| connectrpc.com/connect (server) | supported | yes: connect-go: path, h := {pkg}connect.New{S}Handler(&impl{}); mux.Handle(path, h) (plan 8.4) |
+| github.com/go-kratos/kratos (gRPC transport) | not yet | no: kratos gRPC transport: pb.Register{S}Server(grpcSrv, svc) via kratos grpc.NewServer |
+| github.com/grpc-ecosystem/grpc-gateway/v2 | partly | yes: grpc-gateway REST mapping from option (google.api.http) in the .proto, incl. additional_bindings (plan 8.4)<br>yes: pb.Register{S}HandlerFromEndpoint(ctx, mux, addr, opts)<br>no: pb.Register{S}HandlerServer(ctx, mux, impl) in-process |
+| github.com/twitchtv/twirp | not yet | no: twirp New{S}Server(impl) mounted at server.PathPrefix(); path /twirp/{pkg}.{S}/{M}<br>no: twirp New{S}ProtobufClient(baseURL, httpClient) then client.M |
+| go-micro.dev/v4 | not yet | no: go-micro service handler registration |
+| google.golang.org/grpc (client) | partly | yes: conn from grpc.NewClient(literal target), then pb.New{S}Client(conn) stored on a struct field typed pb.{S}Client<br>yes: server-streaming client call returning a stream<br>yes: deprecated grpc.Dial(os.Getenv(...)) and a local client variable<br>no: grpc.DialContext with a dns:/// target (plan 8.6)<br>yes: conn.Invoke with the full wire path literal (plan 8.3 literal_path)<br>no: dynamic client through grpcreflect (plan 8.3: not covered) |
+| google.golang.org/grpc (server) | partly | yes: server struct embedding pb.Unimplemented{S}Server, unary method (plan row grpc-go-unimplemented)<br>no: pb.Register{S}Server(s, impl) registration (plan section 3, go)<br>yes: server-streaming method M(req, stream pb.S_MServer) error (plan 8.2)<br>yes: client-streaming method M(stream pb.S_MServer) error (plan 8.2)<br>yes: bidirectional streaming method (plan 8.2)<br>yes: hand-written grpc.ServiceDesc literal + RegisterService (plan 8.3, keyed-literal reader)<br>no: grpc_health_v1.RegisterHealthServer(s, health.NewServer())<br>yes: reflection.Register(s) must NOT become a route (plan 8.3)<br>yes: checked-in generated orders_grpc.pb.go: the Unimplemented base's methods and the generated client's c.cc.Invoke must NOT become routes or calls (plan trap T5) |
+| storj.io/drpc | not yet | no: storj drpc generated DRPC{S} interfaces |
+
+## Databases and data stores
+
+13 supported, 10 partly, 25 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| cloud.google.com/go/bigquery | not yet | no: client.Query(sql).Read<br>no: Dataset().Table().Inserter().Put |
+| cloud.google.com/go/firestore | supported | yes: Collection().Doc().Get/Set<br>yes: Collection().Where().Documents().GetAll |
+| cloud.google.com/go/spanner | partly | partly: Single().Query(ctx, spanner.Statement{SQL: ...})<br>yes: spanner.Insert(table, cols, vals) passed to Apply |
+| database/sql | partly | yes: sql.Open + QueryContext with the query in a constant<br>yes: ExecContext with an inline INSERT<br>yes: transaction: BeginTx, PrepareContext(DELETE), QueryRowContext(SELECT count)<br>partly: main reads or writes a table or collection that a service also owns (the cross-service data link) |
+| entgo.io/ent | not yet | no: client.Review.Query().Where().All / Create().Save |
+| github.com/aerospike/aerospike-client-go/v7 | not yet | no: github.com/aerospike/aerospike-client-go/v7 basic read/write |
+| github.com/aws/aws-sdk-go (v1 dynamodb, s3) | not yet | no: github.com/aws/aws-sdk-go (v1 dynamodb, s3) basic read/write |
+| github.com/aws/aws-sdk-go-v2/service/dynamodb | supported | yes: PutItem with TableName: aws.String(literal)<br>yes: GetItem with TableName from a constant<br>yes: Query |
+| github.com/aws/aws-sdk-go-v2/service/s3 | partly | yes: PutObject with Bucket literal<br>no: GetObject with Bucket from os.Getenv<br>yes: manager.NewUploader(client).Upload |
+| github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos | not yet | no: github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos basic read/write |
+| github.com/Azure/azure-sdk-for-go/sdk/storage/azblob | not yet | no: github.com/Azure/azure-sdk-for-go/sdk/storage/azblob basic read/write |
+| github.com/bradfitz/gomemcache | partly | partly: mc.Set(&memcache.Item{Key: k}) and mc.Get(k) |
+| github.com/ClickHouse/clickhouse-go/v2 | supported | yes: conn.Query(ctx, sql)<br>yes: PrepareBatch(ctx, "INSERT INTO t") |
+| github.com/dgraph-io/badger | not yet | no: github.com/dgraph-io/badger basic read/write |
+| github.com/doug-martin/goqu/v9 | supported | yes: goqu From(table).Where().ScanVals<br>yes: Insert(table).Rows().Executor().Exec() |
+| github.com/elastic/go-elasticsearch/v8 | partly | partly: es.Index(index, body)<br>yes: es.Search(es.Search.WithIndex(name))<br>no: typed client Search().Index(name).Do |
+| github.com/go-pg/pg/v10 | not yet | no: db.Model(&v).Where().Select() and Insert with pg:"table" tag |
+| github.com/go-sql-driver/mysql | supported | yes: sql.Open("mysql", dsn) then Query |
+| github.com/gocql/gocql | supported | yes: session.Query(cql).Exec() / .Iter() |
+| github.com/gocraft/dbr/v2 | not yet | no: github.com/gocraft/dbr/v2 basic read/write |
+| github.com/gomodule/redigo | not yet | no: conn.Do("COMMAND", key, ...) |
+| github.com/hashicorp/consul/api (KV) | not yet | no: github.com/hashicorp/consul/api (KV) basic read/write |
+| github.com/influxdata/influxdb-client-go/v2 | not yet | no: github.com/influxdata/influxdb-client-go/v2 basic read/write |
+| github.com/jackc/pgx/v5 | partly | yes: pgx.Connect then conn.QueryRow<br>yes: pgxpool.New then pool.Exec<br>yes: pool.Query<br>no: pgx.Batch Queue<br>yes: CopyFrom with pgx.Identifier{table} |
+| github.com/jmoiron/sqlx | partly | yes: db.Select(&dest, query)<br>no: db.Get with db.Rebind(query)<br>yes: NamedExec INSERT<br>yes: Queryx<br>yes: MustExec |
+| github.com/lib/pq | supported | yes: Exec with pq.Array argument<br>yes: COPY with pq.CopyIn(table, cols...) |
+| github.com/Masterminds/squirrel | partly | yes: Select().From(table).RunWith(db).Query()<br>no: Insert(table).ToSql() then db.Exec |
+| github.com/mattn/go-sqlite3 and modernc.org/sqlite | supported | yes: sql.Open("sqlite3", file) then Exec<br>yes: sql.Open("sqlite", file) then QueryRow |
+| github.com/meilisearch/meilisearch-go | not yet | no: github.com/meilisearch/meilisearch-go basic read/write |
+| github.com/milvus-io/milvus-sdk-go/v2 | not yet | no: github.com/milvus-io/milvus-sdk-go/v2 basic read/write |
+| github.com/minio/minio-go/v7 | supported | yes: minio PutObject/GetObject(ctx, bucket, object, ...) |
+| github.com/neo4j/neo4j-go-driver/v5 | supported | yes: neo4j.ExecuteQuery(ctx, driver, cypher) and session.Run(ctx, cypher) |
+| github.com/olivere/elastic/v7 | not yet | no: github.com/olivere/elastic/v7 basic read/write |
+| github.com/opensearch-project/opensearch-go | not yet | no: github.com/opensearch-project/opensearch-go basic read/write |
+| github.com/qdrant/go-client | not yet | no: github.com/qdrant/go-client basic read/write |
+| github.com/redis/go-redis/v9 | supported | yes: Set/Get/HSet/LPush with literal or built keys<br>yes: Pipeline commands then Exec<br>yes: NewClusterClient then Del |
+| github.com/redis/rueidis | not yet | no: client.Do(ctx, client.B().Set().Key(k).Value(v).Build()) |
+| github.com/upper/db/v4 | not yet | no: github.com/upper/db/v4 basic read/write |
+| github.com/uptrace/bun | partly | yes: NewSelect().Model(&slice) with bun:"table:..." tag<br>partly: NewInsert().Model(&v).Exec<br>yes: NewSelect().Table(name)<br>yes: NewRaw SQL |
+| github.com/volatiletech/sqlboiler/v4 | not yet | no: github.com/volatiletech/sqlboiler/v4 basic read/write |
+| go.etcd.io/bbolt | not yet | no: tx.Bucket([]byte(name)).Put/Get inside Update/View closures |
+| go.etcd.io/etcd/client/v3 | not yet | no: clientv3 Put/Get with key or prefix |
+| go.mongodb.org/mongo-driver | supported | yes: Database().Collection() then FindOne/InsertOne/UpdateOne<br>yes: one-line chain Database().Collection().Aggregate |
+| go.mongodb.org/mongo-driver/v2 | supported | yes: mongo-driver v2 (Connect without ctx), Find/DeleteMany |
+| gocloud.dev/blob | not yet | no: gocloud.dev/blob basic read/write |
+| gorm.io/gorm | partly | yes: model-based queries: First, Where().Order().Find<br>yes: Create(&model)<br>yes: Model(&Order{}).Where().Update<br>yes: Delete(&Order{}, id)<br>yes: Table(name) names the table<br>yes: Raw SQL through GORM<br>yes: Exec SQL through GORM<br>no: model with TableName() override |
+| sqlc (generated code) | not yet | no: sqlc generated Queries: SQL in const strings, called through q.db.QueryRow/Exec |
+| xorm.io/xorm | not yet | no: engine.Where().Get(&model) with TableName()<br>no: engine.Table(name).Where().Count() |
+
+## Messaging and events (queues, topics, streams)
+
+5 supported, 14 partly, 15 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| channels (in-process bus) | not yet | no: in-process event bus on channels shared between packages (Publish/Subscribe by topic string) |
+| cloud.google.com/go/pubsub | partly | no: client.Topic(name).Publish(ctx, msg), inline or through a variable<br>partly: client.Subscription(name).Receive(ctx, cb) |
+| cloud.google.com/go/pubsub/v2 (Publisher/Subscriber API) | not yet | no: cloud.google.com/go/pubsub/v2 (Publisher/Subscriber API) basic use |
+| github.com/apache/pulsar-client-go | supported | yes: CreateProducer(pulsar.ProducerOptions{Topic}) then Send<br>yes: client.Subscribe(pulsar.ConsumerOptions{Topic, SubscriptionName}) then Receive |
+| github.com/aws/aws-sdk-go v1 (sqs, sns) | not yet | no: github.com/aws/aws-sdk-go v1 (sqs, sns) basic use |
+| github.com/aws/aws-sdk-go-v2 (sqs, sns, eventbridge, kinesis) | partly | yes: SQS SendMessage with QueueUrl literal<br>no: SQS ReceiveMessage with QueueUrl from os.Getenv<br>yes: SNS Publish with TopicArn literal<br>no: EventBridge PutEvents with EventBusName and DetailType<br>yes: Kinesis PutRecord with StreamName |
+| github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus | partly | yes: client.NewSender(queue).SendMessage<br>no: NewReceiverForQueue(queue).ReceiveMessages |
+| github.com/centrifugal/centrifuge | not yet | no: github.com/centrifugal/centrifuge basic use |
+| github.com/cloudevents/sdk-go/v2 | not yet | no: cloudevents.NewClientHTTP(WithPort) + StartReceiver(ctx, fn)<br>no: c.Send(cloudevents.ContextWithTarget(ctx, url), event) |
+| github.com/confluentinc/confluent-kafka-go/v2 | supported | yes: Produce(&kafka.Message{TopicPartition: kafka.TopicPartition{Topic: &topic}})<br>yes: SubscribeTopics([]string{...}, nil)<br>yes: Subscribe(topic, nil) |
+| github.com/dapr/go-sdk | partly | yes: Dapr client.PublishEvent(ctx, pubsub, topic, data)<br>partly: service AddTopicEventHandler(&common.Subscription{PubsubName, Topic, Route}, h) |
+| github.com/eclipse/paho.mqtt.golang | partly | partly: client.Publish(topic, qos, retained, payload)<br>no: client.Subscribe(filter-with-+, qos, cb) |
+| github.com/go-co-op/gocron (scheduler) | not yet | no: github.com/go-co-op/gocron (scheduler) basic use |
+| github.com/go-redis/redis/v8 | not yet | no: github.com/go-redis/redis/v8 basic use |
+| github.com/gocraft/work | not yet | no: github.com/gocraft/work basic use |
+| github.com/hibiken/asynq | partly | yes: client.Enqueue(asynq.NewTask(type, payload))<br>yes: mux.HandleFunc(type, fn)<br>no: mux.Handle(constType, handlerType) |
+| github.com/IBM/sarama | partly | yes: SyncProducer.SendMessage(&sarama.ProducerMessage{Topic: ...})<br>yes: ProducerMessage built in a variable, then SendMessage(msg)<br>no: AsyncProducer.Input() <- msg<br>no: ConsumerGroup.Consume(ctx, []string{topic}, handler) with a ConsumerGroupHandler<br>yes: Consumer.ConsumePartition(topic, partition, offset) |
+| github.com/lib/pq (LISTEN/NOTIFY) | supported | yes: pq.NewListener + Listen(channel): Postgres LISTEN/NOTIFY as an event bus |
+| github.com/nats-io/nats.go | partly | yes: nc.Publish(subject, data)<br>partly: nc.Subscribe(subject, callback)<br>no: nc.QueueSubscribe(subject, queue, cb)<br>no: nc.Request(subject, data, timeout) and a responder that calls m.Respond<br>yes: nc.JetStream() then js.Publish / js.Subscribe<br>partly: jetstream.New(nc); stream.CreateOrUpdateConsumer(ConsumerConfig{FilterSubject}); cons.Consume(cb); js.Publish(ctx, subj, data) |
+| github.com/nsqio/go-nsq | partly | yes: producer.Publish(topic, body)<br>no: nsq.NewConsumer(topic, channel, cfg) + AddHandler(HandleMessage) |
+| github.com/rabbitmq/amqp091-go | partly | yes: PublishWithContext(ctx, exchange, routingKey, ...)<br>yes: Consume(queue, ...)<br>no: QueueBind(queue, routingKey, exchange): joins a routing key to a queue |
+| github.com/redis/go-redis/v9 (pub/sub, streams) | partly | yes: rdb.Publish(ctx, channel, msg)<br>yes: rdb.Subscribe(ctx, channel) then sub.Channel()<br>yes: XAdd(ctx, &redis.XAddArgs{Stream: ...})<br>no: XReadGroup(ctx, &redis.XReadGroupArgs{Streams: []string{name, ">"}}) |
+| github.com/RichardKnop/machinery/v2 | not yet | no: server.SendTask(&tasks.Signature{Name}) and RegisterTask(name, fn) |
+| github.com/riverqueue/river | partly | partly: client.Insert(ctx, args, nil) where args has Kind() string<br>no: river.AddWorker(workers, &Worker{}) with Work(ctx, *river.Job[Args]) |
+| github.com/robfig/cron/v3 (scheduler) | not yet | no: github.com/robfig/cron/v3 (scheduler) basic use |
+| github.com/segmentio/kafka-go | partly | yes: kafka.NewReader(kafka.ReaderConfig{Topic}) then ReadMessage/FetchMessage<br>partly: kafka.Writer{Topic: ...} then WriteMessages<br>yes: Writer with no topic; Topic on each kafka.Message |
+| github.com/Shopify/sarama (old import path) | not yet | no: github.com/Shopify/sarama (old import path) basic use |
+| github.com/streadway/amqp | supported | yes: legacy streadway/amqp Consume and Publish (same API as amqp091) |
+| github.com/ThreeDotsLabs/watermill | partly | partly: publisher.Publish(topic, msg)<br>partly: router.AddHandler(name, subTopic, sub, pubTopic, pub, fn)<br>no: router.AddNoPublisherHandler(name, topic, sub, fn) |
+| github.com/twmb/franz-go | supported | yes: kgo.NewClient(kgo.ConsumeTopics(...)) then PollFetches<br>yes: Produce/ProduceSync(ctx, &kgo.Record{Topic: ...}) |
+| go-micro.dev broker | not yet | no: go-micro.dev broker basic use |
+| go.etcd.io/etcd/client/v3 (Watch) | not yet | no: clientv3 Watch on a prefix (change notifications) |
+| go.temporal.io/sdk (workflows and activities) | not yet | no: go.temporal.io/sdk (workflows and activities) basic use |
+| slack-go, twilio-go, sendgrid-go (SaaS API calls) | not yet | no: slack-go, twilio-go, sendgrid-go (SaaS API calls) basic use |
+
+## Build tools and package managers
+
+8 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| bazel (rules_go + gazelle) | supported | yes: MODULE.bazel + BUILD.bazel with go_binary / go_library / go_test, one root go.mod |
+| bazel (WORKSPACE, legacy) | supported | yes: WORKSPACE + BUILD files and no go.mod at all |
+| dep / glide (pre-modules) | supported | yes: Gopkg.toml (dep) and glide.yaml, no go.mod, GOPATH import paths |
+| go modules | supported | yes: one go.mod at the root, package main plus one sub-package<br>yes: several go.mod in one repo, joined by one-line `replace X => ../path`<br>yes: replace written as a block: `replace ( X => ../path )`<br>yes: vendored dependencies in vendor/ with vendor/modules.txt |
+| go workspaces | supported | yes: go.work with a `use ( ... )` block, no replace directives<br>yes: go.work with one `use` per line and a workspace-level replace |
+| goreleaser | supported | yes: .goreleaser.yaml declaring two builds (main: ./cmd/x) from one module |
+| mage | supported | yes: magefile.go (`//go:build mage`, package main) at the root of a library module |
+| make / Task | supported | yes: Makefile and Taskfile.yml that build two binaries from one module |
+
+## Project and folder layouts
+
+6 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| go build | supported | yes: bin/ and dist/ build output, and a coverage profile |
+| go build (cgo) | supported | yes: Go package with `import "C"` and .c/.h files beside it |
+| go build (tags) | supported | yes: platform files: _windows.go, _linux.go, and //go:build js && wasm |
+| go modules | supported | yes: golang-standards layout: cmd/, internal/, pkg/, api/, configs/, scripts/, test/<br>yes: one go.mod with two programs under cmd/api and cmd/worker sharing internal/<br>yes: a module nested inside another module's folder (examples/ and tools/ with their own go.mod)<br>yes: tools.go with `//go:build tools` importing code generators<br>yes: major version in a subdirectory: v2/ with its own go.mod (module .../v2)<br>yes: a library with examples/<name>/main.go programs inside the same module |
+| go test | supported | yes: _test.go beside code, external test package (package x_test), testdata/ holding .go fixtures |
+| protoc / go generate | supported | yes: generated *.pb.go and `// Code generated ... DO NOT EDIT.` files inside the module, plus a //go:generate line |
+
+## Deployment files
+
+17 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| aws sam | supported | yes: template.yaml with AWS::Serverless::Function CodeUri per service |
+| docker buildx bake | supported | yes: docker-bake.hcl targets with context |
+| docker compose | supported | yes: docker-compose.yml, `build: ./services/x` string form, plus image-only infra<br>yes: `build: {context: ., dockerfile: services/x/Dockerfile}`: context is the repo root<br>yes: deploy/docker-compose.yml with `../services/x` contexts<br>yes: compose.yaml plus compose.override.yaml, `profiles`, `extends`, and an `image:` + `build:` service |
+| dockerfile | supported | yes: a Dockerfile in each service folder and nothing else<br>yes: docker/<svc>/Dockerfile kept apart from the code |
+| fly.io | supported | yes: fly.toml per service with app = "name" |
+| github actions | supported | yes: dorny/paths-filter with one named filter per service<br>yes: a build matrix over services with working-directory: services/${{ matrix.service }} |
+| gitlab ci | supported | yes: .gitlab-ci.yml jobs with rules:changes per service |
+| google app engine | supported | yes: app.yaml per service (runtime go122, service: name) plus dispatch.yaml |
+| helm | supported | yes: charts/<svc>/Chart.yaml type application, one library chart, one umbrella chart with dependencies |
+| heroku procfile | supported | yes: Procfile inside each service folder (web and worker process types) |
+| kubernetes | supported | yes: multi-document manifest: Deployment `shop-orders-api` (name differs from folder), Service, CronJob `billing` |
+| kubernetes (kustomize) | supported | yes: kustomize base + overlays; workloads in base, overlays patch them |
+| kubernetes + ko | supported | yes: `image: ko://example.com/shop/orders` naming the Go import path to build |
+| render | supported | yes: one render.yaml at the root listing services with rootDir |
+| serverless framework | supported | yes: serverless.yml per service, provider.runtime provided.al2, functions with handler bootstrap |
+| skaffold | supported | yes: skaffold.yaml build.artifacts with context per service |
+| vercel | supported | yes: vercel.json with Go serverless functions in api/*.go |

package/docs/supported-java.md

@@ -0,0 +1,226 @@
+# Supported in Java
+
+<!-- GENERATED by scripts/gen-supported-docs.js. Do not edit by hand: run the script again. -->
+<!-- source: catalog/java.json; catalog/java.structure.json -->
+<!-- measured: coverage corpus 1bb4ebb, niro-local 2b30d4fd -->
+
+This page lists the Java libraries, frameworks and build tools Niro was tested against, and whether it recognised each one.
+
+**What the marks mean.**
+
+- **Supported:** Niro recognised every way of using it that the test code tries.
+- **Partly:** Niro recognised some of those ways, or recognised one only in part.
+- **Not yet:** Niro did not recognise it in the test code.
+
+The test code is made up for the purpose: one small service per library, with the names invented. So "supported" means Niro recognised it there. It is good evidence, but it is not a promise about every codebase. If Niro misses something in your code, the coverage audit reports the gap on its own (see [coverage-audit-and-consent.md](coverage-audit-and-consent.md)).
+<!-- source: niro-coverage-corpus README.md ("Synthetic test code ... All names are made up"); catalog status merged pairs one to one with measured found -->
+
+The test catalog also holds 8 look-alike cases for Java: code that Niro must NOT take for a route, a call or a store. They test that Niro ignores the look-alike, so they are left out of this page and its counts.
+<!-- source: catalog/java.json and catalog/java.structure.json, rows marked as traps (scripts/gen-supported-docs.js isTrap) -->
+
+## Web frameworks and HTTP servers (the routes your code serves)
+
+18 supported, 1 partly, 3 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Armeria | partly | yes: annotated service @Get(path) / @Post(path)<br>no: Server.builder().service(path, (ctx, req) -> ...) |
+| AWS SAM template.yaml | supported | yes: AWS::Serverless::Function (Runtime java17, Handler package.Class::method or package.Class) with Events Type HttpApi or Api Path and Method |
+| Azure Functions (Java) | supported | yes: @FunctionName("X") method with a parameter annotated @HttpTrigger(methods = {HttpMethod.GET}, route = "x/{id}"), served under the host.json routePrefix<br>yes: @HttpTrigger with no route and no methods: the route is the @FunctionName name and every verb |
+| Eclipse Jetty (embedded) | supported | yes: ServletContextHandler.addServlet(holder or class, pattern) |
+| Helidon SE 4 | supported | yes: HttpRouting.Builder.get(path, handler).post(path, lambda) |
+| Javalin | supported | yes: app.get(path, lambda) / app.post(path, Class::method)<br>yes: ApiBuilder path(prefix, () -> { get(h); post(sub, h); }) in config.router.apiBuilder |
+| JAX-RS (jakarta.ws.rs: Jersey, RESTEasy, Quarkus REST) | supported | yes: @Path on class and method, @GET/@POST/@DELETE |
+| JAX-RS (javax.ws.rs: Dropwizard, Java EE 8) | supported | yes: @Path / @GET / @PUT in the javax namespace |
+| Jooby | not yet | no: get(path, ctx -> ...) inside the Jooby subclass initialiser |
+| Micronaut HTTP | supported | yes: @Controller(prefix) with @Get(path) and @Post (no path) |
+| Play Framework (Java) | not yet | no: conf/routes lines: VERB path controllers.X.method() |
+| Quarkus reactive routes | supported | yes: @RouteBase(path) + @Route(path, methods) |
+| Quarkus REST (RESTEasy Reactive) | supported | yes: plain JAX-RS @Path/@GET in a Quarkus app |
+| Ratpack | supported | yes: chain.get(path, handler) with no leading slash<br>yes: chain.prefix(prefix, sub -> sub.post(path, handler)) |
+| Serverless Framework serverless.yml | supported | yes: functions.<name>.handler package.Class[::method] with events httpApi or http |
+| Spark Java | supported | yes: static get(path, (req, res) -> ...) and Spark.post(...) |
+| Spring Boot | supported | yes: new ServletRegistrationBean<>(new XServlet(), path) |
+| Spring Web MVC | supported | yes: @RestController + class @RequestMapping prefix + @GetMapping/@PostMapping/@PutMapping/@DeleteMapping<br>yes: @RequestMapping(path = {a, b}, method = RequestMethod.POST) on @Controller + @ResponseBody<br>yes: mapping path held in a static final String constant |
+| Spring WebFlux | supported | yes: annotated @RestController returning Mono |
+| Spring WebFlux (functional) | supported | yes: RouterFunctions.route().GET(path, handler).POST(...).build()<br>yes: static route(GET(path), handler) from RequestPredicates<br>yes: nest(path(prefix), route(GET(sub), handler)) |
+| Undertow | not yet | no: Handlers.routing().get(path, handler).post(path, lambda) |
+| Vert.x Web | supported | yes: router.get(path).handler(h) / router.post(path).handler(lambda)<br>yes: router.route(HttpMethod.X, path).handler(h) |
+
+## The language's own HTTP server
+
+3 supported, 0 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| com.sun.net.httpserver (JDK) | supported | yes: HttpServer.createContext(path, lambda)<br>yes: createContext(path, new XHandler()) with a class implementing HttpHandler<br>yes: createContext(path, Class::method), verb read inside from getRequestMethod()<br>yes: HttpsServer.createContext |
+| Servlet API (jakarta.servlet) | supported | yes: @WebServlet("/path") on an HttpServlet subclass, verbs from doGet/doPost<br>yes: @WebServlet(name=, urlPatterns={a, b})<br>yes: ServletContext.addServlet(name, X.class).addMapping(path) |
+| Servlet API (javax.servlet) | supported | yes: @WebServlet(urlPatterns = ...) in the old javax namespace |
+| Servlet API (WEB-INF/web.xml) | not yet | no: <servlet-mapping> url-pattern naming a servlet-class |
+
+## HTTP client libraries (the calls your code makes to other services)
+
+14 supported, 1 partly, 5 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Apache HttpClient 4 | supported | yes: client.execute(new HttpGet/HttpPost/HttpDelete(url)) |
+| Apache HttpClient 5 | supported | yes: client.execute(new HttpGet(url), responseHandler) |
+| Apache HttpClient 5 Fluent | supported | yes: Request.get(url).execute() / Request.post(url) |
+| AsyncHttpClient | supported | yes: client.prepareGet(url).execute() / preparePost |
+| Google HTTP Client | not yet | no: factory.buildGetRequest(new GenericUrl(url)).execute() |
+| JAX-RS client (Jersey, RESTEasy) | supported | yes: ClientBuilder.newClient().target(base).path(p).request().get()/post() |
+| Jetty HttpClient | supported | yes: httpClient.GET(url) / newRequest(url).method(..).send() |
+| Micronaut HTTP client | not yet | no: @Client(base) interface with @Get(path) |
+| MicroProfile REST Client (Quarkus, Open Liberty) | supported | yes: @RegisterRestClient(baseUri) interface with @Path + @GET |
+| OkHttp | supported | yes: client.newCall(new Request.Builder().url(x)[.post(body)].build()).execute() |
+| OpenFeign (plain) | not yet | no: @RequestLine("VERB /path") with Feign.builder().target(Api.class, base) |
+| Reactor Netty HttpClient | supported | yes: HttpClient.create().baseUrl(base).get().uri(path) |
+| Retrofit | not yet | no: interface with @GET/@POST and Retrofit.Builder().baseUrl(base) |
+| Spring Cloud OpenFeign | supported | yes: @FeignClient(name, url) interface with @GetMapping/@PostMapping<br>yes: @FeignClient(name = service) with no url (service discovery) |
+| Spring HTTP interface (@HttpExchange) | not yet | no: interface with @HttpExchange(base) and @GetExchange/@PostExchange |
+| Spring RestClient (6.1+) | supported | yes: RestClient.create(base).get().uri(path, vars).retrieve().body(T) |
+| Spring RestTemplate | supported | yes: getForObject(literal url + id, type)<br>yes: postForEntity(baseUrl from @Value("${...}") + path)<br>yes: exchange(url template, HttpMethod.PUT, entity, type, vars)<br>yes: delete(url) and postForObject(url, ...) |
+| Spring WebClient | supported | yes: WebClient.create(base).get().uri(path, vars).retrieve()<br>yes: WebClient.builder().baseUrl(base with a path).build() then .uri(sub) |
+| Unirest for Java | supported | yes: Unirest.get(url with {param}).routeParam(..) / Unirest.post(url) |
+| Vert.x WebClient | partly | partly: client.get(port, host, path).send()<br>yes: client.getAbs/postAbs(absolute url).send() |
+
+## The language's own HTTP client
+
+1 supported, 1 partly, 1 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| java.net.http.HttpClient (JDK 11+) | partly | partly: send(HttpRequest.newBuilder().uri(URI.create(x)).GET().build(), handler)<br>yes: sendAsync / send with .POST(BodyPublishers...)<br>yes: HttpRequest.newBuilder(URI) with no .uri() step |
+| java.net.HttpURLConnection (JDK) | not yet | no: (HttpURLConnection) new URL(x).openConnection() then setRequestMethod("POST")<br>no: URI.create(x).toURL().openConnection(), default GET |
+| java.net.URL (JDK) | supported | yes: new URL(x).openStream() |
+
+## gRPC
+
+7 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Armeria gRPC | supported | yes: GrpcService.builder().addService(impl of the generated base) |
+| grpc-java | supported | yes: class extends {S}Grpc.{S}ImplBase with @Override per RPC (unary, server stream, client stream)<br>yes: class implements {S}Grpc.AsyncService, BindableService |
+| grpc-java client | supported | yes: {S}Grpc.newBlockingStub(channel).rpc(req), channel from ManagedChannelBuilder.forAddress/forTarget<br>yes: non-RPC stub step before the call: stub.withDeadlineAfter(..).rpc(req)<br>yes: {S}Grpc.newStub(channel).rpc(req, StreamObserver)<br>yes: {S}Grpc.newFutureStub(channel).rpc(req) returning ListenableFuture<br>yes: ClientCalls.blockingUnaryCall(channel, {S}Grpc.get{M}Method(), options, req) |
+| grpc-spring-boot-starter (net.devh) | supported | yes: @GrpcService on a subclass of the generated base |
+| grpc-spring-boot-starter (net.devh) client | supported | yes: @GrpcClient("name") on a stub field, address in application.yml |
+| LogNet grpc-spring-boot-starter | supported | yes: @GRpcService on a subclass of the generated base |
+| Quarkus gRPC | supported | yes: @GrpcService class implements the Mutiny interface {S}, methods return Uni |
+
+## Databases and data stores
+
+21 supported, 8 partly, 3 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| AWS SDK v2 DynamoDB | supported | yes: dynamo.getItem(GetItemRequest.builder().tableName(name)...) |
+| AWS SDK v2 DynamoDB Enhanced | supported | yes: enhanced.table(name, TableSchema.fromBean(..)).getItem |
+| AWS SDK v2 S3 | supported | yes: s3.putObject(PutObjectRequest.builder().bucket(name)..) / getObjectAsBytes |
+| DataStax Java driver (Cassandra) | partly | partly: session.execute(CQL string) / SimpleStatement.newInstance(CQL) |
+| Ebean ORM | partly | partly: DB.find(X.class).where()...findList() / DB.save(x) |
+| Elasticsearch Java client | supported | yes: client.search(s -> s.index(name)...) / client.index(i -> i.index(name)) |
+| Hibernate ORM (native Session) | partly | partly: session.persist / session.get(X.class, id) / createQuery(HQL) |
+| JDBC (java.sql, JDK) | supported | yes: DriverManager.getConnection(url) + createStatement().executeQuery(SQL)<br>yes: conn.prepareStatement(SQL) then executeUpdate/executeQuery<br>yes: conn.prepareCall("{call proc(?)}") |
+| JDBC (javax.sql.DataSource) | supported | yes: dataSource.getConnection().createStatement().executeUpdate(SQL) |
+| JDBI 3 | supported | yes: jdbi.withHandle(h -> h.createQuery(SQL)) / h.execute(SQL)<br>yes: SqlObject interface with @SqlQuery/@SqlUpdate |
+| Jedis (Redis) | partly | partly: jedis.get/set on keys, JedisPooled.hincrBy |
+| jOOQ | supported | yes: dsl.selectFrom(table("name")) / insertInto(table("name"))<br>yes: dsl.fetch(SQL string, binds) |
+| JPA EntityManager (jakarta.persistence) | supported | yes: em.persist / em.find(X.class, id) / em.remove<br>yes: em.createQuery(JPQL naming the entity, X.class)<br>yes: em.createNativeQuery(SQL).executeUpdate() |
+| Lettuce (Redis) | supported | yes: RedisClient.create(uri).connect().sync().get(key) / async().expire |
+| Micronaut Data JDBC | supported | yes: @JdbcRepository interface extends CrudRepository<T, Id>, entity @MappedEntity(name) |
+| MongoDB Java driver | partly | partly: db.getCollection(name).find / insertOne / deleteMany |
+| MyBatis | supported | yes: @Mapper interface with @Select/@Insert SQL<br>yes: mapper XML <select id> bound to an interface method |
+| MyBatis-Plus | supported | yes: interface extends BaseMapper<T>, entity @TableName, selectList/insert |
+| Neo4j Java driver | partly | partly: session.run(Cypher, params) |
+| Quarkus Hibernate ORM with Panache | not yet | no: entity extends PanacheEntity: list(..), persist(), count() |
+| Redisson | not yet | no: redisson.getMap(name).put / getLock(name) |
+| Spring cache abstraction | not yet | no: @Cacheable("cache-name") on a method |
+| Spring Data Elasticsearch | supported | yes: interface extends ElasticsearchRepository<T, Id>, @Document(indexName) |
+| Spring Data JDBC | supported | yes: interface extends CrudRepository<T, Id>, entity @Table(name) from data.relational |
+| Spring Data JPA | supported | yes: interface extends JpaRepository<Entity, Id> with derived finders; entity @Table(name)<br>yes: @Query("SELECT o FROM Entity o ...") on a repository method<br>yes: @Query(value = SQL, nativeQuery = true) |
+| Spring Data MongoDB | partly | yes: interface extends MongoRepository<T, Id>, @Document(name)<br>no: mongoTemplate.find(query, T.class, "collection") / insert(doc, "collection") |
+| Spring Data R2DBC | supported | yes: interface extends R2dbcRepository<T, Id>, entity @Table(name) |
+| Spring Data Redis | partly | partly: redisTemplate.opsForValue().get/set, opsForHash().put |
+| Spring JDBC | supported | yes: jdbcTemplate.queryForList / update(SQL, args)<br>yes: NamedParameterJdbcTemplate.update(SQL with :names, map)<br>yes: new SimpleJdbcInsert(jdbc).withTableName(name).execute(map) |
+| Spring JDBC JdbcClient (6.1+) | supported | yes: jdbcClient.sql(SQL).param(..).query(T).list() |
+| Spring R2DBC DatabaseClient | supported | yes: client.sql(SQL).fetch()/all() |
+| Vert.x SQL client | supported | yes: pool.query(SQL).execute() / preparedQuery(SQL).execute(tuple) |
+
+## Messaging and events (queues, topics, streams)
+
+14 supported, 7 partly, 4 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Apache Camel | not yet | no: RouteBuilder.configure(): from("kafka:topic?..").to("jms:queue:name") |
+| Apache Kafka clients | supported | yes: producer.send(new ProducerRecord<>(topic, key, value))<br>yes: consumer.subscribe(List.of(topic)) + poll loop |
+| Apache Pulsar client | supported | yes: client.newProducer().topic(name).create().send(..)<br>yes: client.newConsumer().topic(name).subscriptionName(..).subscribe() |
+| AWS SDK v2 SNS | supported | yes: sns.publish(PublishRequest.builder().topicArn(arn)...) |
+| AWS SDK v2 SQS | partly | yes: sqs.sendMessage(SendMessageRequest.builder().queueUrl(url)...)<br>no: sqs.receiveMessage(ReceiveMessageRequest.builder().queueUrl(url)...) |
+| Azure Service Bus | partly | yes: new ServiceBusClientBuilder().sender().queueName(name).buildClient().sendMessage(..)<br>partly: builder.processor().queueName(name).processMessage(cb) |
+| Eclipse Paho MQTT | supported | yes: client.publish(topic, msg) / client.subscribe(filter, listener) |
+| Google Cloud Pub/Sub | partly | yes: Publisher.newBuilder(TopicName.of(project, topic)).build().publish(msg)<br>no: Subscriber.newBuilder(ProjectSubscriptionName.of(project, sub), receiver) |
+| Jakarta Messaging (JMS) | partly | partly: class implements MessageListener { onMessage(..) } |
+| Jakarta Messaging (JMS) classic API | supported | yes: session.createConsumer(session.createQueue(name)).setMessageListener(..)<br>yes: session.createProducer(session.createQueue(name)).send(msg) |
+| Jakarta Messaging 2.0 simplified API | supported | yes: context.createConsumer(context.createQueue(name)) / createProducer().send(queue, body) |
+| Java Message Service (javax.jms) | supported | yes: the classic API in the old javax namespace |
+| Jedis pub/sub | supported | yes: jedis.publish(channel, msg) / jedis.subscribe(JedisPubSub, channel) |
+| Kafka Streams | not yet | no: builder.stream(topic) ... .to(topic) |
+| Micronaut Kafka | not yet | no: @KafkaListener class with @Topic method; @KafkaClient interface with @Topic method |
+| NATS Java client (jnats) | supported | yes: connection.publish(subject, bytes)<br>yes: dispatcher.subscribe(subject) / connection.subscribe(subject) |
+| RabbitMQ Java client | partly | yes: channel.basicPublish("", queue, props, body)<br>no: channel.basicConsume(queue, autoAck, DeliverCallback, CancelCallback)<br>no: basicConsume(queue, ack, new DefaultConsumer(ch) { handleDelivery(..) }) |
+| SmallRye / MicroProfile Reactive Messaging (Quarkus) | not yet | no: @Incoming(channel), @Outgoing(channel), @Channel Emitter; channel to topic in application.properties |
+| Spring AMQP (RabbitMQ) | partly | yes: rabbitTemplate.convertAndSend(routingKey, message) on the default exchange<br>partly: convertAndSend(exchange, routingKey, message)<br>yes: @RabbitListener(queues = "literal") |
+| Spring application events (in-process) | supported | yes: publisher.publishEvent(obj) + @EventListener on the type |
+| Spring Cloud AWS | supported | yes: @SqsListener("queue-name")<br>yes: sqsTemplate.send(queue, payload) |
+| Spring Cloud Stream | partly | no: @Bean Consumer<T> name() bound in application.yml (name-in-0.destination)<br>partly: streamBridge.send(binding or destination, payload) |
+| Spring Data Redis pub/sub | supported | yes: redisTemplate.convertAndSend(channel, msg) / container.addMessageListener(l, new ChannelTopic(ch)) |
+| Spring for Apache Kafka | supported | yes: kafkaTemplate.send(topic, [key,] value)<br>yes: @KafkaListener(topics = "literal")<br>yes: @KafkaListener(topics = "${property}") resolved from application.yml |
+| Spring JMS | supported | yes: jmsTemplate.convertAndSend(destination, payload)<br>yes: @JmsListener(destination = "literal") |
+
+## Build tools and package managers
+
+19 supported, 1 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Apache Ant | supported | yes: root build.xml calling <ant dir=...> per module; flat src/ folders; Main-Class in the jar manifest |
+| Apache Ant + Ivy | supported | yes: ivy.xml per module naming the other module as a dependency, ivysettings.xml at the root |
+| Bazel (Bzlmod, MODULE.bazel) | supported | yes: MODULE.bazel with bazel_dep, BUILD.bazel files loading rules_java |
+| Bazel (WORKSPACE) | supported | yes: WORKSPACE at the root, BUILD per package with java_binary, java_library and java_test |
+| Bndtools workspace (OSGi) | supported | yes: cnf/ plus one folder per bundle with bnd.bnd and flat src/ |
+| Gradle (Groovy DSL) | supported | yes: settings.gradle include, application and Spring Boot services, java-library module, project(':x') dependency |
+| Gradle (Kotlin DSL) | supported | yes: settings.gradle.kts include(...), `java-library` and Spring Boot plugin, implementation(project(":x")) |
+| Gradle buildSrc | supported | yes: buildSrc with a precompiled convention plugin applied by id |
+| Gradle composite build | supported | yes: includeBuild("platform/money") with the dependency by coordinates, substituted by Gradle |
+| Gradle included build for convention plugins | supported | yes: pluginManagement { includeBuild("build-logic") } with a Plugin<Project> class; the service applies id("shop.service") |
+| Gradle version catalog | supported | yes: gradle/libs.versions.toml, alias(libs.plugins.x) and typesafe project accessors implementation(projects.moneyLib) |
+| Gradle war plugin | supported | yes: id 'war' with src/main/webapp/WEB-INF/web.xml |
+| Gradle Wrapper | supported | yes: gradlew, gradlew.bat and gradle/wrapper next to a multi-project build |
+| Maven | supported | yes: one pom.xml, src/main/java and src/test/java, target/ output<br>yes: reactor: parent pom packaging pom with <modules>, two Spring Boot services and a jar library<br>yes: <modules> nested two deep: root -> platform (pom) -> libraries, root -> apps (pom) -> service<br>yes: BOM import (scope import, type pom), a local BOM module, and a module listed only inside a <profile> |
+| Maven (ear packaging) | supported | yes: an ear module packaging an ejb module and a war module |
+| Maven (war packaging) | supported | yes: packaging war with src/main/webapp/WEB-INF/web.xml and no main method |
+| Maven + maven-bundle-plugin (OSGi) | supported | yes: packaging bundle; one bundle exports a package, one has a Bundle-Activator |
+| Maven + Quarkus | supported | yes: quarkus-maven-plugin service with no main method, plus a jar library |
+| Maven Wrapper | supported | yes: mvnw, mvnw.cmd and .mvn/wrapper next to a reactor |
+| sbt | partly | partly: build.sbt with project.in(file(..)), dependsOn and aggregate; Java and Scala in one module |
+
+## Project and folder layouts
+
+11 supported, 0 partly, 0 not yet.
+
+| Name | Status | Ways of using it that were tested |
+|---|---|---|
+| Gradle (Groovy DSL) | supported | yes: project(':x').projectDir = file('other/folder') in settings.gradle |
+| Gradle (Kotlin DSL) | supported | yes: include("services:orders") with colon paths mapping to nested folders |
+| Gradle + Micronaut | supported | yes: io.micronaut.application service and io.micronaut.library library |
+| Gradle + Spring Boot | supported | yes: a shared library applying the Spring Boot plugin with bootJar disabled |
+| Gradle test source sets | supported | yes: src/test, src/integrationTest (jvm-test-suite), src/testFixtures, and a test-only module |
+| Gradle with custom sourceSets | supported | yes: srcDirs = ['src'] and ['test'] instead of src/main/java |
+| Java Platform Module System | supported | yes: module-info.java in each module (exports / requires) |
+| javac + jar (no build tool) | supported | yes: flat src/ with packages, a MANIFEST.MF Main-Class and a shell script |
+| Maven | supported | yes: aggregator pom in a subfolder listing ../sibling modules (flat multi-module) |
+| Maven or Gradle output folders | supported | yes: target/, build/, out/ (IntelliJ), bin/ (Eclipse), .gradle/, .idea/ next to real source<br>yes: target/, build/, out/ (IntelliJ), bin/ (Eclipse), .gradle/, .idea/ next to real source, with no .gitignore |
+| niro-local (way of adding a repository) | supported | yes: one `niro-local init` at the repository root; a root docker-compose.yml names each service with `build:`<br>yes: each service folder and the caller added one by one with `niro-local init --project <same>`<br>yes: each service is its own git checkout inside one parent folder; one `niro-local init` at the parent<br>yes: only the caller folder is added; the services it calls are not in the project<br>yes: one `niro-local init` at the root of a Maven reactor with no deploy descriptor |