1.2.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartsocket",
-  "version": "1.1.62",
+  "version": "1.2.0",
   "description": "easy and secure websocket communication",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -22,25 +22,25 @@
     "@apiglobal/typedrequest-interfaces": "^1.0.15",
     "@pushrocks/isohash": "^1.0.2",
     "@pushrocks/isounique": "^1.0.4",
-    "@pushrocks/lik": "^4.0.17",
+    "@pushrocks/lik": "^4.0.20",
     "@pushrocks/smartdelay": "^2.0.10",
-    "@pushrocks/smartenv": "^4.0.11",
-    "@pushrocks/smartexpress": "^3.0.76",
+    "@pushrocks/smartenv": "^4.0.16",
+    "@pushrocks/smartexpress": "^3.0.99",
     "@pushrocks/smartlog": "^2.0.39",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.3",
     "@pushrocks/smartrx": "^2.0.19",
-    "@pushrocks/smarttime": "^3.0.35",
-    "@types/socket.io": "^2.1.11",
-    "@types/socket.io-client": "^1.4.33",
-    "socket.io": "^2.3.0",
-    "socket.io-client": "^2.3.0"
+    "@pushrocks/smarttime": "^3.0.37",
+    "@types/socket.io": "^2.1.12",
+    "@types/socket.io-client": "^1.4.34",
+    "socket.io": "^3.0.4",
+    "socket.io-client": "^3.0.4"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.25",
     "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.48",
+    "@gitzone/tstest": "^1.0.52",
     "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.11.2",
+    "@types/node": "^14.14.14",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

readme.md

