1.1.34

.gitlab-ci.yml

@@ -34,31 +34,6 @@ snyk:
   - docker
   - notpriv
 
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================

.snyk

@@ -1,4 +1,13 @@
 # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.3
+version: v1.13.5
-ignore: {}
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-JSYAML-173999:
+    - '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
+        reason: None given
+        expires: '2019-05-24T15:16:11.291Z'
+  SNYK-JS-JSYAML-174129:
+    - '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
+        reason: None given
+        expires: '2019-05-24T15:16:11.291Z'
 patch: {}

README.md

@@ -14,7 +14,7 @@ easy and secure websocket communication
 [![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-standard-brightgreen.svg)](http://standardjs.com/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 

npmextra.json

@@ -14,4 +14,4 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartsocket",
-  "version": "1.1.27",
+  "version": "1.1.34",
   "description": "easy and secure websocket communication",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,11 +19,12 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartsocket#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
+    "@pushrocks/lik": "^3.0.5",
-    "@pushrocks/smartdelay": "^2.0.2",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartexpress": "^3.0.19",
     "@pushrocks/smarthash": "^2.0.4",
-    "@pushrocks/smartlog": "^2.0.16",
+    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.2",
     "@types/shortid": "0.0.29",
     "@types/socket.io": "^2.1.2",
     "@types/socket.io-client": "^1.4.32",
@@ -33,10 +34,10 @@
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.5",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.20",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^10.12.19"
+    "@types/node": "^11.13.7"
   },
   "private": false
 }

test/test.expressserver.ts

@@ -0,0 +1,139 @@
+// 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 smartexpress from '@pushrocks/smartexpress';
+
+import socketIoClient = require('socket.io-client');
+import smartsocket = require('../ts/index');
+
+let testSmartsocket: smartsocket.Smartsocket;
+let testSmartsocketClient: smartsocket.SmartsocketClient;
+let testSocketRole1: smartsocket.SocketRole;
+let testSocketFunction1: smartsocket.SocketFunction;
+let myseServer: smartexpress.Server;
+
+const testConfig = {
+  port: 3000
+};
+
+// class smartsocket
+tap.test('should create a new smartsocket', async () => {
+  testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
+  expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
+});
+
+tap.test('Should accept an smartExpressServer as server', async () => {
+  myseServer = new smartexpress.Server({
+    cors: true,
+    forceSsl: false,
+    port: testConfig.port
+  });
+
+  testSmartsocket.setExternalServer('smartexpress', myseServer);
+
+  await myseServer.start();
+});
+
+tap.test('should start listening when .started is called', async () => {
+  await testSmartsocket.start();
+});
+
+// class socketrole
+tap.test('should add a socketrole', async () => {
+  testSocketRole1 = new smartsocket.SocketRole({
+    name: 'testRole1',
+    passwordHash: smarthash.sha256FromStringSync('testPassword')
+  });
+  testSmartsocket.addSocketRoles([testSocketRole1]);
+});
+
+// class SocketFunction
+tap.test('should register a new Function', async () => {
+  testSocketFunction1 = new smartsocket.SocketFunction({
+    allowedRoles: [testSocketRole1],
+    funcDef: async dataArg => {
+      return dataArg;
+    },
+    funcName: 'testFunction1'
+  });
+});
+
+// class SmartsocketClient
+tap.test('should react to a new websocket connection from client', async () => {
+  const done = smartpromise.defer();
+  testSmartsocketClient = new smartsocket.SmartsocketClient({
+    port: testConfig.port,
+    url: 'http://localhost',
+    password: 'testPassword',
+    alias: 'testClient1',
+    role: 'testRole1'
+  });
+  testSmartsocketClient.connect().then(() => {
+    done.resolve();
+  });
+  await done.promise;
+});
+tap.test('client should disconnect and reconnect', async () => {
+  let done = smartpromise.defer();
+  testSmartsocketClient
+    .disconnect()
+    .then(() => {
+      let done = smartpromise.defer();
+      setTimeout(() => {
+        testSmartsocketClient.connect().then(done.resolve);
+      }, 0);
+      return done.promise;
+    })
+    .then(() => {
+      done.resolve();
+    });
+  await done.promise;
+});
+
+tap.test('2 clients should connect in parallel', async () => {
+  // TODO: implement parallel test
+});
+
+tap.test('should be able to make a functionCall from client to server', async () => {
+  let done = smartpromise.defer();
+  testSmartsocketClient
+    .serverCall('testFunction1', {
+      value1: 'hello'
+    })
+    .then(dataArg => {
+      console.log(dataArg);
+      done.resolve();
+    });
+  await done.promise;
+});
+
+tap.test('should be able to make a functionCall from server to client', async () => {
+  let done = smartpromise.defer();
+  let targetSocket = (() => {
+    return smartsocket.allSocketConnections.find(socketConnectionArg => {
+      return socketConnectionArg.alias === 'testClient1';
+    });
+  })();
+  testSmartsocket
+    .clientCall(
+      'testFunction1',
+      {
+        value1: 'helloFromServer'
+      },
+      targetSocket
+    )
+    .then(dataArg => {
+      console.log(dataArg);
+      done.resolve();
+    });
+});
+
+// terminate
+tap.test('should close the server', async () => {
+  await testSmartsocket.stop();
+  await myseServer.stop();
+});
+
+tap.start();

test/test.ts

