graphql-engine/v3
dependabot[bot] 6ee7a183d4 Bump syn from 2.0.79 to 2.0.82 (#1242)
Bumps [syn](https://github.com/dtolnay/syn) from 2.0.79 to 2.0.82.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/dtolnay/syn/releases">syn's
releases</a>.</em></p>
<blockquote>
<h2>2.0.82</h2>
<ul>
<li>Provide <code>Parse</code> impls for PreciseCapture and
CapturedParam (<a
href="https://redirect.github.com/dtolnay/syn/issues/1757">#1757</a>, <a
href="https://redirect.github.com/dtolnay/syn/issues/1758">#1758</a>)</li>
<li>Support parsing <code>unsafe</code> attributes (<a
href="https://redirect.github.com/dtolnay/syn/issues/1759">#1759</a>)</li>
<li>Add Fold and VisitMut methods for Vec&lt;Attribute&gt; (<a
href="https://redirect.github.com/dtolnay/syn/issues/1762">#1762</a>)</li>
</ul>
<h2>2.0.81</h2>
<ul>
<li>Add TypeParamBound::PreciseCapture to represent precise capture
syntax <code>impl Trait + use&lt;'a, T&gt;</code> (<a
href="https://redirect.github.com/dtolnay/syn/issues/1752">#1752</a>, <a
href="https://redirect.github.com/dtolnay/syn/issues/1753">#1753</a>, <a
href="https://redirect.github.com/dtolnay/syn/issues/1754">#1754</a>)</li>
</ul>
<h2>2.0.80</h2>
<ul>
<li>Add <code>Expr::RawAddr</code> (<a
href="https://redirect.github.com/dtolnay/syn/issues/1743">#1743</a>)</li>
<li>Reject precise captures and ~const in inappropriate syntax positions
(<a
href="https://redirect.github.com/dtolnay/syn/issues/1747">#1747</a>)</li>
<li>Reject trait bound containing only precise capture (<a
href="https://redirect.github.com/dtolnay/syn/issues/1748">#1748</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="76092cf236"><code>76092cf</code></a>
Release 2.0.82</li>
<li><a
href="937dbcb95c"><code>937dbcb</code></a>
Merge pull request <a
href="https://redirect.github.com/dtolnay/syn/issues/1762">#1762</a>
from dtolnay/vecattr</li>
<li><a
href="386ae9da28"><code>386ae9d</code></a>
Add Fold and VisitMut methods for Vec&lt;Attribute&gt;</li>
<li><a
href="4c7f82e6fc"><code>4c7f82e</code></a>
Merge pull request <a
href="https://redirect.github.com/dtolnay/syn/issues/1759">#1759</a>
from dtolnay/unsafeattr</li>
<li><a
href="a45af00fdf"><code>a45af00</code></a>
Parse unsafe attributes</li>
<li><a
href="e011ba794a"><code>e011ba7</code></a>
Merge pull request <a
href="https://redirect.github.com/dtolnay/syn/issues/1758">#1758</a>
from dtolnay/precisecapture</li>
<li><a
href="c25900d5f4"><code>c25900d</code></a>
Implement Parse for CapturedParam</li>
<li><a
href="fc22fcea08"><code>fc22fce</code></a>
Merge pull request <a
href="https://redirect.github.com/dtolnay/syn/issues/1757">#1757</a>
from dtolnay/precisecapture</li>
<li><a
href="3a45d69b8b"><code>3a45d69</code></a>
Implement Parse for PreciseCapture</li>
<li><a
href="c9bdfacf92"><code>c9bdfac</code></a>
Tweak parsing logic for TypeParamBound</li>
<li>Additional commits viewable in <a
href="https://github.com/dtolnay/syn/compare/2.0.79...2.0.82">compare
view</a></li>
</ul>
</details>
<br />

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=syn&package-manager=cargo&previous-version=2.0.79&new-version=2.0.82)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)

</details>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
V3_GIT_ORIGIN_REV_ID: ac1e763ef4c423426042dd8e913246b8be7de489
2024-10-21 09:45:17 +00:00
..
.cargo v3: open-source hasura v3 engine 2023-12-19 09:05:39 +00:00
crates Revert "subscriptions: Unhide OpenDd Metadata and lift from unstability" (#1246) 2024-10-21 04:51:11 +00:00
docs Update architecture doc (#1130) 2024-09-19 14:28:56 +00:00
nix Make sleep available in Docker images (#1026) 2024-08-28 12:14:08 +00:00
rfcs RFC | OpenDD changes for field arguments (#682) 2024-06-10 10:29:26 +00:00
static subscriptions: respect allow_subscriptions in select permissions (#1235) 2024-10-17 16:18:09 +00:00
.dockerignore Include the dev-auth-webhook crate in the workspace. (#500) 2024-04-24 08:12:37 +00:00
.envrc Add instructions for using the Nix Flake (#547) 2024-05-10 12:27:48 +00:00
.envrc.local.example Add instructions for using the Nix Flake (#547) 2024-05-10 12:27:48 +00:00
.gitignore Set the crate properties once, to improve the Nix build. (#334) 2024-03-06 17:15:13 +00:00
.prettierignore Use "dev" as the version in development for Nix builds. (#665) 2024-06-05 08:20:49 +00:00
.prettierrc Format everything with Prettier. (#530) 2024-04-30 14:58:57 +00:00
Cargo.lock Bump syn from 2.0.79 to 2.0.82 (#1242) 2024-10-21 09:45:17 +00:00
Cargo.toml Fix a few small JSONAPI bugs (#1230) 2024-10-17 10:44:49 +00:00
changelog.md [ENG-643] Support array-valued session variables (#1221) 2024-10-17 19:41:36 +00:00
ci.docker-compose.yaml Bump all the packages (#1199) 2024-10-03 09:10:06 +00:00
CONTRIBUTING.md Add UNSTABLE_FEATURES env var (#652) 2024-06-03 08:50:43 +00:00
custom-connector.Dockerfile Upgrade to Rust 1.81.0 (#1119) 2024-09-18 07:29:12 +00:00
dev-auth-webhook.Dockerfile Upgrade to Rust 1.81.0 (#1119) 2024-09-18 07:29:12 +00:00
docker-compose.yaml Fix docker-compose.yaml (#1197) 2024-10-02 11:07:29 +00:00
Dockerfile Upgrade to Rust 1.81.0 (#1119) 2024-09-18 07:29:12 +00:00
flake.lock Upgrade to Rust 1.81.0 (#1119) 2024-09-18 07:29:12 +00:00
flake.nix Bump all the packages (#1199) 2024-10-03 09:10:06 +00:00
justfile Revert "subscriptions: Unhide OpenDd Metadata and lift from unstability" (#1246) 2024-10-21 04:51:11 +00:00
README.md Fix docker-compose.yaml (#1197) 2024-10-02 11:07:29 +00:00
rust-toolchain.toml Upgrade to Rust 1.81.0 (#1119) 2024-09-18 07:29:12 +00:00

Hasura GraphQL Engine V3

Docs

Hasura V3 is the API execution engine, based over the Open Data Domain Specification (OpenDD spec) and Native Data Connector Specifications (NDC spec), which powers the Hasura Data Delivery Network (DDN). The v3-engine expects to run against an OpenDDS metadata file and exposes a GraphQL endpoint according to the specified metadata. The v3-engine needs a data connector to run alongside, for the execution of data source specific queries.

Data connectors

Hasura v3-engine does not execute queries directly - instead it sends IR (abstracted, intermediate query) to NDC agents (aka data connectors). To run queries on a database, we'll need to run the data connector that supports the database.

Available data connectors are listed at the Connector Hub

For local development, we use the reference agent implementation that is a part of the NDC spec.

To start the reference agent only, you can do:

docker compose up reference_agent

Run v3-engine (with Postgres)

Building with Docker

You can also start v3-engine, along with a Postgres data connector and Jaeger for tracing using Docker:

docker compose up

Open http://localhost:3000 for GraphiQL, or http://localhost:4002 to view traces in Jaeger.

Note: you'll need to add {"x-hasura-role": "admin"} to the Headers section to run queries from GraphiQL.

NDC Postgres is the official connector by Hasura for Postgres Database. For running V3 engine for GraphQL API on Postgres, you need to run NDC Postgres Connector and have a metadata.json file that is authored specifically for your Postgres database and models (tables, views, functions).

The recommended way to author metadata.json for Postgres, is via Hasura DDN.

Follow the Hasura DDN Guide to create a Hasura DDN project, connect your cloud or local Postgres Database (Hasura DDN provides a secure tunnel mechanism to connect your local database easily), and model your GraphQL API. You can then download the authored metadata.json and use the following steps to run GraphQL API on your local Hasura V3 engine.

Running tests

To run the test suite, you need to docker login to ghcr.io first:

docker login -u <username> -p <token> ghcr.io

where username is your github username, and token is your github PAT. The PAT needs to have the read:packages scope and Hasura SSO configured. See this for more details.

Running just watch will start the Docker dependencies, build the engine, and run all the tests.

Alternatively, run the tests once with just test

Updating goldenfiles

There are some tests where we compare the output of the test against an expected golden file. If you make some changes which expectedly change the goldenfile, you can regenerate them like this:

just update-golden-files

Some other tests use insta, and these can be reviewed with cargo insta review. If the cargo insta command cannot be found, install it with cargo install cargo-insta.

Run benchmarks

The benchmarks operate against the reference agent using the same test cases as the test suite, and need a similar setup.

To run benchmarks for the lexer, parser and validation:

cargo bench -p lang-graphql "lexer"
cargo bench -p lang-graphql "parser"
cargo bench -p lang-graphql "validation/.*"