@@ -8,13 +8,20 @@ easy and secure websocket communication
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartsocket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartsocket/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartsocket.svg)](https://www.npmjs.com/package/@pushrocks/smartsocket)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartsocket/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartsocket)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartsocket/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartsocket/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartsocket)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartsocket)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartsocket)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartsocket)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartsocket)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -30,7 +37,7 @@ import * as q from q; // q is a promise library
 
 // The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
 let mySmartsocket = new smartsocket.Smartsocket({
-  port: 3000 // the port smartsocket will listen on
+  port: 3000, // the port smartsocket will listen on
 });
 
 // optional:
@@ -43,7 +50,7 @@ mySmartsocket.setServer(someExpressServer);
 // "SocketFunction"s know which "SocketRole"s are allowed to execute them
 let mySocketRole = new smartsocket.SocketRole({
   name: 'someRoleName',
-  passwordHash: 'someHashedString'
+  passwordHash: 'someHashedString',
 });
 
 // A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
@@ -51,10 +58,10 @@ let mySocketRole = new smartsocket.SocketRole({
 // Any "SocketRequest" carries a unique identifier. If the referenced function's promise resolved any passed on argument will be returned to the requesting party
 let testSocketFunction1 = new smartsocket.SocketFunction({
   funcName: 'testSocketFunction1',
-  funcDef: data => {
+  funcDef: (data) => {
     console.log('testSocketFunction1 executed successfully!');
   },
-  allowedRoles: [mySocketRole] // all roles that have access to a specific function
+  allowedRoles: [mySocketRole], // all roles that have access to a specific function
 });
 
 // A "Smartsocket" exposes a .clientCall() that gets
@@ -62,7 +69,7 @@ let testSocketFunction1 = new smartsocket.SocketFunction({
 // 2. the data to pass in
 // 3. And a target "SocketConnection" (there can be multiple connections at once)
 // any unique id association is done internally
-mySmartsocket.clientCall('restart', data, someTargetConnection).then(responseData => {});
+mySmartsocket.clientCall('restart', data, someTargetConnection).then((responseData) => {});
 ```
 
 #### Client side
@@ -77,7 +84,7 @@ let testSmartsocketClient = new smartsocket.SmartsocketClient({
   url: 'http://localhost',
   password: 'testPassword',
   alias: 'testClient1',
-  role: 'testRole1'
+  role: 'testRole1',
 });
 
 // You can .connect() and .disconnect() from a "Smartsocket"
@@ -88,12 +95,12 @@ testSmartsocketClient.connect().then(() => {
 // The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once
 let testSocketFunction2 = new smartsocket.SocketFunction({
   funcName: 'testSocketFunction2',
-  funcDef: data => {}, // the function to execute, has to return promise
-  allowedRoles: []
+  funcDef: (data) => {}, // the function to execute, has to return promise
+  allowedRoles: [],
 });
 
 // A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
-mySmartsocketClient.serverCall('function', functionCallData).then(functionResponseData => {
+mySmartsocketClient.serverCall('function', functionCallData).then((functionResponseData) => {
   // the functionResponseData comes from the server... awesome, right?
 });
 ```
@@ -103,6 +110,10 @@ mySmartsocketClient.serverCall('function', functionCallData).then(functionRespon
 > `data` is always a js object that you can design for your specific needs.  
 > It supports buffers for large binary data network exchange.
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.expressserver.ts

@@ -1,11 +1,9 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smarthash from '@pushrocks/smarthash';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as isohash from '@pushrocks/isohash';
 import * as smartexpress from '@pushrocks/smartexpress';
 
-import socketIoClient = require('socket.io-client');
 import smartsocket = require('../ts/index');
 
 let testSmartsocket: smartsocket.Smartsocket;
@@ -15,7 +13,7 @@ let testSocketFunction1: smartsocket.SocketFunction<any>;
 let myseServer: smartexpress.Server;
 
 const testConfig = {
-  port: 3000,
+  port: 3005,
 };
 
 // class smartsocket
@@ -40,7 +38,7 @@ tap.test('Should accept an smartExpressServer as server', async () => {
 tap.test('should add a socketrole', async () => {
   testSocketRole1 = new smartsocket.SocketRole({
     name: 'testRole1',
-    passwordHash: smarthash.sha256FromStringSync('testPassword'),
+    passwordHash: await isohash.sha256FromString('testPassword'),
   });
   testSmartsocket.addSocketRoles([testSocketRole1]);
 });
@@ -87,10 +85,25 @@ tap.test('2 clients should connect in parallel', async () => {
 });
 
 tap.test('should be able to make a functionCall from client to server', async () => {
-  const response = await testSmartsocketClient.serverCall('testFunction1', {
-    value1: 'hello',
-  });
-  console.log(response);
+  const totalCycles = 20000;
+  let counter = 0;
+  let startTime = Date.now();
+  while (counter < totalCycles) {
+    const randomString = `hello ${Math.random()}`;
+    const response: any = await testSmartsocketClient.serverCall('testFunction1', {
+      value1: randomString,
+    });
+    expect(response.value1).to.equal(randomString);
+    if (counter % 100 === 0) {
+      console.log(
+        `processed 100 more messages in ${Date.now() - startTime}ms. ${
+          totalCycles - counter
+        } messages to go.`
+      );
+      startTime = Date.now();
+    }
+    counter++;
+  }
 });
 
 tap.test('should be able to make a functionCall from server to client', async () => {});

test/test.ts

@@ -1,11 +1,8 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smarthash from '@pushrocks/smarthash';
-import * as smartpromise from '@pushrocks/smartpromise';
-
-import socketIoClient = require('socket.io-client');
 import smartsocket = require('../ts/index');
+import * as isohash from '@pushrocks/isohash';
 
 let testSmartsocket: smartsocket.Smartsocket;
 let testSmartsocketClient: smartsocket.SmartsocketClient;
@@ -48,7 +45,7 @@ tap.test('should create a new smartsocket', async () => {
 tap.test('should add a socketrole', async () => {
   testSocketRole1 = new smartsocket.SocketRole({
     name: 'testRole1',
-    passwordHash: smarthash.sha256FromStringSync('testPassword'),
+    passwordHash: await isohash.sha256FromString('testPassword'),
   });
   testSmartsocket.addSocketRoles([testSocketRole1]);
 });

ts/smartsocket.classes.smartsocket.ts

@@ -60,8 +60,10 @@ export class Smartsocket {
   public async stop() {
     await plugins.smartdelay.delayFor(1000);
     this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
-      logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
-      socketObjectArg.socket.disconnect();
+      if (socketObjectArg) {
+        logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
+        socketObjectArg.socket.disconnect();
+      }
     });
     this.socketConnections.wipe();
     this.io.close();

ts/smartsocket.classes.smartsocketclient.ts

@@ -64,8 +64,16 @@ export class SmartsocketClient {
   /**
    * connect the client to the server
    */
-  public connect() {
+  public async connect() {
     const done = plugins.smartpromise.defer();
+    const smartenvInstance = new plugins.smartenv.Smartenv();
+    const socketIoClient = await smartenvInstance.getEnvAwareModule({
+      nodeModuleName: 'socket.io-client',
+      webUrlArg: 'https://cdn.jsdelivr.net/npm/socket.io-client@2/dist/socket.io.js',
+      getFunction: () => {
+        return globalThis.io;
+      },
+    });
     logger.log('info', 'trying to connect...');
     const socketUrl = `${this.serverUrl}:${this.serverPort}`;
     this.socketConnection = new SocketConnection({
@@ -74,7 +82,7 @@ export class SmartsocketClient {
       role: this.socketRole,
       side: 'client',
       smartsocketHost: this,
-      socket: plugins.socketIoClient(socketUrl, {
+      socket: await socketIoClient.connect(socketUrl, {
         multiplex: false,
         reconnectionAttempts: 5,
       }),
@@ -155,6 +163,14 @@ export class SmartsocketClient {
     }
   }
 
+  /**
+   * stops the client completely
+   */
+  public async stop() {
+    this.autoReconnect = false;
+    await this.disconnect();
+  }
+
   /**
    * try a reconnection
    */

ts/smartsocket.classes.socketconnection.ts

@@ -143,7 +143,7 @@ export class SocketConnection {
         }
       });
       this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
-        logger.log('info', `received response for request with id ${dataArg.shortId}`);
+        // logger.log('info', `received response for request with id ${dataArg.shortId}`);
         const targetSocketRequest = SocketRequest.getSocketRequestById(
           this.smartsocketRef,
           dataArg.shortId

ts/smartsocket.classes.socketrequest.ts

@@ -90,7 +90,7 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
    * handles the response that is received by the requesting side
    */
   public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
-    logger.log('info', 'handling response!');
+    // logger.log('info', 'handling response!');
     this.done.resolve(responseDataArg.funcCallData);
     this.smartsocketRef.socketRequests.remove(this);
   }
@@ -110,11 +110,11 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
       logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
       return;
     }
-    logger.log('info', `invoking ${targetSocketFunction.name}`);
+    // logger.log('info', `invoking ${targetSocketFunction.name}`);
     targetSocketFunction
       .invoke(this.funcCallData, this.originSocketConnection)
       .then((resultData) => {
-        logger.log('info', 'got resultData. Sending it to requesting party.');
+        // logger.log('info', 'got resultData. Sending it to requesting party.');
         const responseData: ISocketRequestDataObject<T> = {
           funcCallData: resultData,
           shortId: this.shortid,

ts/smartsocket.classes.socketserver.ts

@@ -14,7 +14,6 @@ export class SocketServer {
   private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
   // wether httpServer is standalone
   private standaloneServer = false;
-  private expressServer: any;
 
   constructor(smartSocketInstance: Smartsocket) {
     this.smartsocket = smartSocketInstance;

ts/smartsocket.classes.socketstats.ts

@@ -1,3 +1,3 @@
 import * as plugins from './smartsocket.plugins';
 
-export class SocketStats {}
+export class SocketStats {}

ts/smartsocket.plugins.ts

@@ -25,10 +25,3 @@ export {
   smarttime,
   smartrx,
 };
-
-// third party
-import socketIoClient from 'socket.io-client';
-
-export {
-  socketIoClient
-};

ts/smartsocket.pluginstyped.ts

@@ -2,19 +2,15 @@
 import type http from 'http';
 import type https from 'https';
 
-export {
-  http,
-  https
-};
+export { http, https };
 
 // pushrocks scope
 import type * as smartexpress from '@pushrocks/smartexpress';
 
-export {
-  smartexpress
-};
+export { smartexpress };
 
 // third party scope
 import type socketIo from 'socket.io';
+import type socketIoClient from 'socket.io-client';
 
-export { socketIo };
+export { socketIo, socketIoClient };