Merge pull request #72 from Luidog/sessions-testing

Session testing

Author: Luidog

package.json

@@ -4,7 +4,7 @@
   "description": "A FileMaker Data API client designed to allow easier interaction with a FileMaker database from a web environment.",
   "main": "index.js",
   "scripts": {
-    "test": "nyc _mocha --recursive  ./test/*.test.js --timeout=15000 --exit",
+    "test": "nyc _mocha --recursive  ./test/*.test.js --timeout=40000 --exit",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "report": "nyc report --reporter=html",
     "examples": "node examples/index.js",

src/models/agent.model.js

@@ -210,20 +210,29 @@ class Agent extends EmbeddedDocument {
    * @return {Object} request The configured axios instance to use for a request.
    */
   request(data, parameters = {}) {
-    instance.interceptors.request.use(
-      ({ httpAgent, httpsAgent, ...request }) =>
-        new Promise((resolve, reject) =>
+    const id = uuidv4();
+    const interceptor = instance.interceptors.request.use(
+      ({ httpAgent, httpsAgent, ...request }) => {
+        instance.interceptors.request.eject(interceptor);
+        return new Promise((resolve, reject) =>
           this.push({
-            request: this.handleRequest(request),
+            request: this.handleRequest(request, id),
             resolve,
             reject
           })
-        )
+        );
+      }
     );
 
-    instance.interceptors.response.use(
-      response => this.handleResponse(response),
-      error => this.handleError(error)
+    const response = instance.interceptors.response.use(
+      response => {
+        instance.interceptors.response.eject(response);
+        return this.handleResponse(response, id);
+      },
+      error => {
+        instance.interceptors.response.eject(response);
+        return this.handleError(error, id);
+      }
     );
 
     return instance(
@@ -244,17 +253,22 @@ class Agent extends EmbeddedDocument {
    * @description handles request data before it is sent to the resource. This function
    * will eventually be used to cancel the request and return the configuration body.
    * This function will test the url for an http proticol and reject if none exist.
-   * @param  {Object} response The axios response
+   * @param  {Object} response The axios response.
+   * @param {String} id the request id.
    * @return {Promise}      the request configuration object
    */
-  handleResponse(response) {
+  handleResponse(response, id) {
+    const token = _.get(response, 'config.headers.Authorization');
+    if (token) {
+      this.connection.deactivate(token, id);
+    }
     if (typeof response.data !== 'object') {
       return Promise.reject({
         message: 'The Data API is currently unavailable',
         code: '1630'
       });
     } else {
-      this.connection.extend(response.config.headers.Authorization);
+      this.connection.extend(token);
       return response;
     }
   }
@@ -266,10 +280,12 @@ class Agent extends EmbeddedDocument {
    * @description handles request data before it is sent to the resource. This function
    * will eventually be used to cancel the request and return the configuration body.
    * This function will test the url for an http proticol and reject if none exist.
-   * @param  {Object} config The axios request configuration
+   * @param  {Object} config The axios request configuration.
+   * @param {String} id the request id.
    * @return {Promise}      the request configuration object
    */
-  handleRequest(config) {
+  handleRequest(config, id) {
+    config.id = id;
     return config.url.startsWith('http')
       ? omit(config, ['params.request', 'data.request'])
       : Promise.reject({
@@ -360,9 +376,17 @@ class Agent extends EmbeddedDocument {
    * function will add an expired property to the error response if it recieves a invalid
    * token response.
    * @param  {Object} error The error recieved from the requested resource.
+   * @param {String} id the request id.
    * @return {Promise}      A promise rejection containing a code and a message
    */
-  handleError(error) {
+  handleError(error, id) {
+    const token = _.get(error, 'config.headers.Authorization');
+    if (token) {
+      this.connection.deactivate(token, id);
+    }
+    
+    this.connection.confirm();
+
     if (error.code) {
       return Promise.reject({ code: error.code, message: error.message });
     } else if (
@@ -375,9 +399,7 @@ class Agent extends EmbeddedDocument {
       });
     } else {
       if (error.response.data.messages[0].code === '952')
-        this.connection.clear(
-          _.get(error, 'response.config.headers.Authorization')
-        );
+        this.connection.clear(token);
       return Promise.reject(error.response.data.messages[0]);
     }
   }
@@ -401,15 +423,24 @@ class Agent extends EmbeddedDocument {
       const WATCHER = setTimeout(
         function watch() {
           this.connection.clear();
-          if (this.queue.length > 0) {
+          if (
+            this.queue.length > 0 &&
+            !this.connection.starting &&
+            this.connection.available()
+          ) {
             this.shift();
           }
 
-          if (this.pending.length > 0 && this.connection.ready()) {
+          if (
+            this.pending.length > 0 &&
+            !this.connection.starting &&
+            this.connection.available()
+          ) {
             this.resolve();
           }
 
           if (
+            this.pending.length > 0 &&
             !this.connection.available() &&
             !this.connection.starting &&
             this.connection.sessions.length < this.concurrency
@@ -453,7 +484,8 @@ class Agent extends EmbeddedDocument {
         Object.assign(
           this.mutate(pending.request, (value, key) =>
             key.replace(/{{dot}}/g, '.')
-          )
+          ),
+          { id: pending.id }
         ),
         _.isEmpty(this.agent) ? {} : this.localize()
       )

src/models/connection.model.js

@@ -104,7 +104,7 @@ class Connection extends EmbeddedDocument {
    * @see  {@link Connection#available}
    * @return {String} The session token.
    */
-  authentication({ headers, ...request }) {
+  authentication({ headers, id, ...request }) {
     return new Promise((resolve, reject) => {
       const sessions = _.sortBy(
         this.sessions.filter(session => !session.expired()),
@@ -114,6 +114,7 @@ class Connection extends EmbeddedDocument {
       const session = sessions[0];
       session.active = true;
       session.url = request.url;
+      session.request = id;
       session.used = moment().format();
       resolve({
         ...request,
@@ -125,18 +126,6 @@ class Connection extends EmbeddedDocument {
     });
   }
 
-  /**
-   * @method ready
-   * @public
-   * @memberof Connection
-   * @description Saves a token retrieved from the Data API as a sessions
-   * @see  {@link session}
-   * @return {Boolean} data a boolean indicating if the connection has a session.
-   */
-  ready() {
-    return this.sessions.filter(session => !session.expired()).length > 0;
-  }
-
   /**
    * @method available
    * @public
@@ -287,6 +276,38 @@ class Connection extends EmbeddedDocument {
     const session = _.find(this.sessions, session => session.token === token);
     if (session) session.extend();
   }
+
+  /**
+   * @method confirm
+   * @memberOf confirm
+   * @description The confirm method will set the active property to false when a session does not have a
+   * valid request id.
+   */
+  confirm() {
+    this.sessions.forEach(session => {
+      if (_.isEmpty(session.request)) {
+        session.active = false;
+      }
+    });
+  }
+  /**
+   * @method  deactivate
+   * @memberOf Connection
+   * @public
+   * @description The deactivate method will reactive a session by setting the active property to false.
+   * @param {String} header The header containing the token representing the session to deactivate
+   * @param {String} id The request id.
+   * @see  {@link Agent#handleResponse}
+   * @see  {@link Agent#handleError}
+   */
+  deactivate(header, id) {
+    const token = header.replace('Bearer ', '');
+    const session = _.find(
+      this.sessions,
+      session => session.token === token || session.request === id
+    );
+    if (session) session.deactivate();
+  }
 }
 
 module.exports = {

src/models/session.model.js

@@ -43,6 +43,13 @@ class Session extends EmbeddedDocument {
       used: {
         type: String
       },
+      /* A string containing the request created when the token is in use..
+       * @member Session#request
+       * @type String
+       */
+      request: {
+        type: String
+      },
       /* A boolean set if the current session is in use.
        * @member Session#active
        * @type Boolean
@@ -95,13 +102,26 @@ class Session extends EmbeddedDocument {
    * @method extend
    * @memberof Session
    * @public
-   * @description This method extends a Data API session and sets it to inactive.
+   * @description This method extends a Data API session.
    * @see  {@link Agent#handleResponse}
    */
   extend() {
     this.active = false;
     this.expires = moment().add(15, 'minutes').format();
   }
+
+  /**
+   * @method  deactivate
+   * @memberOf Sessions
+   * @public
+   * @description This method sets deactivates a session by setting active to false.
+   * @see  {@link Agent#handleResponse}
+   * @see  {@link Agent#handleError}
+   */
+  deactivate() {
+    this.request = "";
+    this.active = false;
+  }
 }
 
 module.exports = {

test/admin/index.js

@@ -30,8 +30,15 @@ const login = () =>
       return response.data.response.token;
     });
 
-const logout = (token = adminToken) => instance
+const logout = (token = adminToken) =>
+  token
+    ? instance
         .delete(`/fmi/admin/api/v2/user/auth/${token}`, {})
+        .then(response => {
+          adminToken = false;
+          return response.data.response.token;
+        })
+    : Promise.resolve();
 
 const remove = ({ id }, token = adminToken) =>
   instance

test/queue.test.js

@@ -42,6 +42,7 @@ describe('Request Queue Capabilities', () => {
     client = Filemaker.create({
       database: process.env.DATABASE,
       server: process.env.SERVER,
+      concurrency: 25,
       user: process.env.USERNAME,
       password: process.env.PASSWORD
     });