Updated the javascript client to call the new heartbeats api

Author: niemyjski

appveyor.yml

@@ -1,4 +1,4 @@
-version: 1.3.{build}
+version: 1.4.{build}
 
 install:
   - ps: Install-Product node 5

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "exceptionless",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "JavaScript client for Exceptionless",
   "license": "Apache-2.0",
   "main": "dist/exceptionless.js",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exceptionless",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "JavaScript client for Exceptionless",
   "license": "Apache-2.0",
   "main": "dist/exceptionless.node.js",
@@ -29,24 +29,24 @@
   "devDependencies": {
     "chai": "3.5.0",
     "del": "2.2.0",
-    "es5-shim": "4.5.7",
+    "es5-shim": "4.5.8",
     "es6-shim": "0.35.0",
     "gulp": "3.9.1",
     "gulp-concat": "2.6.0",
     "gulp-exec": "2.1.2",
     "gulp-mocha": "2.2.0",
     "gulp-replace": "0.5.4",
     "gulp-sourcemaps": "1.6.0",
-    "gulp-tslint": "4.3.4",
+    "gulp-tslint": "5.0.0",
     "gulp-uglify": "1.5.3",
     "gulp-wrap-umd": "0.2.1",
     "rimraf": "2.5.2",
     "source-map-support": "0.4.0",
-    "mock-fs": "3.8.0",
-    "tracekit": "0.3.2",
-    "tslint": "3.6.0",
-    "tsproject": "1.2.0",
-    "typescript": "1.8.9",
+    "mock-fs": "3.9.0",
+    "tracekit": "0.3.5",
+    "tslint": "3.8.1",
+    "tsproject": "1.2.1",
+    "typescript": "1.8.10",
     "typescript-formatter": "2.1.0"
   },
   "dependencies": {

src/ExceptionlessClient.ts

@@ -101,20 +101,16 @@ export class ExceptionlessClient {
     this.createSessionStart().submit(callback);
   }
 
-  public createSessionEnd(): EventBuilder {
-    return this.createEvent().setType('sessionend');
-  }
-
-  public submitSessionEnd(callback?: (context: EventPluginContext) => void): void {
-    this.createSessionEnd().submit(callback);
-  }
-
-  public createSessionHeartbeat(): EventBuilder {
-    return this.createEvent().setType('heartbeat');
+  public submitSessionEnd(sessionIdOrUserId: string): void {
+    if (sessionIdOrUserId) {
+      this.config.submissionClient.sendHeartbeat(sessionIdOrUserId, true, this.config);
+    }
   }
 
-  public submitSessionHeartbeat(callback?: (context: EventPluginContext) => void): void {
-    this.createSessionHeartbeat().submit(callback);
+  public submitSessionHeartbeat(sessionIdOrUserId: string): void {
+    if (sessionIdOrUserId) {
+      this.config.submissionClient.sendHeartbeat(sessionIdOrUserId, false, this.config);
+    }
   }
 
   public createEvent(pluginContextData?: ContextData): EventBuilder {

src/configuration/Configuration.ts

@@ -97,6 +97,7 @@ export class Configuration implements IConfigurationSettings {
     this.log = inject(configSettings.log) || new NullLog();
     this.apiKey = configSettings.apiKey;
     this.serverUrl = configSettings.serverUrl;
+    this.heartbeatServerUrl = configSettings.heartbeatServerUrl;
 
     this.environmentInfoCollector = inject(configSettings.environmentInfoCollector);
     this.errorParser = inject(configSettings.errorParser);
@@ -167,10 +168,37 @@ export class Configuration implements IConfigurationSettings {
   public set serverUrl(value: string) {
     if (!!value) {
       this._serverUrl = value;
+      this._heartbeatServerUrl = value;
       this.log.info(`serverUrl: ${this._serverUrl}`);
     }
   }
 
+  /**
+   * The heartbeat server url that all heartbeats will be sent to.
+   * @type {string}
+   * @private
+   */
+  private _heartbeatServerUrl: string = 'https://heartbeat.exceptionless.io';
+
+  /**
+   * The heartbeat server url that all heartbeats will be sent to.
+   * @returns {string}
+   */
+  public get heartbeatServerUrl(): string {
+    return this._heartbeatServerUrl;
+  }
+
+  /**
+   * The heartbeat server url that all heartbeats will be sent to.
+   * @param value
+   */
+  public set heartbeatServerUrl(value: string) {
+    if (!!value) {
+      this._heartbeatServerUrl = value;
+      this.log.info(`heartbeatServerUrl: ${this._heartbeatServerUrl}`);
+    }
+  }
+
   /**
    * A list of exclusion patterns.
    * @type {Array}
@@ -352,9 +380,9 @@ export class Configuration implements IConfigurationSettings {
   /**
    * Automatically send a heartbeat to keep the session alive.
    */
-  public useSessions(sendHeartbeats: boolean = true): void {
+  public useSessions(sendHeartbeats: boolean = true, heartbeatInterval: number = 30000): void {
     if (sendHeartbeats) {
-      this.addPlugin(new HeartbeatPlugin());
+      this.addPlugin(new HeartbeatPlugin(heartbeatInterval));
     }
   }
 

src/configuration/IConfigurationSettings.ts

@@ -12,6 +12,7 @@ import { ISubmissionClient } from '../submission/ISubmissionClient';
 export interface IConfigurationSettings {
   apiKey?: string;
   serverUrl?: string;
+  heartbeatServerUrl?: string;
   environmentInfoCollector?: IEnvironmentInfoCollector;
   errorParser?: IErrorParser;
   lastReferenceIdManager?: ILastReferenceIdManager;

src/plugins/default/HeartbeatPlugin.ts

@@ -6,8 +6,13 @@ export class HeartbeatPlugin implements IEventPlugin {
   public priority: number = 100;
   public name: string = 'HeartbeatPlugin';
 
+  private _heartbeatInterval: number;
   private _heartbeatIntervalId: any;
-  private _lastUser: IUserInfo;
+
+  constructor (heartbeatInterval: number = 30000) {
+    this._heartbeatInterval = heartbeatInterval;
+  }
+
 
   public run(context: EventPluginContext, next?: () => void): void {
     let clearHeartbeatInterval = () => {
@@ -17,24 +22,13 @@ export class HeartbeatPlugin implements IEventPlugin {
       }
     };
 
-    let type = context.event.type;
-    if (type !== 'heartbeat') {
-      if (type === 'sessionend') {
-        clearHeartbeatInterval();
-      } else {
-        let user: IUserInfo = context.event.data['@user'];
-        if (user && user.identity) {
-          let submitHeartbeatFn = () => context.client.createSessionHeartbeat().setUserIdentity(user).submit();
-
-          if (!this._heartbeatIntervalId) {
-            this._lastUser = user;
-          } else {
-            clearHeartbeatInterval();
-          }
-
-          this._heartbeatIntervalId = setInterval(submitHeartbeatFn, 30000);
-        }
-      }
+    if (this._heartbeatIntervalId) {
+      clearHeartbeatInterval();
+    }
+
+    let user: IUserInfo = context.event.data['@user'];
+    if (user && user.identity) {
+      this._heartbeatIntervalId = setInterval(() => context.client.submitSessionHeartbeat(user.identity), this._heartbeatInterval);
     }
 
     next && next();

src/submission/DefaultSubmissionAdapter.ts

@@ -5,7 +5,7 @@ import { SubmissionRequest } from './SubmissionRequest';
 declare var XDomainRequest: { new (); create(); };
 
 export class DefaultSubmissionAdapter implements ISubmissionAdapter {
-  public sendRequest(request: SubmissionRequest, callback: SubmissionCallback, isAppExiting?: boolean) {
+  public sendRequest(request: SubmissionRequest, callback?: SubmissionCallback, isAppExiting?: boolean) {
     // TODO: Handle sending events when app is exiting with send beacon.
     const TIMEOUT: string = 'timeout';  // optimization for minifier.
     const LOADED: string = 'loaded';  // optimization for minifier.
@@ -62,7 +62,7 @@ export class DefaultSubmissionAdapter implements ISubmissionAdapter {
         }
       }
 
-      callback(status || 500, message || '', responseText, parseResponseHeaders(xhr.getAllResponseHeaders && xhr.getAllResponseHeaders()));
+      callback && callback(status || 500, message || '', responseText, parseResponseHeaders(xhr.getAllResponseHeaders && xhr.getAllResponseHeaders()));
     }
 
     function createRequest(userAgent: string, method: string, url: string): XMLHttpRequest {
@@ -89,10 +89,10 @@ export class DefaultSubmissionAdapter implements ISubmissionAdapter {
       return xhr;
     }
 
-    let url = `${request.serverUrl}${request.path}?access_token=${encodeURIComponent(request.apiKey)}`;
+    let url = `${request.url}?access_token=${encodeURIComponent(request.apiKey)}`;
     let xhr = createRequest(request.userAgent, request.method || 'POST', url);
     if (!xhr) {
-      return callback(503, 'CORS not supported.');
+      return (callback && callback(503, 'CORS not supported.'));
     }
 
     if (WITH_CREDENTIALS in xhr) {

src/submission/DefaultSubmissionClient-spec.ts

@@ -34,7 +34,7 @@ class TestAdapter implements ISubmissionAdapter {
     return this;
   }
 
-  public sendRequest(request: SubmissionRequest, callback: SubmissionCallback, isAppExiting?: boolean) {
+  public sendRequest(request: SubmissionRequest, callback?: SubmissionCallback, isAppExiting?: boolean) {
     this.request = request;
     this.callback = callback;
 
@@ -50,7 +50,7 @@ class TestAdapter implements ISubmissionAdapter {
     }
 
     this.checks.forEach(c => c(this.request));
-    this.callback(this.status, this.message, this.data, this.headers);
+    this.callback && this.callback(this.status, this.message, this.data, this.headers);
   }
 }
 
@@ -72,7 +72,6 @@ describe('DefaultSubmissionClient', () => {
 
     adapter = new TestAdapter(r => {
       expect(r.apiKey).to.equal(apiKey);
-      expect(r.serverUrl).to.equal(serverUrl);
     });
 
     config.submissionAdapter = adapter;
@@ -84,7 +83,7 @@ describe('DefaultSubmissionClient', () => {
     adapter.withCheck(r => {
       expect(r.data).to.equal(JSON.stringify(events));
       expect(r.method).to.equal('POST');
-      expect(r.path).to.equal('/api/v2/events');
+      expect(r.url).to.equal(`${config.serverUrl}/api/v2/events`);
     });
 
     submissionClient.postEvents(events, config, () => done());
@@ -103,7 +102,7 @@ describe('DefaultSubmissionClient', () => {
     adapter.withCheck(r => {
       expect(r.data).to.equal(JSON.stringify(events));
       expect(r.method).to.equal('POST');
-      expect(r.path).to.equal('/api/v2/events');
+      expect(r.url).to.equal(`${config.serverUrl}/api/v2/events`);
     });
 
     submissionClient.postEvents(events, config, () => done());
@@ -120,7 +119,7 @@ describe('DefaultSubmissionClient', () => {
     adapter.withCheck(r => {
       expect(r.data).to.equal(JSON.stringify(description));
       expect(r.method).to.equal('POST');
-      expect(r.path).to.equal('/api/v2/events/by-ref/123454321/user-description');
+      expect(r.url).to.equal(`${config.serverUrl}/api/v2/events/by-ref/123454321/user-description`);
     });
 
     submissionClient.postUserDescription('123454321', description, config, () => done());
@@ -129,7 +128,6 @@ describe('DefaultSubmissionClient', () => {
   });
 
   it('should get project settings', (done) => {
-
     adapter.withResponse(200, null, JSON.stringify({ version: 1 }));
 
     submissionClient.getSettings(config, response => {

src/submission/DefaultSubmissionClient.ts

@@ -15,14 +15,14 @@ export class DefaultSubmissionClient implements ISubmissionClient {
 
   public postEvents(events: IEvent[], config: Configuration, callback: (response: SubmissionResponse) => void, isAppExiting?: boolean): void {
     let data = JSON.stringify(events);
-    let request = this.createRequest(config, 'POST', '/api/v2/events', data);
+    let request = this.createRequest(config, 'POST',  `${config.serverUrl}/api/v2/events`, data);
     let cb = this.createSubmissionCallback(config, callback);
 
     return config.submissionAdapter.sendRequest(request, cb, isAppExiting);
   }
 
   public postUserDescription(referenceId: string, description: IUserDescription, config: Configuration, callback: (response: SubmissionResponse) => void): void {
-    let path = `/api/v2/events/by-ref/${encodeURIComponent(referenceId)}/user-description`;
+    let path = `${config.serverUrl}/api/v2/events/by-ref/${encodeURIComponent(referenceId)}/user-description`;
     let data = JSON.stringify(description);
     let request = this.createRequest(config, 'POST', path, data);
     let cb = this.createSubmissionCallback(config, callback);
@@ -31,7 +31,7 @@ export class DefaultSubmissionClient implements ISubmissionClient {
   }
 
   public getSettings(config: Configuration, callback: (response: SettingsResponse) => void): void {
-    let request = this.createRequest(config, 'GET', '/api/v2/projects/config');
+    let request = this.createRequest(config, 'GET', `${config.serverUrl}/api/v2/projects/config`);
     let cb = (status, message, data?, headers?) => {
       if (status !== 200) {
         return callback(new SettingsResponse(false, null, -1, null, message));
@@ -54,12 +54,16 @@ export class DefaultSubmissionClient implements ISubmissionClient {
     return config.submissionAdapter.sendRequest(request, cb);
   }
 
-  private createRequest(config: Configuration, method: string, path: string, data: string = null): SubmissionRequest {
+  public sendHeartbeat(sessionIdOrUserId: string, closeSession: boolean, config: Configuration): void {
+    let request = this.createRequest(config, 'GET', `${config.heartbeatServerUrl}/api/v2/events/session/heartbeat?id=${sessionIdOrUserId}&close=${closeSession}`);
+    config.submissionAdapter.sendRequest(request);
+  }
+
+  private createRequest(config: Configuration, method: string, url: string, data: string = null): SubmissionRequest {
     return {
       method,
-      path,
+      url,
       data,
-      serverUrl: config.serverUrl,
       apiKey: config.apiKey,
       userAgent: config.userAgent
     };