mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 01:12:56 +03:00

Shahidh K Muhammed 76ceb707f4

bundle console assets into server (close #516 , close #521 , close #2130 ) (#2192 )

This PR builds console static assets into the server docker image at `/srv/console-assets`. When env var `HASURA_GRAPHQL_CONSOLE_ASSETS_DIR=/srv/console-assets` or flag `--console-assets-dir=/srv/console-assets` is set on the server, the files in this directory are served at `/console/assets/*`.

The console html template will have a variable called `cdnAssets: false` when this flag is set and it loads assets from server itself instead of CDN.

The assets are moved to a new bucket with a new naming scheme:

```
graphql-engine-cdn.hasura.io/console/assets/
   /common/{}
   /versioned/<version/{}
   /channel/<channel>/<version>/{}
```

Console served by CLI will still load assets from CDN - will fix that in the next release.

2019-05-16 13:15:29 +05:30

2.7 KiB

Raw Blame History

Contributing

This guide explains how to set up the graphql-engine server for development on your own machine and how to contribute.

Pre-requisites

stack
A Postgres server (Recommended: Use docker to run a local postgres instance)
GNU Make (optional)
Node.js (v8.9+)
libpq-dev
psql
python >= 3.7 with pip3

Upgrading npm

If your npm is too old (< 5.7),

npm install -g npm@latest

sudo npm install -g npm@latest

or update your nodejs

Getting pip3

sudo apt install python3-pip

Development workflow

Fork and clone

Fork the repo on GitHub
Clone your forked repo: git clone https://github.com/<your-username>/graphql-engine
cd graphql-engine

Compile

compile console assets

cd console
npm ci
npm run server-build
cd ..

compile the server
```
cd server
stack build --fast
```

Run

Make sure postgres is running (Postgres >= 9.5)
Create a database on postgres
Run the binary: stack exec graphql-engine -- --database-url=<database-url> serve

Use --enable-console --console-assets-dir ../console/static/dist if you want console to be served.

database url looks like: postgres://<username>:<password>@<host>:<port>/<dbname>

Running Postgres

The easiest way is to run docker in a container

docker run -p 5432:5432 -d postgres:11.1

Test if it's running by

telnet localhost 5432

psql

You will need psql or another client

sudo apt install postgresql-client

Work

Work on the feature/fix
Add test cases if relevant

Test

Install the py-test dependencies:

pip3 install -r tests-py/requirements.txt

Make sure postgres is running
Run the graphql-engine:

stack exec graphql-engine -- --database-url=<database-url> serve --enable-console

Set the environmental variables for event-trigger tests

export EVENT_WEBHOOK_HEADER="MyEnvValue"
export WEBHOOK_FROM_ENV="http://127.0.0.1:5592"

Run tests:

cd tests-py
pytest --hge-urls http://127.0.0.1:8080 --pg-urls <database_url> -vv

Create Pull Request

Make sure your commit messages meet the guidelines.
Create a pull request from your forked repo to the main repo.
Every pull request will automatically build and run the tests.

Code conventions

This helps enforce a uniform style for all committers.

Compiler warnings are turned on, make sure your code has no warnings.
Use hlint to make sure your code has no warnings.
Use stylish-haskell to format your code.

2.7 KiB Raw Blame History