refactor: remove deprecated pkceMethods configuration property

BREAKING CHANGE: The deprecated `pkceMethods` configuration property was removed, use `pkce.methods` instead.
panva · May 14, 2020 · 65712d0 · 65712d0
1 parent 3076f32
commit 65712d0
Show file tree

Hide file tree

Showing 5 changed files with 1 addition and 54 deletions.
diff --git a/lib/helpers/configuration.js b/lib/helpers/configuration.js
@@ -363,12 +363,6 @@ class Configuration {
   }
 
   checkPkceMethods() {
-    if (this.pkceMethods) {
-      this.pkceMethodsDeprecationNotice();
-      this.pkce.methods = this.pkceMethods;
-      delete this.pkceMethods;
-    }
-
     if (!Array.isArray(this.pkce.methods)) {
       throw new TypeError('pkce.methods must be an array');
     }
@@ -535,12 +529,6 @@ class Configuration {
   }
 }
 
-Configuration.prototype.pkceMethodsDeprecationNotice = deprecate(
-  /* istanbul ignore next */
-  () => {},
-  `pkceMethods is deprecated, use pkce.methods for configuring it instead, see ${docs('pkce')}`,
-);
-
 Configuration.prototype.postLogoutSuccessSourceDeprecationNotice = deprecate(
   /* istanbul ignore next */
   () => {},

diff --git a/lib/helpers/defaults.js b/lib/helpers/defaults.js
@@ -2682,7 +2682,6 @@ function getDefaults() {
       ],
     },
 
-    pkceMethods: undefined,
     postLogoutSuccessSource: undefined,
     logoutSource: undefined,
   };

diff --git a/test/configuration/constructor.test.js b/test/configuration/constructor.test.js
@@ -171,45 +171,8 @@ describe('Provider configuration', () => {
     });
   });
 
-  describe('pkceMethods', () => {
-    it('validates configuration pkceMethods members', () => {
-      const throws = [
-        () => {
-          new Provider('http://localhost:3000', {
-            pkceMethods: ['S256', 'plain', 'foobar'],
-          });
-        },
-        () => {
-          new Provider('http://localhost:3000', {
-            pkceMethods: ['foobar'],
-          });
-        },
-      ];
-
-      throws.forEach((fn) => {
-        expect(fn).to.throw('only plain and S256 code challenge methods are supported');
-      });
-    });
-
-    it('validates configuration pkceMethods presence', () => {
-      expect(() => {
-        new Provider('http://localhost:3000', {
-          pkceMethods: [],
-        });
-      }).to.throw('pkce.methods must not be empty');
-    });
-
-    it('validates configuration pkceMethods type', () => {
-      expect(() => {
-        new Provider('http://localhost:3000', {
-          pkceMethods: 'public',
-        });
-      }).to.throw('pkce.methods must be an array');
-    });
-  });
-
   describe('pkce.methods', () => {
-    it('validates configuration pkceMethods members', () => {
+    it('validates configuration pkce.methods members', () => {
       const throws = [
         () => {
           new Provider('http://localhost:3000', {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1035,8 +1035,6 @@ export interface Configuration {
 
   responseTypes?: ResponseType[];
 
-  pkceMethods?: PKCEMethods[];
-
   pkce?: {
     methods: PKCEMethods[];
     required?: (ctx: KoaContextWithOIDC, client: Client) => boolean;

diff --git a/types/oidc-provider-tests.ts b/types/oidc-provider-tests.ts
@@ -238,7 +238,6 @@ const provider = new Provider('https://op.example.com', {
     ],
   },
   responseTypes: ['code', 'code id_token', 'none'],
-  pkceMethods: ['plain', 'S256'],
   pkce: {
     methods: ['plain', 'S256'],
     required(ctx, client) {