Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neurocode-io/cache-offloader

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/neurocode-io/cache-offloader
Owner: neurocode-io
Created: 2021-08-05T11:51:57.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-03-13T23:07:13.000Z (8 months ago)
Last Synced: 2024-06-21T08:30:10.189Z (5 months ago)
Language: Go
Size: 259 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # cache-offloader

[![CICD](https://github.com/neurocode-io/cache-offloader/actions/workflows/main.yml/badge.svg)](https://github.com/neurocode-io/cache-offloader/actions/workflows/main.yml)

[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/gomods/athens.svg)](https://github.com/gomods/athens)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=alert_status)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=security_rating)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)

# Using the service

This service provides a stale while revalidate cache for your HTTP requests. If a request is made to a URL that is already in the cache, the cache will be used. The cache will also be used if the cache is stale. However, an asynchronous request will be made to the server to refresh the cache.

Check out the `dev.env` file for configuration options.

Essentially you can choose between in-memory or redis persistence. 

Redis persistence is recommended when you have multiple processes running the service (or multiple pods).

The environment variable CACHE_IGNORE_ENDPOINTS defines the endpoints that are allowed to passthrough without any caching.

You can also choose to incude query parameters in the cache key. `CACHE_SHOULD_HASH_QUERY` is a boolean flag that defines whether or not to hash the query parameters. 

For example if you have a request to `/api/v1/users?id=1` and `CACHE_SHOULD_HASH_QUERY` is set to `true`, the cache key will be `/api/v1/users?id=1`. If `CACHE_SHOULD_HASH_QUERY` is set to `false`, the cache key will be `/api/v1/users`.

You can also configure `CACHE_HASH_QUERY_IGNORE` to ignore certain query parameters from the cache key. For example if you have a request to `/api/v1/users?id=1&utm=1` and `CACHE_HASH_QUERY_IGNORE=utm` the cache key will be `/api/v1/users?id=1`.

Another useful configuration option is `CACHE_STALE_WHILE_REVALIDATE_SEC`. This defines the time in seconds that the cache entry is considered stale and the cache is revalidated asynchronously.

# Dev

```

make run

```

Check its working:

```

http localhost:8000/probes/readiness

```

# Test

```

go install github.com/golang/mock/mockgen@latest

```