fix(authentication): Improve JWT strategy configuration error message (…

…#1844)
feathersjs · Mar 2, 2020 · 2c771db · 2c771db
1 parent ecdd0c9
commit 2c771db
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/packages/authentication/src/jwt.ts b/packages/authentication/src/jwt.ts
@@ -69,6 +69,10 @@ export class JWTStrategy extends AuthenticationBaseStrategy {
         throw new Error(`Invalid JwtStrategy option 'authentication.${this.name}.${key}'. Did you mean to set it in 'authentication.jwtOptions'?`);
       }
     }
+
+    if (typeof this.configuration.header !== 'string') {
+      throw new Error(`The 'header' option for the ${this.name} strategy must be a string`);
+    }
   }
 
   /**

diff --git a/packages/authentication/test/jwt.test.ts b/packages/authentication/test/jwt.test.ts
@@ -306,6 +306,16 @@ describe('authentication/jwt', () => {
         assert.strictEqual(error.message, `Invalid JwtStrategy option 'authentication.otherJwt.expiresIn'. Did you mean to set it in 'authentication.jwtOptions'?`);
       }
     });
+
+    it('errors when `header` option is an object`', () => {
+      app.get('authentication').otherJwt = {
+        header: { message: 'This is wrong' }
+      };
+
+      assert.throws(() => app.service('authentication').register('otherJwt', new JWTStrategy()), {
+        message: `The 'header' option for the otherJwt strategy must be a string`
+      });
+    });
   });
 
   describe('parse', () => {