Compare commits

..

18 Commits

Author SHA1 Message Date
a4ad33a0ee 1.0.102 2020-09-30 00:13:15 +00:00
18fad25b8c fix(core): update 2020-09-30 00:13:14 +00:00
82f4413064 1.0.101 2020-09-29 19:39:13 +00:00
71bccf54f1 fix(core): update 2020-09-29 19:39:13 +00:00
78ee8f2592 1.0.100 2020-09-24 18:17:53 +00:00
820ce76fe3 fix(core): update 2020-09-24 18:17:52 +00:00
5d8c2064e0 1.0.99 2020-09-24 18:13:49 +00:00
9d1fc94e06 fix(core): update 2020-09-24 18:13:48 +00:00
c4640a3bc7 1.0.98 2019-11-10 16:55:18 +01:00
b6392ec6ba fix(core): update 2019-11-10 16:55:17 +01:00
bd4897f392 1.0.97 2019-11-09 18:44:34 +01:00
dbdc8a2811 fix(core): update 2019-11-09 18:44:33 +01:00
908d00981b 1.0.96 2019-11-09 14:06:52 +01:00
669ef262d7 fix(core): update 2019-11-09 14:06:51 +01:00
30053fe441 1.0.95 2019-11-09 13:00:30 +01:00
afb4e3339a fix(core): update 2019-11-09 13:00:30 +01:00
e413a8116d 1.0.94 2019-11-09 12:59:51 +01:00
ffeed0565c fix(core): update 2019-11-09 12:59:51 +01:00
27 changed files with 9492 additions and 1069 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds
dist/
dist_web/
dist_serve/
dist_ts_web/
dist_*/
# custom

View File

@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: "$CI_BUILD_STAGE"
key: '$CI_BUILD_STAGE'
stages:
- security
@ -19,20 +19,35 @@ mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
snyk:
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts
- npmci command snyk test
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
- notpriv
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
@ -48,28 +63,27 @@ testStable:
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install lts
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
release:
stage: release
script:
- npmci node install lts
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
@ -79,11 +93,15 @@ release:
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
@ -94,20 +112,20 @@ trigger:
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-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:

26
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

View File

@ -1,5 +1,6 @@
{
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",

9945
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,53 +1,57 @@
{
"name": "@pushrocks/smartuniverse",
"version": "1.0.93",
"version": "1.0.102",
"private": false,
"description": "messaging service for your micro services",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/)",
"testManual": "(tsrun test/test.ts)",
"build": "(tsbuild)",
"build": "(tsbuild --web && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
"format": "(gitzone format)"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.17",
"@gitzone/tstest": "^1.0.28",
"@pushrocks/tapbundle": "^3.0.13",
"@types/node": "^12.12.6",
"tslint": "^5.20.1",
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tstest": "^1.0.48",
"@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^14.11.2",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
},
"peerDependencies": {
"rxjs": "*"
},
"dependencies": {
"@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.21",
"@apiglobal/typedrequest-interfaces": "^1.0.15",
"@pushrocks/lik": "^4.0.17",
"@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartexpress": "^3.0.76",
"@pushrocks/smartfile": "^8.0.0",
"@pushrocks/smarthash": "^2.1.6",
"@pushrocks/smartlog": "^2.0.39",
"@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"
"@pushrocks/smartrequest": "^1.1.51",
"@pushrocks/smartrx": "^2.0.19",
"@pushrocks/smartsocket": "^1.1.63",
"@pushrocks/smarttime": "^3.0.35",
"@pushrocks/smartunique": "^3.0.3"
},
"files": [
"ts/*",
"ts_web/*",
"dist/*",
"dist_web/*",
"dist_ts_web/*",
"assets/*",
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

View File

@ -8,13 +8,20 @@ messaging service for micro services
* [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)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartuniverse/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartuniverse)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartuniverse)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartuniverse)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartuniverse)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartuniverse)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
@ -33,7 +40,7 @@ Think Kafka, but without Kafka.
import * as smartuniverse from '@pushrocks/smartuniverse';
const myUniverse = new smartuniverse.Universe({
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
messageExpiryInMilliseconds: 60000, // the standard time in milliseconds until a message expires
});
// create as many channels as you like
@ -47,6 +54,10 @@ 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)

View File

