hasura / hasura/graphql-engine

Console graphql engine check mix console api migration health and graphql-engine health

Open
#9,156 0 comments 0 reactions 0 assignees View on GitHub
k/bug t/product-platform
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

### Version Information

Server Version:
CLI Version (for CLI related issue):

v2.11.X -> v2.14.0.beta2

### Environment

OSS Edition

### What is the current behaviour?

When migration api is unavailable, console consider that graphql-engine is unavailable.

### What is the expected behaviour?

Data tab should be still available but all migration related stuffs should be disabled

### How to reproduce the issue?

1. ```docker run -p 127.0.0.1:8080:8080/tcp --volume /path/to/config.yaml:/config.yaml--entrypoint /bin/hasura-cli hasura/graphql-engine:v2.14.0-beta.1.cli-migrations-v3 console --console-port 8080 --address 0.0.0.0 --api-port 8081 --no-browser ```

2 Connect to browser

### Screenshots or Screencast

![Capture d’écran du 2022-10-28 17-36-12](https://user-images.githubusercontent.com/13641063/198677048-95dd7ab8-67ea-46d8-977a-35014dea8b9d.png)
![Capture d’écran du 2022-10-28 17-35-58](https://user-images.githubusercontent.com/13641063/198677072-aaab9da6-565b-4c81-8cbc-2d23fa726d0a.png)

### Any possible solutions/workarounds you're aware of?

* We use console behind a vpn + reverse proxy which enforce security and user auth, maybe a flag --api-url is missing to specify external api url which is usable from front.
* Disable migration api related feature in console when this api is unavailable.
* Change error message to indicate that migration/console api is unavailable instead of displaying a message that indicate that graphql-engine is unavailable which is pretty confusing.

### Keywords

console, proxy

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the issue with the provided Docker command and inspect the console's separate health checks for the migration API and graphql-engine. Done means the Data tab remains available when the migration API is unavailable, migration-related features are disabled, and the error identifies the unavailable service accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.