@@ -1,8 +1,8 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as nodehash from '@pushrocks/smarthash';
+import * as smarthash from '@pushrocks/smarthash';
-import * as smartq from '@pushrocks/smartpromise';
+import * as smartpromise from '@pushrocks/smartpromise';
 
 import socketIoClient = require('socket.io-client');
 import smartsocket = require('../ts/index');
@@ -30,7 +30,7 @@ tap.test('should start listening when .started is called', async () => {
 tap.test('should add a socketrole', async () => {
   testSocketRole1 = new smartsocket.SocketRole({
     name: 'testRole1',
-    passwordHash: nodehash.sha256FromStringSync('testPassword')
+    passwordHash: smarthash.sha256FromStringSync('testPassword')
   });
   testSmartsocket.addSocketRoles([testSocketRole1]);
 });
@@ -48,7 +48,7 @@ tap.test('should register a new Function', async () => {
 
 // class SmartsocketClient
 tap.test('should react to a new websocket connection from client', async () => {
-  const done = smartq.defer();
+  const done = smartpromise.defer();
   testSmartsocketClient = new smartsocket.SmartsocketClient({
     port: testConfig.port,
     url: 'http://localhost',
@@ -62,11 +62,11 @@ tap.test('should react to a new websocket connection from client', async () => {
   await done.promise;
 });
 tap.test('client should disconnect and reconnect', async () => {
-  let done = smartq.defer();
+  let done = smartpromise.defer();
   testSmartsocketClient
     .disconnect()
     .then(() => {
-      let done = smartq.defer();
+      let done = smartpromise.defer();
       setTimeout(() => {
         testSmartsocketClient.connect().then(done.resolve);
       }, 0);
@@ -83,7 +83,7 @@ tap.test('2 clients should connect in parallel', async () => {
 });
 
 tap.test('should be able to make a functionCall from client to server', async () => {
-  let done = smartq.defer();
+  let done = smartpromise.defer();
   testSmartsocketClient
     .serverCall('testFunction1', {
       value1: 'hello'
@@ -96,7 +96,7 @@ tap.test('should be able to make a functionCall from client to server', async ()
 });
 
 tap.test('should be able to make a functionCall from server to client', async () => {
-  let done = smartq.defer();
+  let done = smartpromise.defer();
   let targetSocket = (() => {
     return smartsocket.allSocketConnections.find(socketConnectionArg => {
       return socketConnectionArg.alias === 'testClient1';

ts/smartsocket.classes.smartsocket.ts

@@ -13,7 +13,7 @@ import { SocketServer } from './smartsocket.classes.socketserver';
 import * as SocketIO from 'socket.io';
 
 export interface ISmartsocketConstructorOptions {
-  port: number;
+  port?: number;
 }
 
 export class Smartsocket {
@@ -29,7 +29,9 @@ export class Smartsocket {
   }
 
   // tslint:disable-next-line:member-ordering
-  public setExternalServer = this.socketServer.setExternalServer;
+  public async setExternalServer (serverType: 'smartexpress', serverArg: any) {
+    await this.socketServer.setExternalServer(serverType, serverArg);
+  }
 
   /**
    * starts smartsocket

ts/smartsocket.classes.socketserver.ts

@@ -23,12 +23,9 @@ export class SocketServer {
    * starts the server with another server
    * also works with an express style server
    */
-  public async setExternalServer(serverType: 'express' | 'http', serverArg: any) {
+  public async setExternalServer(serverType: 'smartexpress', serverArg: plugins.smartexpress.Server) {
-    if (serverType === 'http') {
+    await serverArg.startedPromise;
-      this.httpServer = serverArg;
+    this.httpServer = serverArg.httpServer;
-    } else if (serverType === 'express') {
-      this.expressServer = serverArg;
-    }
   }
 
   /**
@@ -37,14 +34,10 @@ export class SocketServer {
   public getServerForSocketIo() {
     if (this.httpServer) {
       return this.httpServer;
-    } else if (this.expressServer) {
+    } else {
-      return this.expressServer;
-    } else if (!this.httpServer && !this.expressServer) {
       this.httpServer = new http.Server();
       this.standaloneServer = true;
       return this.httpServer;
-    } else {
-      throw new Error('no server specified!');
     }
   }
 
@@ -55,7 +48,12 @@ export class SocketServer {
     const done = plugins.smartpromise.defer();
 
     // handle http servers
+    // in case an external server has been set "this.standaloneServer" should be false
     if (this.httpServer && this.standaloneServer) {
+      if (!this.smartsocket.options.port) {
+        console.log('there should be a port specifed for smartsocket!')
+        throw new Error('there should be a port specified for smartsocket')
+      }
       this.httpServer.listen(this.smartsocket.options.port, () => {
         console.log(`Server started in standalone mode on ${this.smartsocket.options.port}`);
         done.resolve();

ts/smartsocket.plugins.ts

@@ -2,9 +2,10 @@ import * as lik from '@pushrocks/lik';
 import * as smartlog from '@pushrocks/smartlog';
 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 shortid from 'shortid';
 import * as socketIo from 'socket.io';
 import * as socketIoClient from 'socket.io-client';
 
-export { lik, smartlog, smarthash, smartdelay, smartpromise, shortid, socketIo, socketIoClient };
+export { lik, smartlog, smarthash, smartdelay, smartexpress, smartpromise, shortid, socketIo, socketIoClient };