remove redis cloud TLS Profile feature (#20)

Signed-off-by: Thomas Hunter II <[email protected]>
valkey-io · Dec 6, 2024 · 171a0b0 · 171a0b0
1 parent fc9037d
commit 171a0b0
Show file tree

Hide file tree

Showing 6 changed files with 3 additions and 273 deletions.
diff --git a/README.md b/README.md
@@ -849,34 +849,6 @@ const valkey = new Valkey({
 });
 ```
 
-
-### TLS Profiles
-
-> **Warning**
-> TLS profiles described in this section are going to be deprecated in the next major version. Please provide TLS options explicitly.
-
-To make it easier to configure we provide a few pre-configured TLS profiles that can be specified by setting the `tls` option to the profile's name or specifying a `tls.profile` option in case you need to customize some values of the profile.
-
-Profiles:
-
-- `RedisCloudFixed`: Contains the CA for [Redis.com](https://redis.com/) Cloud fixed subscriptions
-- `RedisCloudFlexible`: Contains the CA for [Redis.com](https://redis.com/) Cloud flexible subscriptions
-
-```javascript
-const valkey = new Valkey({
-  host: "localhost",
-  tls: "RedisCloudFixed",
-});
-
-const valkeyWithClientCertificate = new Valkey({
-  host: "localhost",
-  tls: {
-    profile: "RedisCloudFixed",
-    key: "123",
-  },
-});
-```
-
 <hr>
 
 ## Sentinel

diff --git a/lib/Redis.ts b/lib/Redis.ts
@@ -27,7 +27,6 @@ import {
   Debug,
   isInt,
   parseURL,
-  resolveTLSProfile,
 } from "./utils";
 import applyMixin from "./utils/applyMixin";
 import Commander from "./utils/Commander";
@@ -742,8 +741,7 @@ class Redis extends Commander implements DataHandledable {
       options.db = parseInt(options.db, 10);
     }
 
-    // @ts-expect-error
-    this.options = resolveTLSProfile(options);
+    this.options = options;
   }
 
   /**

diff --git a/lib/cluster/util.ts b/lib/cluster/util.ts
@@ -1,4 +1,4 @@
-import { parseURL, resolveTLSProfile } from "../utils";
+import { parseURL } from "../utils";
 import { isIP } from "net";
 import { SrvRecord } from "dns";
 
@@ -67,7 +67,7 @@ export function normalizeNodeOptions(
       options.host = "127.0.0.1";
     }
 
-    return resolveTLSProfile(options);
+    return options;
   });
 }
 

diff --git a/lib/constants/TLSProfiles.ts b/lib/constants/TLSProfiles.ts
diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -3,8 +3,6 @@ import { defaults, noop } from "./lodash";
 import { Callback } from "../types";
 import Debug from "./debug";
 
-import TLSProfiles from "../constants/TLSProfiles";
-
 /**
  * Convert a buffer to string, supports buffer array
  *
@@ -255,25 +253,6 @@ interface TLSOptions {
   [key: string]: any;
 }
 
-/**
- * Resolve TLS profile shortcut in connection options
- */
-export function resolveTLSProfile(options: TLSOptions): TLSOptions {
-  let tls = options?.tls;
-
-  if (typeof tls === "string") tls = { profile: tls };
-
-  const profile = TLSProfiles[tls?.profile];
-
-  if (profile) {
-    tls = Object.assign({}, profile, tls);
-    delete tls.profile;
-    options = Object.assign({}, options, { tls });
-  }
-
-  return options;
-}
-
 /**
  * Get a random element from `array`
  */

diff --git a/test/unit/utils.ts b/test/unit/utils.ts
@@ -1,7 +1,6 @@
 import * as sinon from "sinon";
 import { expect } from "chai";
 import * as utils from "../../lib/utils";
-import TLSProfiles from "../../lib/constants/TLSProfiles";
 
 describe("utils", () => {
   describe(".convertBufferToString", () => {
@@ -206,75 +205,6 @@ describe("utils", () => {
     });
   });
 
-  describe(".resolveTLSProfile", () => {
-    it("should leave options alone when no tls profile is set", () => {
-      [
-        { host: "localhost", port: 6379 },
-        { host: "localhost", port: 6379, tls: true },
-        { host: "localhost", port: 6379, tls: false },
-        { host: "localhost", port: 6379, tls: "foo" },
-        { host: "localhost", port: 6379, tls: {} },
-        { host: "localhost", port: 6379, tls: { ca: "foo" } },
-        { host: "localhost", port: 6379, tls: { profile: "foo" } },
-      ].forEach((options) => {
-        expect(utils.resolveTLSProfile(options)).to.eql(options);
-      });
-    });
-
-    it("should have redis.com profiles defined", () => {
-      expect(TLSProfiles).to.have.property("RedisCloudFixed");
-      expect(TLSProfiles).to.have.property("RedisCloudFlexible");
-    });
-
-    it("should read profile from options.tls.profile", () => {
-      const input = {
-        host: "localhost",
-        port: 6379,
-        tls: { profile: "RedisCloudFixed" },
-      };
-      const expected = {
-        host: "localhost",
-        port: 6379,
-        tls: TLSProfiles.RedisCloudFixed,
-      };
-
-      expect(utils.resolveTLSProfile(input)).to.eql(expected);
-    });
-
-    it("should read profile from options.tls", () => {
-      const input = {
-        host: "localhost",
-        port: 6379,
-        tls: "RedisCloudFixed",
-      };
-      const expected = {
-        host: "localhost",
-        port: 6379,
-        tls: TLSProfiles.RedisCloudFixed,
-      };
-
-      expect(utils.resolveTLSProfile(input)).to.eql(expected);
-    });
-
-    it("supports extra options when using options.tls.profile", () => {
-      const input = {
-        host: "localhost",
-        port: 6379,
-        tls: { profile: "RedisCloudFixed", key: "foo" },
-      };
-      const expected = {
-        host: "localhost",
-        port: 6379,
-        tls: {
-          ...TLSProfiles.RedisCloudFixed,
-          key: "foo",
-        },
-      };
-
-      expect(utils.resolveTLSProfile(input)).to.eql(expected);
-    });
-  });
-
   describe(".sample", () => {
     it("should return a random value", () => {
       let stub = sinon.stub(Math, "random").callsFake(() => 0);