-
Notifications
You must be signed in to change notification settings - Fork 32
/
README.md
159 lines (120 loc) · 5.29 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# Apollo HTTP Data Source
[![CI](https://github.com/StarpTech/apollo-datasource-http/actions/workflows/ci.yml/badge.svg)](https://github.com/StarpTech/apollo-datasource-http/actions/workflows/ci.yml)
---
> **Note**: Are you looking for the next generation API Developer Platform? 🔎 Have a look at: [WunderGraph](https://github.com/wundergraph/wundergraph)
Turn your services, databases and 3rd party APIs into a secure unified API in just a few minutes. 🪄
---
Optimized JSON HTTP Data Source for Apollo Server
- Uses [Undici](https://github.com/nodejs/undici) under the hood. It's around `60%` faster than `apollo-datasource-rest`
- Request Deduplication (LRU), Request Cache (TTL) and `stale-if-error` Cache (TTL)
- Support [AbortController ](https://github.com/mysticatea/abort-controller) to manually cancel all running requests
- Support for [Apollo Cache Storage backend](https://www.apollographql.com/docs/apollo-server/data/data-sources/#using-memcachedredis-as-a-cache-storage-backend)
## Documentation
View the [Apollo Server documentation for data sources](https://www.apollographql.com/docs/apollo-server/features/data-sources/) for more details.
## Usage
To get started, install the `apollo-datasource-http` package:
```bash
npm install apollo-datasource-http
```
To define a data source, extend the [`HTTPDataSource`](./src/http-data-source.ts) class and implement the data fetching methods that your resolvers require. Data sources can then be provided via the `dataSources` property to the `ApolloServer` constructor, as demonstrated in the section below.
```ts
// instantiate a pool outside of your hotpath
const baseURL = 'https://movies-api.example.com'
const pool = new Pool(baseURL)
const server = new ApolloServer({
typeDefs,
resolvers,
dataSources: () => {
return {
moviesAPI: new MoviesAPI(baseURL, pool),
}
},
})
```
Your implementation of these methods can call on convenience methods built into the [HTTPDataSource](./src/http-data-source.ts) class to perform HTTP requests, while making it easy to pass different options and handle errors.
```ts
import { Pool } from 'undici'
import { HTTPDataSource } from 'apollo-datasource-http'
const datasource = new (class MoviesAPI extends HTTPDataSource {
constructor(baseURL: string, pool: Pool) {
// global client options
super(baseURL, {
pool,
clientOptions: {
bodyTimeout: 5000,
headersTimeout: 2000,
},
requestOptions: {
headers: {
'X-Client': 'client',
},
},
})
}
onCacheKeyCalculation(request: Request): string {
// return different key based on request options
}
async onRequest(request: Request): Promise<void> {
// manipulate request before it is send
// for example assign a AbortController signal to all requests and abort
request.signal = this.context.abortController.signal
setTimeout(() => {
this.context.abortController.abort()
}, 3000).unref()
}
onResponse<TResult = unknown>(request: Request, response: Response<TResult>): Response<TResult> {
// manipulate response or handle unsuccessful response in a different way
return super.onResponse(request, response)
}
onError(error: Error, request: Request): void {
// in case of a request error
if (error instanceof RequestError) {
console.log(error.request, error.response)
}
}
async createMovie() {
return this.post('/movies', {
body: {
name: 'Dude Where\'s My Car',
}
})
}
async getMovie(id) {
return this.get(`/movies/${id}`, {
query: {
a: 1,
},
context: {
tracingName: 'getMovie',
},
headers: {
'X-Foo': 'bar',
},
requestCache: {
maxTtl: 10 * 60, // 10min, will respond for 10min with the cached result (updated every 10min)
maxTtlIfError: 30 * 60, // 30min, will respond with the cached response in case of an error (for further 20min)
},
})
}
})()
```
## Hooks
- `onCacheKeyCalculation` - Returns the cache key for request memoization.
- `onRequest` - Is executed before a request is made. This can be used to intercept requests (setting header, timeouts ...).
- `onResponse` - Is executed when a response has been received. This can be used to alter the response before it is passed to caller or to log errors.
- `onError` - Is executed for any request error.
## Error handling
The http client throws for unsuccessful responses (statusCode >= 400). In case of an request error `onError` is executed. By default the error is rethrown as a `ApolloError` to avoid exposing sensitive information.
## Benchmark
See [README.md](benchmarks/README.md)
## Production checklist
This setup is in use with Redis. If you use Redis ensure that limits are set:
```
maxmemory 10mb
maxmemory-policy allkeys-lru
```
This will limit the cache to 10MB and removes the least recently used keys from the cache.
## Versioning
We follow [semver](https://semver.org/). Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API **SHOULD NOT** be considered stable ([source](https://semver.org/#spec-item-4)).
## Node.js support
We test this software against **latest** major releases of the [Node.js LTS policy](https://github.com/nodejs/Release). `Current` is included to catch regression earlier.