v2.6.0

Release Notes

The highlight of this release is that Websocket support has been added to the QuickAdapter (the adapter that's the fastest to use and also provides the best performance). Since this adapter is using zio-http under the hood, we deprecated the existing tapir-based ZHttpAdapter which you can simply replace by the QuickAdapter. A small breaking change coming with this change is that we moved WebSocketHooks to another package and changed the type to describe transformation from StreamTransformer to ZPipeline.

Apart from that, there are quite a few performance improvements, in particular some coming from zio-query that should make things a lot faster if you use queries with a DataSource.

New features

• Added WebSocket support to caliban-quick #2150 by @kyri-petrou
• Added excludeDeprecated option to client code generation #2163 by @jeejeeone
• Allowed prepending input path to HttpInterpreter-generated Tapir endpoints #2188 by @olisikh
• Allowed providing a custom zio.query.Cache when executing queries by @kyri-petrou
• Added interpreterUnsafe method to GraphQL #2160 by @kyri-petrou

Bug fixes

• Fixed incorrect wrapping of pure values by some FieldWrappers #2162 by @kyri-petrou
• Fixed enum annotation issue #2166 by @kyri-petrou
• Fixed InputValue.ObjectValue#toString #2173 by @ghostdogpr

Performance improvements

• Optimized performance of Schema, ArgBuilder and Executor #2120 by @kyri-petrou
• Updated zio-query to get better performance #2177 by @kyri-petrou
• Improved jsoniter encoding performance #2181 by @kyri-petrou
• Avoided unnecessary .units in Validator #2182 by @kyri-petrou
• Improved performance of ApolloFederatedTracing wrapper #2167 by @kyri-petrou

Important dependency upgrades

• Updated zio-http to 3.0.0-RC6 #2159 by @kyri-petrou

v2.5.3

Release Notes

This release includes support for subscriptions over Server-Sent Events, as well as a few bug fixes and improvements.

Server

• Added support for subscriptions over Server-Sent Events #2126 by @SvenW and #2141 by @kyri-petrou
• Fixed an issue with error handling with application/graphql-response+json #2144 by @ghostdogpr
• Optimized performance #2121 #2142 by @kyri-petrou
• Added Mixed query execution mode, where top-level fields are guaranteed to be executed in parallel and nested fields are executed in batched mode #2129 by @kyri-petrou
• Improved UX for constructing a Caliban interpreter via interop #2130 by @kyri-petrou

Tools

• Fixed an issue with schema codegen when using the @lazy directive and the ZIO environment is not Any #2125 by @develeon

v2.5.2

Release Notes

This release includes a new set of performance improvements as well as some usability improvements, in particular for schema code generation. It is fully backward compatible with 2.5.0.

Server

• Improved performance #2092 #2102 #2103 #2111 #2113 by @kyri-petrou and #2112 by @ghostdogpr
• Improved QuickAdapter UX & performance #2090 by @kyri-petrou
• Defined a specific innerThrowable type for errors raised in ArgBuilders #2118 by @kyri-petrou

Client

• Allowed Jsoniter parsing large JSON payloads #2085 by @ghostdogpr and #2109 by @harrylaou
• Added a render method in CalibanClientError that can render extensions #2110 by @harrylaou

Tools

• Added a new directive called @newtype for the schema codegen to map ID to your own types #2091 by @develeon
• Made the schema codegen generate the @GQLDeprecated annotation for deprecated fields #2107 by @johnspade
• Fixed schema codegen when using derives with a ZIO Environment that is not Any #2104 by @develeon
• Fixed schema comparison of implements #2116 by @ghostdogpr

v2.5.1

Release Notes

This release brings a bug fix for an issue that was introduced in 2.5.0 and possibly caused duplicated fields in responses when using fragments. It is fully backward compatible with 2.5.0.

Server

• Fixed a field merging issue that might cause duplicated fields in responses when using fragments #2077 #2081 by @kyri-petrou
• Added annotations for forcing object fields as nullable / non-nullable #2075 by @kyri-petrou
• Made Document serialization friendly-ier #2061 by @kyri-petrou
• Added code to catch exceptions happening in FunctionStep #2059 by @kyri-petrou

Interop

• Added InjectEnv implicit for cats.effect.IO #2062 by @kyri-petrou
• Fixed content type performance issue with zio-http #2060 by @kyri-petrou

Tools

• Fix server code generation to support @lazy fields with abstract effect #2064 by @johnspade

v2.5.0

Release Notes

This release brings an incredible amount of performance improvements, some major library upgrades (zio-http, Play) as well as some powerful new derivation abilities such as deriving fields from case class methods.

Server

• Improved compile and runtime performance #2013 #2014 #2015 #2017 #2019 #2020 #2021 #2024 #2029 #2031 #2033 #2039 #2044 #2046 #2051 #2052 #2053 #2056 by @kyri-petrou
• Added the ability to exclude fields from interfaces #1975 by @kyri-petrou
• Added the ability to derive fields from case class methods with Scala 3 #2041 by @kyri-petrou
• Added apply method to Schema and ArgBuilder for convenience #2023 by @kyri-petrou
• Updated zio-query to 0.6.0 which contains some performance optimizations #2037 @kyri-petrou
• Allowed parallel execution of mutation non-top level fields #2040 by @kyri-petrou
• Implemented path via a PathValue type instead of Either[String, Int] #2048 by @kyri-petrou

Adapters

• Updated zio-http to RC4 & Play to 3.0.0 #1968 by @kyri-petrou
• Added api.unsafe.runServer to run a server immediately in the QuickAdapter #2050 by @kyri-petrou
• Removed unnecessary dependency on pekko-serialization-jackson #2028 by @kyri-petrou

Federation

• Added federation 2.6 support, updated gateway dependencies #2043 by @paulpdaniels

v2.4.3

Release Notes

This version brings a few bug fixes and improvements related to schema derivation on Scala 3.
In addition to that, it contains a new adapter named QuickAdapter and based on zio-http, that serves 2 purposes:

• Offer the best performance among all adapters. This adapter is not using Tapir under the hood to prevent any overhead. We picked zio-http and jsoniter-scala because they gave the best benchmarks results among all our supported adapters and json libraries. The only drawback is that it doesn't include WebSocket support at the moment. If you care about performance above all, use this adapter!

• Be super quick and easy to get started. With this adapter you can simply do that to go from your api to a running server:

import caliban._
import caliban.quick._ // adds syntax to `GraphQL`

val api: GraphQL[Any] = ???

api.runServer(
  port = 8080,
  apiPath = "/api/graphql",
  graphiqlPath = Some("/graphiql")
)

Server

• Added QuickAdapter (see above) #1998 by @kyri-petrou
• Fixed derivation of nested sum types with Scala 3 #2005 by @kyri-petrou
• Fixed incorrect enum value renaming with Scala 3 #2006 by @kyri-petrou
• Optimized schema derivation with Scala 3 #1995 by @kyri-petrou

Tools

• Fixed incorrect interface description in server code gen #2000 by @ghostdogpr

v2.4.2

Release Notes

This version brings a few bug fixes as well as some performance improvements.
Big thanks to @kyri-petrou for his many contributions!

Server

• Fixed schema renaming on recursive types #1974 by @kyri-petrou
• Fixed schema renaming on interfaces #1978 by @kyri-petrou
• Fixed schema derivation for nested sum types on Scala 3 #1991 #1994 by @kyri-petrou
• Fixed an issue with @defer fields not working as expected when backed by DataSources #1981 by @kyri-petrou
• Improved performance of resolving large objects #1967 by @kyri-petrou
• Improved performance of jsoniter codecs #1979 by @kyri-petrou
• Improved interface field description #1976 by @kyri-petrou
• Used magnolia macros and reduced Scala 3 compilation time + codegen size #1952 by @kyri-petrou
• Added a helper method for creating custom enum schemas #1953 by @kyri-petrou

Tools

• Fixed a warning about impure expression that could popup when using the compile time codegen #1965 by @satorg

v2.4.1

Release Notes

This version fixes a regression introduced in 2.4.0 that prevents the usage of java.time types in schemas when using Scala 3 and JDK 17+ (#1950).

v2.4.0

Release Notes

This version contains:

• an important number of performance improvements
• support for new specs and protocols: deprecated input fields, GraphQL over HTTP, new Apollo Caching, Federation 2.5
• usability improvements, small fixes and library upgrades

Warning

Due to an issue in zio-http 3.0.0-RC2, servers exposing websocket endpoints via the caliban-zio-http module are required to include additional config for subscriptions to work as shown in this example.

This is a temporary workaround until a new version of zio-http is released which contains a fix to this issue.

Server

• Optimized core performance #1876 #1922 #1929 by @kyri-petrou
• Added support for deprecated input fields (draft spec) #1932 by @ghostdogpr
• Added a wrapper for the new Apollo Caching Protocol. The old is now deprecated #1878 by @paulpdaniels
• Added a simple wrapper to check directives #1905 by @ghostdogpr
• Updated zio-query to the latest version so that it catches die errors happening inside the DataSource #1916 by @ghostdogpr
• Fixed mocking up superclass for module class macros warning on Scala 3 #1880 by @kyri-petrou
• Fixed duplicate types being output when calling render on a schema #1888 by @nox213
• Used the latest version of Magnolia #1858 by @kyri-petrou
• Made Introspection introspectable #1900 by @ghostdogpr
• Removed old deprecated code #1902 by @ghostdogpr
• Added the option to disable tracing of pure fields in ApolloTracing wrapper #1907 by @kyri-petrou
• Added the option to dynamically enable / disable ApolloTracing #1933 by @kyri-petrou
• Stopped generating a stack trace in CalibanError (not that getCause will return null in ValidationError) #1924 by @kyri-petrou
• Changed tracing span name to adhere to semantic guidelines #1875 by @Fluxx
• Fixed inline character escaping when rendering GraphQL #1936 by @paulpdaniels

Adapters

• Added 100% compliance with GraphQL over HTTP spec #1909 by @kyri-petrou
• Updated zio-http to RC2 #1910 by @kyri-petrou
• Enabled support for play-json in Scala 3 #1893 by @kyri-petrou

Tools

• Properly escaped union types in client code generation #1908 by @ghostdogpr
• Fixed various things in server code generation #1925 by @oyvindberg
• Added support for a @lazy directive to generate side-effecting fields in server code generation #1927 by @oyvindberg

Federation

• Added federation 2.5 support #1906 by @paulpdaniels

v2.3.1

Release Notes

This version contains important performance improvements as well as support for Pekko.

Server

• Performance improvements
  • Drastically improved performance of the metrics wrapper #1850 by @kyri-petrou
  • Optimized query execution by resolving fields lazily and prevent unnecessary work #1849 by @kyri-petrou
  • Improved performance and correctness of schema and type rendering #1835 by @paulpdaniels
  • Reduced size of the code generated by Schema derivation with Scala 3 #1830 by @kyri-petrou
  • Optimized VariableCoercer #1856 by @kyri-petrou
• Added support for auto enum derivation with Scala 3 #1834 by @kyri-petrou
• Added a wrapper that allows skipping selected validation wrappers during introspection #1837 by @kyri-petrou
• Fixed WS protocol by always returning an id upon errors #1845 by @SvenW
• Added a helper renderSchema to render a schema without a resolver #1877 by @ghostdogpr

Adapters

• Added support for Pekko #1862 by @MichelEdkrantz