1.0.23

.gitlab-ci.yml

@@ -3,7 +3,7 @@ image: hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
@@ -26,8 +26,8 @@ mirror:
 snyk:
   stage: security
   script:
-    - npmci command yarn global add snyk
+    - npmci command npm install -g snyk
-    - npmci command yarn install --ignore-scripts
+    - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
   - docker
@@ -117,7 +117,7 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command yarn global add npmpage
+    - npmci command npm install -g npmpage
     - npmci command npmpage
   tags:
     - docker

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.16",
+  "version": "1.0.23",
+  "private": true,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -12,14 +13,17 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@types/node": "^9.6.0",
+    "@types/node": "^9.6.18",
-    "tapbundle": "^2.0.0"
+    "tapbundle": "^2.0.0",
+    "ts-node": "^6.0.5",
+    "typescript": "^2.8.3"
+  },
+  "peerDependencies": {
+    "rxjs": "*"
   },
   "dependencies": {
     "lik": "^2.0.5",
     "nodehash": "^1.0.4",
-    "rxjs": "^5.5.8",
-    "smartcli": "^2.0.12",
     "smartdelay": "^1.0.4",
     "smartexpress": "^1.0.21",
     "smartfile": "^4.2.28",

test/test.ts

@@ -5,8 +5,8 @@ import * as smartuniverse from '../ts/index';
 import { Observable } from 'rxjs';
 
 let testUniverse: smartuniverse.Universe;
-let testUniverseClient: smartuniverse.UniverseClient;
+let testUniverseClient: smartuniverse.ClientUniverse;
-let testMessageObservable: Observable<smartuniverse.UniverseMessage>;
+let testClientChannel: smartuniverse.ClientUniverseChannel;
 
 tap.test('first test', async () => {
   testUniverse = new smartuniverse.Universe({
@@ -20,10 +20,19 @@ tap.test('add a message to the SmartUniverse', async () => {
 
 // testing message handling
 tap.test('create smartuniverse client', async () => {
-  testUniverseClient = new smartuniverse.UniverseClient({
+  testUniverseClient = new smartuniverse.ClientUniverse({
     serverAddress: 'http://localhost:8765'
   });
-  expect(testUniverseClient).to.be.instanceof(smartuniverse.UniverseClient);
+  expect(testUniverseClient).to.be.instanceof(smartuniverse.ClientUniverse);
+});
+
+tap.test('should add a channel to the universe', async () => {
+  await testUniverse.addChannel('testChannel', 'testPassword');
+});
+
+tap.test('should get a observable correctly', async () => {
+  testClientChannel = await testUniverseClient.getChannel('testChannel');
+  expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
 });
 
 tap.test('should send a message correctly', async () => {
@@ -32,10 +41,6 @@ tap.test('should send a message correctly', async () => {
   });
 });
 
-tap.test('should get a observable correctly', async () => {
-  testMessageObservable = testUniverseClient.getMessageObservable();
-});
-
 tap.test('should receive a message correctly', async () => {});
 
 tap.test('should disconnect the client correctly', async () => {

ts/index.ts

@@ -1,3 +1,10 @@
+// Client classes
+export * from './smartuniverse.classes.clientuniverse';
+export * from './smartuniverse.classes.clientuniversechannel';
+
+// Server classes
 export * from './smartuniverse.classes.universe';
-export * from './smartuniverse.classes.universeclient';
+export * from './smartuniverse.classes.universecache';
+export * from './smartuniverse.classes.universechannel';
 export * from './smartuniverse.classes.universemessage';
+export * from './smartuniverse.interfaces';

ts/smartuniverse.classes.clientuniverse.ts

@@ -1,14 +1,16 @@
 import * as plugins from './smartuniverse.plugins';
 
+import { Objectmap } from 'lik';
 import { Observable } from 'rxjs';
 import { Smartsocket, SmartsocketClient } from 'smartsocket';
 import * as url from 'url';
 
 import {
+  ClientUniverseChannel,
   IServerGetMessagesRequestBody,
-  IServerPutMessageRequestBody
+  IServerPutMessageRequestBody,
-} from './smartuniverse.classes.universe';
+  UniverseMessage
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
+} from './';
 
 export interface IClientOptions {
   serverAddress: string;
@@ -18,10 +20,12 @@ export interface IClientOptions {
  * this class is for client side only!!!
  * allows connecting to a universe server
  */
-export class UniverseClient {
+export class ClientUniverse {
   public options;
-  private socketClient: plugins.smartsocket.SmartsocketClient;
+  public socketClient: plugins.smartsocket.SmartsocketClient;
-  private observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
+  public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
+
+  public channelCache = new Objectmap<ClientUniverseChannel>();
 
   constructor(optionsArg: IClientOptions) {
     this.options = optionsArg;
@@ -38,7 +42,21 @@ export class UniverseClient {
     });
   }
 
-  public getMessageObservable() {
+  public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
+    await this.checkConnection();
+    const clientUniverseChannel = await ClientUniverseChannel.createClientUniverseChannel(
+      this,
+      channelName
+    );
+    this.channelCache.add(clientUniverseChannel);
+    return clientUniverseChannel;
+  }
+
+  public close() {
+    this.socketClient.disconnect();
+  }
+
+  private async checkConnection() {
     if (!this.socketClient && !this.observableIntake) {
       const parsedURL = url.parse(this.options.serverAddress);
       this.socketClient = new SmartsocketClient({
@@ -51,10 +69,5 @@ export class UniverseClient {
       this.observableIntake = new plugins.smartrx.ObservableIntake();
       this.socketClient.connect();
     }
-    return this.observableIntake.observable;
-  }
-
-  public close() {
-    this.socketClient.disconnect();
   }
 }

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -0,0 +1,34 @@
+import * as plugins from './smartuniverse.plugins';
+
+import { ClientUniverse, IUniverseChannel } from './';
+
+export class ClientUniverseChannel implements IUniverseChannel {
+  // ======
+  // STATIC
+  // ======
+  public static async createClientUniverseChannel(
+    clientUniverseArg: ClientUniverse,
+    channelName: string
+  ): Promise<ClientUniverseChannel> {
+    const clientChannel = new ClientUniverseChannel(clientUniverseArg);
+    await clientChannel.transmitSubscription();
+    return clientChannel;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+
+  public clientUniverse: ClientUniverse;
+
+  constructor(clientUniverseArg: ClientUniverse) {
+    this.clientUniverse = clientUniverseArg;
+  }
+
+  /**
+   * tells the universe about this instances interest into a channel
+   */
+  public async transmitSubscription() {
+    this.clientUniverse.socketClient;
+  }
+}

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -0,0 +1,15 @@
+import * as plugins from './smartuniverse.plugins';
+
+import { IUniverseMessage } from './';
+
+export class ClientUniverseMessage implements IUniverseMessage {
+  // ======
+  // STATIC
+  // ======
+  createMessage(messageArg: string, payloadArg: any) {}
+
+  // ========
+  // INSTANCE
+  // ========
+  constructor(messageArg, payloadArg) {}
+}

ts/smartuniverse.classes.universe.ts

@@ -1,9 +1,7 @@
 import * as plugins from './smartuniverse.plugins';
 
 import { Handler, Route, Server } from 'smartexpress';
-import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { UniverseCache, UniverseChannel, UniverseMessage } from './';
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
-import { UniverseStore } from './smartuniverse.classes.universestore';
 
 import * as paths from './smartuniverse.paths';
 
@@ -17,6 +15,9 @@ export interface IServerGetMessagesRequestBody {
   youngerThan: number;
 }
 
+/**
+ * the interface for a standard request
+ */
 export interface IServerPutMessageRequestBody {
   channel: string;
   passphrase: string;
@@ -24,9 +25,12 @@ export interface IServerPutMessageRequestBody {
   payload: any;
 }
 
+/**
+ * main class that setsup a Universe
+ */
 export class Universe {
   // subinstances
-  public universeStore: UniverseStore;
+  public universeCache: UniverseCache;
 
   // options
   private options: ISmartUniverseConstructorOptions;
@@ -48,7 +52,15 @@ export class Universe {
 
   constructor(optionsArg: ISmartUniverseConstructorOptions) {
     this.options = optionsArg;
-    this.universeStore = new UniverseStore(this.options.messageExpiryInMilliseconds);
+    this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
+  }
+
+  /**
+   * adds a channel to the Universe
+   */
+  public async addChannel(nameArg: string, passphraseArg: string) {
+    const newChannel = new UniverseChannel(this.universeCache, nameArg, passphraseArg);
+    this.universeCache.channelMap.add(newChannel);
   }
 
   /**
@@ -62,45 +74,26 @@ export class Universe {
       port: portArg
     });
 
-    // message handling
-    // adds messages
-    const addMessageHandler = new Handler('PUT', request => {
-      const requestBody: IServerPutMessageRequestBody = request.body;
-      const message = new UniverseMessage(
-        requestBody.message,
-        requestBody.payload,
-        
-      )
-      this.universeStore.addMessage(message);
-      console.log(requestBody);
-      return true;
-    });
-
-    // gets messages
-    const readMessageHandler = new Handler('GET', request => {
-      const done = plugins.smartq.defer<UniverseMessage[]>();
-      const requestBody = request.body;
-      const messageObservable = this.universeStore.readMessagesYoungerThan(requestBody.since);
-      messageObservable.toArray().subscribe(universeMessageArrayArg => {
-        done.resolve(universeMessageArrayArg);
-      });
-      return done.promise;
-    });
-
-    // create new Route for messages
-    const messageRoute = new Route(this.smartexpressServer, 'message');
-    messageRoute.addHandler(addMessageHandler);
-    messageRoute.addHandler(readMessageHandler);
-
-    const leaderElectionRoute = new Route(this.smartexpressServer, 'leadelection');
-    // TODO: implement Handlers for leader election
-
     // add websocket upgrade
     this.smartsocket = new plugins.smartsocket.Smartsocket({
       port: 12345 // fix this within smartsocket
     });
 
-    this.smartsocket.setExternalServer('express', this.smartexpressServer as any); // should work with express as well
+    const ClientRole = new plugins.smartsocket.SocketRole({
+      name: 'clientuniverse',
+      passwordHash: 'clientuniverse' // authentication happens on another level
+    });
+
+    this.smartsocket.addSocketRoles([ClientRole]);
+
+    const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
+      allowedRoles: [ClientRole],
+      funcName: 'channelSubscription',
+      funcDef: () => {}
+    });
+
+    this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
+    // should work with express as well
     this.smartsocket.start();
 
     await this.smartexpressServer.start();

ts/smartuniverse.classes.universecache.ts

@@ -1,5 +1,6 @@
 import * as plugins from './smartuniverse.plugins';
 
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
 import { UniverseMessage } from './smartuniverse.classes.universemessage';
 
 import { Objectmap } from 'lik';
@@ -10,11 +11,27 @@ import { rxjs } from 'smartrx';
 /**
  * universe store handles the creation, storage and retrieval of messages.
  */
-export class UniverseStore {
+export class UniverseCache {
+  // ========
+  // INSTANCE
+  // ========
   public standardMessageExpiry: number;
   public destructionTime: number = 60000;
-  public messageStore = new Objectmap<UniverseMessage>();
+
-  private lastId: number = 0; // stores the last id
+  /**
+   * stores messages for this instance
+   */
+  public messageMap = new Objectmap<UniverseMessage>();
+
+  /**
+   * stores the channels that are available within the universe
+   */
+  public channelMap = new Objectmap<UniverseChannel>();
+
+  /**
+   * allows messages to be processed in a blacklist mode for further analysis
+   */
+  public blackListChannel = new UniverseChannel(this, 'blacklist', 'nada');
 
   constructor(standardMessageExpiryArg: number) {
     this.standardMessageExpiry = standardMessageExpiryArg;
@@ -25,15 +42,17 @@ export class UniverseStore {
    * @param messageArg
    * @param attachedPayloadArg
    */
-  public addMessage(messageArg: UniverseMessage) {
+  public async addMessage(messageArg: UniverseMessage) {
-    this.messageStore.add(messageArg);
+    messageArg.setUniverseCache(this);
+    UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
+    this.messageMap.add(messageArg);
   }
 
   /**
    * Read a message from the UniverseStore
    */
   public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
-    const messageObservable = rxjs.Observable.from(this.messageStore.getArray()).filter(
+    const messageObservable = rxjs.Observable.from(this.messageMap.getArray()).filter(
       messageArg => {
         return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
       }

ts/smartuniverse.classes.universechannel.ts

@@ -1,46 +1,91 @@
 import * as plugins from './smartuniverse.plugins';
 
 import { Objectmap } from 'lik';
+import { UniverseCache } from './smartuniverse.classes.universecache';
+import { UniverseMessage } from './smartuniverse.classes.universemessage';
 
 /**
  * enables messages to stay within a certain scope.
  */
 export class UniverseChannel {
-  /**
+  // ======
-   * stores the channels that are available within the universe
+  // STATIC
-   */
+  // ======
-  public static channelStore = new Objectmap();
+
-  
   /**
    * creates new channels
    * @param channelArg the name of the topic
    * @param passphraseArg the secret thats used for a certain topic.
    */
-  public static createChannel = (channelNameArg: string, passphraseArg: string) => {
+  public static createChannel(
-    const newChannel = new UniverseChannel(channelNameArg, passphraseArg);
+    universeCacheArg: UniverseCache,
+    channelNameArg: string,
+    passphraseArg: string
+  ) {
+    const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
     return newChannel;
   }
-  
+
+  /**
+   * returns boolean wether certain channel exists
+   */
+  public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
+    const channel = universeCacheArg.channelMap.find(channelArg => {
+      return channelArg.name === channelNameArg;
+    });
+    if (channel) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  public static authorizeAMessageForAChannel(
+    universeCacheArg: UniverseCache,
+    universeMessageArg: UniverseMessage
+  ) {
+    const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
+      const result = universeChannel.authenticate(universeMessageArg);
+      return result;
+    });
+    if (foundChannel) {
+      universeMessageArg.authenticated = true;
+      universeMessageArg.universeChannelList.add(foundChannel);
+      return foundChannel;
+    } else {
+      universeMessageArg.authenticated = false;
+      universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
+    }
+  }
+
+  // ========
+  // INSTANCE
+  // ========
   /**
    * the name of the channel
    */
   public name: string;
+  public universeCacheInstance: UniverseCache;
 
   /**
    * the passphrase for the channel
    */
   public passphrase: string;
 
-  constructor(channelNameArg: string, passphraseArg: string) {
+  constructor(universeCacheArg: UniverseCache, channelNameArg: string, passphraseArg: string) {
     this.name = channelNameArg;
     this.passphrase = passphraseArg;
-    UniverseChannel.channelStore.add(this);
   }
 
   /**
    * authenticates a client on the server side
    */
-  public async authenticateClient(passphraseArg: string): boolean {
+  public authenticate(universeMessageArg: UniverseMessage): boolean {
-    return passphraseArg === this.passphrase;
+    return (
+      this.name === universeMessageArg.requestedChannelName &&
+      this.passphrase === universeMessageArg.requestedChannelPassphrase
+    );
   }
+
+  public pushToClients(messageArg: UniverseMessage) {}
 }

ts/smartuniverse.classes.universemessage.ts

@@ -1,10 +1,15 @@
 import * as plugins from './smartuniverse.plugins';
 
+import { Objectmap } from 'lik';
+
 import { Timer, TimeStamp } from 'smarttime';
-import { UniverseStore } from './smartuniverse.classes.universestore';
+import { Universe } from './smartuniverse.classes.universe';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { UniverseCache } from './smartuniverse.classes.universecache';
 
 /**
  * represents a message within a universe
+ * acts as a container to save message states like authentication status
  */
 export class UniverseMessage {
   /**
@@ -16,13 +21,25 @@ export class UniverseMessage {
   public id: number;
 
   /**
-   * the universe store the message is attached to
+   * the UniverseCache the message is attached to
    */
-  public universeStore: UniverseStore;
+  public universeCache: UniverseCache;
+
+  /**
+   * requestedChannelName
+   */
+  public requestedChannelName: string;
+  public requestedChannelPassphrase: string;
+
   /**
    * enables unprotected grouping of messages for efficiency purposes.
    */
-  public universeChannel: string;
+  public universeChannelList = new Objectmap<UniverseChannel>();
+
+  /**
+   * wether the message is authenticated
+   */
+  public authenticated: boolean = null;
 
   /**
    * time of creation
@@ -47,37 +64,48 @@ export class UniverseMessage {
    */
   constructor(
     messageArg: string,
+    requestedChannelNameArg: string,
+    passphraseArg: string,
     attachedPayloadArg: any
   ) {
     this.timestamp = new TimeStamp();
     this.message = messageArg;
+    this.requestedChannelName = requestedChannelNameArg;
+    this.requestedChannelPassphrase = passphraseArg;
     this.attachedPayload = attachedPayloadArg;
+    // prevent memory issues
     this.fallBackDestruction();
   }
 
-  public setUniverseStore (universeStoreArg: UniverseStore) {
+  public setUniverseCache(universeCacheArg: UniverseCache) {
-    this.universeStore = universeStoreArg;
+    this.universeCache = universeCacheArg;
   }
 
-  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 messageStore
+      // set up self destruction by removing this from the parent messageCache
       this.destructionTimer.completed.then(async () => {
-        this.universeStore.messageStore.remove(this);
+        this.universeCache.messageMap.remove(this);
       });
     } else {
       this.fallBackDestruction();
     }
-
+  }
-  };
 
   /**
-   * prevents memory leaks if channels have no default 
+   * handles bad messages for further analysis
    */
-  private fallBackDestruction () {
+  handleAsBadMessage() {
+    console.log('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.cli.ts

@@ -1,14 +0,0 @@
-import * as plugins from './smartuniverse.plugins';
-
-import { Universe } from './index';
-
-process.env.CLI = 'true';
-
-const universeCli = new plugins.smartcli.Smartcli();
-
-universeCli.standardTask().then(async argvArg => {
-  const standardUniverse = new Universe({
-    messageExpiryInMilliseconds: 60000
-  });
-  await standardUniverse.initServer(8765);
-});

ts/smartuniverse.interfaces.ts

@@ -0,0 +1,3 @@
+export interface IUniverseChannel {}
+
+export interface IUniverseMessage {}

ts/smartuniverse.plugins.ts

@@ -1,7 +1,6 @@
 import * as lik from 'lik';
 import * as nodehash from 'nodehash';
 import * as path from 'path';
-import * as smartcli from 'smartcli';
 import * as smartdelay from 'smartdelay';
 import * as smartexpress from 'smartexpress';
 import * as smartfile from 'smartfile';
@@ -15,7 +14,6 @@ export {
   lik,
   nodehash,
   path,
-  smartcli,
   smartdelay,
   smartexpress,
   smartfile,