1.2.12

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +39,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
     }
   ]
 }

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartsocket",
-      "shortDescription": "easy and secure websocket communication",
+      "description": "easy and secure websocket communication",
       "npmPackagename": "@pushrocks/smartsocket",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartsocket",
-  "version": "1.2.2",
+  "version": "1.2.12",
   "description": "easy and secure websocket communication",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -22,25 +22,26 @@
     "@apiglobal/typedrequest-interfaces": "^1.0.15",
     "@pushrocks/isohash": "^1.0.2",
     "@pushrocks/isounique": "^1.0.4",
-    "@pushrocks/lik": "^4.0.20",
+    "@pushrocks/lik": "^5.0.0",
-    "@pushrocks/smartdelay": "^2.0.10",
+    "@pushrocks/smartdelay": "^2.0.13",
     "@pushrocks/smartenv": "^4.0.16",
-    "@pushrocks/smartexpress": "^3.0.99",
+    "@pushrocks/smartexpress": "^3.0.108",
-    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartjson": "^4.0.6",
-    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smartlog": "^2.0.44",
+    "@pushrocks/smartpromise": "^3.1.6",
     "@pushrocks/smartrx": "^2.0.19",
-    "@pushrocks/smarttime": "^3.0.37",
+    "@pushrocks/smarttime": "^3.0.43",
-    "@types/socket.io": "^2.1.12",
+    "@types/socket.io": "^3.0.2",
-    "@types/socket.io-client": "^1.4.34",
+    "@types/socket.io-client": "^3.0.0",
-    "socket.io": "^3.0.4",
+    "socket.io": "^3.1.0",
-    "socket.io-client": "^3.0.4"
+    "socket.io-client": "^3.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.28",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsrun": "^1.2.18",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tstest": "^1.0.60",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^3.2.15",
-    "@types/node": "^14.14.14",
+    "@types/node": "^17.0.9",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

test/test.reconnect.ts

@@ -0,0 +1,5 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+tap.test('should run a test', async () => {});
+
+tap.start();

test/test.tagging.ts

@@ -90,6 +90,32 @@ tap.test('should react to a new websocket connection from client', async () => {
   await testSmartsocketClient.connect();
 });
 
+tap.test('should be able to tag a connection from client', async (tools) => {
+  await testSmartsocketClient.addTag({
+    id: 'awesome',
+    payload: 'yes',
+  });
+  const tagOnServerSide = await testSmartsocket.socketConnections
+    .findSync((socketConnection) => {
+      return true;
+    })
+    .getTagById('awesome');
+  expect(tagOnServerSide.payload).to.equal('yes');
+});
+
+tap.test('should be able to tag a connection from server', async (tools) => {
+  await testSmartsocket.socketConnections
+    .findSync((socketConnection) => {
+      return true;
+    })
+    .addTag({
+      id: 'awesome2',
+      payload: 'absolutely',
+    });
+  const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
+  expect(tagOnClientSide.payload).to.equal('absolutely');
+});
+
 tap.test('2 clients should connect in parallel', async () => {
   // TODO: implement parallel test
 });
