Only re-auth if authenticator is set

Author: Aschen

doc/7/core-classes/kuzzle/authenticate/index.md

@@ -15,10 +15,6 @@ Authenticate the SDK by using the function set in the [authenticator](/sdk/js/7/
 authenticate();
 ```
 
-## Resolves
-
-Resolves to the authentication token.
-
 ## Usage
 
 <<< ./snippets/authenticate.js

doc/7/core-classes/kuzzle/authenticate/snippets/authenticate.js

@@ -3,11 +3,8 @@ kuzzle.authenticator = async () => {
 };
 
 try {
-  const jwt = await kuzzle.authenticate();
-  console.log(jwt);
-  /*
-    'eyJhbGciOiJIUzI1NiIsIkpXVCJ9.eyJfaWQiOiJmb28iLCJpYXQiOjE.wSPmb0z2tErRdYEg'
-  */
+  await kuzzle.authenticate();
+
   console.log('Success');
 } catch (error) {
   console.error(error.message);

doc/7/core-classes/kuzzle/properties/index.md

@@ -44,15 +44,15 @@ The `authenticator` property can be set to a function returning a promise.
 
 This function will be called after a successful reconnection if the current authentication token is not valid anymore.  
 
-This function has to authenticate the SDK (by setting the `jwt` property). It can be a call to [auth.login](/sdk/js/7/controllers/auth/login) for example.
+This function has to authenticate the SDK. It can be a call to [auth.login](/sdk/js/7/controllers/auth/login) for example.
 
 ```js
 kuzzle.authenticator = async () => {
   await kuzzle.auth.login('local', { username: 'user', password: 'pass' });
 }
 ```
 
-If the `authenticator` function fail, then the `reconnected` event is never emitted and a `reconnectionError` event is emitted.
+If the `authenticator` function fail to authenticate the SDK, then the `reconnected` event is never emitted and a `reconnectionError` event is emitted.
 
 ### offlineQueueLoader
 

src/Kuzzle.ts

@@ -536,9 +536,9 @@ export class Kuzzle extends KuzzleEventEmitter {
         this.stopQueuing();
       }
 
-      // If the SDK was authenticated, check if the token is still valid and try
+      // If an authenticator was set, check if the token is still valid and try
       // to re-authenticate if needed. Otherwise the SDK is in disconnected state.
-      if (this.jwt && ! await this.tryReAuthenticate()) {
+      if (this.authenticator && ! await this.tryReAuthenticate()) {
         this.disconnect();
 
         return;
@@ -592,18 +592,18 @@ export class Kuzzle extends KuzzleEventEmitter {
    *
    * @returns The authentication token
    */
-  async authenticate (): Promise<string> {
+  async authenticate (): Promise<void> {
     if (typeof this.authenticator !== 'function') {
       throw new Error('The "authenticator" property must be a function.');
     }
 
     await this.authenticator();
 
-    if (! this.jwt) {
-      throw new Error('The "authenticator" function did not authenticate the SDK. ("jwt" is not set)');
-    }
+    const { valid } = await this.auth.checkToken();
 
-    return this.jwt;
+    if (! valid) {
+      throw new Error('The "authenticator" function failed to authenticate the SDK.');
+    }
   }
 
   /**

test/kuzzle/authenticator.test.js

@@ -6,7 +6,6 @@ const { Kuzzle } = require('../../src/Kuzzle');
 describe('Kuzzle authenticator function mecanisms', () => {
   let kuzzle;
   let protocol;
-  let validJwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
 
   beforeEach(() => {
     protocol = new ProtocolMock('somewhere');
@@ -23,7 +22,7 @@ describe('Kuzzle authenticator function mecanisms', () => {
     let promise;
 
     beforeEach(() => {
-      kuzzle.jwt = validJwt;
+      kuzzle.authenticator = async () => {};
 
       sinon.stub(kuzzle, 'tryReAuthenticate').resolves(true);
       sinon.stub(kuzzle, 'disconnect');
@@ -32,7 +31,7 @@ describe('Kuzzle authenticator function mecanisms', () => {
       kuzzle.on('reconnected', reconnectedSpy);
     });
 
-    it('should try to re-authenticate when reconnecting if a JWT was set', async () => {
+    it('should try to re-authenticate when reconnecting if an authenticator was set', async () => {
       promise = new Promise(_resolve => {
         resolve = _resolve;
       });
@@ -69,12 +68,12 @@ describe('Kuzzle authenticator function mecanisms', () => {
       return promise;
     });
 
-    it('should not try to authenticate if the SDK was not authenticated', async () => {
+    it('should not try to authenticate if no authenticator was set', async () => {
+      kuzzle.authenticator = null;
       promise = new Promise(_resolve => {
         resolve = _resolve;
       });
       await kuzzle.connect();
-      kuzzle.jwt = null;
 
       protocol.emit('reconnect');
 
@@ -131,18 +130,18 @@ describe('Kuzzle authenticator function mecanisms', () => {
 
   describe('#authenticate', () => {
     beforeEach(() => {
-      kuzzle.authenticator = async () => {
-        kuzzle.jwt = validJwt;
-      };
+      kuzzle.authenticator = async () => {};
+
+      sinon.stub(kuzzle.auth, 'checkToken').resolves({ valid: true });
 
       sinon.spy(kuzzle, 'authenticator');
     });
 
     it('should execute the "authenticator"', async () => {
-      const token = await kuzzle.authenticate();
+      await kuzzle.authenticate();
 
       should(kuzzle.authenticator).be.calledOnce();
-      should(token).be.eql(validJwt);
+      should(kuzzle.auth.checkToken).be.calledOnce();
     });
 
     it('should throw an error if the "authenticator" is not set', () => {
@@ -151,8 +150,8 @@ describe('Kuzzle authenticator function mecanisms', () => {
       should(kuzzle.authenticate()).be.rejected();
     });
 
-    it('should throw an error if the "authenticator" does not set the JWT', () => {
-      kuzzle.authenticator = async () => {};
+    it('should throw an error if the "authenticator" does not authenticate the SDK', () => {
+      kuzzle.auth.checkToken.resolves({ valid: false });
 
       should(kuzzle.authenticate()).be.rejected();
     });