1.0.73

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
-dist/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -38,19 +38,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -60,12 +48,24 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
   - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -78,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -106,13 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+ignore: {}
+patch: {}

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${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"
+    }
+  ]
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.41",
+  "version": "1.0.73",
   "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
@@ -9,31 +9,44 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
+    "testManual": "(tsrun test/test.ts)",
     "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tstest": "^1.0.20",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^11.13.4",
-    "tslint": "^5.15.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.4",
+    "tslint": "^5.19.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "peerDependencies": {
     "rxjs": "*"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.5",
+    "@pushrocks/lik": "^3.0.11",
     "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartexpress": "^3.0.18",
-    "@pushrocks/smartfile": "^7.0.2",
-    "@pushrocks/smarthash": "^2.0.4",
+    "@pushrocks/smartexpress": "^3.0.40",
+    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smarthash": "^2.0.6",
+    "@pushrocks/smartlog": "^2.0.19",
     "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartrequest": "^1.1.27",
     "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smartsocket": "^1.1.27",
-    "@pushrocks/smarttime": "^3.0.7",
+    "@pushrocks/smartsocket": "^1.1.49",
+    "@pushrocks/smarttime": "^3.0.12",
     "@pushrocks/smartunique": "^3.0.1"
-  }
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -1,16 +1,13 @@
 # @pushrocks/smartuniverse
-
 messaging service for micro services
 
 ## Availabililty and Links
