1.1.56

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartsocket",
-  "version": "1.1.49",
+  "version": "1.1.56",
   "description": "easy and secure websocket communication",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -21,25 +21,25 @@
   "dependencies": {
     "@apiglobal/typedrequest-interfaces": "^1.0.7",
     "@pushrocks/lik": "^3.0.11",
-    "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartexpress": "^3.0.40",
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartexpress": "^3.0.52",
     "@pushrocks/smarthash": "^2.0.6",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@types/shortid": "0.0.29",
-    "@types/socket.io": "^2.1.2",
+    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrx": "^2.0.5",
+    "@pushrocks/smartunique": "^3.0.1",
+    "@types/socket.io": "^2.1.4",
     "@types/socket.io-client": "^1.4.32",
-    "shortid": "^2.2.15",
-    "socket.io": "^2.2.0",
-    "socket.io-client": "^2.2.0"
+    "socket.io": "^2.3.0",
+    "socket.io-client": "^2.3.0"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.17",
     "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.28",
     "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.4",
-    "tslint": "^5.19.0",
+    "@types/node": "^12.12.5",
+    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "private": false,

test/test.ts

@@ -21,7 +21,7 @@ export interface IReqResClient {
   };
   response: {
     value1: string;
-  }
+  };
 }
 
 export interface IReqResServer {

ts/interfaces/connection.ts

@@ -0,0 +1,5 @@
+export interface IRequestAuthPayload {
+  serverShortId: string;
+}
+
+export type TConnectionEvent = 'terminated' | 'error';

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './connection';

ts/smartsocket.classes.smartsocket.ts

@@ -16,6 +16,10 @@ export interface ISmartsocketConstructorOptions {
 }
 
 export class Smartsocket {
+  /**
+   * a unique id to detect server restarts
+   */
+  public shortId = plugins.smartunique.shortId();
   public options: ISmartsocketConstructorOptions;
   public io: SocketIO.Server;
   public socketConnections = new Objectmap<SocketConnection>();
@@ -80,7 +84,7 @@ export class Smartsocket {
         funcName: functionNameArg
       },
       originSocketConnection: targetSocketConnectionArg,
-      shortId: plugins.shortid.generate(),
+      shortId: plugins.smartunique.shortId(),
       side: 'requesting'
     });
     const response: ISocketFunctionCallDataResponse<T> = await socketRequest.dispatch();

ts/smartsocket.classes.smartsocketclient.ts

@@ -1,9 +1,11 @@
 import * as plugins from './smartsocket.plugins';
+import * as interfaces from './interfaces';
 
 import { SocketConnection } from './smartsocket.classes.socketconnection';
 import { ISocketFunctionCallDataRequest, SocketFunction } from './smartsocket.classes.socketfunction';
 import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
 import { SocketRole } from './smartsocket.classes.socketrole';
