Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(router): enable using redis clusters for rate limiting and apq #1499

Merged
merged 15 commits into from
Jan 31, 2025

Conversation

df-wg
Copy link
Contributor

@df-wg df-wg commented Jan 8, 2025

Motivation and Context

Previously, users were only able to provide a single redis instance to Cosmo for both APQ/Rate Limiting. This didn't take advantage of Redis' built-in cluster mode, which takes care of horizontal scaling for the users.

This PR enables that. In order to do it, users can provide a list of their cluster URLs instead of the singular URL they used to provide, in the now renamed urls field. In order to opt in to cluster mode, users have to set cluster_enabled: true in their configuration for both APQ and Rate Limiting

Warning

As part of the preparations for Cosmo V1, targeted for release in Q1 2025, this pull request introduces essential changes to enhance long-term stability and maintainability. While we strive to minimize breaking changes, they are sometimes necessary to lay the foundation for a more robust and scalable system.

Before:

rate_limit:
  enabled: true
  strategy: "simple"
  storage:
    url: "testuser:testpass@localhost:8000"
    key_prefix: "cosmo_rate_limit"  

storage_providers:
  redis:
    - id: "my_redis"
      url: "test:testpass@localhost:8000"

After

rate_limit:
  enabled: true
  strategy: "simple"
  storage:
    cluster_enabled: true
    urls:
      - "testuser:testpass@localhost:8000"
      - "test2:testpass@localhost:8001"
    key_prefix: "cosmo_rate_limit"  

storage_providers:
  redis:
    - id: "my_redis"
      cluster_enabled: true
      urls:
        - "test:testpass@localhost:8000"
        - "test2:testpass@localhost:8001"

Migration Path:

[ ] Rename storage_providers.redis.url to storage_providers.redis.urls, and rate_limit.storage.url to rate_limit.storage.urls, as the first value of a list

Checklist

  • I have discussed my proposed changes in an issue and have received approval to proceed.
  • I have followed the coding standards of the project.
  • Tests or benchmarks have been added or updated.
  • Documentation has been updated on https://github.com/wundergraph/cosmo-docs.
  • I have read the Contributors Guide.

Copy link

github-actions bot commented Jan 8, 2025

Router image scan passed

✅ No security vulnerabilities found in image:

ghcr.io/wundergraph/cosmo/router:sha-eaafdace83a5d516c3369dac1d11b808af5646dd