@@ -108,7 +134,7 @@ tap.test('should be able to make a functionCall from server to client', async ()
     {
       hi: 'hi there from server',
     },
-    testSmartsocket.socketConnections.find((socketConnection) => {
+    testSmartsocket.socketConnections.findSync((socketConnection) => {
       return true;
     })
   );
@@ -118,10 +144,19 @@ tap.test('should be able to make a functionCall from server to client', async ()
 
 tap.test('client should disconnect and reconnect', async (tools) => {
   await testSmartsocketClient.disconnect();
-  await tools.delayFor(100);
   await testSmartsocketClient.connect();
 });
 
+tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
+  console.log(testSmartsocket.socketConnections.getArray().length);
+  const tagOnServerSide = await testSmartsocket.socketConnections
+    .findSync((socketConnection) => {
+      return true;
+    })
+    .getTagById('awesome');
+  expect(tagOnServerSide.payload).to.equal('yes');
+});
+
 // terminate
 tap.test('should close the server', async () => {
   await testSmartsocket.stop();

ts/interfaces/index.ts

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

ts/interfaces/tag.ts

@@ -0,0 +1,6 @@
+export interface ITag<T = any> {
+  id: string;
+  payload: T;
+}
+
+export type TTagStore = { [key: string]: ITag };

ts/smartsocket.classes.smartsocket.ts

@@ -61,8 +61,8 @@ export class Smartsocket {
     await plugins.smartdelay.delayFor(1000);
     this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
       if (socketObjectArg) {
-        logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
+        logger.log('info', `disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`);
-        socketObjectArg.socket.disconnect();
+        socketObjectArg.disconnect();
       }
     });
     this.socketConnections.wipe();
@@ -113,7 +113,7 @@ export class Smartsocket {
   /**
    * the standard handler for new socket connections
    */
-  private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
+  private async _handleSocketConnection(socketArg: SocketIO.Socket) {
     const socketConnection: SocketConnection = new SocketConnection({
       alias: undefined,
       authenticated: false,
@@ -124,7 +124,14 @@ export class Smartsocket {
     });
     logger.log('info', 'Socket connected. Trying to authenticate...');
     this.socketConnections.add(socketConnection);
+    const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
+      if (eventArg === 'disconnected') {
+        this.socketConnections.remove(socketConnection);
+        disconnectSubscription.unsubscribe();
+      }
+    });
     await socketConnection.authenticate();
     await socketConnection.listenToFunctionRequests();
+    await socketConnection.socket.emit('serverFullyReactive');
   }
 }

ts/smartsocket.classes.smartsocketclient.ts

@@ -45,6 +45,40 @@ export class SmartsocketClient {
   public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
   public socketRoles = new plugins.lik.ObjectMap<SocketRole>();
 
+  // tagStore
+  private tagStore: { [key: string]: interfaces.ITag } = {};
+  private tagStoreSubscription: plugins.smartrx.rxjs.Subscription;
+
+  /**
+   * adds a tag to a connection
+   */
+  public async addTag(tagArg: interfaces.ITag) {
+    if (this.socketConnection) {
+      await this.socketConnection.addTag(tagArg);
+    } else {
+      this.tagStore[tagArg.id] = tagArg;
+    }
+  }
+
+  /**
+   * gets a tag by id
+   * @param tagIdArg
+   */
+  public async getTagById(tagIdArg: interfaces.ITag['id']) {
+    return this.tagStore[tagIdArg];
+  }
+
+  /**
+   * removes a tag from a connection
+   */
+  public async removeTagById(tagIdArg: interfaces.ITag['id']) {
+    if (this.socketConnection) {
+      this.socketConnection.removeTagById(tagIdArg);
+    } else {
+      delete this.tagStore[tagIdArg];
+    }
+  }
+
   constructor(optionsArg: ISmartsocketClientOptions) {
     this.alias = optionsArg.alias;
     this.serverUrl = optionsArg.url;
@@ -104,11 +138,29 @@ export class SmartsocketClient {
         logger.log('info', 'server requested authentication');
 
         // lets register the authenticated event
-        this.socketConnection.socket.on('authenticated', () => {
+        this.socketConnection.socket.on('authenticated', async () => {
           this.remoteShortId = requestAuthPayload.serverShortId;
           logger.log('info', 'client is authenticated');
           this.socketConnection.authenticated = true;
-          this.socketConnection.listenToFunctionRequests();
+          await this.socketConnection.listenToFunctionRequests();
+        });
+
+        this.socketConnection.socket.on('serverFullyReactive', async () => {
+          // lets take care of retagging
+          const oldTagStore = this.tagStore;
+          this.tagStoreSubscription?.unsubscribe();
+          for (const keyArg of Object.keys(this.tagStore)) {
+            this.socketConnection.addTag(this.tagStore[keyArg]);
+          }
+          this.tagStoreSubscription = this.socketConnection.tagStoreObservable.subscribe(
+            (tagStoreArg) => {
+              this.tagStore = tagStoreArg;
+            }
+          );
+
+          for (const tag of Object.keys(oldTagStore)) {
+            await this.addTag(oldTagStore[tag]);
+          }
           done.resolve();
         });
 
@@ -150,6 +202,7 @@ export class SmartsocketClient {
    * disconnect from the server
    */
   public async disconnect() {
+    this.tagStoreSubscription?.unsubscribe();
     if (this.socketConnection) {
       await this.socketConnection.disconnect();
       this.socketConnection = undefined;
@@ -176,7 +229,7 @@ export class SmartsocketClient {
    * try a reconnection
    */
   public async tryDebouncedReconnect() {
-    await plugins.smartdelay.delayForRandom(10000, 60000);
+    await plugins.smartdelay.delayForRandom(10000, 50000);
     await this.connect();
   }
 

ts/smartsocket.classes.socketconnection.ts

@@ -8,7 +8,7 @@ import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.s
 import { SocketRole } from './smartsocket.classes.socketrole';
 
 // socket.io
-import * as SocketIO from 'socket.io';
+import * as pluginsTyped from './smartsocket.pluginstyped';
 import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
 import { logger } from './smartsocket.logging';
 
@@ -57,6 +57,10 @@ export class SocketConnection {
   public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
   public eventStatus: interfaces.TConnectionStatus = 'new';
 
+  private tagStore: interfaces.TTagStore = {};
+  public tagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
+  public remoteTagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
+
   constructor(optionsArg: ISocketConnectionConstructorOptions) {
     this.alias = optionsArg.alias;
     this.authenticated = optionsArg.authenticated;
@@ -79,9 +83,49 @@ export class SocketConnection {
       );
       await this.disconnect();
       allSocketConnections.remove(this);
+      this.eventSubject.next('disconnected');
     });
   }
 
+  /**
+   * adds a tag to a connection
+   */
+  public async addTag(tagArg: interfaces.ITag) {
+    const done = plugins.smartpromise.defer();
+    this.tagStore[tagArg.id] = tagArg;
+    this.tagStoreObservable.next(this.tagStore);
+    const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
+      if (!remoteTagStore[tagArg.id]) {
+        return;
+      }
+      const localTagString = plugins.smartjson.stringify(tagArg);
+      const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
+      if (localTagString === remoteTagString) {
+        remoteSubscription.unsubscribe();
+        done.resolve();
+      }
+    });
+    this.socket.emit('updateTagStore', this.tagStore);
+    await done.promise;
+  }
+
+  /**
+   * gets a tag by id
+   * @param tagIdArg
+   */
+  public async getTagById(tagIdArg: interfaces.ITag['id']) {
+    return this.tagStore[tagIdArg];
+  }
+
+  /**
+   * removes a tag from a connection
+   */
+  public async removeTagById(tagIdArg: interfaces.ITag['id']) {
+    delete this.tagStore[tagIdArg];
+    this.tagStoreObservable.next(this.tagStore);
+    this.socket.emit('updateTagStore', this.tagStore);
+  }
+
   // authenticating --------------------------
 
   /**
@@ -91,7 +135,7 @@ export class SocketConnection {
     const done = plugins.smartpromise.defer();
     this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
       logger.log('info', 'received authentication data. now hashing and comparing...');
-      this.socket.removeListener('dataAuth', () => {});
+      this.socket.removeAllListeners('dataAuth');
       if (await SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
         // TODO: authenticate password
         this.alias = dataArg.alias;
@@ -124,7 +168,7 @@ export class SocketConnection {
       this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
         // check if requested function is available to the socket's scope
         // logger.log('info', 'function request received');
-        const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.find(
+        const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.findSync(
           (socketFunctionArg) => {
             return socketFunctionArg.name === dataArg.funcCallData.funcName;
           }
@@ -150,6 +194,16 @@ export class SocketConnection {
         );
         targetSocketRequest.handleResponse(dataArg);
       });
+
+      this.socket.on('updateTagStore', async (tagStoreArg: interfaces.TTagStore) => {
+        if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
+          this.tagStore = tagStoreArg;
+          this.socket.emit('updateTagStore', this.tagStore);
+          this.tagStoreObservable.next(this.tagStore);
+        }
+        this.remoteTagStoreObservable.next(tagStoreArg);
+      });
+
       logger.log('info', `now listening to function requests for ${this.alias}`);
       done.resolve(this);
     } else {

ts/smartsocket.classes.socketfunction.ts

@@ -58,7 +58,7 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
     smartsocketRefArg: Smartsocket | SmartsocketClient,
     functionNameArg: string
   ): SocketFunction<Q> {
-    return smartsocketRefArg.socketFunctions.find((socketFunctionArg) => {
+    return smartsocketRefArg.socketFunctions.findSync((socketFunctionArg) => {
       return socketFunctionArg.name === functionNameArg;
     });
   }

ts/smartsocket.classes.socketrequest.ts

@@ -45,7 +45,7 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
     smartsocketRef: Smartsocket | SmartsocketClient,
     shortIdArg: string
   ): SocketRequest<any> {
-    return smartsocketRef.socketRequests.find((socketRequestArg) => {
+    return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
       return socketRequestArg.shortid === shortIdArg;
     });
   }

ts/smartsocket.classes.socketrole.ts

@@ -23,7 +23,7 @@ export class SocketRole {
     referenceSmartsocket: Smartsocket | SmartsocketClient,
     socketRoleNameArg: string
   ): SocketRole {
-    return referenceSmartsocket.socketRoles.find((socketRoleArg) => {
+    return referenceSmartsocket.socketRoles.findSync((socketRoleArg) => {
       return socketRoleArg.name === socketRoleNameArg;
     });
   }
@@ -32,8 +32,10 @@ export class SocketRole {
     dataArg: ISocketConnectionAuthenticationObject,
     referenceSmartsocket: Smartsocket | SmartsocketClient
   ): Promise<boolean> {
-    const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role)
+    const targetPasswordHash = SocketRole.getSocketRoleByName(
-      .passwordHash;
+      referenceSmartsocket,
+      dataArg.role
+    ).passwordHash;
     const computedCompareHash = await plugins.isohash.sha256FromString(dataArg.password);
     return targetPasswordHash === computedCompareHash;
   }

ts/smartsocket.classes.socketserver.ts

@@ -12,7 +12,10 @@ import { logger } from './smartsocket.logging';
 export class SocketServer {
   private smartsocket: Smartsocket;
   private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
-  // wether httpServer is standalone
+  
+  /**
+   * wether httpServer is standalone
+   */
   private standaloneServer = false;
 
   constructor(smartSocketInstance: Smartsocket) {
@@ -77,5 +80,9 @@ export class SocketServer {
   /**
    * closes the server
    */
-  public async stop() {}
+  public async stop() {
+    if (this.httpServer) {
+      this.httpServer.close();
+    }
+  }
 }

ts/smartsocket.classes.socketstats.ts

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

ts/smartsocket.plugins.ts

@@ -8,6 +8,7 @@ import * as isohash from '@pushrocks/isohash';
 import * as isounique from '@pushrocks/isounique';
 import * as lik from '@pushrocks/lik';
 import * as smartenv from '@pushrocks/smartenv';
+import * as smartjson from '@pushrocks/smartjson';
 import * as smartlog from '@pushrocks/smartlog';
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
@@ -19,6 +20,7 @@ export {
   isounique,
   lik,
   smartenv,
+  smartjson,
   smartlog,
   smartdelay,
   smartpromise,

ts/smartsocket.pluginstyped.ts

@@ -13,4 +13,4 @@ export { smartexpress };
 import type socketIo from 'socket.io';
 import type socketIoClient from 'socket.io-client';
 
-export { socketIo, socketIoClient };
+export { socketIoClient, socketIo };