2.0.0

.gitlab-ci.yml

@@ -36,6 +36,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

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "apiglobal",
       "gitrepo": "typedsocket",
-      "shortDescription": "a typedrequest extension supporting websockets",
+      "description": "a typedrequest extension supporting websockets",
       "npmPackagename": "@apiglobal/typedsocket",
       "license": "MIT",
       "projectDomain": "api.global"

package.json

@@ -1,30 +1,33 @@
 {
   "name": "@apiglobal/typedsocket",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "private": false,
   "description": "a typedrequest extension supporting websockets",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany --skiplibcheck)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.14.16",
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tsbundle": "^1.0.101",
+    "@gitzone/tstest": "^1.0.69",
+    "@pushrocks/smartenv": "^5.0.0",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.23",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@apiglobal/typedrequest": "^1.0.56",
+    "@apiglobal/typedrequest": "^2.0.0",
     "@apiglobal/typedrequest-interfaces": "^1.0.15",
-    "@pushrocks/isohash": "^1.0.2",
-    "@pushrocks/smartsocket": "^1.2.0"
+    "@pushrocks/isohash": "^2.0.0",
+    "@pushrocks/smartsocket": "^2.0.4",
+    "@pushrocks/smartstring": "^4.0.2"
   },
   "browserslist": [
     "last 1 chrome versions"

readme.md

@@ -25,7 +25,11 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 ## Usage
 
-Use TypeScript for best in class intellisense
+Use TypeScript for best in class intellisense.
+
+TypedSocket is the typedrequest you love, just in a bidirectional way.
+
+See the following examples from our test for reference:
 
 ## Contribution
 

test-inactive/test.browser.ts

@@ -1,6 +1,6 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as typedsocket from '../ts/index';
+import * as typedsocket from '../ts/index.js';
 
 tap.test('should create a client', async () => {
   console.log('Browser test') // TODO: implement browser tests

test/test.ts

@@ -2,8 +2,7 @@ import { expect, tap } from '@pushrocks/tapbundle';
 import * as typedrequest from '@apiglobal/typedrequest';
 import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
 
-import * as typedsocket from '../ts/index';
-import { request } from 'http';
+import * as typedsocket from '../ts/index.js';
 
 interface IRequest_Client_Server extends typedrequestInterfaces.implementsTR<
   typedrequestInterfaces.ITypedRequest,
@@ -31,18 +30,38 @@ tap.test('should add some handlers', async () => {
   }));
 })
 