+import { defaultLogger } from '@pushrocks/smartlog';
 
 /**
  * interface for class SmartsocketClient
@@ -14,14 +16,24 @@ export interface ISmartsocketClientOptions {
   alias: string; // an alias makes it easier to identify this client in a multo client environment
   role: string;
   password: string; // by setting a password access to functions can be limited
+  autoReconnect?: boolean;
 }
 
 export class SmartsocketClient {
+  // a unique id
+  public shortId = plugins.smartunique.shortId();
+
+  // the shortId of the remote we connect to
+  public remoteShortId: string = null;
+
   public alias: string;
   public socketRole: SocketRole;
   public socketConnection: SocketConnection;
   public serverUrl: string;
   public serverPort: number;
+  public autoReconnect: boolean;
+
+  public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionEvent>();
 
   public socketFunctions = new plugins.lik.Objectmap<SocketFunction<any>>();
   public socketRequests = new plugins.lik.Objectmap<SocketRequest<any>>();
@@ -35,6 +47,7 @@ export class SmartsocketClient {
       name: optionsArg.role,
       passwordHash: optionsArg.password
     });
+    this.autoReconnect = optionsArg.autoReconnect;
   }
 
   public addSocketFunction(socketFunction: SocketFunction<any>) {
@@ -55,21 +68,58 @@ export class SmartsocketClient {
       role: this.socketRole,
       side: 'client',
       smartsocketHost: this,
-      socket: plugins.socketIoClient(socketUrl, { multiplex: false })
+      socket: plugins.socketIoClient(socketUrl, {
+        multiplex: false,
+        reconnectionAttempts: 5,
+      })
     });
-    this.socketConnection.socket.on('requestAuth', () => {
+
+    const timer = new plugins.smarttime.Timer(5000);
+    timer.start();
+    timer.completed.then(() => {
+      defaultLogger.log('warn', 'connection to server timed out.');
+      this.disconnect();
+    });
+
+    // authentication flow
+    this.socketConnection.socket.on('requestAuth', (requestAuthPayload: interfaces.IRequestAuthPayload) => {
+      timer.reset();
       plugins.smartlog.defaultLogger.log('info', 'server requested authentication');
-      this.socketConnection.socket.emit('dataAuth', {
-        role: this.socketRole.name,
-        password: this.socketRole.passwordHash,
-        alias: this.alias
-      });
+      
+      // lets register the authenticated event
       this.socketConnection.socket.on('authenticated', () => {
+        this.remoteShortId = requestAuthPayload.serverShortId;
         plugins.smartlog.defaultLogger.log('info', 'client is authenticated');
         this.socketConnection.authenticated = true;
         this.socketConnection.listenToFunctionRequests();
         done.resolve();
       });
+
+      // lets register the forbidden event
+      this.socketConnection.socket.on('forbidden', async () => {
+        defaultLogger.log('warn', `disconnecting due to being forbidden to use the ressource`);
+        await this.disconnect();
+      });
+
+      // lets provide the actual auth data
+      this.socketConnection.socket.emit('dataAuth', {
+        role: this.socketRole.name,
+        password: this.socketRole.passwordHash,
+        alias: this.alias
+      });
+
+    });
+
+    // handle disconnection and errors
+    this.socketConnection.socket.on('disconnect', async () => {
+      await this.disconnect();
+    });
+
+    this.socketConnection.socket.on('reconnect_failed', async () => {
+      await this.disconnect();
+    });
+    this.socketConnection.socket.on('connect_error', async () => {
+      await this.disconnect();
     });
     return done.promise;
   }
@@ -78,9 +128,26 @@ export class SmartsocketClient {
    * disconnect from the server
    */
   public async disconnect() {
-    this.socketConnection.socket.disconnect(true);
-    this.socketConnection = undefined;
-    plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
+    if (this.socketConnection) {
+      this.socketConnection.disconnect();
+      this.socketConnection = undefined;
+      plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
+    }
+    defaultLogger.log('warn', `disconnected from server ${this.remoteShortId}`);
+    this.remoteShortId = null;
+    this.eventSubject.next('terminated');
+
+    if (this.autoReconnect) {
+      this.tryDebouncedReconnect();
+    }
+  }
+
+  /**
+   * try a reconnection
+   */
+  public async tryDebouncedReconnect() {
+    await plugins.smartdelay.delayForRandom(10000, 60000);
+    await this.connect();
   }
 
   /**
@@ -93,7 +160,7 @@ export class SmartsocketClient {
     const socketRequest = new SocketRequest<T>(this, {
       side: 'requesting',
       originSocketConnection: this.socketConnection,
-      shortId: plugins.shortid.generate(),
+      shortId: plugins.smartunique.shortId(),
       funcCallData: {
         funcName: functionNameArg,
         funcDataArg: dataArg

ts/smartsocket.classes.socketconnection.ts

@@ -1,4 +1,5 @@
 import * as plugins from './smartsocket.plugins';
+import * as interfaces from './interfaces';
 
 import { Objectmap } from '@pushrocks/lik';
 
@@ -53,6 +54,9 @@ export class SocketConnection {
   public role: SocketRole;
   public smartsocketRef: Smartsocket | SmartsocketClient;
   public socket: SocketIO.Socket | SocketIOClient.Socket;
+
+  public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionEvent>();
+
   constructor(optionsArg: ISocketConnectionConstructorOptions) {
     this.alias = optionsArg.alias;
     this.authenticated = optionsArg.authenticated;
@@ -63,12 +67,12 @@ export class SocketConnection {
 
     // standard behaviour that is always true
     allSocketConnections.add(this);
-    this.socket.on('disconnect', () => {
+    this.socket.on('disconnect', async () => {
       plugins.smartlog.defaultLogger.log(
         'info',
         `SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
       );
-      this.socket.disconnect();
+      await this.disconnect();
       allSocketConnections.remove(this);
     });
   }
@@ -80,7 +84,7 @@ export class SocketConnection {
    */
   public authenticate() {
     const done = plugins.smartpromise.defer();
-    this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
+    this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
       plugins.smartlog.defaultLogger.log(
         'info',
         'received authentication data. now hashing and comparing...'
@@ -99,11 +103,14 @@ export class SocketConnection {
         done.resolve(this);
       } else {
         this.authenticated = false;
-        this.socket.disconnect();
+        await this.disconnect();
         done.reject('not authenticated');
       }
     });
-    this.socket.emit('requestAuth');
+    const requestAuthPayload: interfaces.IRequestAuthPayload = {
+      serverShortId: this.smartsocketRef.shortId
+    };
+    this.socket.emit('requestAuth', requestAuthPayload);
     return done.promise;
   }
 
@@ -163,5 +170,9 @@ export class SocketConnection {
     return done.promise;
   }
 
-  // sending ----------------------
+  // disconnecting ----------------------
+  public async disconnect() {
+    this.socket.disconnect(true);
+    this.eventSubject.next('terminated');
+  }
 }

ts/smartsocket.plugins.ts

@@ -10,6 +10,9 @@ import * as smarthash from '@pushrocks/smarthash';
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartexpress from '@pushrocks/smartexpress';
 import * as smartpromise from '@pushrocks/smartpromise';
+import * as smarttime from '@pushrocks/smarttime';
+import * as smartunique from '@pushrocks/smartunique';
+import * as smartrx from '@pushrocks/smartrx';
 
 
 export {
@@ -18,16 +21,17 @@ export {
   smarthash,
   smartdelay,
   smartexpress,
-  smartpromise
+  smartpromise,
+  smarttime,
+  smartunique,
+  smartrx
 };
 
 // third party scope
-import * as shortid from 'shortid';
 import socketIo from 'socket.io';
 import socketIoClient from 'socket.io-client';
 
 export {
-  shortid,
   socketIo,
   socketIoClient
 };