@df-wg df-wg force-pushed the dave/eng-6144-verify-use-of-redis-cluster-mode-for-apq branch from a152f50 to fbe58fc Compare January 22, 2025 07:13
@df-wg df-wg force-pushed the dave/eng-6144-verify-use-of-redis-cluster-mode-for-apq branch from de3fe03 to 6c94921 Compare January 27, 2025 08:35
@df-wg df-wg force-pushed the dave/eng-6144-verify-use-of-redis-cluster-mode-for-apq branch from d9388bb to 27b8c6d Compare January 30, 2025 08:12
Copy link
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@df-wg df-wg enabled auto-merge (squash) January 31, 2025 08:50
@df-wg df-wg merged commit 7c5b3a7 into main Jan 31, 2025
13 checks passed
@df-wg df-wg deleted the dave/eng-6144-verify-use-of-redis-cluster-mode-for-apq branch January 31, 2025 09:04
james-braund-cabiri added a commit to cabiri-io/cosmo that referenced this pull request Jan 31, 2025
* feat: expose type data and record subgraphs for enums (wundergraph#1495)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* feat: improve rate limit responses (add code, hide stats) (wundergraph#1497)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: provider should be specified in the config.yaml (wundergraph#1397)

* fix: update the timeouts for clickhouse and platform service (wundergraph#1500)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* fix: add edfs to the demo environment (wundergraph#1505)

* docs(CONTRIBUTING): fixup minor mistake in CONTRIBUTING.md under Go workspace (wundergraph#1502)

Co-authored-by: Dustin Deus <[email protected]>

* fix: full demo broken in main branch (wundergraph#1508)

* feat(router): optionally add jitter to config polling interval (wundergraph#1506)

Co-authored-by: Dustin Deus <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]

* fix(router): remove wildcard from router graphql path (wundergraph#1509)

* fix: use gauge for server.uptime metric (wundergraph#1510)

Co-authored-by: Ludwig <[email protected]>

* feat: cache warmer (wundergraph#1501)

Co-authored-by: Ludwig <[email protected]>
Co-authored-by: starptech <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* fix(cache warmup): consider only po of the last 7 days (wundergraph#1513)

* chore(release): Publish [skip ci]

 - [email protected]

* fix(cache operation): swallow cache errors and other improvements (wundergraph#1515)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]
 - [email protected]

* feat: add variables remapping support (wundergraph#1516)

Co-authored-by: starptech <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]

* fix(router): write proper line endings and header for multipart (wundergraph#1517)

* chore(release): Publish [skip ci]

 - [email protected]

* feat(router): optimize playground delivery, add concurrency_limit to config (wundergraph#1519)

* fix(router): enable health checks during startup (wundergraph#1529)

* feat: improve cache warmer (wundergraph#1530)

Co-authored-by: Ludwig <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* fix: remove semaphore from ResolveGraphQLSubscription (wundergraph#1532)

* chore(release): Publish [skip ci]

 - [email protected]

* feat: add compatibility handshake between router and execution config (wundergraph#1534)

* chore(release): Publish [skip ci]

 - [email protected]
 - @wundergraph/[email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* feat: also add handshake for static execution configs (wundergraph#1535)

* chore(router): bump demo library to pickup subscription fix (wundergraph#1518)

* feat(router): add interface for trace propagation (wundergraph#1526)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: adding/removing directive is not picked up by wgc subgraph check (wundergraph#1494)

* chore(deps): upgrade ristretto to v2 (wundergraph#1538)

* feat: add normalizedQuery to query plan and request info to trace (wundergraph#1536)

Co-authored-by: df-wg <[email protected]>

* fix: add copy button to subgraph routing url (wundergraph#1543)

Co-authored-by: Dustin Deus <[email protected]>

* fix: webhooks shot when schema is unchanged (wundergraph#1542)

* fix: trim the inputs of group mappers (wundergraph#1541)

* fix: subgraphs search functionality (wundergraph#1540)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]
 - [email protected]

* fix: increase max concurrent resolvers (wundergraph#1544)

* refactor(router): redesign JWK authentication logic (wundergraph#1498)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: increase the test timeout value to prevent failures on slower machines (wundergraph#1547)

* fix: reduce the breaking change retention duration (wundergraph#1550)

* fix: change the defaults of breaking-change-retention (wundergraph#1551)

* feat(router): enable starting the router without subgraphs (wundergraph#1533)

* fix(router): parse accept header per rfc 9110 (wundergraph#1549)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* feat(router): enable using redis clusters for rate limiting and apq (wundergraph#1499)

* fix: json schema for traffic shaping subgraphs (wundergraph#1552)

* chore: Update aws-lambda-router customisation after upstream sync

---------

Co-authored-by: Nithin Kumar B <[email protected]>
Co-authored-by: hardworker-bot <[email protected]>
Co-authored-by: Jens Neuse <[email protected]>
Co-authored-by: Alessandro Pagnin <[email protected]>
Co-authored-by: Suvij Surya <[email protected]>
Co-authored-by: endigma <[email protected]>
Co-authored-by: Dustin Deus <[email protected]>
Co-authored-by: Ludwig <[email protected]>
Co-authored-by: Sergiy 🇺🇦 <[email protected]>
Co-authored-by: df-wg <[email protected]>
Co-authored-by: Aenimus <[email protected]>
james-braund-cabiri added a commit to cabiri-io/cosmo that referenced this pull request Feb 4, 2025
* feat: expose type data and record subgraphs for enums (wundergraph#1495)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* feat: improve rate limit responses (add code, hide stats) (wundergraph#1497)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: provider should be specified in the config.yaml (wundergraph#1397)

* fix: update the timeouts for clickhouse and platform service (wundergraph#1500)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* fix: add edfs to the demo environment (wundergraph#1505)

* docs(CONTRIBUTING): fixup minor mistake in CONTRIBUTING.md under Go workspace (wundergraph#1502)

Co-authored-by: Dustin Deus <[email protected]>

* fix: full demo broken in main branch (wundergraph#1508)

* feat(router): optionally add jitter to config polling interval (wundergraph#1506)

Co-authored-by: Dustin Deus <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]

* fix(router): remove wildcard from router graphql path (wundergraph#1509)

* fix: use gauge for server.uptime metric (wundergraph#1510)

Co-authored-by: Ludwig <[email protected]>

* feat: cache warmer (wundergraph#1501)

Co-authored-by: Ludwig <[email protected]>
Co-authored-by: starptech <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* fix(cache warmup): consider only po of the last 7 days (wundergraph#1513)

* chore(release): Publish [skip ci]

 - [email protected]

* fix(cache operation): swallow cache errors and other improvements (wundergraph#1515)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]
 - [email protected]

* feat: add variables remapping support (wundergraph#1516)

Co-authored-by: starptech <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]

* fix(router): write proper line endings and header for multipart (wundergraph#1517)

* chore(release): Publish [skip ci]

 - [email protected]

* feat(router): optimize playground delivery, add concurrency_limit to config (wundergraph#1519)

* fix(router): enable health checks during startup (wundergraph#1529)

* feat: improve cache warmer (wundergraph#1530)

Co-authored-by: Ludwig <[email protected]>

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* fix: remove semaphore from ResolveGraphQLSubscription (wundergraph#1532)

* chore(release): Publish [skip ci]

 - [email protected]

* feat: add compatibility handshake between router and execution config (wundergraph#1534)

* chore(release): Publish [skip ci]

 - [email protected]
 - @wundergraph/[email protected]
 - @wundergraph/[email protected]
 - [email protected]
 - [email protected]
 - @wundergraph/[email protected]
 - [email protected]

* feat: also add handshake for static execution configs (wundergraph#1535)

* chore(router): bump demo library to pickup subscription fix (wundergraph#1518)

* feat(router): add interface for trace propagation (wundergraph#1526)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: adding/removing directive is not picked up by wgc subgraph check (wundergraph#1494)

* chore(deps): upgrade ristretto to v2 (wundergraph#1538)

* feat: add normalizedQuery to query plan and request info to trace (wundergraph#1536)

Co-authored-by: df-wg <[email protected]>

* fix: add copy button to subgraph routing url (wundergraph#1543)

Co-authored-by: Dustin Deus <[email protected]>

* fix: webhooks shot when schema is unchanged (wundergraph#1542)

* fix: trim the inputs of group mappers (wundergraph#1541)

* fix: subgraphs search functionality (wundergraph#1540)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]
 - [email protected]

* fix: increase max concurrent resolvers (wundergraph#1544)

* refactor(router): redesign JWK authentication logic (wundergraph#1498)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: increase the test timeout value to prevent failures on slower machines (wundergraph#1547)

* fix: reduce the breaking change retention duration (wundergraph#1550)

* fix: change the defaults of breaking-change-retention (wundergraph#1551)

* feat(router): enable starting the router without subgraphs (wundergraph#1533)

* fix(router): parse accept header per rfc 9110 (wundergraph#1549)

* chore(release): Publish [skip ci]

 - [email protected]
 - [email protected]
 - [email protected]

* feat(router): enable using redis clusters for rate limiting and apq (wundergraph#1499)

* fix: json schema for traffic shaping subgraphs (wundergraph#1552)

* fix: subgraph timeout can't be bigger than global timeout (wundergraph#1548)

* fix: error when graph token is not set when cache warmup is enabled (wundergraph#1554)

* chore(release): Publish [skip ci]

 - [email protected]

* fix: incorrect graphql endpoint in playground (wundergraph#1562)

* chore(release): Publish [skip ci]

 - @wundergraph/[email protected]
 - [email protected]

* fix: update vulnerable packages (wundergraph#1560)

* fix: synchronize go mod versions (wundergraph#1564)

* chore: reduce verbose logging for failed tests (wundergraph#1565)

* fix: Add missing config mapping, bump aws-lambda-router version

* fix: Repair PNPM lockfile after merge

---------

Co-authored-by: Nithin Kumar B <[email protected]>
Co-authored-by: hardworker-bot <[email protected]>
Co-authored-by: Jens Neuse <[email protected]>
Co-authored-by: Alessandro Pagnin <[email protected]>
Co-authored-by: Suvij Surya <[email protected]>
Co-authored-by: endigma <[email protected]>
Co-authored-by: Dustin Deus <[email protected]>
Co-authored-by: Ludwig <[email protected]>
Co-authored-by: Sergiy 🇺🇦 <[email protected]>
Co-authored-by: df-wg <[email protected]>
Co-authored-by: Aenimus <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants