1.0.96

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,10 +18,11 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
   stage: security
@@ -31,47 +32,51 @@ snyk:
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +86,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.62",
+  "version": "1.0.96",
   "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
@@ -14,37 +14,38 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.7.1",
-    "tslint": "^5.18.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.12.7",
+    "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0"
   },
   "peerDependencies": {
     "rxjs": "*"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.10",
-    "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartexpress": "^3.0.38",
-    "@pushrocks/smartfile": "^7.0.4",
+    "@apiglobal/typedrequest-interfaces": "^1.0.7",
+    "@pushrocks/lik": "^3.0.11",
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartexpress": "^3.0.52",
+    "@pushrocks/smartfile": "^7.0.6",
     "@pushrocks/smarthash": "^2.0.6",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.16",
-    "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smartsocket": "^1.1.44",
+    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.42",
+    "@pushrocks/smartrx": "^2.0.5",
+    "@pushrocks/smartsocket": "^1.1.58",
     "@pushrocks/smarttime": "^3.0.12",
     "@pushrocks/smartunique": "^3.0.1"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -47,9 +47,13 @@ myUniverse.start(8765); // start the server and provide the port on which to lis
 
 All your microservices represents clients in the universe that may talk to each other using the universe server.
 
+## 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)
-| 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

@@ -31,30 +31,31 @@ tap.test('add a message to the SmartUniverse', async () => {
 // testing message handling
 tap.test('create smartuniverse client', async () => {
   testClientUniverse = new smartuniverse.ClientUniverse({
-    serverAddress: testServerData.serverAddress
+    serverAddress: testServerData.serverAddress,
+    autoReconnect: true
   });
   expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
 });
 
 tap.test('should add a channel to the universe', async () => {
-  await testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+  testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
 });
 
 tap.test('should add the same channel to the client universe in the same way', async () => {
-  await testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+  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 (await testClientUniverse.getChannel(testChannelData.channelName)).sendMessage({
+  await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
     messageText: 'hello'
   });
 });
@@ -65,16 +66,67 @@ tap.test('universe should contain the sent message', async () => {
 
 tap.test('a second client should be able to subscibe', async () => {
   testClientUniverse2 = new smartuniverse.ClientUniverse({
-    serverAddress: testServerData.serverAddress
+    serverAddress: testServerData.serverAddress,
+    autoReconnect: true
   });
 
   testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
+  await testClientUniverse2.start();
 });
 
-tap.test('should receive a message correctly', async () => {});
+tap.test('should receive a message correctly', async tools => {
+  const done = tools.defer();
+  const testChannel = testClientUniverse.getChannel(testChannelData.channelName);
+  const testChannel2 = testClientUniverse2.getChannel(testChannelData.channelName);
+  const subscription = testChannel2.subscribe(messageArg => {
+    if (messageArg.messageText === 'hellothere') {
+      console.log('Yay##########');
+      done.resolve();
+    }
+  });
+  await testChannel.sendMessage({
+    messageText: 'hellothere'
+  });
+  await done.promise;
+});
 
-tap.test('should disconnect the client correctly', async () => {
-  testClientUniverse.stop();
+interface IDemoReqRes {
+  method: 'demo';
+  request: {
+    wowso: string;
+  };
+  response: {
+    hereso: string;
+  };
+}
+
+tap.test('ReactionRequest and ReactionResponse should work', async () => {
+  const reactionResponse = new smartuniverse.ReactionResponse<IDemoReqRes>({
+    channels: [testUniverse.getChannel(testChannelData.channelName)],
+    funcDef: async reqData => {
+      console.log(reqData);
+      return {
+        hereso: 'Hello there'
+      };
+    },
+    method: 'demo'
+  });
+  const reactionRequest = new smartuniverse.ReactionRequest<IDemoReqRes>({
+    method: 'demo'
+  });
+  const reactionResult = await reactionRequest.fire(
+    [testClientUniverse2.getChannel(testChannelData.channelName)],
+    {
+      wowso: 'wowza'
+    }
+  );
+  const result = await reactionResult.getFirstResult();
+  console.log(result);
+});
+
+tap.test('should disconnect the client correctly', async tools => {
+  await testClientUniverse.stop();
+  await testClientUniverse2.stop();
 });
 
 tap.test('should end the server correctly', async tools => {

ts/index.ts

@@ -9,4 +9,8 @@ export * from './smartuniverse.classes.universecache';
 export * from './smartuniverse.classes.universechannel';
 export * from './smartuniverse.classes.universemessage';
 
+// Reaction Response
+export * from './smartuniverse.classes.reactionrequest';
+export * from './smartuniverse.classes.reactionresponse';
+
 export * from './interfaces';

ts/interfaces/index.ts

@@ -1,4 +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

@@ -1,17 +1,3 @@
-export type IServerCallActions =
-  | 'channelSubscription'
-  | 'processMessage'
-  | 'channelUnsubscribe'
-  | 'terminateConnection';
-
-/**
- * the interface for a subscription
- */
-export interface IServerCallSubscribeActionPayload {
-  name: string;
-  passphrase: string;
-}
-
 export interface IServerUnsubscribeActionPayload {
   name: string;
 }

ts/interfaces/universemessage.interfaces.ts

@@ -1,11 +1,10 @@
 export interface IMessageCreator {
   messageText: string;
   payload?: string | number | any;
-  payloadStringType?: 'Buffer' | 'string' | 'object';
 }
 
 /**
- * 
+ * A universe
  */
 export interface IUniverseMessage extends IMessageCreator {
   id: string;

ts/smartuniverse.classes.broadcastevent.ts

@@ -0,0 +1,8 @@
+import * as plugins from './smartuniverse.plugins';
+
+/**
+ * broadcasts an event to multiple channels
+ */
+export class BroadcastEvent<T> {
+  fire() {}
+}

ts/smartuniverse.classes.broadcastsubscription.ts

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

ts/smartuniverse.classes.clientuniverse.ts

@@ -12,6 +12,7 @@ import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache
 
 export interface IClientOptions {
   serverAddress: string;
+  autoReconnect: boolean;
 }
 
 /**
@@ -19,9 +20,9 @@ export interface IClientOptions {
  * allows connecting to a universe server
  */
 export class ClientUniverse {
-  public options;
+  public options: IClientOptions;
   public smartsocketClient: plugins.smartsocket.SmartsocketClient;
-  public observableIntake: plugins.smartrx.ObservableIntake<ClientUniverseMessage>;
+  public messageRxjsSubject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage<any>>();
   public clientUniverseCache = new ClientUniverseCache();
 
   constructor(optionsArg: IClientOptions) {
@@ -32,15 +33,20 @@ 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) {
-    const existingChannel = await this.getChannel(channelNameArg);
+  public addChannel(channelNameArg: string, passphraseArg: string) {
+    const existingChannel = this.getChannel(channelNameArg);
 
     if (existingChannel) {
       throw new Error('channel exists');
     }
 
     // lets create the channel
-    await ClientUniverseChannel.createClientUniverseChannel(this, channelNameArg, passphraseArg);
+    const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(
+      this,
+      channelNameArg,
+      passphraseArg
+    );
+    return clientUniverseChannel;
   }
 
   /**
@@ -48,7 +54,7 @@ export class ClientUniverse {
    * @param channelName
    * @param passphraseArg
    */
-  public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
+  public getChannel(channelName: string): ClientUniverseChannel {
     const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
       return channel.name === channelName;
     });
@@ -60,17 +66,19 @@ export class ClientUniverse {
    * @param messageArg
    */
   public removeChannel(channelNameArg, notifyServer = true) {
-    const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(channelItemArg => {
-      return channelItemArg.name === channelNameArg;
-    });
+    const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
+      channelItemArg => {
+        return channelItemArg.name === channelNameArg;
+      }
+    );
   }
 
   public async start() {
     await this.checkConnection();
   }
 
-  public stop() {
-    this.smartsocketClient.disconnect();
+  public async stop() {
+    await this.disconnect('triggered');
   }
 
   /**
@@ -78,17 +86,23 @@ export class ClientUniverse {
    * since password validation is done through other means, a connection should always be possible
    */
   public async checkConnection(): Promise<void> {
-    if (!this.smartsocketClient && !this.observableIntake) {
+    if (!this.smartsocketClient) {
       const parsedURL = url.parse(this.options.serverAddress);
       const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
-        alias: process.env.SOCKET_ALIAS || 'someclient',
+        alias: 'universeclient',
         password: 'UniverseClient',
         port: parseInt(parsedURL.port, 10),
         role: 'UniverseClient',
         url: parsedURL.protocol + '//' + parsedURL.hostname
       };
       this.smartsocketClient = new SmartsocketClient(socketConfig);
-      this.observableIntake = new plugins.smartrx.ObservableIntake();
+
+      this.smartsocketClient.eventSubject.subscribe(async eventArg => {
+        switch (eventArg) {
+          case 'disconnected':
+            this.disconnect('upstreamEvent');
+        }
+      });
 
       // lets define some basic actions
 
@@ -98,20 +112,44 @@ export class ClientUniverse {
       const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
         funcName: 'unsubscribe',
         allowedRoles: [],
-        funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
-          throw new Error('TODO');
+        funcDef: async (dataArg: interfaces.IServerUnsubscribeActionPayload) => {
+          const channel = this.clientUniverseCache.channelMap.find(channelArg => {
+            return channelArg.name === dataArg.name;
+          });
+          if (channel) {
+            channel.unsubscribe();
+          }
+          return {};
         }
       });
 
       /**
        * handles message reception
        */
-      const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
+      const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<
+        interfaces.ISocketRequest_ProcessMessage
+      >({
         funcName: 'processMessage',
         allowedRoles: [],
-        funcDef: async (messageDescriptorArg: interfaces.IUniverseMessage) => {
+        funcDef: async messageDescriptorArg => {
           plugins.smartlog.defaultLogger.log('info', 'Got message from server');
-          this.observableIntake.push(ClientUniverseMessage.createMessageFromMessageDescriptor(messageDescriptorArg));
+          const clientUniverseMessage = ClientUniverseMessage.createMessageFromMessageDescriptor(
+            messageDescriptorArg
+          );
+          this.messageRxjsSubject.next(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'
+            };
+          }
         }
       });
 
@@ -122,8 +160,24 @@ export class ClientUniverse {
       await this.smartsocketClient.connect();
       plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
       await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
-        await clientUniverseChannelArg.subscribe();
+        await clientUniverseChannelArg.populateSubscriptionToServer();
       });
     }
   }
+
+  public async disconnect(
+    reason: 'upstreamEvent' | 'triggered' = 'triggered',
+    tryReconnect = false
+  ) {
+    if (reason === 'triggered') {
+      const smartsocketToDisconnect = this.smartsocketClient;
+      this.smartsocketClient = null; // making sure the upstreamEvent does  not interfere
+      await smartsocketToDisconnect.disconnect();
+    }
+    if (this.options.autoReconnect && reason === 'upstreamEvent' && this.smartsocketClient) {
+      await plugins.smartdelay.delayForRandom(5000, 20000);
+      this.smartsocketClient = null;
+      this.checkConnection();
+    }
+  }
 }

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -2,6 +2,9 @@ import * as plugins from './smartuniverse.plugins';
 import * as interfaces from './interfaces';
 
 import { ClientUniverse } from './';
+import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
+import { ReactionRequest } from './smartuniverse.classes.reactionrequest';
+import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
 
 export class ClientUniverseChannel implements interfaces.IUniverseChannel {
   // ======
@@ -13,11 +16,11 @@ 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> {
+  ): ClientUniverseChannel {
     const clientChannel = new ClientUniverseChannel(
       clientUniverseArg,
       channelNameArg,
@@ -34,6 +37,8 @@ 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<ClientUniverseMessage<any>>();
 
   // refs
   public clientUniverseRef: ClientUniverse;
@@ -48,13 +53,34 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
    * subscribes to a channel
    * tells the universe about this instances interest into a channel
    */
-  public async subscribe() {
-    const serverCallActionName: interfaces.IServerCallActions = 'channelSubscription';
-    const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
-      name: this.name,
-      passphrase: this.passphrase
-    };
-    await this.clientUniverseRef.smartsocketClient.serverCall(serverCallActionName, serverCallActionPayload);
+  public subscribe(observingFunctionArg: (messageArg: ClientUniverseMessage<any>) => void) {
+    return this.subject.subscribe(
+      messageArg => {
+        observingFunctionArg(messageArg);
+      },
+      error => console.log(error)
+    );
+  }
+
+  public unsubscribe() {
+    // TODO: unsubscribe all users
+  }
+
+  public async populateSubscriptionToServer() {
+    // 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;
+    }
+  }
+
+  public async emitMessageLocally(messageArg: ClientUniverseMessage<any>) {
+    this.subject.next(messageArg);
   }
 
   /**
@@ -69,9 +95,11 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
       passphrase: this.passphrase,
       targetChannelName: this.name,
       messageText: messageArg.messageText,
-      payload: messageArg.payload,
-      payloadStringType: messageArg.payloadStringType
+      payload: messageArg.payload
     };
-    await this.clientUniverseRef.smartsocketClient.serverCall('processMessage', universeMessageToSend);
+    await this.clientUniverseRef.smartsocketClient.serverCall(
+      'processMessage',
+      universeMessageToSend
+    );
   }
 }

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -2,7 +2,7 @@ import * as plugins from './smartuniverse.plugins';
 
 import * as interfaces from './interfaces';
 
-export class ClientUniverseMessage implements interfaces.IUniverseMessage {
+export class ClientUniverseMessage<T> implements interfaces.IUniverseMessage {
   // ======
   // STATIC
   // ======
@@ -22,8 +22,7 @@ export class ClientUniverseMessage implements interfaces.IUniverseMessage {
   public smartTimestamp: plugins.smarttime.TimeStamp;
   public messageText: string;
   public passphrase: string;
-  public payload: any;
-  public payloadStringType;
+  public payload: T;
   public targetChannelName: string;
 
   constructor(messageArg: interfaces.IUniverseMessage) {

ts/smartuniverse.classes.reactionrequest.ts

@@ -0,0 +1,83 @@
+import * as plugins from './smartuniverse.plugins';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
+import { ReactionResult } from './smartuniverse.classes.reactionresult';
+import { UniverseMessage } from './smartuniverse.classes.universemessage';
+import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
+
+export interface IReactionRequestConstructorOptions<
+  T extends plugins.typedrequestInterfaces.ITypedRequest
+> {
+  method: T['method'];
+}
+
+export interface ICombinatorPayload<T extends plugins.typedrequestInterfaces.ITypedRequest> {
+  /**
+   * needed for tying responses to requests
+   */
+  id: string;
+  typedRequestPayload: {
+    method: T['method'];
+    request: T['request'];
+    response: T['response'];
+  };
+}
+
+export class ReactionRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
+  public method: T['method'];
+
+  constructor(optionsArg: IReactionRequestConstructorOptions<T>) {
+    this.method = optionsArg.method;
+  }
+
+  public async fire(
+    channelsArg: Array<UniverseChannel | ClientUniverseChannel>,
+    requestDataArg: T['request'],
+    timeoutMillisArg = 5000
+  ) {
+    const subscriptionMap = new plugins.lik.Objectmap<plugins.smartrx.rxjs.Subscription>();
+    const reactionResult = new ReactionResult<T>();
+    const requestId = plugins.smartunique.shortId();
+    for (const channel of channelsArg) {
+      subscriptionMap.add(
+        channel.subscribe(
+          (
+            messageArg:
+              | UniverseMessage<ICombinatorPayload<T>>
+              | ClientUniverseMessage<ICombinatorPayload<T>>
+          ) => {
+            if (
+              messageArg.messageText === 'reactionResponse' &&
+              messageArg.payload.typedRequestPayload.method === this.method
+            ) {
+              const payload: ICombinatorPayload<T> = messageArg.payload;
+              if (payload.id !== requestId) {
+                return;
+              }
+              reactionResult.pushReactionResponse(payload.typedRequestPayload.response);
+            }
+          }
+        )
+      );
+      const payload: ICombinatorPayload<T> = {
+        id: requestId,
+        typedRequestPayload: {
+          method: this.method,
+          request: requestDataArg,
+          response: null
+        }
+      };
+      channel.sendMessage({
+        messageText: 'reactionRequest',
+        payload
+      });
+    }
+    plugins.smartdelay.delayFor(timeoutMillisArg).then(async () => {
+      await subscriptionMap.forEach(subscriptionArg => {
+        subscriptionArg.unsubscribe();
+      });
+      reactionResult.complete();
+    });
+    return reactionResult;
+  }
+}

ts/smartuniverse.classes.reactionresponse.ts

@@ -0,0 +1,63 @@
+import * as plugins from './smartuniverse.plugins';
+
+import { ICombinatorPayload } from './smartuniverse.classes.reactionrequest';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
+import { UniverseMessage } from './smartuniverse.classes.universemessage';
+import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
+
+export type TReactionResponseFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
+  dataArg: T['request']
+) => Promise<T['response']>;
+
+export interface IReactionResponseConstructorOptions<
+  T extends plugins.typedrequestInterfaces.ITypedRequest
+> {
+  method: T['method'];
+  channels: Array<UniverseChannel | ClientUniverseChannel>;
+  funcDef: TReactionResponseFuncDef<T>;
+}
+
+export class ReactionResponse<T extends plugins.typedrequestInterfaces.ITypedRequest> {
+  public method: T['method'];
+  public channels = new plugins.lik.Objectmap<UniverseChannel | ClientUniverseChannel>();
+  public funcDef: TReactionResponseFuncDef<T>;
+
+  constructor(optionsArg: IReactionResponseConstructorOptions<T>) {
+    this.method = optionsArg.method;
+    this.channels.addArray(optionsArg.channels);
+    this.funcDef = optionsArg.funcDef;
+    for (const channel of this.channels.getArray()) {
+      channel.subscribe(messageArg => {
+        this.processMessageForReaction(channel, messageArg);
+      });
+    }
+  }
+
+  private async processMessageForReaction(
+    channelArg: UniverseChannel | ClientUniverseChannel,
+    messageArg:
+      | UniverseMessage<ICombinatorPayload<T>>
+      | ClientUniverseMessage<ICombinatorPayload<T>>
+  ) {
+    if (
+      messageArg.messageText === 'reactionRequest' &&
+      messageArg.payload.typedRequestPayload.method === this.method
+    ) {
+      const response: T['response'] = await this.funcDef(
+        messageArg.payload.typedRequestPayload.request
+      );
+      const payload: ICombinatorPayload<T> = {
+        ...messageArg.payload,
+        typedRequestPayload: {
+          ...messageArg.payload.typedRequestPayload,
+          response
+        }
+      };
+      channelArg.sendMessage({
+        messageText: 'reactionResponse',
+        payload
+      });
+    }
+  }
+}

ts/smartuniverse.classes.reactionresult.ts

@@ -0,0 +1,52 @@
+import * as plugins from './smartuniverse.plugins';
+import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
+
+export class ReactionResult<T extends plugins.typedrequestInterfaces.ITypedRequest> {
+  private resultReplaySubject = new plugins.smartrx.rxjs.ReplaySubject<T['response']>();
+  private endResult: Array<T['response']> = [];
+  private completeDeferred = plugins.smartpromise.defer<Array<T['response']>>();
+
+  constructor() {
+    this.resultSubscribe(responseArg => {
+      this.endResult.push(responseArg);
+    });
+  }
+
+  public resultSubscribe(observerArg: (responseArg: T['response']) => void) {
+    return this.resultReplaySubject.subscribe(observerArg);
+  }
+
+  /**
+   * gets the end result as an array of all results
+   */
+  public async getEndResult() {
+    const result = await this.completeDeferred.promise;
+    return result;
+  }
+
+  /**
+   * if there is a single respondant, or you are only interested in the first result
+   */
+  public async getFirstResult() {
+    const done = plugins.smartpromise.defer<T['response']>();
+    const subscription = this.resultReplaySubject.subscribe(result => {
+      done.resolve(result);
+      subscription.unsubscribe();
+    });
+    return await done.promise;
+  }
+
+  /**
+   * push a reactionResponse
+   */
+  public async pushReactionResponse(responseArg: T['response']) {
+    this.resultReplaySubject.next(responseArg);
+  }
+
+  /**
+   * completes the ReactionResult
+   */
+  public async complete() {
+    this.completeDeferred.resolve(this.endResult);
+  }
+}

ts/smartuniverse.classes.universe.ts

@@ -10,6 +10,7 @@ import { UniverseConnection } from './smartuniverse.classes.universeconnection';
 
 export interface ISmartUniverseConstructorOptions {
   messageExpiryInMilliseconds: number;
+  externalServer?: plugins.smartexpress.Server;
 }
 
 /**
@@ -59,8 +60,18 @@ export class Universe {
   /**
    * adds a channel to the Universe
    */
-  public async addChannel(nameArg: string, passphraseArg: string) {
+  public addChannel(nameArg: string, passphraseArg: string) {
     const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
+    return newChannel;
+  }
+
+  /**
+   * returns a channel
+   */
+  public getChannel(channelNameArg: string) {
+    return this.universeCache.channelMap.find(channelArg => {
+      return channelArg.name === channelNameArg;
+    });
   }
 
   /**
@@ -68,14 +79,19 @@ export class Universe {
    */
   public async start(portArg: number) {
     // lets create the base smartexpress server
-    this.smartexpressServer = new plugins.smartexpress.Server({
-      cors: true,
-      defaultAnswer: async () => {
-        return `smartuniverse server ${this.getUniverseVersion()}`;
-      },
-      forceSsl: false,
-      port: portArg
-    });
+    if (!this.options.externalServer) {
+      this.smartexpressServer = new plugins.smartexpress.Server({
+        cors: true,
+        defaultAnswer: async () => {
+          return `smartuniverse server ${this.getUniverseVersion()}`;
+        },
+        forceSsl: false,
+        port: portArg
+      });
+    } else {
+      console.log('Universe is using externally supplied server');
+      this.smartexpressServer = this.options.externalServer;
+    }
 
     // add websocket upgrade
     this.smartsocket = new plugins.smartsocket.Smartsocket({});
@@ -89,24 +105,21 @@ export class Universe {
     // add the role to smartsocket
     this.smartsocket.addSocketRoles([ClientRole]);
 
-    const socketFunctionSubscription = new plugins.smartsocket.SocketFunction({
+    const socketFunctionSubscription = new plugins.smartsocket.SocketFunction<
+      interfaces.ISocketRequest_SubscribeChannel
+    >({
       allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
-      funcName: 'channelSubscription',
-      funcDef: async (
-        dataArg: interfaces.IServerCallSubscribeActionPayload,
-        socketConnectionArg
-      ) => {
-        // run in "this context" of this class
-        await (async () => {
-          const universeConnection = new UniverseConnection({
-            socketConnection: socketConnectionArg,
-            authenticationRequests: [dataArg]
-          });
-          await UniverseConnection.addConnectionToCache(this, universeConnection);
-          return {
-            'subscription status': 'success'
-          };
-        })();
+      funcName: 'subscribeChannel',
+      funcDef: async (dataArg, socketConnectionArg) => {
+        const universeConnection = new UniverseConnection({
+          universe: this,
+          socketConnection: socketConnectionArg,
+          authenticationRequests: [dataArg]
+        });
+        await UniverseConnection.addConnectionToCache(this, universeConnection);
+        return {
+          subscriptionStatus: 'subscribed'
+        };
       }
     });
 
@@ -114,30 +127,36 @@ export class Universe {
       allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
       funcName: 'processMessage',
       funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
-        // run in "this" context of this class
-        await (async () => {
-          const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
-            this.universeCache,
-            socketConnectionArg
+        const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
+          this.universeCache,
+          socketConnectionArg
+        );
+        if (universeConnection) {
+          plugins.smartlog.defaultLogger.log(
+            'ok',
+            'found UniverseConnection for socket for incoming message'
           );
-          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
+        } else {
+          plugins.smartlog.defaultLogger.log(
+            'warn',
+            'found no Authorized channel for incoming message'
           );
-          if (foundChannel && unauthenticatedMessage.authenticated) {
-            const authenticatedMessage = unauthenticatedMessage;
-            await this.universeCache.addMessage(authenticatedMessage);
-          }
-        })();
+          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);
+        }
       }
     });
 
@@ -145,10 +164,13 @@ export class Universe {
     this.smartsocket.addSocketFunction(socketFunctionSubscription);
     this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
 
+    // start the server
+    if (!this.options.externalServer) {
+      await this.smartexpressServer.start();
+    }
+
     // add smartsocket to the running smartexpress app
-    this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer as any);
-    // start everything
-    await this.smartexpressServer.start();
+    await this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer);
     await this.smartsocket.start();
     plugins.smartlog.defaultLogger.log('success', 'started universe');
   }
@@ -158,6 +180,8 @@ export class Universe {
    */
   public async stopServer() {
     await this.smartsocket.stop();
-    await this.smartexpressServer.stop();
+    if (!this.options.externalServer) {
+      await this.smartexpressServer.stop();
+    }
   }
 }

ts/smartuniverse.classes.universecache.ts

@@ -19,12 +19,12 @@ export class UniverseCache {
   // INSTANCE
   // ========
   public standardMessageExpiry: number;
-  public destructionTime: number = 60000;
+  public destructionTime: number = 10000;
 
   /**
    * stores messages for this instance
    */
-  public messageMap = new Objectmap<UniverseMessage>();
+  public messageMap = new Objectmap<UniverseMessage<any>>();
 
   /**
    * stores the channels that are available within the universe
@@ -54,12 +54,12 @@ export class UniverseCache {
    * @param messageArg
    * @param attachedPayloadArg
    */
-  public async addMessage(messageArg: UniverseMessage) {
+  public async addMessage(messageArg: UniverseMessage<any>) {
     messageArg.setUniverseCache(this);
     UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
     this.messageMap.add(messageArg);
     messageArg.universeChannelList.forEach(universeChannel => {
-      universeChannel.pushToClients(messageArg);
+      universeChannel.push(messageArg);
     });
   }
 
@@ -69,7 +69,7 @@ export class UniverseCache {
   public readMessagesYoungerThan(
     unixTimeArg?: number,
     channelName?: string
-  ): Observable<UniverseMessage> {
+  ): Observable<UniverseMessage<any>> {
     const messageObservable = from(this.messageMap.getArray()).pipe(
       filter(messageArg => {
         return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);

ts/smartuniverse.classes.universechannel.ts

@@ -52,7 +52,7 @@ export class UniverseChannel {
    */
   public static authorizeAMessageForAChannel(
     universeCacheArg: UniverseCache,
-    universeMessageArg: UniverseMessage
+    universeMessageArg: UniverseMessage<any>
   ): UniverseChannel {
     const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
       const result = universeChannel.authenticate(universeMessageArg);
@@ -85,6 +85,7 @@ export class UniverseChannel {
    */
   public name: string;
   public universeRef: Universe;
+  private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage<any>>();
 
   /**
    * the passphrase for the channel
@@ -102,7 +103,7 @@ export class UniverseChannel {
    * # the messages channelName against the unverseChannel's name
    * # the messages password against the universeChannel's password
    */
-  public authenticate(universeMessageArg: UniverseMessage): boolean {
+  public authenticate(universeMessageArg: UniverseMessage<any>): boolean {
     return (
       this.name === universeMessageArg.targetChannelName &&
       this.passphrase === universeMessageArg.passphrase
@@ -113,25 +114,55 @@ export class UniverseChannel {
    * pushes a message to clients
    * @param messageArg
    */
-  public async pushToClients(messageArg: UniverseMessage) {
+  public async push(messageArg: UniverseMessage<any>) {
+    this.subject.next(messageArg);
     const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
-    this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
+    await 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 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
+        payload: messageArg.payload
       };
-      smartsocket.clientCall('processMessage', universeMessageToSend, universeConnection.socketConnection);
+      smartsocket.clientCall(
+        'processMessage',
+        universeMessageToSend,
+        universeConnection.socketConnection
+      );
     }
   }
+
+  // functions to interact with a channel locally
+  public subscribe(observingFunctionArg: (messageArg: UniverseMessage<any>) => void) {
+    return this.subject.subscribe(
+      messageArg => {
+        observingFunctionArg(messageArg);
+      },
+      error => console.log(error)
+    );
+  }
+
+  /**
+   * sends a message to the channel
+   */
+  public async sendMessage(messageDescriptor: interfaces.IMessageCreator) {
+    const messageToSend = new UniverseMessage({
+      id: plugins.smartunique.shortId(),
+      messageText: messageDescriptor.messageText,
+      payload: messageDescriptor.payload,
+      targetChannelName: this.name,
+      passphrase: this.passphrase,
+      timestamp: Date.now()
+    });
+    this.universeRef.universeCache.addMessage(messageToSend);
+  }
 }

ts/smartuniverse.classes.universeconnection.ts

@@ -26,6 +26,7 @@ export class UniverseConnection {
       universeConnection
     );
     universeRef.universeCache.connectionMap.add(universeConnection);
+    console.log('hi');
   }
 
   /**
@@ -58,7 +59,10 @@ export class UniverseConnection {
     universeConnectionArg: UniverseConnection
   ): Promise<UniverseConnection> {
     for (const authenticationRequest of universeConnectionArg.authenticationRequests) {
-      const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(universeRef, authenticationRequest.name);
+      const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(
+        universeRef,
+        authenticationRequest.name
+      );
       if (universeChannelToAuthenticateAgainst.passphrase === authenticationRequest.passphrase) {
         universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst);
       }
@@ -89,30 +93,43 @@ export class UniverseConnection {
     return universeConnection;
   }
 
+  // INSTANCE
+  public universeRef: Universe;
   public terminatedDeferred = plugins.smartpromise.defer();
 
   /**
    * the socketClient to ping
    */
   public socketConnection: plugins.smartsocket.SocketConnection;
-  public authenticationRequests: interfaces.IServerCallSubscribeActionPayload[] = [];
-  public subscribedChannels: UniverseChannel[] = [];
+  public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
   public authenticatedChannels: UniverseChannel[] = [];
   public failedToJoinChannels: UniverseChannel[] = [];
 
   /**
-   * terminates the connection
+   * disconnect the connection
    */
-  public terminateConnection() {
-    this.socketConnection.socket.disconnect();
+  public async disconnect(reason: 'upstreamevent' | 'triggered' = 'triggered') {
+    if (reason === 'triggered') {
+      await this.socketConnection.disconnect();
+    }
+    this.universeRef.universeCache.connectionMap.remove(this);
     this.terminatedDeferred.resolve();
   }
 
   constructor(optionsArg: {
+    universe: Universe;
     socketConnection: plugins.smartsocket.SocketConnection;
-    authenticationRequests: interfaces.IServerCallSubscribeActionPayload[];
+    authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
   }) {
+    this.universeRef = optionsArg.universe;
     this.authenticationRequests = optionsArg.authenticationRequests;
     this.socketConnection = optionsArg.socketConnection;
+    this.socketConnection.eventSubject.subscribe(async eventArg => {
+      switch (eventArg) {
+        case 'disconnected':
+          await this.disconnect('upstreamevent');
+          break;
+      }
+    });
   }
 }

ts/smartuniverse.classes.universemessage.ts

@@ -13,8 +13,11 @@ 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) {
+export class UniverseMessage<T> implements interfaces.IUniverseMessage {
+  public static createMessageFromPayload(
+    socketConnectionArg: SocketConnection,
+    dataArg: interfaces.IUniverseMessage
+  ) {
     const universeMessageInstance = new UniverseMessage(dataArg);
     universeMessageInstance.socketConnection = socketConnectionArg;
     return universeMessageInstance;
@@ -25,8 +28,7 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
   public smartTimestamp: TimeStamp;
   public messageText: string;
   public passphrase: string;
-  public payload: any;
-  public payloadStringType;
+  public payload: T;
   public targetChannelName: string;
   public socketConnection: SocketConnection;
 
@@ -62,28 +64,34 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
     this.passphrase = messageDescriptor.passphrase;
     this.payload = messageDescriptor.payload;
     // prevent memory issues
-    this.fallBackDestruction();
+    this.setDestructionTimer();
   }
 
   public setUniverseCache(universeCacheArg: UniverseCache) {
     this.universeCache = universeCacheArg;
   }
 
-  public setTargetChannel() {
+  public setTargetChannel() {}
 
-  }
-
-  public setDestructionTimer(selfdestructAfterArg: number) {
+  public setDestructionTimer(selfdestructAfterArg?: number) {
     if (selfdestructAfterArg) {
       this.destructionTimer = new Timer(selfdestructAfterArg);
       this.destructionTimer.start();
-
       // set up self destruction by removing this from the parent messageCache
-      this.destructionTimer.completed.then(async () => {
-        this.universeCache.messageMap.remove(this);
-      });
+      this.destructionTimer.completed
+        .then(async () => {
+          this.universeCache.messageMap.remove(this);
+        })
+        .catch(err => {
+          console.log(err);
+          console.log(this);
+        });
     } else {
-      this.fallBackDestruction();
+      plugins.smartdelay.delayFor(1000).then(() => {
+        if (!this.destructionTimer) {
+          this.setDestructionTimer(6000);
+        }
+      });
     }
   }
 
@@ -93,15 +101,4 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
   public handleAsBadMessage() {
     plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
   }
-
-  /**
-   * prevents memory leaks if channels have no default
-   */
-  private fallBackDestruction() {
-    plugins.smartdelay.delayFor(1000).then(() => {
-      if (!this.destructionTimer) {
-        this.setDestructionTimer(6000);
-      }
-    });
-  }
 }

ts/smartuniverse.plugins.ts

@@ -3,6 +3,11 @@ import * as path from 'path';
 
 export { path };
 
+// apiglobal scope
+import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
+
+export { typedrequestInterfaces };
+
 // pushrocks scope
 import * as lik from '@pushrocks/lik';
 import * as smarthash from '@pushrocks/smarthash';