feat(redis): add options to set username and password separately (#4453)

Example of configuration:

```yaml title="router.yaml"
supergraph:
  query_planning:
    experimental_cache:
      redis: #highlight-line
        urls: ["redis://..."] #highlight-line
        username: admin/123 # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url
        password: admin # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url
        timeout: 5ms # Optional, by default: 2ms
        ttl: 24h # Optional, by default no expiration
```

Fixes #4346
---------

Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>

.changesets/feat_bnjjj_feat_4346.md

@@ -0,0 +1,17 @@
+### Add options to set username and password separately for Redis ([Issue #4346](https://github.com/apollographql/router/issues/4346))
+
+Example of configuration:
+
+```yaml title="router.yaml"
+supergraph:
+  query_planning:
+    experimental_cache:
+      redis: #highlight-line
+        urls: ["redis://..."] #highlight-line
+        username: admin/123 # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url. This field takes precedence over the username in the URL
+        password: admin # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url. This field takes precedence over the password in the URL
+        timeout: 5ms # Optional, by default: 2ms
+        ttl: 24h # Optional, by default no expiration
+```
+
+By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/4453

apollo-router/src/cache/redis.rs

@@ -136,6 +136,14 @@ impl RedisCacheStorage {
         let url = Self::preprocess_urls(config.urls)?;
         let mut client_config = RedisConfig::from_url(url.as_str())?;
 
+        if let Some(username) = config.username {
+            client_config.username = Some(username);
+        }
+
+        if let Some(password) = config.password {
+            client_config.password = Some(password);
+        }
+
         if let Some(tls) = config.tls.as_ref() {
             let tls_cert_store = tls.create_certificate_store().transpose()?;
             let client_cert_config = tls.client_authentication.as_ref();

apollo-router/src/configuration/mod.rs

@@ -913,6 +913,11 @@ pub(crate) struct RedisCache {
     /// List of URLs to the Redis cluster
     pub(crate) urls: Vec<url::Url>,
 
+    /// Redis username if not provided in the URLs. This field takes precedence over the username in the URL
+    pub(crate) username: Option<String>,
+    /// Redis password if not provided in the URLs. This field takes precedence over the password in the URL
+    pub(crate) password: Option<String>,
+
     #[serde(deserialize_with = "humantime_serde::deserialize", default)]
     #[schemars(with = "Option<String>", default)]
     /// Redis request timeout (default: 2ms)

apollo-router/src/configuration/snapshots/apollo_router__configuration__tests__schema_generation.snap

@@ -83,6 +83,11 @@ expression: "&schema"
                     "urls"
                   ],
                   "properties": {
+                    "password": {
+                      "description": "Redis password if not provided in the URLs. This field takes precedence over the password in the URL",
+                      "type": "string",
+                      "nullable": true
+                    },
                     "timeout": {
                       "description": "Redis request timeout (default: 2ms)",
                       "default": null,
@@ -140,6 +145,11 @@ expression: "&schema"
                         "type": "string",
                         "format": "uri"
                       }
+                    },
+                    "username": {
+                      "description": "Redis username if not provided in the URLs. This field takes precedence over the username in the URL",
+                      "type": "string",
+                      "nullable": true
                     }
                   },
                   "additionalProperties": false,
@@ -1207,6 +1217,11 @@ expression: "&schema"
             "urls"
           ],
           "properties": {
+            "password": {
+              "description": "Redis password if not provided in the URLs. This field takes precedence over the password in the URL",
+              "type": "string",
+              "nullable": true
+            },
             "timeout": {
               "description": "Redis request timeout (default: 2ms)",
               "default": null,
@@ -1264,6 +1279,11 @@ expression: "&schema"
                 "type": "string",
                 "format": "uri"
               }
+            },
+            "username": {
+              "description": "Redis username if not provided in the URLs. This field takes precedence over the username in the URL",
+              "type": "string",
+              "nullable": true
             }
           },
           "additionalProperties": false
@@ -2309,6 +2329,11 @@ expression: "&schema"
                     "urls"
                   ],
                   "properties": {
+                    "password": {
+                      "description": "Redis password if not provided in the URLs. This field takes precedence over the password in the URL",
+                      "type": "string",
+                      "nullable": true
+                    },
                     "timeout": {
                       "description": "Redis request timeout (default: 2ms)",
                       "default": null,
@@ -2366,6 +2391,11 @@ expression: "&schema"
                         "type": "string",
                         "format": "uri"
                       }
+                    },
+                    "username": {
+                      "description": "Redis username if not provided in the URLs. This field takes precedence over the username in the URL",
+                      "type": "string",
+                      "nullable": true
                     }
                   },
                   "additionalProperties": false,

docs/source/configuration/distributed-caching.mdx

@@ -95,6 +95,8 @@ supergraph:
     experimental_cache:
       redis: #highlight-line
         urls: ["redis://..."] #highlight-line
+        username: admin/123 # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url. This field takes precedence over the username in the URL
+        password: admin # Optional, can be part of the urls directly, mainly useful if you have special character like '/' in your password that doesn't work in url. This field takes precedence over the password in the URL
         timeout: 5ms # Optional, by default: 2ms
         ttl: 24h # Optional, by default no expiration
 ```