hasura / graphql-engine

Blazing fast, instant realtime GraphQL APIs on your DB with fine grained access control, also trigger webhooks on database events.

Hasura GraphQL Engine

The Hasura engine is an open source project which supercharges the building of modern applications by providing access to data via a single, composable, secure API endpoint.

Hasura V2

Hasura V2 is the current stable version of the Hasura GraphQL Engine. Recommended for production use. Please find more detailed information about the V2 Hasura Graphql Engine in the v2 folder and this README.

Hasura V3

The future of data delivery. Currently in alpha. Read more

The Hasura V3 engine code, which powers Hasura DDN, is in the V3 folder of this repo. You can find more detailed information about the Hasura DDN Graphql Engine in this README.

The Hasura DDN architecture includes Data Connectors to connect to data sources. All Hasura connectors are also available completely open source. Check out the Connector Hub which lists all available connectors.

Cloning repository

This repository is a large and active mono-repo containing many parts of the Hasura ecosystem and a long git history, that can make the first time cloning of the repository slow and consume a lot of disk space. We recommend following if you are facing cloning issues.

Shallow clone

This will only clone the latest commit and ignore all historical commits.

git clone https://github.com/hasura/graphql-engine.git --depth 1

Git checkout with only Hasura V3 engine code

git clone --no-checkout https://github.com/hasura/graphql-engine.git --depth 1
cd graphql-engine
git sparse-checkout init --cone
git sparse-checkout set v3
git checkout @

This checkouts the top level files and only the v3 folder which contains the Hasura V3 Engine code.

Support & Troubleshooting

To troubleshoot most issues, check out our documentation and community resources. If you have encountered a bug or need to get in touch with us, you can contact us using one of the following channels:

• Hasura DDN documentation: DDN docs
• Hasura V2 documentation: V2 docs
• Support & feedback: Discord
• Issue & bug tracking: GitHub issues
• Follow product updates: @HasuraHQ
• Talk to us on our website chat

Code of Conduct

We are committed to fostering an open and welcoming environment in the community. Please see the Code of Conduct.

Security

If you want to report a security issue, please read this.

Stay up to date

Join our communities to stay up to date on announcements, events, product updates, and technical blogs. https://hasura.io/community/

Contributing

Check out our contributing guide for more details.

Brand assets

Hasura brand assets (logos, the Hasura mascot, powered by badges etc.) can be found in the v2/assets/brand folder. Feel free to use them in your application/website etc. We'd be thrilled if you add the "Powered by Hasura" badge to your applications built using Hasura. ❤️

Licenses

V2

The V2 core GraphQL Engine is available under the Apache License 2.0 (Apache-2.0).

All other contents in the v2 folder (except those in server, cli and console directories) are available under the MIT License. This includes everything in the docs and community directories.

V3

The Native Data Connectors are available under the Apache License 2.0.

The core V3 GraphQL Engine is intended to be licensed under Apache 2.0. However, due to certain MPL/GPL dependencies, we are restricted. Hasura intends to update these dependencies soon and publish a long term license under which this code gets available.

graphql-engine's Issues

remove unnecessary tests

server throws 400 bad request for access key mismatch

Its currently giving a 400 bad request in case access key is wrong.

It should give 401 unauthorized.

[server] change current docker build flow to multi-stage builds

update readme

build/ci-cd system

jobs

• build

  • server
  • cli
  • console

• test

  • server
  • cli
  • console

• deploy

  • server
  • cli
  • console

workflows

pull requests

• build
• test

tagged releases

• build
• test
• deploy

release-* branch updates

• deploy console

tests fail with directory already exist error

test log

go test -ldflags "-X github.com/hasura/graphql-engine/cli/version.BuildVersion=pull83-d1c525d" ./...
Error: getting manifests failed: failed copying files to temp dir: destination already exists
--- FAIL: TestValidate (0.24s)
	cli_test.go:69: execution failed: getting manifests failed: failed copying files to temp dir: destination already exists
FAIL
FAIL	github.com/hasura/graphql-engine/cli	0.253s
?   	github.com/hasura/graphql-engine/cli/assets	[no test files]
?   	github.com/hasura/graphql-engine/cli/cmd/hasura	[no test files]
ok  	github.com/hasura/graphql-engine/cli/commands	3.441s
?   	github.com/hasura/graphql-engine/cli/migrate	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/api	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/cmd	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/database	[no test files]
ok  	github.com/hasura/graphql-engine/cli/migrate/database/hasuradb	0.007s [no tests to run]
?   	github.com/hasura/graphql-engine/cli/migrate/database/testing	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/source	[no test files]
ok  	github.com/hasura/graphql-engine/cli/migrate/source/file	0.021s
ok  	github.com/hasura/graphql-engine/cli/migrate/source/stub	0.003s
?   	github.com/hasura/graphql-engine/cli/migrate/source/testing	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/testing	[no test files]
ok  	github.com/hasura/graphql-engine/cli/util	1.062s
?   	github.com/hasura/graphql-engine/cli/util/fake	[no test files]
ok  	github.com/hasura/graphql-engine/cli/version	0.005s
Makefile:52: recipe for target 'test' failed
make: *** [test] Error 1
Exited with code 2

