Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
apollo-datasource-http
Advanced tools
[![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)
Optimized JSON HTTP Data Source for Apollo Server
54%
faster than apollo-datasource-rest
stale-if-error
Cache (TTL)View the Apollo Server documentation for data sources for more details.
To get started, install the apollo-datasource-http
package:
npm install apollo-datasource-http
To define a data source, extend the HTTPDataSource
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.
// 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 class to perform HTTP requests, while making it easy to pass different options and handle errors.
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: RequestError, request: Request): void {
// log errors
}
async getMovie(id) {
return this.get(`/movies/${id}`, {
query: {
a: 1,
},
context: {
tracingName: 'getMovie',
},
headers: {
'X-Foo': 'bar',
},
requestCache: {
maxCacheTimeout: 50 // In case of the cache does not respond for any reason (ms).
maxTtl: 1000 * 60 * 10, // 10min, will respond for 10min with the cached result (updated every 10min)
maxTtlIfError: 1000 * 60 * 30, // 30min, will respond in an error case with the cached response (for further 20min)
},
})
}
})()
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.The http client throws for unsuccessful responses (statusCode >= 400). In case of an request error onError
is executed. By default the error is rethrown in form of the original error.
See README.md
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.
FAQs
[![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)
The npm package apollo-datasource-http receives a total of 6,221 weekly downloads. As such, apollo-datasource-http popularity was classified as popular.
We found that apollo-datasource-http demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.