-
-- [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-- [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
-- [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
-- [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
+* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
 
 ## Status for master
-
 [![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
 [![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
@@ -28,6 +25,7 @@ Use TypeScript for best in class instellisense.
 Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
 
 ### Server side
+
 every universe has a server that manages messages.  
 Think Kafka, but without Kafka.
 
@@ -46,11 +44,12 @@ myUniverse.start(8765); // start the server and provide the port on which to lis
 ```
 
 ### Client side
+
 All your microservices represents clients in the universe that may talk to each other using the universe server.
 
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -6,11 +6,16 @@ import { Observable } from 'rxjs';
 
 let testUniverse: smartuniverse.Universe;
 let testClientUniverse: smartuniverse.ClientUniverse;
+let testClientUniverse2: smartuniverse.ClientUniverse;
 let testClientChannel: smartuniverse.ClientUniverseChannel;
 
+const testServerData = {
+  serverAddress: 'http://localhost:8765'
+};
+
 const testChannelData = {
   channelName: 'awesomeTestChannel',
-  channelPass: 'awesomeChannelPAss'
+  channelPass: 'awesomeChannelPass'
 };
 
 tap.test('first test', async () => {
@@ -26,31 +31,50 @@ tap.test('add a message to the SmartUniverse', async () => {
 // testing message handling
 tap.test('create smartuniverse client', async () => {
   testClientUniverse = new smartuniverse.ClientUniverse({
-    serverAddress: 'http://localhost:8765'
+    serverAddress: testServerData.serverAddress
   });
   expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
 });
 
 tap.test('should add a channel to the universe', async () => {
-  await testUniverse.addChannel('testChannel', 'testPassword');
+  testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
+tap.test('should add the same channel to the client universe in the same way', async () => {
+  testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
+tap.test('should start the ClientUniverse', async () => {
+  await testClientUniverse.start();
 });
 
 tap.test('should get a observable correctly', async () => {
-  testClientChannel = await testClientUniverse.getChannel(testChannelData.channelName);
+  testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
   expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
 });
 
 tap.test('should send a message correctly', async () => {
-  await testClientUniverse.sendMessage({
-    messageText: 'hello',
-    targetChannelName: 'channel1'
+  await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
+    messageText: 'hello'
   });
 });
 
+tap.test('universe should contain the sent message', async () => {
+  expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
+});
+
+tap.test('a second client should be able to subscibe', async () => {
+  testClientUniverse2 = new smartuniverse.ClientUniverse({
+    serverAddress: testServerData.serverAddress
+  });
+
+  testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
 tap.test('should receive a message correctly', async () => {});
 
 tap.test('should disconnect the client correctly', async () => {
-  testClientUniverse.close();
+  await testClientUniverse.stop();
 });
 
 tap.test('should end the server correctly', async tools => {

ts/index.ts

@@ -1,6 +1,7 @@
 // Client classes
 export * from './smartuniverse.classes.clientuniverse';
 export * from './smartuniverse.classes.clientuniversechannel';
+export * from './smartuniverse.classes.clientuniversemessage';
 
 // Server classes
 export * from './smartuniverse.classes.universe';

ts/interfaces/index.ts

@@ -1,3 +1,5 @@
 export * from './http.interfaces';
+export * from './socketfunctionrequests';
 export * from './universechannel.interfaces';
 export * from './universemessage.interfaces';
+export * from './universeactions.interfaces';

ts/interfaces/socketfunctionrequests.ts

@@ -0,0 +1,20 @@
+import * as interfaces from './index';
+
+export interface ISocketRequest_SubscribeChannel {
+  method: 'subscribeChannel';
+  request: {
+    name: string;
+    passphrase: string;
+  };
+  response: {
+    subscriptionStatus: 'subscribed' | 'unsubscribed'
+  };
+}
+
+export interface ISocketRequest_ProcessMessage {
+  method: 'processMessage';
+  request: interfaces.IUniverseMessage;
+  response: {
+    messageStatus: 'ok' | 'channel not found'
+  };
+}

ts/interfaces/universeactions.interfaces.ts

@@ -0,0 +1,10 @@
+export type IServerCallActions =
+  | 'channelSubscription'
+  | 'processMessage'
+  | 'channelUnsubscribe'
+  | 'terminateConnection';
+
+
+export interface IServerUnsubscribeActionPayload {
+  name: string;
+}

ts/interfaces/universemessage.interfaces.ts

@@ -2,9 +2,11 @@ export interface IMessageCreator {
   messageText: string;
   payload?: string | number | any;
   payloadStringType?: 'Buffer' | 'string' | 'object';
-  targetChannelName: string;
 }
 
+/**
+ * A universe
+ */
 export interface IUniverseMessage extends IMessageCreator {
   id: string;
   /**
@@ -12,4 +14,5 @@ export interface IUniverseMessage extends IMessageCreator {
    */
   timestamp: number;
   passphrase: string;
+  targetChannelName: string;
 }

ts/smartuniverse.classes.clientuniverse.ts

@@ -7,10 +7,8 @@ import * as url from 'url';
 
 import * as interfaces from './interfaces';
 
-import {
-  ClientUniverseChannel,
-  UniverseMessage
-} from './';
+import { ClientUniverseChannel, ClientUniverseMessage } from './';
+import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
 
 export interface IClientOptions {
   serverAddress: string;
@@ -22,10 +20,9 @@ export interface IClientOptions {
  */
 export class ClientUniverse {
   public options;
-  public socketClient: plugins.smartsocket.SmartsocketClient;
-  public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
-
-  public channelCache = new Objectmap<ClientUniverseChannel>();
+  public smartsocketClient: plugins.smartsocket.SmartsocketClient;
+  public observableIntake: plugins.smartrx.ObservableIntake<ClientUniverseMessage>;
+  public clientUniverseCache = new ClientUniverseCache();
 
   constructor(optionsArg: IClientOptions) {
     this.options = optionsArg;
@@ -35,7 +32,7 @@ export class ClientUniverse {
    * adds a channel to the channelcache
    * TODO: verify channel before adding it to the channel cache
    */
-  public async addChannel (channelNameArg: string, passphraseArg: string) {
+  public addChannel(channelNameArg: string, passphraseArg: string) {
     const existingChannel = this.getChannel(channelNameArg);
 
     if (existingChannel) {
@@ -43,11 +40,12 @@ export class ClientUniverse {
     }
 
     // lets create the channel
-    ClientUniverseChannel.createClientUniverseChannel(
+    const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(
       this,
       channelNameArg,
       passphraseArg
     );
+    return clientUniverseChannel;
   }
 
   /**
@@ -55,49 +53,102 @@ export class ClientUniverse {
    * @param channelName
    * @param passphraseArg
    */
-  public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
-    await this.checkConnection();
-    const clientUniverseChannel = this.channelCache.find(channel => {
+  public getChannel(channelName: string): ClientUniverseChannel {
+    const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
       return channel.name === channelName;
-    })
+    });
     return clientUniverseChannel;
   }
 
-  public async sendMessage(messageArg: interfaces.IMessageCreator) {
-    const requestBody: interfaces.IUniverseMessage = {
-      id: plugins.smartunique.shortId(),
-      timestamp: Date.now(),
-      passphrase: (await this.getChannel(messageArg.targetChannelName)).passphrase,
-      ...messageArg,
-
-    };
-    const requestBodyString = JSON.stringify(requestBody);
-    // TODO: User websocket connection if available
-    const response = await plugins.smartrequest.postJson(`${this.options.serverAddress}/sendmessage` , {
-      requestBody: requestBodyString
-    });
+  /**
+   * remove a a achannel
+   * @param messageArg
+   */
+  public removeChannel(channelNameArg, notifyServer = true) {
+    const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
+      channelItemArg => {
+        return channelItemArg.name === channelNameArg;
+      }
+    );
   }
 
-  public close() {
-    this.socketClient.disconnect();
+  public async start() {
+    await this.checkConnection();
+  }
+
+  public async stop() {
+    await this.smartsocketClient.disconnect();
   }
 
   /**
    * checks the connection towards a universe server
    * since password validation is done through other means, a connection should always be possible
    */
-  private async checkConnection(): Promise<void> {
-    if (!this.socketClient && !this.observableIntake) {
+  public async checkConnection(): Promise<void> {
+    if (!this.smartsocketClient && !this.observableIntake) {
       const parsedURL = url.parse(this.options.serverAddress);
-      this.socketClient = new SmartsocketClient({
-        alias: process.env.SOCKET_ALIAS || 'someclient',
+      const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
+        alias: 'universeclient',
         password: 'UniverseClient',
         port: parseInt(parsedURL.port, 10),
         role: 'UniverseClient',
-        url: parsedURL.hostname
-      });
+        url: parsedURL.protocol + '//' + parsedURL.hostname
+      };
+      this.smartsocketClient = new SmartsocketClient(socketConfig);
       this.observableIntake = new plugins.smartrx.ObservableIntake();
-      this.socketClient.connect();
+
+      // lets define some basic actions
+
+      /**
+       * should handle a forced unsubscription by the server
+       */
+      const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
+        funcName: 'unsubscribe',
+        allowedRoles: [],
+        funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
+          throw new Error('TODO');
+        }
+      });
+
+      /**
+       * handles message reception
+       */
+      const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<
+        interfaces.ISocketRequest_ProcessMessage
+      >({
+        funcName: 'processMessage',
+        allowedRoles: [],
+        funcDef: async messageDescriptorArg => {
+          plugins.smartlog.defaultLogger.log('info', 'Got message from server');
+          const clientUniverseMessage = ClientUniverseMessage.createMessageFromMessageDescriptor(
+            messageDescriptorArg
+          );
+          this.observableIntake.push(clientUniverseMessage);
+
+          // lets find the corresponding channel
+          const targetChannel = this.getChannel(clientUniverseMessage.targetChannelName);
+          if (targetChannel) {
+            await targetChannel.emitMessageLocally(clientUniverseMessage);
+            return {
+              messageStatus: 'ok'
+            };
+          } else {
+            return {
+              messageStatus: 'channel not found'
+            };
+          }
+        }
+      });
+
+      // add functions
+      this.smartsocketClient.addSocketFunction(socketFunctionUnsubscribe);
+      this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
+
+      await this.smartsocketClient.connect();
+      plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
+      await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
+        await clientUniverseChannelArg.subscribe();
+      });
     }
   }
 }

ts/smartuniverse.classes.clientuniversecache.ts

@@ -0,0 +1,11 @@
+import * as plugins from './smartuniverse.plugins';
+import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
+
+/**
+ * a cache for clients
+ * keeps track of which messages have already been received
+ * good for deduplication in mesh environments
+ */
+export class ClientUniverseCache {
+  public channelMap = new plugins.lik.Objectmap<ClientUniverseChannel>();
+}

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -2,6 +2,7 @@ import * as plugins from './smartuniverse.plugins';
 import * as interfaces from './interfaces';
 
 import { ClientUniverse } from './';
+import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
 
 export class ClientUniverseChannel implements interfaces.IUniverseChannel {
   // ======
@@ -13,14 +14,17 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
    * @param channelNameArg
    * @param passphraseArg
    */
-  public static async createClientUniverseChannel(
+  public static createClientUniverseChannel(
     clientUniverseArg: ClientUniverse,
     channelNameArg: string,
     passphraseArg: string
-  ): Promise<ClientUniverseChannel> {
-    const clientChannel = new ClientUniverseChannel(clientUniverseArg, channelNameArg, passphraseArg);
-    clientUniverseArg.channelCache.add(clientChannel);
-    await clientChannel.subscribe();
+  ): ClientUniverseChannel {
+    const clientChannel = new ClientUniverseChannel(
+      clientUniverseArg,
+      channelNameArg,
+      passphraseArg
+    );
+    clientUniverseArg.clientUniverseCache.channelMap.add(clientChannel);
     return clientChannel;
   }
 
@@ -31,12 +35,14 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
   // properties
   public name: string;
   public passphrase: string;
+  public status: 'subscribed' | 'unsubscribed' = 'unsubscribed';
+  private subject = new plugins.smartrx.rxjs.Subject();
 
   // refs
-  public clientUniverse: ClientUniverse;
+  public clientUniverseRef: ClientUniverse;
 
   constructor(clientUniverseArg: ClientUniverse, nameArg: string, passphraseArg: string) {
-    this.clientUniverse = clientUniverseArg;
+    this.clientUniverseRef = clientUniverseArg;
     this.name = nameArg;
     this.passphrase = passphraseArg;
   }
@@ -45,7 +51,47 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
    * subscribes to a channel
    * tells the universe about this instances interest into a channel
    */
-  public async subscribe() {
-    this.clientUniverse.socketClient;
+  public async subscribe(observerArg?: plugins.smartrx.rxjs.Observer<any>) {
+    // lets make sure the channel is connected
+    if (this.status === 'unsubscribed') {
+      const response = await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>(
+        'subscribeChannel',
+        {
+          name: this.name,
+          passphrase: this.passphrase
+        }
+      );
+      this.status = response.subscriptionStatus;
+    }
+
+    if (observerArg) {
+      return this.subject.subscribe(observerArg);
+    }
+
+  }
+
+  public async emitMessageLocally(messageArg: ClientUniverseMessage) {
+    
+  }
+
+  /**
+   * sends a message towards the server
+   * @param messageArg
+   */
+  public async sendMessage(messageArg: interfaces.IMessageCreator) {
+    await this.clientUniverseRef.checkConnection();
+    const universeMessageToSend: interfaces.IUniverseMessage = {
+      id: plugins.smartunique.shortId(),
+      timestamp: Date.now(),
+      passphrase: this.passphrase,
+      targetChannelName: this.name,
+      messageText: messageArg.messageText,
+      payload: messageArg.payload,
+      payloadStringType: messageArg.payloadStringType
+    };
+    await this.clientUniverseRef.smartsocketClient.serverCall(
+      'processMessage',
+      universeMessageToSend
+    );
   }
 }

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -6,27 +6,34 @@ export class ClientUniverseMessage implements interfaces.IUniverseMessage {
   // ======
   // STATIC
   // ======
-  public static createMessageFromPayload(messageDescriptor: interfaces.IUniverseMessage) {
-
-  };
+  public static createMessageFromMessageDescriptor(messageDescriptor: interfaces.IUniverseMessage) {
+    const clientuniverseMessage = new ClientUniverseMessage(messageDescriptor);
+    return clientuniverseMessage;
+  }
 
   // ========
   // INSTANCE
   // ========
 
+  // properties
   public id: string;
 
   public timestamp: number;
   public smartTimestamp: plugins.smarttime.TimeStamp;
-
   public messageText: string;
   public passphrase: string;
   public payload: any;
   public payloadStringType;
   public targetChannelName: string;
-  constructor(messageArg, payloadArg) {}
-
-  getAsJsonForPayload () {
 
+  constructor(messageArg: interfaces.IUniverseMessage) {
+    for (const key of Object.keys(messageArg)) {
+      this[key] = messageArg[key];
     }
+  }
+
+  /**
+   * gets json for payload
+   */
+  getAsJsonForPayload() {}
 }

ts/smartuniverse.classes.reactionrequest.ts

@@ -0,0 +1,5 @@
+import * as plugins from './smartuniverse.plugins';
+
+export class ReactionRequest {
+
+}

ts/smartuniverse.classes.reactionresponse.ts

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

ts/smartuniverse.classes.universe.ts

@@ -6,15 +6,15 @@ import { UniverseCache, UniverseChannel, UniverseMessage } from './';
 import * as paths from './smartuniverse.paths';
 
 import * as interfaces from './interfaces';
+import { UniverseConnection } from './smartuniverse.classes.universeconnection';
 
 export interface ISmartUniverseConstructorOptions {
   messageExpiryInMilliseconds: number;
+  externalServer?: plugins.smartexpress.Server;
 }
 
-
-
 /**
- * main class that setsup a Universe
+ * main class that setups a Universe
  */
 export class Universe {
   // subinstances
@@ -23,25 +23,6 @@ export class Universe {
   // options
   private options: ISmartUniverseConstructorOptions;
 
-  /**
-   * stores the version of the universe server running
-   * this is done since the version is exposed through the api and multiple fs actions are avoided this way.
-   */
-  private universeVersionStore: string;
-
-  /**
-   * get the currently running version of smartuniverse
-   */
-  public get universeVersion() {
-    if (this.universeVersionStore) {
-      return this.universeVersionStore;
-    } else {
-      const packageJson = plugins.smartfile.fs.toObjectSync(paths.packageJson);
-      this.universeVersionStore = packageJson.version;
-      return this.universeVersionStore;
-    }
-  }
-
   /**
    * the smartexpress server used
    */
@@ -54,73 +35,143 @@ export class Universe {
 
   constructor(optionsArg: ISmartUniverseConstructorOptions) {
     this.options = optionsArg;
-    this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
+    this.universeCache = new UniverseCache(this, this.options.messageExpiryInMilliseconds);
+  }
+
+  /**
+   * stores the version of the universe server running
+   * this is done since the version is exposed through the api and multiple fs actions are avoided this way.
+   */
+  private universeVersionStore: string;
+
+  /**
+   * get the currently running version of smartuniverse
+   */
+  public getUniverseVersion() {
+    if (this.universeVersionStore) {
+      return this.universeVersionStore;
+    } else {
+      const packageJson = plugins.smartfile.fs.toObjectSync(paths.packageJson);
+      this.universeVersionStore = packageJson.version;
+      return this.universeVersionStore;
+    }
   }
 
   /**
    * adds a channel to the Universe
    */
-  public async addChannel(nameArg: string, passphraseArg: string) {
-    const newChannel = UniverseChannel.createChannel(this.universeCache, nameArg, passphraseArg);
+  public addChannel(nameArg: string, passphraseArg: string) {
+    const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
   }
 
   /**
    * initiates a server
    */
-  public async start(portArg: number | string) {
+  public async start(portArg: number) {
     // lets create the base smartexpress server
+    if (!this.options.externalServer) {
       this.smartexpressServer = new plugins.smartexpress.Server({
         cors: true,
         defaultAnswer: async () => {
-        return `smartuniverse server ${this.universeVersion}`;
+          return `smartuniverse server ${this.getUniverseVersion()}`;
         },
         forceSsl: false,
         port: portArg
       });
-
-    // lets create the http request route
-    this.smartexpressServer.addRoute('/sendmessage', new Handler('POST', async (req, res) => {
-      const universeMessageInstance = new UniverseMessage(req.body);
-      this.universeCache.addMessage(universeMessageInstance);
-    }));
+    } else {
+      console.log('Universe is using externally supplied server');
+      this.smartexpressServer = this.options.externalServer;
+    }
 
     // add websocket upgrade
-    this.smartsocket = new plugins.smartsocket.Smartsocket({
-      port: 12345 // fix this within smartsocket
-    });
+    this.smartsocket = new plugins.smartsocket.Smartsocket({});
 
     // add a role for the clients
     const ClientRole = new plugins.smartsocket.SocketRole({
-      name: 'clientuniverse',
-      passwordHash: 'clientuniverse' // authentication happens on another level
+      name: 'UniverseClient',
+      passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
     });
 
     // add the role to smartsocket
     this.smartsocket.addSocketRoles([ClientRole]);
 
-    const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
-      allowedRoles: [ClientRole],
-      funcName: 'channelSubscription',
-      funcDef: () => {
-        console.log('a client connected');
-      } // TODO: implement an action upon connection of clients
+    const socketFunctionSubscription = new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({
+      allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
+      funcName: 'subscribeChannel',
+      funcDef: async (
+        dataArg,
+        socketConnectionArg
+      ) => {
+        const universeConnection = new UniverseConnection({
+          socketConnection: socketConnectionArg,
+          authenticationRequests: [dataArg]
+        });
+        await UniverseConnection.addConnectionToCache(this, universeConnection);
+        return {
+          subscriptionStatus: 'subscribed'
+        };
+      }
     });
 
-    // add smartsocket to the running smartexpress app
-    this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
+    const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
+      allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
+      funcName: 'processMessage',
+      funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
+        const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
+          this.universeCache,
+          socketConnectionArg
+        );
+        if (universeConnection) {
+          plugins.smartlog.defaultLogger.log(
+            'ok',
+            'found UniverseConnection for socket for incoming message'
+          );
+        } else {
+          plugins.smartlog.defaultLogger.log(
+            'warn',
+            'found no Authorized channel for incoming message'
+          );
+          return {
+            error: 'You need to authenticate for a channel'
+          };
+        }
+        const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
+          socketConnectionArg,
+          dataArg
+        );
+        const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
+          this.universeCache,
+          unauthenticatedMessage
+        );
+        if (foundChannel && unauthenticatedMessage.authenticated) {
+          const authenticatedMessage = unauthenticatedMessage;
+          await this.universeCache.addMessage(authenticatedMessage);
+        }
+      }
+    });
 
-    // start the socket
-    this.smartsocket.start();
+    // add socket functions
+    this.smartsocket.addSocketFunction(socketFunctionSubscription);
+    this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
 
-    // start the smartexpress instance
+    // start the server
+    if (!this.options.externalServer) {
       await this.smartexpressServer.start();
     }
 
+    // add smartsocket to the running smartexpress app
+    await this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer);
+    await this.smartsocket.start();
+    plugins.smartlog.defaultLogger.log('success', 'started universe');
+  }
+
   /**
    * stop everything
    */
   public async stopServer() {
     await this.smartsocket.stop();
+    if (!this.options.externalServer) {
       await this.smartexpressServer.stop();
     }
+  }
 }

ts/smartuniverse.classes.universecache.ts

@@ -8,6 +8,8 @@ import { Objectmap } from '@pushrocks/lik';
 import { Observable, from } from 'rxjs';
 import { filter } from 'rxjs/operators';
 import { rxjs } from '@pushrocks/smartrx';
+import { UniverseConnection } from './smartuniverse.classes.universeconnection';
+import { Universe } from './smartuniverse.classes.universe';
 
 /**
  * universe store handles the creation, storage and retrieval of messages.
@@ -29,13 +31,22 @@ export class UniverseCache {
    */
   public channelMap = new Objectmap<UniverseChannel>();
 
+  /**
+   * stores all connections
+   */
+  public connectionMap = new plugins.lik.Objectmap<UniverseConnection>();
+
   /**
    * allows messages to be processed in a blacklist mode for further analysis
    */
-  public blackListChannel = new UniverseChannel(this, 'blacklist', 'nada');
+  public blackListChannel: UniverseChannel;
 
-  constructor(standardMessageExpiryArg: number) {
+  public universeRef: Universe;
+
+  constructor(universeArg: Universe, standardMessageExpiryArg: number) {
+    this.universeRef = universeArg;
     this.standardMessageExpiry = standardMessageExpiryArg;
+    this.blackListChannel = new UniverseChannel(this.universeRef, 'blacklist', 'nada');
   }
 
   /**
@@ -47,12 +58,18 @@ export class UniverseCache {
     messageArg.setUniverseCache(this);
     UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
     this.messageMap.add(messageArg);
+    messageArg.universeChannelList.forEach(universeChannel => {
+      universeChannel.pushToClients(messageArg);
+    });
   }
 
   /**
    * Read a message from the UniverseCache
    */
-  public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
+  public readMessagesYoungerThan(
+    unixTimeArg?: number,
+    channelName?: string
+  ): Observable<UniverseMessage> {
     const messageObservable = from(this.messageMap.getArray()).pipe(
       filter(messageArg => {
         return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);

ts/smartuniverse.classes.universechannel.ts

@@ -1,8 +1,10 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
-import { Objectmap } from '@pushrocks/lik';
 import { UniverseCache } from './smartuniverse.classes.universecache';
 import { UniverseMessage } from './smartuniverse.classes.universemessage';
+import { UniverseConnection } from './smartuniverse.classes.universeconnection';
+import { Universe } from './smartuniverse.classes.universe';
 
 /**
  * enables messages to stay within a certain scope.
@@ -18,12 +20,12 @@ export class UniverseChannel {
    * @param passphraseArg the secret thats used for a certain topic.
    */
   public static createChannel(
-    universeCacheArg: UniverseCache,
+    universeArg: Universe,
     channelNameArg: string,
     passphraseArg: string
   ) {
-    const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
-    universeCacheArg.channelMap.add(newChannel);
+    const newChannel = new UniverseChannel(universeArg, channelNameArg, passphraseArg);
+    universeArg.universeCache.channelMap.add(newChannel);
     return newChannel;
   }
 
@@ -41,10 +43,17 @@ export class UniverseChannel {
     }
   }
 
+  /**
+   * a static message authorization function that takes the  UniverseCache
+   * (where messages and channels are stored and their lifetime is managed)
+   * and the universemessage to find a fitting channel for the message
+   * @param universeCacheArg
+   * @param universeMessageArg
+   */
   public static authorizeAMessageForAChannel(
     universeCacheArg: UniverseCache,
     universeMessageArg: UniverseMessage
-  ) {
+  ): UniverseChannel {
     const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
       const result = universeChannel.authenticate(universeMessageArg);
       return result;
@@ -52,13 +61,22 @@ export class UniverseChannel {
     if (foundChannel) {
       universeMessageArg.authenticated = true;
       universeMessageArg.universeChannelList.add(foundChannel);
+      plugins.smartlog.defaultLogger.log('ok', 'message authorized');
       return foundChannel;
     } else {
       universeMessageArg.authenticated = false;
       universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
+      plugins.smartlog.defaultLogger.log('warn', 'message not valid');
+      return null;
     }
   }
 
+  public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
+    return universeRef.universeCache.channelMap.find(channelArg => {
+      return channelArg.name === universeChannelName;
+    });
+  }
+
   // ========
   // INSTANCE
   // ========
@@ -66,20 +84,23 @@ export class UniverseChannel {
    * the name of the channel
    */
   public name: string;
-  public universeCacheInstance: UniverseCache;
+  public universeRef: Universe;
 
   /**
    * the passphrase for the channel
    */
   public passphrase: string;
 
-  constructor(universeCacheArg: UniverseCache, channelNameArg: string, passphraseArg: string) {
+  constructor(universeArg: Universe, channelNameArg: string, passphraseArg: string) {
+    this.universeRef = universeArg;
     this.name = channelNameArg;
     this.passphrase = passphraseArg;
   }
 
   /**
-   * authenticates a client on the server side
+   * authenticates a client on the server side by matching
+   * # the messages channelName against the unverseChannel's name
+   * # the messages password against the universeChannel's password
    */
   public authenticate(universeMessageArg: UniverseMessage): boolean {
     return (
@@ -88,5 +109,34 @@ export class UniverseChannel {
     );
   }
 
-  public pushToClients(messageArg: UniverseMessage) {}
+  /**
+   * pushes a message to clients
+   * @param messageArg
+   */
+  public async pushToClients(messageArg: UniverseMessage) {
+    const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
+    this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
+      if (socketConnection.authenticatedChannels.includes(this)) {
+        universeConnectionsWithChannelAccess.push(socketConnection);
+      }
+    });
+    for (const universeConnection of universeConnectionsWithChannelAccess) {
+      const smartsocket = universeConnection.socketConnection
+        .smartsocketRef as plugins.smartsocket.Smartsocket;
+      const universeMessageToSend: interfaces.IUniverseMessage = {
+        id: messageArg.id,
+        timestamp: messageArg.timestamp,
+        passphrase: messageArg.passphrase,
+        targetChannelName: this.name,
+        messageText: messageArg.messageText,
+        payload: messageArg.payload,
+        payloadStringType: messageArg.payloadStringType
+      };
+      smartsocket.clientCall(
+        'processMessage',
+        universeMessageToSend,
+        universeConnection.socketConnection
+      );
+    }
+  }
 }

ts/smartuniverse.classes.universeconnection.ts

@@ -0,0 +1,121 @@
+import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { UniverseCache } from './smartuniverse.classes.universecache';
+import { Universe } from './smartuniverse.classes.universe';
+
+/**
+ * represents a connection to the universe
+ */
+export class UniverseConnection {
+  /**
+   *
+   * @param universeConnectionArg
+   */
+  public static async addConnectionToCache(
+    universeRef: Universe,
+    universeConnectionArg: UniverseConnection
+  ) {
+    let universeConnection = universeConnectionArg;
+    universeConnection = await UniverseConnection.deduplicateUniverseConnection(
+      universeRef.universeCache,
+      universeConnection
+    );
+    universeConnection = await UniverseConnection.authenticateAuthenticationRequests(
+      universeRef,
+      universeConnection
+    );
+    universeRef.universeCache.connectionMap.add(universeConnection);
+  }
+
+  /**
+   * deduplicates UniverseConnections
+   */
+  public static async deduplicateUniverseConnection(
+    universeCache: UniverseCache,
+    universeConnectionArg: UniverseConnection
+  ): Promise<UniverseConnection> {
+    let connectionToReturn: UniverseConnection;
+    universeCache.connectionMap.forEach(async existingConnection => {
+      if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
+        connectionToReturn = await this.mergeUniverseConnections(
+          existingConnection,
+          universeConnectionArg
+        );
+      }
+    });
+    if (!connectionToReturn) {
+      connectionToReturn = universeConnectionArg;
+    }
+    return connectionToReturn;
+  }
+
+  /**
+   * authenticate AuthenticationRequests
+   */
+  public static async authenticateAuthenticationRequests(
+    universeRef: Universe,
+    universeConnectionArg: UniverseConnection
+  ): Promise<UniverseConnection> {
+    for (const authenticationRequest of universeConnectionArg.authenticationRequests) {
+      const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(
+        universeRef,
+        authenticationRequest.name
+      );
+      if (universeChannelToAuthenticateAgainst.passphrase === authenticationRequest.passphrase) {
+        universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst);
+      }
+    }
+    return universeConnectionArg;
+  }
+
+  /**
+   * merges two UniverseConnections
+   */
+  public static mergeUniverseConnections(
+    connectionArg1: UniverseConnection,
+    connectionArg2: UniverseConnection
+  ) {
+    return connectionArg1;
+  }
+
+  /**
+   * finds a UniverseConnection by providing a socket connection
+   */
+  public static findUniverseConnectionBySocketConnection(
+    universeCache: UniverseCache,
+    socketConnectionArg: plugins.smartsocket.SocketConnection
+  ): UniverseConnection {
+    const universeConnection = universeCache.connectionMap.find(universeConnectionArg => {
+      return universeConnectionArg.socketConnection === socketConnectionArg;
+    });
+    return universeConnection;
+  }
+
+  public terminatedDeferred = plugins.smartpromise.defer();
+
+  /**
+   * the socketClient to ping
+   */
+  public socketConnection: plugins.smartsocket.SocketConnection;
+  public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
+  public subscribedChannels: UniverseChannel[] = [];
+  public authenticatedChannels: UniverseChannel[] = [];
+  public failedToJoinChannels: UniverseChannel[] = [];
+
+  /**
+   * terminates the connection
+   */
+  public terminateConnection() {
+    this.socketConnection.socket.disconnect();
+    this.terminatedDeferred.resolve();
+  }
+
+  constructor(optionsArg: {
+    socketConnection: plugins.smartsocket.SocketConnection;
+    authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
+  }) {
+    this.authenticationRequests = optionsArg.authenticationRequests;
+    this.socketConnection = optionsArg.socketConnection;
+  }
+}

ts/smartuniverse.classes.universemessage.ts

@@ -7,24 +7,31 @@ import { Timer, TimeStamp } from '@pushrocks/smarttime';
 import { Universe } from './smartuniverse.classes.universe';
 import { UniverseChannel } from './smartuniverse.classes.universechannel';
 import { UniverseCache } from './smartuniverse.classes.universecache';
-import { IUniverseMessage } from './interfaces';
+import { SocketConnection } from '@pushrocks/smartsocket';
 
 /**
  * represents a message within a universe
  * acts as a container to save message states like authentication status
  */
 export class UniverseMessage implements interfaces.IUniverseMessage {
+  public static createMessageFromPayload(
+    socketConnectionArg: SocketConnection,
+    dataArg: interfaces.IUniverseMessage
+  ) {
+    const universeMessageInstance = new UniverseMessage(dataArg);
+    universeMessageInstance.socketConnection = socketConnectionArg;
+    return universeMessageInstance;
+  }
 
   public id: string;
-
   public timestamp: number;
   public smartTimestamp: TimeStamp;
-
   public messageText: string;
   public passphrase: string;
   public payload: any;
   public payloadStringType;
   public targetChannelName: string;
+  public socketConnection: SocketConnection;
 
   /**
    * the UniverseCache the message is attached to
@@ -39,7 +46,7 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
   /**
    * wether the message is authenticated
    */
-  public authenticated: boolean = null;
+  public authenticated: boolean = false;
 
   /**
    * a destruction timer for this message
@@ -51,7 +58,7 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
    * @param messageArg
    * @param attachedPayloadArg
    */
-  constructor(messageDescriptor: IUniverseMessage) {
+  constructor(messageDescriptor: interfaces.IUniverseMessage) {
     this.smartTimestamp = new TimeStamp(this.timestamp);
     this.messageText = messageDescriptor.messageText;
     this.targetChannelName = messageDescriptor.targetChannelName;
@@ -65,6 +72,8 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
     this.universeCache = universeCacheArg;
   }
 
+  public setTargetChannel() {}
+
   public setDestructionTimer(selfdestructAfterArg: number) {
     if (selfdestructAfterArg) {
       this.destructionTimer = new Timer(selfdestructAfterArg);
@@ -83,7 +92,7 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
    * handles bad messages for further analysis
    */
   public handleAsBadMessage() {
-    console.log('received a bad message');
+    plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
   }
 
   /**

ts/smartuniverse.plugins.ts

@@ -9,6 +9,7 @@ import * as smarthash from '@pushrocks/smarthash';
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartexpress from '@pushrocks/smartexpress';
 import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartrx from '@pushrocks/smartrx';
@@ -22,6 +23,7 @@ export {
   smartdelay,
   smartexpress,
   smartfile,
+  smartlog,
   smartpromise,
   smartrx,
   smartrequest,