https://github.com/oslabs-beta/dashql
Optimized lightweight caching solution for GraphQL utilizing Redis at the query field level
https://github.com/oslabs-beta/dashql
caching caching-strategies graphql graphql-caching typescript
Last synced: about 1 year ago
JSON representation
Optimized lightweight caching solution for GraphQL utilizing Redis at the query field level
- Host: GitHub
- URL: https://github.com/oslabs-beta/dashql
- Owner: oslabs-beta
- License: mit
- Created: 2024-02-02T20:02:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T22:00:58.000Z (about 2 years ago)
- Last Synced: 2025-04-30T19:05:38.247Z (about 1 year ago)
- Topics: caching, caching-strategies, graphql, graphql-caching, typescript
- Language: TypeScript
- Homepage: https://dash-ql.vercel.app
- Size: 3.6 MB
- Stars: 44
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About
dashQL is a lightweight GraphQL caching tool utilizing Redis to cache queries at the field level to further improve reponse time and decrease the number of redundant requests required
## Table of Contents
1. [Features](https://github.com/oslabs-beta/dashQL/edit/main/README.md#features)
2. [Getting Started](https://github.com/oslabs-beta/dashQL/edit/main/README.md#getting-started)
3. [Demo](https://github.com/oslabs-beta/dashQL/edit/main/README.md#demo)
4. [Contributing](https://github.com/oslabs-beta/dashQL/edit/main/README.md#contributing-to-dashql)
5. [Authors](https://github.com/oslabs-beta/dashQL/edit/main/README.md#authors)
# Features
* Allows for caching at the field level from the GraphQL abstract syntax tree
* Ability to handle query requests both with and without an argument
* Ability to cache deeply nested queries
# Getting Started
1. Install redis and define host and port in server file
```Javascript
const redisClient = redis.createClient({
host: "localhost",
port: 6379,
});
```
2. Download dashQL as an npm module and save it to your package.json as a dependency
```Javascript
npm install dashql
```
3. Import dashQL into server file
```Javascript
const dashQL = require('dashQL');
```
4. Create an instance of dashQL by passing in redisClient in server file
```Javascript
const dashQL = new dashQL(redisClient);
```
5. On your server file which handles graphQL requests, name the endpoint '/dashQL' and put in dashQL as your middleware and return res.locals back to client
```Javascript
app.use('/dashQL', dashQL, (req: Request, res: Response) => {
return res.status(200).send(res.locals);
});
```
6. Enjoy significantly faster response times specifically at the field level not just per query string!
# Demo
Feel free to visit our website to get an interactive demonstration of how our caching tool works and view the significantly improved response times
After entering our site, you will be met with a demonstration with the ability to run GraphQL queries with an interactive selection tool utilizing the Star Wars API.
1. Select the fields you would like to query and a preview of the GraphQL query will be shown
2. Click the 'Run Query' button to see the GraphQL query result. The metrics above will show the uncached response time populated on the graph and a cache hit/miss result will be logged to the bar charts. A cache miss will be logged the first time a unique query is run indicating that the query was not found in our cache and will be stored.
3. This time, select an additional field to query. Then click the 'Run Query' button. The response time has drastically decreased as the previous field level queries were stored in the cache and the server only has to go to the database for one field.
4. Feel free to play around with nested queries by selecting 'Species' or queries without an '_id' argument.
In this last example, you will notice the response time is decreased even further on the third query request as now all information is coming from the cache.
5. Lastly, click the 'Clear Cache' button to clear the cache and start over.
# Contributing to dashQL
The team at dashQL is excited you are interested in contributing to dashQL.
1. Fork repo from the `dev` branch
2. Create your feature branch (`git checkout -b feature/yourFeature`)
3. Stage and commit your changes (`git commit -m "added cool new feature"`)
4. Push to branch (`git push origin feature/yourFeature`)
5. Open a pull request to `dev` which will be reviewed by one of the dashQL authors prior to merge
## Roadmap for Future Development
- [ ] Handle mutations
- [ ] End-to-end testing
- [ ] Additional eviction strategies
- [ ] Security features
# Authors
Dan Bonney [LinkedIn](https://www.linkedin.com/in/dan-bonney/) | [Github](https://github.com/D-Bonney)
Meredith Fronheiser [LinkedIn](https://www.linkedin.com/in/meredith-fronheiser/) | [Github](https://github.com/mfronheiser)
Kevin Klochan [LinkedIn](https://www.linkedin.com/in/kevin-klochan-7a0ba7218/) | [Github](https://github.com/kevinklochan)
Drew Williams [LinkedIn](https://www.linkedin.com/in/andrew-vaughan-williams/) | [Github](https://github.com/avwilliams1995)
Please ⭐ our repo if you've found this useful, we want to be able to help as many of developers as we can!