add tests for /api/1/table endpoint

This endpoint is no longer required.

https://github.com/ecthiender/graphql-engine/blob/issue-13-server-tests/server/src-lib/Hasura/Server/App.hs#L440

fix console tests

Tests are now failing for console, refer attachment.
console-tests.log

add a version command

that just echos the server version

cypress: handle baseUrl error in the CI

server: random urls says 401 instead of 404 if access key is set

server: accept all supported flags as environment variables

Flags like database-url, access-key etc, needs to have their equivalent environment variables, so that the user can change it on a GUI like Heroku.

when access-key is set, cli should use it to contact api

when cli contacts the graphql engine apis, it needs to use access key when it is set.

support mutiple postgres schemas

wait for cli/server to start on tests

server: console assets versioning

If the server version parses as semver, render the console.html template with assets url as vMAJOR.MINOR, for e.g. https://storage.googleapis.com/hasura-graphql-engine/console/v1.0/main.js

If the version fails to parse as semver, render the version itself.

https://storage.googleapis.com/hasura-graphql-engine/console/{{version}}/main.js

support renaming tables, columns and relationships

replace goyaml with ghodss/yaml

https://github.com/hasura/graphql-engine/blob/master/cli/version/server.go#L10

[server] serve console on /

Add a flag called enable-console which when given, the server should serve the console on /.

add contributing guides

Add CONTRIBUTING.md to cli/, server/ and console/

[server] fix the connection string command line argument

Let's not allow both connection string and individual arguments (host, port etc) at the same time. I've commented out the code temporarily. Also don't use partial functions (init etc).

support subscriptions on graphiql for console

[server] support directives

skip and include are ignored currently

change names "raven" in help text of binary

Running graphql-engine -- --help outputs:

raven - Hasura's datastore

Usage: graphql-engine [--host HOST] [-p|--port PORT] [-u|--user USER]
                      [-p|--password PASSWORD] [--database-url DATABASE-URL]
                      [-d|--dbname NAME] COMMAND

Available options:
  -h,--help                Show this help text
  --host HOST              Postgres server host
  -p,--port PORT           Postgres server port
  -u,--user USER           Database user name
  -p,--password PASSWORD   Password of the user
  --database-url DATABASE-URL
                           Postgres database URL. Example
                           postgres://foo:[email protected]:2345/database
  -d,--dbname NAME         Database name to connect to

Available commands:
  serve                    Start the HTTP api server
  export                   Export raven's schema to stdout
  clean                    Clean raven's metadata to start afresh
  execute                  Execute a query

improve messaging on the console

https://docs.google.com/spreadsheets/d/1be5vKv68u1gye_qe4K04lC21fRIjzWLkTwr1h8OyCv0/edit?ts=5b40c4b6#gid=0
Do this after #56

urls are wrong when access key is set and console redirects

console redirects to /login instead of /console/login when being served on server

type check input variables

[server] error messages which make sense

Haven't paid any attention in the GraphQL part. Also needs a fix in graphql-parser to get source location.

add tests

Use hspec-wai

[console] Resizing columns in the `browse-rows` section sorts the data by that column

mark cypress output directories

add them to .gitignore inside console/cypress, also should be marked as artifact to refer later in case a build/test fails

use row expressions instead of json_build_object

handle the case when auth_hook is provided but not running

add allow-if and deny-if rules to permissions tab

react-router should be upgraded to v5

secure graphql endpoint button should link to better docs

cli: server version handling

CLI should support server versions according to the following scheme:

server	cli	action
non-semver	*	exact match
vMAJ.MIN	>vMAJ.MIN	no action
vMAJ.MIN	<vMAJ.MIN	prompt cli update
-	*	render 1.0-dev console

boolean defaults while creating a table don't work

add mode for server hosted and cli served console

role based schema introspection

If X-Hasura-Role is given, the GraphiQL interface needs to reinitialise with the introspection query.

use logger from execution context in migrate

migrate library should take a logger object instead of calling logrus directly. If logger is not set, logrus.New() can be used.

raise 400 API exception when access key header is sent and access key is not set

Server has to render console with context of whether access key is set or not set

expose metadata clean as an admin only endpoint

The server binary has a clean command to clean existing metadata. Expose it over admin endpoint.

add state comparison tests for cypress

Compare old redux state with new state changes for validating the state after interactions.

fix order by

When the order by column is not included in the fields, currently 500, internal error is thrown

enable analytics and allow opt-out for analytics

handle server enpoints that contains a url path

header validation should account for the query structure

If permissions for different tables (for the same role) use different params, validating the headers only on the permission for the top level table does not work

[server] don't allow untrack of system tracked tables/views

There are views in information_schema like tables, schemata, views. If the API allows untracking, console won't be functional.

materialised views are not listed in console

information_schema.tables from where we currently read untracked tables does not list materialized views. We should probably switch to something more Postgres specific