enhancement: integrate async-graphql into GraphQL API

[deekerno]

Description

Following the switch from graphql-parser to async-graphql-parser for our parsing needs, this PR further integrates available features from GraphQL in order to improve the developer experience.

Specifically, it adds the following features:

• Support introspection queries on GraphQL endpoint #790
• Integrate async-graphql #822
• Test out dynamic schemas in async-graphql #823

Other GraphQL-idiomatic issues will be addressed in a subsequent PR.

Testing steps

CI should pass.

Manual Testing

The main value add in this PR is introspection support for any user-defined schema in the GraphQL playground. To test this with the block explorer example:

• Ensure the DB is clear and build the required WASM module.
• cargo run --bin fuel-indexer -- run --manifest examples/block-explorer/explorer-indexer/explorer_indexer.manifest.yaml --run-migrations --fuel-node-host beta-3.fuel.network --fuel-node-port 80
• Open up the playground: http://localhost:29987/api/playground/fuel_examples/explorer_indexer
• Open the Docs and Schema tabs on the side; you should see that there is now information that helps a user to write their queries.
• Begin typing a query; you should see suggestions for usable fields begin to appear. If not, you can press Option+Space (if on a Mac) to bring up the suggestion dropdown, if applicable at the current cursor location.

Changelog

• Add dynamic schema construction in new dynamic.rs module
• Add full auto-generated documentation for GraphQL playground

[ra0x3]

@deekerno Looks ok but needs to be rebased on master? I still see QueryRoot in the schema.

[ra0x3]

@deekerno

• Testing steps worked
• Left a lot of comments about style and readability

[luizstacio]

@deekerno I was not able to run this PR locally the indexer returns a error, I'm running it using a local postgres database;

2023-05-16T21:45:21.076546Z ERROR fuel_indexer::database: 105: TypeId(-3434938465688289560) not found in tables: {}
2023-05-16T21:45:21.076969Z ERROR fuel_indexer::database: 105: TypeId(4447527238938559951) not found in tables: {}
2023-05-16T21:45:21.077348Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}
2023-05-16T21:45:21.077723Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}
2023-05-16T21:45:21.078104Z ERROR fuel_indexer::database: 105: TypeId(5652593424517424978) not found in tables: {}
2023-05-16T21:45:21.078504Z ERROR fuel_indexer::database: 105: TypeId(-8806802248022301227) not found in tables: {}

I saw this error before when I was doing the PoC where the issue was fixed here. Do I need to change something on my env?

[deekerno]

@deekerno I was not able to run this PR locally the indexer returns a error, I'm running it using a local postgres database;

2023-05-16T21:45:21.076546Z ERROR fuel_indexer::database: 105: TypeId(-3434938465688289560) not found in tables: {}

2023-05-16T21:45:21.076969Z ERROR fuel_indexer::database: 105: TypeId(4447527238938559951) not found in tables: {}

2023-05-16T21:45:21.077348Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.077723Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.078104Z ERROR fuel_indexer::database: 105: TypeId(5652593424517424978) not found in tables: {}

2023-05-16T21:45:21.078504Z ERROR fuel_indexer::database: 105: TypeId(-8806802248022301227) not found in tables: {}

I saw this error before when I was doing the PoC where the issue was fixed here. Do I need to change something on my env?

That kind of error typically goes away when the WASM modules are freshly compiled. If that doesn't work, then you may need to refresh the database.

[luizstacio]

@deekerno I was not able to run this PR locally the indexer returns a error, I'm running it using a local postgres database;

2023-05-16T21:45:21.076546Z ERROR fuel_indexer::database: 105: TypeId(-3434938465688289560) not found in tables: {}

2023-05-16T21:45:21.076969Z ERROR fuel_indexer::database: 105: TypeId(4447527238938559951) not found in tables: {}

2023-05-16T21:45:21.077348Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.077723Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.078104Z ERROR fuel_indexer::database: 105: TypeId(5652593424517424978) not found in tables: {}

2023-05-16T21:45:21.078504Z ERROR fuel_indexer::database: 105: TypeId(-8806802248022301227) not found in tables: {}

I saw this error before when I was doing the PoC where the issue was fixed here. Do I need to change something on my env?

That kind of error typically goes away when the WASM modules are freshly compiled. If that doesn't work, then you may need to refresh the database.

After a cargo clean it work's. Thanks for the help.

Why we have this approach? It looks like a easy thing to break as force users to know about cleaning to make it work, maybe this data should be gather from the database. For sure is not something to be cover on this PR as is not related.

[luizstacio]

Functionality wise is looking good. Thanks for this changes. ✅

[deekerno]

@deekerno I was not able to run this PR locally the indexer returns a error, I'm running it using a local postgres database;

2023-05-16T21:45:21.076546Z ERROR fuel_indexer::database: 105: TypeId(-3434938465688289560) not found in tables: {}

2023-05-16T21:45:21.076969Z ERROR fuel_indexer::database: 105: TypeId(4447527238938559951) not found in tables: {}

2023-05-16T21:45:21.077348Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.077723Z ERROR fuel_indexer::database: 105: TypeId(-1100053459620569284) not found in tables: {}

2023-05-16T21:45:21.078104Z ERROR fuel_indexer::database: 105: TypeId(5652593424517424978) not found in tables: {}

2023-05-16T21:45:21.078504Z ERROR fuel_indexer::database: 105: TypeId(-8806802248022301227) not found in tables: {}

I saw this error before when I was doing the PoC where the issue was fixed here. Do I need to change something on my env?

That kind of error typically goes away when the WASM modules are freshly compiled. If that doesn't work, then you may need to refresh the database.

After a cargo clean it work's. Thanks for the help.

Why we have this approach? It looks like a easy thing to break as force users to know about cleaning to make it work, maybe this data should be gather from the database. For sure is not something to be cover on this PR as is not related.

It's happens sometimes when there are large changes to the underlying schema. We have an outstanding issue for indexer migrations; we'll need to get together and flesh out the process for that.