-tap.test('first test', async (tools) => {
+tap.test('should create Server and Client', async (tools) => {
   testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
-  testTypedSocketClient = await typedsocket.TypedSocket.createClient(testTypedRouter, 'http://localhost');
+  testTypedSocketClient = await typedsocket.TypedSocket.createClient(testTypedRouter, 'http://localhost:3000');
+  console.log('test: waiting 5 seconds');
+  await tools.delayFor(5000);
+  await testTypedSocketServer.stop();
+
+  // lets create another server
+  testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
+  
+  // lets see if auto reconnect works
+  console.log('test: waiting 21 seconds for reconnect');
+  await tools.delayFor(21000);
 });
 
-tap.test('should run without problems for a little bit', async tools => {
-  await tools.delayFor(5000);
+tap.test('should process messages from both sides', async () => {
+  const myServerSideTypedRequest = testTypedSocketServer.createTypedRequest<IRequest_Client_Server>('sayhi');
+  const myClientSideTypedRequest = testTypedSocketClient.createTypedRequest<IRequest_Client_Server>('sayhi');
+  const response = await myClientSideTypedRequest.fire({
+    greeting: 'that is a greeting from the client'
+  });
+  console.log(response);
+  const response2 = await myServerSideTypedRequest.fire({
+    greeting: 'that is a greeting from the server'
+  });
+  console.log(response2);
 })
 
-tap.test('should disconnect', async () => {
+tap.test('should disconnect', async (tools) => {
   await testTypedSocketClient.stop();
   await testTypedSocketServer.stop();
+  tools.delayFor(1000).then(() => process.exit(0));
 })
 
 tap.start();

ts/index.ts

@@ -1 +1 @@
-export * from './typedsocket.classes.typedsocket';
+export * from './typedsocket.classes.typedsocket.js';

ts/typedsocket.classes.typedsocket.ts

@@ -1,41 +1,40 @@
-import * as plugins from './typedsocket.plugins';
+import * as plugins from './typedsocket.plugins.js';
 
 const publicRoleName = 'publicRoleName';
 const publicRolePass = 'publicRolePass';
 
+export type TTypedSocketSide = 'server' | 'client';
+
 export class TypedSocket {
   // STATIC
   /**
    * creates a typedsocket server
    * note: this will fail in browser environments as server libs are not bundled.
    */
-  public static async createServer(
+  public static async createServer (
     typedrouterArg: plugins.typedrequest.TypedRouter,
     smartexpressServerArg?: any
   ): Promise<TypedSocket> {
     const smartsocketServer = new plugins.smartsocket.Smartsocket({
+      alias: 'typedsocketServer',
       port: 3000,
     });
     if (smartexpressServerArg) {
       smartsocketServer.setExternalServer('smartexpress', smartexpressServerArg);
     }
-    const publicRole = new plugins.smartsocket.SocketRole({
-      name: publicRoleName,
-      passwordHash: await plugins.isohash.sha256FromString(publicRolePass),
-    });
-    smartsocketServer.addSocketRoles([publicRole]);
+
     smartsocketServer.socketFunctions.add(
       new plugins.smartsocket.SocketFunction({
         funcName: 'processMessage',
-        allowedRoles: [publicRole],
         funcDef: async (dataArg, socketConnectionArg) => {
           return typedrouterArg.routeAndAddResponse(dataArg);
         },
       })
     );
     const typedsocket = new TypedSocket(
+      'server',
       typedrouterArg,
-      async <T extends plugins.typedrequestInterfaces.ITypedRequest>(
+      async <T extends plugins.typedrequestInterfaces.ITypedRequest> (
         dataArg: T,
         targetConnectionArg?: plugins.smartsocket.SocketConnection
       ): Promise<T> => {
@@ -44,50 +43,53 @@ export class TypedSocket {
             console.log(
               'Since no targetConnection was supplied and there is only one active one present, choosing that one automatically'
             );
-            targetConnectionArg = smartsocketServer.socketConnections.getArray()[0];
+            targetConnectionArg = smartsocketServer.socketConnections.getArray()[ 0 ];
           } else {
-            throw new Error('you need to specify the wanted targetConnection');
+            throw new Error('you need to specify the wanted targetConnection. Currently no target is selectable automatically.');
           }
         }
-        const response: T = (smartsocketServer.clientCall(
+        const response: T = await smartsocketServer.clientCall(
           'processMessage',
           dataArg,
           targetConnectionArg
-        ) as any) as T;
+        ) as any;
         return response;
       },
       smartsocketServer
     );
-
     await smartsocketServer.start();
 
     return typedsocket;
   }
 
-  public static async createClient(
+  public static async createClient (
     typedrouterArg: plugins.typedrequest.TypedRouter,
-    serverUrl: string
+    serverUrlArg: string,
+    aliasArg = 'clientArg'
   ): Promise<TypedSocket> {
-    const smartsocketClient = new plugins.smartsocket.SmartsocketClient({
-      alias: 'client1',
-      role: publicRoleName,
-      password: publicRolePass,
-      port: 3000,
-      url: serverUrl,
+    const domain = new plugins.smartstring.Domain(serverUrlArg);
+
+    const socketOptions: plugins.smartsocket.ISmartsocketClientOptions = {
+      alias: aliasArg,
+      port: domain.port || 3000,
+      url: `${domain.nodeParsedUrl.protocol}//${domain.nodeParsedUrl.hostname}`,
       autoReconnect: true,
-    });
-    smartsocketClient.socketFunctions.add(
+    }
+    console.log(`starting typedsocket with the following settings:`)
+    console.log(socketOptions);
+    const smartsocketClient = new plugins.smartsocket.SmartsocketClient(socketOptions);
+    smartsocketClient.addSocketFunction(
       new plugins.smartsocket.SocketFunction({
         funcName: 'processMessage',
-        allowedRoles: [],
         funcDef: async (dataArg, socketConnectionArg) => {
           return typedrouterArg.routeAndAddResponse(dataArg);
         },
       })
     );
     const typedsocket = new TypedSocket(
+      'client',
       typedrouterArg,
-      async <T extends plugins.typedrequestInterfaces.ITypedRequest>(dataArg: T): Promise<T> => {
+      async <T extends plugins.typedrequestInterfaces.ITypedRequest> (dataArg: T): Promise<T> => {
         const response: T = (smartsocketClient.serverCall('processMessage', dataArg) as any) as T;
         return response;
       },
@@ -100,6 +102,7 @@ export class TypedSocket {
   }
 
   // INSTANCE
+  public side: TTypedSocketSide;
   public typedrouter: plugins.typedrequest.TypedRouter;
   private postMethod: plugins.typedrequest.IPostMethod &
     ((
@@ -108,17 +111,30 @@ export class TypedSocket {
     ) => Promise<plugins.typedrequestInterfaces.ITypedRequest>);
   private socketServerOrClient: plugins.smartsocket.Smartsocket | plugins.smartsocket.SmartsocketClient;
   constructor(
+    sideArg: TTypedSocketSide,
     typedrouterArg: plugins.typedrequest.TypedRouter,
     postMethodArg: plugins.typedrequest.IPostMethod,
     socketServerOrClientArg: plugins.smartsocket.Smartsocket | plugins.smartsocket.SmartsocketClient
   ) {
+    this.side = sideArg;
     this.typedrouter = typedrouterArg;
     this.postMethod = postMethodArg;
     this.socketServerOrClient = socketServerOrClientArg;
   }
 
-  public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(
-    methodName: T['method'],
+  public addTag (keyArg: string, payloadArg: any) {
+    if (this.side === 'client' && this.socketServerOrClient instanceof plugins.smartsocket.SmartsocketClient) {
+      this.socketServerOrClient.socketConnection.addTag({
+        id: keyArg,
+        payload: payloadArg
+      })
+    } else {
+      throw new Error('tagging is only supported on clients');
+    }
+  }
+
+  public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> (
+    methodName: T[ 'method' ],
     targetConnection?: plugins.smartsocket.SocketConnection
   ): plugins.typedrequest.TypedRequest<T> {
     const typedrequest = new plugins.typedrequest.TypedRequest<T>(
@@ -133,21 +149,57 @@ export class TypedSocket {
     return typedrequest;
   }
 
-  public async findTargetConnection(
-    findFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => boolean
+  /**
+   * returns all matching target connection
+   * @param asyncFindFuncArg
+   * @returns 
+   */
+  public async findAllTargetConnections (
+    asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
   ) {
     if (this.socketServerOrClient instanceof plugins.smartsocket.Smartsocket) {
+      const matchingSockets: plugins.smartsocket.SocketConnection[] = [];
       for (const socketConnection of this.socketServerOrClient.socketConnections.getArray()) {
-        if (findFuncArg(socketConnection)) {
-          return socketConnection;
+        if (await asyncFindFuncArg(socketConnection)) {
+          matchingSockets.push(socketConnection);
         }
       }
+      return matchingSockets;
     } else {
-      console.warn('this method >>findTargetConnection<< is only available from the server');
+      throw new Error('this method >>findTargetConnection<< is only available from the server');
     }
   }
 
-  public async stop() {
+  /**
+   * returns a single target connection by returning the first one of all matching ones
+   * @param asyncFindFuncArg
+   * @returns 
+   */
+  public async findTargetConnection (
+    asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
+  ) {
+    const allMatching = await this.findAllTargetConnections(asyncFindFuncArg);
+    return allMatching[ 0 ];
+  }
+
+  public async findAllTargetConnectionsByTag (keyArg: string, payloadArg?: any) {
+    return this.findAllTargetConnections(async socketConnectionArg => {
+      let result: boolean;
+      if (!payloadArg) {
+        result = !!(await socketConnectionArg.getTagById(keyArg));
+      } else {
+        result = !!((await socketConnectionArg.getTagById(keyArg)).payload === payloadArg);
+      }
+      return result;
+    })
+  }
+
+  public async findTargetConnectionByTag (keyArg: string, payloadArg?: any) {
+    const allResults = await this.findAllTargetConnectionsByTag(keyArg, payloadArg)
+    return allResults[ 0 ];
+  }
+
+  public async stop () {
     await this.socketServerOrClient.stop()
   }
 }

ts/typedsocket.plugins.ts

@@ -10,8 +10,10 @@ export {
 // @pushrocks scope
 import * as isohash from '@pushrocks/isohash';
 import * as smartsocket from '@pushrocks/smartsocket';
+import * as smartstring from '@pushrocks/smartstring';
 
 export {
   isohash,
-  smartsocket
+  smartsocket,
+  smartstring
 }