Go to file

Koxiaet 2ddaaaa07f Rework errors This completely overhauls the error system used in async-graphql. - `Error` has been renamed to `ServerError` and `FieldError` has been renamed to just `Error`. This is because `FieldError` is by far the most common error that users will have to use so it makes sense to use the most obvious error name. Also, the current name didn't make sense as it was used for things other than field errors, such as the data callback for websockets. - `ServerError` has been made completely opaque. Before it was an enum of all the possible errors, but now it just contains an error message, the locations, the path and extensions. It is a shame that we lose information, it makes more sense as _conceptually_ GraphQL does not provide that information. It also frees us to change the internals of async-graphql a lot more. - The path of errors is no longer an opaque JSON value but a regular type, `Vec<PathSegment>`. The type duplication of `PathSegment` and `QueryPathSegment` is unfortunate, I plan to work on this in the future. - Now that `ServerError` is opaque, `RuleError` has been removed from the public API, making it simpler. - Additionally `QueryError` has been completely removed. Instead the error messages are constructed ad-hoc; I took care to never repeat an error message. - Instead of constructing field-not-found errors inside the implementations of field resolvers they now return `Option`s, where a `None` value is representative of the field not being found. - As an unfortunate consequence of the last change, self-referential types based on the output of a subscription resolver can no longer be created. This does not mean anything for users, but causes lifetime issues in the implementation of merged objects. I fixed it with a bit of a hack, but this'll have to be looked into further. - `InputValueError` now has a generic parameter - it's kind of weird but it's necessary for ergonomics. It also improves error messages. - The `ErrorExtensions` trait has been removed. I didn't think the `extend` method was necessary since `From` impls exist. But the ergonomics are still there with a new trait `ExtendError`, which is implemented for both errors and results. - `Response` now supports serializing multiple errors. This allows for nice things like having multiple validation errors not be awkwardly shoved into a single error. - When an error occurs in execution, data is sent as `null`. This is slightly more compliant with the spec but the algorithm described in <https://spec.graphql.org/June2018/#sec-Errors-and-Non-Nullability> has yet to be implemented.		2020-09-29 20:06:44 +01:00
.github/workflows	Fix CI	2020-09-15 19:51:50 +01:00
benchmark	2.0.0-alpha.18	2020-09-26 12:36:56 +08:00
derive	Rework errors	2020-09-29 20:06:44 +01:00
docs	Rework errors	2020-09-29 20:06:44 +01:00
integrations	Rework errors	2020-09-29 20:06:44 +01:00
parser	2.0.0-alpha.18	2020-09-26 12:36:56 +08:00
src	Rework errors	2020-09-29 20:06:44 +01:00
tests	Rework errors	2020-09-29 20:06:44 +01:00
.gitignore	Moved benchmark from side repo	2020-06-01 21:05:37 +05:00
.rustfmt.toml	Rustfmt	2020-06-06 15:48:21 +08:00
ARCHITECTURE.md	Rustfmt and write ARCHITECTURE.md	2020-09-23 20:23:15 +01:00
Cargo.toml	2.0.0-alpha.18	2020-09-26 12:36:56 +08:00
feature-comparison.md	Removes code about streaming requests.	2020-07-31 10:10:03 +08:00
LICENSE-APACHE	add some files	2020-03-01 21:56:14 +08:00
LICENSE-MIT	add some files	2020-03-01 21:56:14 +08:00
README.md	Update readme	2020-09-26 11:25:21 +08:00

README.md

A GraphQL server library implemented in Rust

Async-graphql is a high-performance server-side library that supports all GraphQL specifications.

Feature Comparison
Book
中文文档
Docs
GitHub repository
Cargo package
Minimum supported Rust version: 1.46 or later

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

Features

Fully supports async/await
Type safety
Rustfmt friendly (Procedural Macro)
Custom scalars
Minimal overhead
Easy integration (actix_web, tide, warp, rocket ...)
Upload files (Multipart request)
Subscriptions (WebSocket transport)
Custom extensions
Apollo Tracing extension
Limit query complexity/depth
Error Extensions
Apollo Federation
Batch Queries

Crate features

This crate offers the following features, all of which are activated by default:

apollo_tracing: Enable the Apollo tracing extension.
log: Enable the logger extension.
tracing: Enable the tracing extension.
multipart: Support sending files over HTTP multipart.
unblock: Support asynchronous reader for Upload
bson: Integrate with the bson crate.
chrono: Integrate with the chrono crate.
chrono-tz: Integrate with the chrono-tz crate.
url: Integrate with the url crate.
uuid: Integrate with the uuid crate.

Examples

If you are just getting started, we recommend checking out our examples at: https://github.com/async-graphql/examples

To see how you would create a Relay-compliant server using async-graphql, warp, diesel & postgresql, you can also check out a real-world example at: https://github.com/phated/twentyfive-stars

Benchmark

Ensure that there is no CPU-heavy process in background!

cd benchmark

#measure all with system malloc
cargo bench

#measure only chat run
cargo bench -- "chat run"

#measure all with jemalloc
cargo bench --features jemalloc

#measure only simple run with jemalloc 
cargo bench --features jemalloc -- "simple run"

Now HTML report is available at benchmark/target/criterion/report

Integrations

License

Licensed under either of

Apache License, Version 2.0, (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.

References

Contribute

Welcome to contribute !