https://github.com/bod/deferdemo
https://github.com/bod/deferdemo
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bod/deferdemo
- Owner: BoD
- Created: 2022-04-22T08:56:35.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T07:24:01.000Z (almost 4 years ago)
- Last Synced: 2025-01-11T10:38:59.348Z (over 1 year ago)
- Language: Kotlin
- Size: 2.55 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apollo Kotlin `@defer` demo
A simple Android demo app that shows how to use the `@defer` directive with Apollo Kotlin.
## Setup
The server used by this app is the Apollo Router from the [Supergraph Demo for Federation 2](https://github.com/apollographql/supergraph-demo-fed2).
To setup the server:
1. You'll need docker and docker-compose
2. Start a supergraph:
```
git clone git@github.com:apollographql/supergraph-demo-fed2.git
cd supergraph-demo-fed2
make up-supergraph-no-otel-local
```
A GraphQL server will now be listening for connections at http://localhost:4000.
Full setup instructions and more information available [here](https://github.com/apollographql/supergraph-demo-fed2#apollo-router-entity-based-defer).
You can now run the Android app on an emulator.
## What the app demonstrates
You should see a screen showing:
1. Basic product information (Id. SKU, Size)
2. After a few seconds: more information about inventory (estimated delivery, fastest delivery)
This is because the inventory fields are queried in a fragment with the `@defer` directive:
```graphql
query ProductQuery {
product(id: "converse-1") {
...ProductInfoBasic
...ProductInfoInventory @defer # <- here!
}
}
# Basic info (fast)
fragment ProductInfoBasic on Product {
id
sku
dimensions {
size
}
}
# Inventory (slow)
fragment ProductInfoInventory on Product {
delivery {
estimatedDelivery
fastestDelivery
}
}
```
This way, fast fields can be received as soon as available, while the slower fields are received asynchronously.
## Alternative branch using GraphQL Helix
In the [`helix`](https://github.com/BoD/DeferDemo/tree/helix) branch, an alternative version of this demo is available, which uses an instance of the [GraphQL Helix](https://www.graphql-helix.com/) server instead of the Apollo Supergraph demo. It may be easier to setup.
Checkout the `helix` branch and follow the instructions in the [`helix/README.md`](https://github.com/BoD/DeferDemo/blob/helix/helix/README.md) file to start the server.