@ -10,17 +10,17 @@ let testClientUniverse2: smartuniverse.ClientUniverse;
let testClientChannel: smartuniverse.ClientUniverseChannel;
const testServerData = {
serverAddress: 'http://localhost:8765'
serverAddress: 'http://localhost:8765',
};
const testChannelData = {
channelName: 'awesomeTestChannel',
channelPass: 'awesomeChannelPass'
channelPass: 'awesomeChannelPass',
};
tap.test('first test', async () => {
testUniverse = new smartuniverse.Universe({
messageExpiryInMilliseconds: 1000
messageExpiryInMilliseconds: 1000,
});
});
@ -31,7 +31,8 @@ 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);
});
@ -54,8 +55,8 @@ tap.test('should get a observable correctly', async () => {
});
tap.test('should send a message correctly', async () => {
await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
messageText: 'hello'
await testClientUniverse.getChannel(testChannelData.channelName).postMessage({
messageText: 'hello',
});
});
@ -65,7 +66,8 @@ 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);
@ -76,20 +78,20 @@ 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 => {
const subscription = testChannel2.subscribe((messageArg) => {
if (messageArg.messageText === 'hellothere') {
console.log('Yay##########');
done.resolve();
}
});
await testChannel.sendMessage({
messageText: 'hellothere'
await testChannel.postMessage({
messageText: 'hellothere',
});
await done.promise;
});
interface IDemoReqRes {
method: 'demo',
method: 'demo';
request: {
wowso: string;
};
@ -101,20 +103,23 @@ interface IDemoReqRes {
tap.test('ReactionRequest and ReactionResponse should work', async () => {
const reactionResponse = new smartuniverse.ReactionResponse<IDemoReqRes>({
channels: [testUniverse.getChannel(testChannelData.channelName)],
funcDef: async reqData => {
funcDef: async (reqData) => {
console.log(reqData);
return {
hereso: 'Hello there'
hereso: 'Hello there',
};
},
method: 'demo'
method: 'demo',
});
const reactionRequest = new smartuniverse.ReactionRequest<IDemoReqRes>({
method: 'demo'
});
const reactionResult = await reactionRequest.fire([testClientUniverse2.getChannel(testChannelData.channelName)], {
wowso: 'wowza'
method: 'demo',
});
const reactionResult = await reactionRequest.fire(
[testClientUniverse2.getChannel(testChannelData.channelName)],
{
wowso: 'wowza',
}
);
const result = await reactionResult.getFirstResult();
console.log(result);
});

View File

@ -1,7 +1,7 @@
// Client classes
export * from './smartuniverse.classes.clientuniverse';
export * from './smartuniverse.classes.clientuniversechannel';
export * from './smartuniverse.classes.clientuniversemessage';
export * from './smartuniverse.classes.client.universe';
export * from './smartuniverse.classes.client.universechannel';
export * from './smartuniverse.classes.client.universemessage';
// Server classes
export * from './smartuniverse.classes.universe';
@ -10,7 +10,7 @@ export * from './smartuniverse.classes.universechannel';
export * from './smartuniverse.classes.universemessage';
// Reaction Response
export * from './smartuniverse.classes.reactionrequest';
export * from './smartuniverse.classes.reactionresponse';
export * from './smartuniverse.classes.event.reactionrequest';
export * from './smartuniverse.classes.event.reactionresponse';
export * from './interfaces';

View File

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

View File

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

View File

@ -1,17 +1,18 @@
import * as plugins from './smartuniverse.plugins';
import { Objectmap } from '@pushrocks/lik';
import { Observable } from 'rxjs';
import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
import * as url from 'url';
import * as interfaces from './interfaces';
import { ClientUniverseChannel, ClientUniverseMessage } from './';
import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
import { ClientUniverseChannel, ClientUniverseMessage } from '.';
import { ClientUniverseCache } from './smartuniverse.classes.client.universecache';
import { logger } from './smartuniverse.logging';
export interface IClientOptions {
serverAddress: string;
autoReconnect: boolean;
}
/**
@ -24,6 +25,8 @@ export class ClientUniverse {
public messageRxjsSubject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage<any>>();
public clientUniverseCache = new ClientUniverseCache();
public autoReconnectStatus: 'on' | 'off' = 'off';
constructor(optionsArg: IClientOptions) {
this.options = optionsArg;
}
@ -54,7 +57,7 @@ export class ClientUniverse {
* @param passphraseArg
*/
public getChannel(channelName: string): ClientUniverseChannel {
const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
const clientUniverseChannel = this.clientUniverseCache.channelMap.find((channel) => {
return channel.name === channelName;
});
return clientUniverseChannel;
@ -66,17 +69,21 @@ export class ClientUniverse {
*/
public removeChannel(channelNameArg, notifyServer = true) {
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
channelItemArg => {
(channelItemArg) => {
return channelItemArg.name === channelNameArg;
}
);
}
public async start() {
if (this.options.autoReconnect) {
this.autoReconnectStatus = 'on';
}
await this.checkConnection();
}
public async stop() {
this.autoReconnectStatus = 'off';
await this.disconnect('triggered');
}
@ -84,7 +91,7 @@ export class ClientUniverse {
* checks the connection towards a universe server
* since password validation is done through other means, a connection should always be possible
*/
public async checkConnection(): Promise<void> {
private async checkConnection(): Promise<void> {
if (!this.smartsocketClient) {
const parsedURL = url.parse(this.options.serverAddress);
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
@ -92,11 +99,11 @@ export class ClientUniverse {
password: 'UniverseClient',
port: parseInt(parsedURL.port, 10),
role: 'UniverseClient',
url: parsedURL.protocol + '//' + parsedURL.hostname
url: parsedURL.protocol + '//' + parsedURL.hostname,
};
this.smartsocketClient = new SmartsocketClient(socketConfig);
this.smartsocketClient.eventSubject.subscribe(async eventArg => {
this.smartsocketClient.eventSubject.subscribe(async (eventArg) => {
switch (eventArg) {
case 'disconnected':
this.disconnect('upstreamEvent');
@ -112,14 +119,14 @@ export class ClientUniverse {
funcName: 'unsubscribe',
allowedRoles: [],
funcDef: async (dataArg: interfaces.IServerUnsubscribeActionPayload) => {
const channel = this.clientUniverseCache.channelMap.find(channelArg => {
const channel = this.clientUniverseCache.channelMap.find((channelArg) => {
return channelArg.name === dataArg.name;
});
if (channel) {
channel.unsubscribe();
}
return {};
}
},
});
/**
@ -130,8 +137,8 @@ export class ClientUniverse {
>({
funcName: 'processMessage',
allowedRoles: [],
funcDef: async messageDescriptorArg => {
plugins.smartlog.defaultLogger.log('info', 'Got message from server');
funcDef: async (messageDescriptorArg) => {
logger.log('info', 'Got message from server');
const clientUniverseMessage = ClientUniverseMessage.createMessageFromMessageDescriptor(
messageDescriptorArg
);
@ -142,14 +149,14 @@ export class ClientUniverse {
if (targetChannel) {
await targetChannel.emitMessageLocally(clientUniverseMessage);
return {
messageStatus: 'ok'
messageStatus: 'ok',
};
} else {
return {
messageStatus: 'channel not found'
messageStatus: 'channel not found',
};
}
}
},
});
// add functions
@ -157,21 +164,32 @@ export class ClientUniverse {
this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
await this.smartsocketClient.connect();
plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
logger.log('info', 'universe client connected successfully');
await this.clientUniverseCache.channelMap.forEach(async (clientUniverseChannelArg) => {
await clientUniverseChannelArg.populateSubscriptionToServer();
});
}
}
public async disconnect(reason: 'upstreamEvent' | 'triggered' = 'triggered', tryReconnect = false) {
if ('triggered') {
this.smartsocketClient.disconnect();
private async disconnect(
reason: 'upstreamEvent' | 'triggered' = 'triggered',
tryReconnect = false
) {
const instructDisconnect = async () => {
if (this.smartsocketClient) {
const smartsocketToDisconnect = this.smartsocketClient;
this.smartsocketClient = null; // making sure the upstreamEvent does not interfere
await smartsocketToDisconnect.disconnect();
}
this.smartsocketClient = null;
if (tryReconnect) {
};
if (reason === 'triggered' && this.smartsocketClient) {
await instructDisconnect();
}
if (this.autoReconnectStatus === 'on' && reason === 'upstreamEvent') {
await instructDisconnect();
await plugins.smartdelay.delayForRandom(5000, 20000);
this.checkConnection();
await this.checkConnection();
}
}
}

View File

@ -1,5 +1,5 @@
import * as plugins from './smartuniverse.plugins';
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
/**
* a cache for clients
@ -7,5 +7,5 @@ import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversecha
* good for deduplication in mesh environments
*/
export class ClientUniverseCache {
public channelMap = new plugins.lik.Objectmap<ClientUniverseChannel>();
public channelMap = new plugins.lik.ObjectMap<ClientUniverseChannel>();
}

View File

@ -1,10 +1,10 @@
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';
import { ClientUniverse } from '.';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
import { ReactionRequest } from './smartuniverse.classes.event.reactionrequest';
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse';
export class ClientUniverseChannel implements interfaces.IUniverseChannel {
// ======
@ -54,12 +54,11 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
* tells the universe about this instances interest into a channel
*/
public subscribe(observingFunctionArg: (messageArg: ClientUniverseMessage<any>) => void) {
return this.subject.subscribe(
messageArg => {
(messageArg) => {
observingFunctionArg(messageArg);
},
error => console.log(error)
(error) => console.log(error)
);
}
@ -74,7 +73,7 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
interfaces.ISocketRequest_SubscribeChannel
>('subscribeChannel', {
name: this.name,
passphrase: this.passphrase
passphrase: this.passphrase,
});
this.status = response.subscriptionStatus;
}
@ -88,15 +87,15 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
* sends a message towards the server
* @param messageArg
*/
public async sendMessage(messageArg: interfaces.IMessageCreator) {
await this.clientUniverseRef.checkConnection();
public async postMessage(messageArg: interfaces.IMessageCreator) {
await this.clientUniverseRef.start(); // its ok to call this multiple times
const universeMessageToSend: interfaces.IUniverseMessage = {
id: plugins.smartunique.shortId(),
timestamp: Date.now(),
passphrase: this.passphrase,
targetChannelName: this.name,
messageText: messageArg.messageText,
payload: messageArg.payload
payload: messageArg.payload,
};
await this.clientUniverseRef.smartsocketClient.serverCall(
'processMessage',

View File

@ -0,0 +1,17 @@
import * as plugins from './smartuniverse.plugins';
/**
* broadcasts an event to multiple channels
* also handles subscription
*/
export class BroadcastEvent<T extends plugins.typedrequestInterfaces.ITypedEvent<any>> {
public eventSubject = new plugins.smartrx.rxjs.Subject<T['payload']>();
constructor() {}
public fire(eventPayloadArg: T['payload']) {}
public subscribe(funcArg: (nextArg: T['payload']) => void): plugins.smartrx.rxjs.Subscription {
return this.eventSubject.subscribe(funcArg);
}
}

View File

@ -1,11 +1,13 @@
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 { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
import { ReactionResult } from './smartuniverse.classes.event.reactionresult';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
export interface IReactionRequestConstructorOptions<T extends plugins.typedrequestInterfaces.ITypedRequest> {
export interface IReactionRequestConstructorOptions<
T extends plugins.typedrequestInterfaces.ITypedRequest
> {
method: T['method'];
}
@ -15,9 +17,9 @@ export interface ICombinatorPayload<T extends plugins.typedrequestInterfaces.ITy
*/
id: string;
typedRequestPayload: {
method: T['method'],
request : T['request'],
response: T['response']
method: T['method'];
request: T['request'];
response: T['response'];
};
}
@ -28,35 +30,50 @@ export class ReactionRequest<T extends plugins.typedrequestInterfaces.ITypedRequ
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>();
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) {
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
}
response: null,
},
};
channel.sendMessage({
channel.postMessage({
messageText: 'reactionRequest',
payload
payload,
});
}
plugins.smartdelay.delayFor(timeoutMillisArg).then(async () => {
await subscriptionMap.forEach(subscriptionArg => {
await subscriptionMap.forEach((subscriptionArg) => {
subscriptionArg.unsubscribe();
});
reactionResult.complete();

View File

@ -1,12 +1,14 @@
import * as plugins from './smartuniverse.plugins';
import { ICombinatorPayload } from './smartuniverse.classes.reactionrequest';
import { ICombinatorPayload } from './smartuniverse.classes.event.reactionrequest';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
export type TReactionResponseFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (dataArg: T['request']) => Promise<T['response']>;
export type TReactionResponseFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
dataArg: T['request']
) => Promise<T['response']>;
export interface IReactionResponseConstructorOptions<
T extends plugins.typedrequestInterfaces.ITypedRequest
@ -18,7 +20,7 @@ export interface IReactionResponseConstructorOptions<
export class ReactionResponse<T extends plugins.typedrequestInterfaces.ITypedRequest> {
public method: T['method'];
public channels = new plugins.lik.Objectmap<UniverseChannel | ClientUniverseChannel>();
public channels = new plugins.lik.ObjectMap<UniverseChannel | ClientUniverseChannel>();
public funcDef: TReactionResponseFuncDef<T>;
constructor(optionsArg: IReactionResponseConstructorOptions<T>) {
@ -26,7 +28,7 @@ export class ReactionResponse<T extends plugins.typedrequestInterfaces.ITypedReq
this.channels.addArray(optionsArg.channels);
this.funcDef = optionsArg.funcDef;
for (const channel of this.channels.getArray()) {
channel.subscribe(messageArg => {
channel.subscribe((messageArg) => {
this.processMessageForReaction(channel, messageArg);
});
}
@ -42,17 +44,19 @@ export class ReactionResponse<T extends plugins.typedrequestInterfaces.ITypedReq
messageArg.messageText === 'reactionRequest' &&
messageArg.payload.typedRequestPayload.method === this.method
) {
const response: T['response'] = await this.funcDef(messageArg.payload.typedRequestPayload.request);
const response: T['response'] = await this.funcDef(
messageArg.payload.typedRequestPayload.request
);
const payload: ICombinatorPayload<T> = {
...messageArg.payload,
typedRequestPayload: {
...messageArg.payload.typedRequestPayload,
response
}
response,
},
};
channelArg.sendMessage({
channelArg.postMessage({
messageText: 'reactionResponse',
payload
payload,
});
}
}

View File

@ -1,5 +1,5 @@
import * as plugins from './smartuniverse.plugins';
import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse';
export class ReactionResult<T extends plugins.typedrequestInterfaces.ITypedRequest> {
private resultReplaySubject = new plugins.smartrx.rxjs.ReplaySubject<T['response']>();
@ -7,7 +7,7 @@ export class ReactionResult<T extends plugins.typedrequestInterfaces.ITypedReque
private completeDeferred = plugins.smartpromise.defer<Array<T['response']>>();
constructor() {
this.resultSubscribe(responseArg => {
this.resultSubscribe((responseArg) => {
this.endResult.push(responseArg);
});
}
@ -29,7 +29,7 @@ export class ReactionResult<T extends plugins.typedrequestInterfaces.ITypedReque
*/
public async getFirstResult() {
const done = plugins.smartpromise.defer<T['response']>();
const subscription = this.resultReplaySubject.subscribe(result => {
const subscription = this.resultReplaySubject.subscribe((result) => {
done.resolve(result);
subscription.unsubscribe();
});

View File

@ -1,4 +1,5 @@
import * as plugins from './smartuniverse.plugins';
import * as pluginsTyped from './smartuniverse.pluginstyped';
import { Handler, Route, Server } from '@pushrocks/smartexpress';
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
@ -7,10 +8,11 @@ import * as paths from './smartuniverse.paths';
import * as interfaces from './interfaces';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
import { logger } from './smartuniverse.logging';
export interface ISmartUniverseConstructorOptions {
messageExpiryInMilliseconds: number;
externalServer?: plugins.smartexpress.Server;
externalServer?: pluginsTyped.smartexpress.Server;
}
/**
@ -26,7 +28,7 @@ export class Universe {
/**
* the smartexpress server used
*/
private smartexpressServer: plugins.smartexpress.Server;
private smartexpressServer: pluginsTyped.smartexpress.Server;
/**
* the smartsocket used
@ -69,7 +71,7 @@ export class Universe {
* returns a channel
*/
public getChannel(channelNameArg: string) {
return this.universeCache.channelMap.find(channelArg => {
return this.universeCache.channelMap.find((channelArg) => {
return channelArg.name === channelNameArg;
});
}
@ -78,28 +80,21 @@ export class Universe {
* initiates a server
*/
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.getUniverseVersion()}`;
},
forceSsl: false,
// add websocket upgrade
this.smartsocket = new plugins.smartsocket.Smartsocket({
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({});
// lets create the base smartexpress server
if (this.options.externalServer) {
console.log('Universe is using externally supplied server');
this.smartsocket.setExternalServer('smartexpress' ,this.options.externalServer);
}
// add a role for the clients
const ClientRole = new plugins.smartsocket.SocketRole({
name: 'UniverseClient',
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient'), // authentication happens on another level
});
// add the role to smartsocket
@ -114,13 +109,13 @@ export class Universe {
const universeConnection = new UniverseConnection({
universe: this,
socketConnection: socketConnectionArg,
authenticationRequests: [dataArg]
authenticationRequests: [dataArg],
});
await UniverseConnection.addConnectionToCache(this, universeConnection);
return {
subscriptionStatus: 'subscribed'
subscriptionStatus: 'subscribed',
};
}
},
});
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
@ -132,17 +127,11 @@ export class Universe {
socketConnectionArg
);
if (universeConnection) {
plugins.smartlog.defaultLogger.log(
'ok',
'found UniverseConnection for socket for incoming message'
);
logger.log('ok', 'found UniverseConnection for socket for incoming message');
} else {
plugins.smartlog.defaultLogger.log(
'warn',
'found no Authorized channel for incoming message'
);
logger.log('warn', 'found no Authorized channel for incoming message');
return {
error: 'You need to authenticate for a channel'
error: 'You need to authenticate for a channel',
};
}
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
@ -157,22 +146,16 @@ export class Universe {
const authenticatedMessage = unauthenticatedMessage;
await this.universeCache.addMessage(authenticatedMessage);
}
}
},
});
// add socket functions
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
await this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer);
await this.smartsocket.start();
plugins.smartlog.defaultLogger.log('success', 'started universe');
logger.log('success', 'started universe');
}
/**
@ -180,8 +163,5 @@ export class Universe {
*/
public async stopServer() {
await this.smartsocket.stop();
if (!this.options.externalServer) {
await this.smartexpressServer.stop();
}
}
}

View File

@ -3,11 +3,10 @@ import * as plugins from './smartuniverse.plugins';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { Objectmap } from '@pushrocks/lik';
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';
@ -24,17 +23,17 @@ export class UniverseCache {
/**
* stores messages for this instance
*/
public messageMap = new Objectmap<UniverseMessage<any>>();
public messageMap = new ObjectMap<UniverseMessage<any>>();
/**
* stores the channels that are available within the universe
*/
public channelMap = new Objectmap<UniverseChannel>();
public channelMap = new ObjectMap<UniverseChannel>();
/**
* stores all connections
*/
public connectionMap = new plugins.lik.Objectmap<UniverseConnection>();
public connectionMap = new plugins.lik.ObjectMap<UniverseConnection>();
/**
* allows messages to be processed in a blacklist mode for further analysis
@ -58,7 +57,7 @@ export class UniverseCache {
messageArg.setUniverseCache(this);
UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
this.messageMap.add(messageArg);
messageArg.universeChannelList.forEach(universeChannel => {
messageArg.universeChannelList.forEach((universeChannel) => {
universeChannel.push(messageArg);
});
}
@ -71,7 +70,7 @@ export class UniverseCache {
channelName?: string
): Observable<UniverseMessage<any>> {
const messageObservable = from(this.messageMap.getArray()).pipe(
filter(messageArg => {
filter((messageArg) => {
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
})
);

View File

@ -5,6 +5,7 @@ import { UniverseCache } from './smartuniverse.classes.universecache';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
import { Universe } from './smartuniverse.classes.universe';
import { logger } from './smartuniverse.logging';
/**
* enables messages to stay within a certain scope.
@ -33,7 +34,7 @@ export class UniverseChannel {
* returns boolean wether certain channel exists
*/
public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
const channel = universeCacheArg.channelMap.find(channelArg => {
const channel = universeCacheArg.channelMap.find((channelArg) => {
return channelArg.name === channelNameArg;
});
if (channel) {
@ -54,25 +55,25 @@ export class UniverseChannel {
universeCacheArg: UniverseCache,
universeMessageArg: UniverseMessage<any>
): UniverseChannel {
const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
const foundChannel = universeCacheArg.channelMap.find((universeChannel) => {
const result = universeChannel.authenticate(universeMessageArg);
return result;
});
if (foundChannel) {
universeMessageArg.authenticated = true;
universeMessageArg.universeChannelList.add(foundChannel);
plugins.smartlog.defaultLogger.log('ok', 'message authorized');
logger.log('ok', 'message authorized');
return foundChannel;
} else {
universeMessageArg.authenticated = false;
universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
plugins.smartlog.defaultLogger.log('warn', 'message not valid');
logger.log('warn', 'message not valid');
return null;
}
}
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
return universeRef.universeCache.channelMap.find(channelArg => {
return universeRef.universeCache.channelMap.find((channelArg) => {
return channelArg.name === universeChannelName;
});
}
@ -117,7 +118,7 @@ export class UniverseChannel {
public async push(messageArg: UniverseMessage<any>) {
this.subject.next(messageArg);
const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
await this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
await this.universeRef.universeCache.connectionMap.forEach(async (socketConnection) => {
if (socketConnection.authenticatedChannels.includes(this)) {
universeConnectionsWithChannelAccess.push(socketConnection);
}
@ -131,7 +132,7 @@ export class UniverseChannel {
passphrase: messageArg.passphrase,
targetChannelName: this.name,
messageText: messageArg.messageText,
payload: messageArg.payload
payload: messageArg.payload,
};
smartsocket.clientCall(
'processMessage',
@ -144,24 +145,24 @@ export class UniverseChannel {
// functions to interact with a channel locally
public subscribe(observingFunctionArg: (messageArg: UniverseMessage<any>) => void) {
return this.subject.subscribe(
messageArg => {
(messageArg) => {
observingFunctionArg(messageArg);
},
error => console.log(error)
(error) => console.log(error)
);
}
/**
* sends a message to the channel
*/
public async sendMessage(messageDescriptor: interfaces.IMessageCreator) {
public async postMessage(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()
timestamp: Date.now(),
});
this.universeRef.universeCache.addMessage(messageToSend);
}

View File

@ -37,7 +37,7 @@ export class UniverseConnection {
universeConnectionArg: UniverseConnection
): Promise<UniverseConnection> {
let connectionToReturn: UniverseConnection;
universeCache.connectionMap.forEach(async existingConnection => {
universeCache.connectionMap.forEach(async (existingConnection) => {
if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
connectionToReturn = await this.mergeUniverseConnections(
existingConnection,
@ -87,7 +87,7 @@ export class UniverseConnection {
universeCache: UniverseCache,
socketConnectionArg: plugins.smartsocket.SocketConnection
): UniverseConnection {
const universeConnection = universeCache.connectionMap.find(universeConnectionArg => {
const universeConnection = universeCache.connectionMap.find((universeConnectionArg) => {
return universeConnectionArg.socketConnection === socketConnectionArg;
});
return universeConnection;
@ -121,9 +121,10 @@ export class UniverseConnection {
socketConnection: plugins.smartsocket.SocketConnection;
authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
}) {
this.universeRef = optionsArg.universe;
this.authenticationRequests = optionsArg.authenticationRequests;
this.socketConnection = optionsArg.socketConnection;
this.socketConnection.eventSubject.subscribe(async eventArg => {
this.socketConnection.eventSubject.subscribe(async (eventArg) => {
switch (eventArg) {
case 'disconnected':
await this.disconnect('upstreamevent');

View File

@ -1,13 +1,12 @@
import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces';
import { Objectmap } from '@pushrocks/lik';
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 { SocketConnection } from '@pushrocks/smartsocket';
import { logger } from './smartuniverse.logging';
/**
* represents a message within a universe
@ -40,7 +39,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
/**
* enables unprotected grouping of messages for efficiency purposes.
*/
public universeChannelList = new Objectmap<UniverseChannel>();
public universeChannelList = new plugins.lik.ObjectMap<UniverseChannel>();
/**
* wether the message is authenticated
@ -78,9 +77,11 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
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.destructionTimer.completed
.then(async () => {
this.universeCache.messageMap.remove(this);
}).catch(err => {
})
.catch((err) => {
console.log(err);
console.log(this);
});
@ -97,6 +98,6 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
* handles bad messages for further analysis
*/
public handleAsBadMessage() {
plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
logger.log('warn', 'received a bad message');
}
}

View File

@ -0,0 +1,2 @@
import * as plugins from './smartuniverse.plugins';
export const logger = new plugins.smartlog.ConsoleLog();

View File

@ -6,15 +6,12 @@ export { path };
// apiglobal scope
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
export {
typedrequestInterfaces
};
export { typedrequestInterfaces };
// pushrocks scope
import * as lik from '@pushrocks/lik';
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';
@ -28,7 +25,6 @@ export {
lik,
smarthash,
smartdelay,
smartexpress,
smartfile,
smartlog,
smartpromise,
@ -36,5 +32,5 @@ export {
smartrequest,
smartsocket,
smarttime,
smartunique
smartunique,
};

View File

@ -0,0 +1,5 @@
import type * as smartexpress from '@pushrocks/smartexpress';
export {
smartexpress
};