Compare commits

..

No commits in common. "master" and "v1.0.75" have entirely different histories.

42 changed files with 3753 additions and 5748 deletions

View File

@ -1,66 +0,0 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -1,124 +0,0 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
npmci command tsdoc
continue-on-error: true

4
.gitignore vendored
View File

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

119
.gitlab-ci.yml Normal file
View File

@ -0,0 +1,119 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: "$CI_BUILD_STAGE"
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
tags:
- docker
- notpriv
snyk:
stage: security
script:
- npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags:
- docker
- notpriv
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install lts
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
release:
stage: release
script:
- npmci node install lts
- npmci npm publish
only:
- tags
tags:
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
script:
- npmci command npm install -g tslint typescript
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- docker
- notpriv
pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata
script:
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

4
.snyk Normal file
View File

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

24
.vscode/launch.json vendored
View File

@ -2,10 +2,28 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"command": "npm test", "name": "current file",
"name": "Run npm test", "type": "node",
"request": "launch", "request": "launch",
"type": "node-terminal" "args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }

26
.vscode/settings.json vendored
View File

@ -1,26 +0,0 @@
{
"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,33 +1,17 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "code.foss.global", "githost": "gitlab.com",
"gitscope": "push.rocks", "gitscope": "pushrocks",
"gitrepo": "smartuniverse", "gitrepo": "smartuniverse",
"description": "A messaging service enabling secure, reactive communication between microservices.", "shortDescription": "messaging service for micro services",
"npmPackagename": "@push.rocks/smartuniverse", "npmPackagename": "@pushrocks/smartuniverse",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks", "projectDomain": "push.rocks"
"keywords": [
"microservices",
"messaging",
"reactive programming",
"event-driven",
"channel-based communication",
"client-server architecture",
"message encryption",
"typescript",
"websocket",
"scalability"
]
} }
}, },
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

3080
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,72 +1,52 @@
{ {
"name": "@push.rocks/smartuniverse", "name": "@pushrocks/smartuniverse",
"version": "1.0.108", "version": "1.0.75",
"private": false, "private": false,
"description": "A messaging service enabling secure, reactive communication between microservices.", "description": "messaging service for your micro services",
"main": "dist_ts/index.js", "main": "dist/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"testManual": "(tsrun test/test.ts)", "testManual": "(tsrun test/test.ts)",
"build": "(tsbuild --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)", "build": "(tsbuild)",
"format": "(gitzone format)", "format": "(gitzone format)"
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.66", "@gitzone/tsbuild": "^2.1.17",
"@gitzone/tsbundle": "^2.0.8", "@gitzone/tstest": "^1.0.24",
"@gitzone/tsrun": "^1.2.44", "@pushrocks/tapbundle": "^3.0.13",
"@gitzone/tstest": "^1.0.77", "@types/node": "^12.7.4",
"@push.rocks/tapbundle": "^5.0.12", "tslint": "^5.20.0",
"@types/node": "^20.4.4" "tslint-config-prettier": "^1.18.0"
},
"peerDependencies": {
"rxjs": "*"
}, },
"dependencies": { "dependencies": {
"@apiglobal/typedrequest-interfaces": "^2.0.1", "@pushrocks/lik": "^3.0.11",
"@apiglobal/typedserver": "^2.0.65", "@pushrocks/smartdelay": "^2.0.3",
"@push.rocks/isohash": "^2.0.1", "@pushrocks/smartexpress": "^3.0.40",
"@push.rocks/isounique": "^1.0.5", "@pushrocks/smartfile": "^7.0.4",
"@push.rocks/lik": "^6.0.3", "@pushrocks/smarthash": "^2.0.6",
"@push.rocks/smartdelay": "^3.0.5", "@pushrocks/smartlog": "^2.0.19",
"@push.rocks/smartlog": "^3.0.3", "@pushrocks/smartpromise": "^3.0.2",
"@push.rocks/smartpromise": "^4.0.2", "@pushrocks/smartrequest": "^1.1.27",
"@push.rocks/smartrx": "^3.0.6", "@pushrocks/smartrx": "^2.0.5",
"@push.rocks/smartsocket": "^2.0.20", "@pushrocks/smartsocket": "^1.1.49",
"@push.rocks/smarttime": "^4.0.4", "@pushrocks/smarttime": "^3.0.12",
"@push.rocks/smarturl": "^3.0.7" "@pushrocks/smartunique": "^3.0.1"
}, },
"files": [ "files": [
"ts/**/*", "ts/*",
"ts_web/**/*", "ts_web/*",
"dist/**/*", "dist/*",
"dist_*/**/*", "dist_web/*",
"dist_ts/**/*", "dist_ts_web/*",
"dist_ts_web/**/*", "assets/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
], ]
"browserslist": [ }
"last 1 chrome versions"
],
"type": "module",
"keywords": [
"microservices",
"messaging",
"reactive programming",
"event-driven",
"channel-based communication",
"client-server architecture",
"message encryption",
"typescript",
"websocket",
"scalability"
],
"homepage": "https://code.foss.global/push.rocks/smartuniverse",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartuniverse.git"
}
}

4610
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1 +0,0 @@

148
readme.md
View File

@ -1,127 +1,55 @@
# @push.rocks/smartuniverse # @pushrocks/smartuniverse
messaging service for your micro services messaging service for micro services
## Install ## Availabililty and Links
To install `@push.rocks/smartuniverse`, use the following command with npm: * [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
```bash * [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
npm install @push.rocks/smartuniverse --save * [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
``` * [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
This command adds `@push.rocks/smartuniverse` to your project's dependencies.
## 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/)
## Usage ## Usage
`@push.rocks/smartuniverse` is designed to enable messaging services for microservices, allowing them to communicate in a structured and secure manner. Below are examples and scenarios illustrating how to use `@push.rocks/smartuniverse` for both server (managing messages across services) and client (microservices communicating within the universe) aspects.
### Server side setup: Creating your Universe Use TypeScript for best in class instellisense.
First, you need to set up the server side of your messaging ecosystem, which involves creating a "universe" where channels reside. ### What is smartuniverse all about?
Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
### Server side
every universe has a server that manages messages.
Think Kafka, but without Kafka.
```typescript ```typescript
import { Universe } from '@push.rocks/smartuniverse'; import * as smartuniverse from '@pushrocks/smartuniverse';
// Initialize a new Universe const myUniverse = new smartuniverse.Universe({
const myUniverse = new Universe({ messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
messageExpiryInMilliseconds: 60000, // messages expire after 60 seconds
}); });
// Create channels for communication within the universe // create as many channels as you like
// These channels can be thought of as topics or queues that services can subscribe to or post messages to myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
myUniverse.addChannel('channel-one', 'password1'); myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
myUniverse.addChannel('channel-two', 'password2');
// Start the universe server on a specified port myUniverse.start(8765); // start the server and provide the port on which to listen on
myUniverse.start(8765);
``` ```
By starting the universe, you've established a messaging hub for your microservices. Ensure that the services know the universe's address and the channels and passwords they should use for communication. ### Client side
### Client side: Microservices joining the Universe All your microservices represents clients in the universe that may talk to each other using the universe server.
On the client side, your microservices will join the universe, subscribing to channels to listen for messages or post their messages to be consumed by other services. For further information read the linked docs at the top of this readme.
```typescript > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
import { ClientUniverse, ClientUniverseChannel } from '@push.rocks/smartuniverse'; | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
// Initialize client that connects to the universe server [![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
const clientUniverse = new ClientUniverse({
serverAddress: 'http://your-universe-server:8765',
autoReconnect: true,
});
// Define a channel to subscribe to (the channel must be created in the universe server)
const channel = clientUniverse.addChannel('channel-one', 'password1');
// Start the client to enable communication
clientUniverse.start();
// Posting a message to the channel
channel.postMessage({
messageText: 'Hello, universe!',
payload: { some: 'data' },
});
// Listening for messages from the channel
channel.subscribe((message) => {
console.log('Received message:', message);
});
```
### Reaction Patterns: Request and Response Within the Universe
`@push.rocks/smartuniverse` supports reactive programming. Microservices can emit "reaction requests" and listen for "reaction responses" tied to specific actions or commands.
```typescript
import { ReactionRequest, ReactionResponse } from '@push.rocks/smartuniverse';
// Define a request-response type
interface MyRequestResponse {
method: 'greet';
request: { name: string };
response: { message: string };
};
// Creating a reaction request on client side
const reactionRequest = new ReactionRequest<MyRequestResponse>({ method: 'greet' });
// Emitting a reaction request and handling responses
reactionRequest.fire([channel], { name: 'World' }).then((reactionResult) => {
reactionResult.getFirstResult().then((response) => {
console.log(response.message); // Output: Hello, World!
});
});
// Handling reaction requests on server side or another client
const reactionResponse = new ReactionResponse<MyRequestResponse>({
channels: [myUniverse.getChannel('channel-one')],
funcDef: async (requestData) => {
return { message: `Hello, ${requestData.name}!` };
},
method: 'greet',
});
```
This pattern enables a powerful, flexible communication system where services can asynchronously request information or trigger actions across the microservices architecture without direct coupling.
### Conclusion
`@push.rocks/smartuniverse` provides a robust platform for facilitating communication between microservices. By setting up a universe and defining channels, your services can securely exchange messages, supporting both direct communications and reactive programming patterns. Whether sharing updates, events, or performing request-response interactions, `@push.rocks/smartuniverse` simplifies the process of building a cohesive microservices ecosystem.
For more advanced use cases and configuration options, refer to the complete documentation.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,6 +1,8 @@
// tslint:disable-next-line:no-implicit-dependencies // tslint:disable-next-line:no-implicit-dependencies
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as smartuniverse from '../ts/index.js'; import * as smartuniverse from '../ts/index';
import { Observable } from 'rxjs';
let testUniverse: smartuniverse.Universe; let testUniverse: smartuniverse.Universe;
let testClientUniverse: smartuniverse.ClientUniverse; let testClientUniverse: smartuniverse.ClientUniverse;
@ -8,17 +10,17 @@ let testClientUniverse2: smartuniverse.ClientUniverse;
let testClientChannel: smartuniverse.ClientUniverseChannel; let testClientChannel: smartuniverse.ClientUniverseChannel;
const testServerData = { const testServerData = {
serverAddress: 'http://localhost:8765', serverAddress: 'http://localhost:8765'
}; };
const testChannelData = { const testChannelData = {
channelName: 'awesomeTestChannel', channelName: 'awesomeTestChannel',
channelPass: 'awesomeChannelPass', channelPass: 'awesomeChannelPass'
}; };
tap.test('first test', async () => { tap.test('first test', async () => {
testUniverse = new smartuniverse.Universe({ testUniverse = new smartuniverse.Universe({
messageExpiryInMilliseconds: 1000, messageExpiryInMilliseconds: 1000
}); });
}); });
@ -29,10 +31,9 @@ tap.test('add a message to the SmartUniverse', async () => {
// testing message handling // testing message handling
tap.test('create smartuniverse client', async () => { tap.test('create smartuniverse client', async () => {
testClientUniverse = new smartuniverse.ClientUniverse({ testClientUniverse = new smartuniverse.ClientUniverse({
serverAddress: testServerData.serverAddress, serverAddress: testServerData.serverAddress
autoReconnect: true,
}); });
expect(testClientUniverse).toBeInstanceOf(smartuniverse.ClientUniverse); expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
}); });
tap.test('should add a channel to the universe', async () => { tap.test('should add a channel to the universe', async () => {
@ -49,85 +50,34 @@ tap.test('should start the ClientUniverse', async () => {
tap.test('should get a observable correctly', async () => { tap.test('should get a observable correctly', async () => {
testClientChannel = testClientUniverse.getChannel(testChannelData.channelName); testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
expect(testClientChannel).toBeInstanceOf(smartuniverse.ClientUniverseChannel); expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
}); });
tap.test('should send a message correctly', async () => { tap.test('should send a message correctly', async () => {
await testClientUniverse.getChannel(testChannelData.channelName).postMessage({ await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
messageText: 'hello', messageText: 'hello'
}); });
}); });
tap.test('universe should contain the sent message', async () => { tap.test('universe should contain the sent message', async () => {
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).toEqual('hello'); expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
}); });
tap.test('a second client should be able to subscibe', async () => { tap.test('a second client should be able to subscibe', async () => {
testClientUniverse2 = new smartuniverse.ClientUniverse({ testClientUniverse2 = new smartuniverse.ClientUniverse({
serverAddress: testServerData.serverAddress, serverAddress: testServerData.serverAddress
autoReconnect: true,
}); });
testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass); testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
await testClientUniverse2.start();
}); });
tap.test('should receive a message correctly', async (tools) => { tap.test('should receive a message correctly', async () => {});
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.postMessage({
messageText: 'hellothere',
});
await done.promise;
});
interface IDemoReqRes { tap.test('should disconnect the client correctly', async () => {
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 testClientUniverse.stop();
await testClientUniverse2.stop();
}); });
tap.test('should end the server correctly', async (tools) => { tap.test('should end the server correctly', async tools => {
await testUniverse.stopServer(); await testUniverse.stopServer();
}); });

View File

@ -1,8 +0,0 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartuniverse',
version: '1.0.108',
description: 'messaging service for your micro services'
}

View File

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

View File

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

View File

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

View File

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

View File

@ -1,6 +1,7 @@
export interface IMessageCreator { export interface IMessageCreator {
messageText: string; messageText: string;
payload?: string | number | any; payload?: string | number | any;
payloadStringType?: 'Buffer' | 'string' | 'object';
} }
/** /**

View File

@ -1,186 +0,0 @@
import * as plugins from './smartuniverse.plugins.js';
import { Smartsocket, SmartsocketClient } from '@push.rocks/smartsocket';
import * as interfaces from './interfaces/index.js';
import { ClientUniverseChannel, ClientUniverseMessage } from './index.js';
import { ClientUniverseCache } from './smartuniverse.classes.client.universecache.js';
import { logger } from './smartuniverse.logging.js';
export interface IClientOptions {
serverAddress: string;
autoReconnect: boolean;
}
/**
* this class is for client side only!!!
* allows connecting to a universe server
*/
export class ClientUniverse {
public options: IClientOptions;
public smartsocketClient: plugins.smartsocket.SmartsocketClient;
public messageRxjsSubject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage<any>>();
public clientUniverseCache = new ClientUniverseCache();
public autoReconnectStatus: 'on' | 'off' = 'off';
constructor(optionsArg: IClientOptions) {
this.options = optionsArg;
}
/**
* adds a channel to the channelcache
* TODO: verify channel before adding it to the channel cache
*/
public addChannel(channelNameArg: string, passphraseArg: string) {
const existingChannel = this.getChannel(channelNameArg);
if (existingChannel) {
throw new Error('channel exists');
}
// lets create the channel
const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(
this,
channelNameArg,
passphraseArg
);
return clientUniverseChannel;
}
/**
* gets a channel from the channelcache
* @param channelName
* @param passphraseArg
*/
public getChannel(channelName: string): ClientUniverseChannel {
const clientUniverseChannel = this.clientUniverseCache.channelMap.findSync((channel) => {
return channel.name === channelName;
});
return clientUniverseChannel;
}
/**
* remove a a achannel
* @param messageArg
*/
public removeChannel(channelNameArg, notifyServer = true) {
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemoveSync(
(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');
}
/**
* checks the connection towards a universe server
* since password validation is done through other means, a connection should always be possible
*/
private async checkConnection(): Promise<void> {
if (!this.smartsocketClient) {
const parsedURL = plugins.smarturl.Smarturl.createFromUrl(this.options.serverAddress);
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
alias: 'universeclient',
port: parseInt(parsedURL.port, 10),
url: parsedURL.protocol + '//' + parsedURL.hostname,
};
this.smartsocketClient = new SmartsocketClient(socketConfig);
this.smartsocketClient.eventSubject.subscribe(async (eventArg) => {
switch (eventArg) {
case 'disconnected':
this.disconnect('upstreamEvent');
}
});
// lets define some basic actions
/**
* should handle a forced unsubscription by the server
*/
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
funcName: 'unsubscribe',
funcDef: async (dataArg: interfaces.IServerUnsubscribeActionPayload) => {
const channel = this.clientUniverseCache.channelMap.findSync((channelArg) => {
return channelArg.name === dataArg.name;
});
if (channel) {
channel.unsubscribe();
}
return {};
},
});
/**
* handles message reception
*/
const socketFunctionProcessMessage =
new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_ProcessMessage>({
funcName: 'processMessage',
funcDef: async (messageDescriptorArg) => {
logger.log('info', 'Got message from server');
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',
};
}
},
});
// add functions
this.smartsocketClient.addSocketFunction(socketFunctionUnsubscribe);
this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
await this.smartsocketClient.connect();
logger.log('info', 'universe client connected successfully');
await this.clientUniverseCache.channelMap.forEach(async (clientUniverseChannelArg) => {
await clientUniverseChannelArg.populateSubscriptionToServer();
});
}
}
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();
}
};
if (reason === 'triggered' && this.smartsocketClient) {
await instructDisconnect();
}
if (this.autoReconnectStatus === 'on' && reason === 'upstreamEvent') {
await instructDisconnect();
await plugins.smartdelay.delayForRandom(5000, 20000);
await this.checkConnection();
}
}
}

View File

@ -0,0 +1,154 @@
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';
export interface IClientOptions {
serverAddress: string;
}
/**
* this class is for client side only!!!
* allows connecting to a universe server
*/
export class ClientUniverse {
public options;
public smartsocketClient: plugins.smartsocket.SmartsocketClient;
public observableIntake: plugins.smartrx.ObservableIntake<ClientUniverseMessage>;
public clientUniverseCache = new ClientUniverseCache();
constructor(optionsArg: IClientOptions) {
this.options = optionsArg;
}
/**
* adds a channel to the channelcache
* TODO: verify channel before adding it to the channel cache
*/
public addChannel(channelNameArg: string, passphraseArg: string) {
const existingChannel = this.getChannel(channelNameArg);
if (existingChannel) {
throw new Error('channel exists');
}
// lets create the channel
const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(
this,
channelNameArg,
passphraseArg
);
return clientUniverseChannel;
}
/**
* gets a channel from the channelcache
* @param channelName
* @param passphraseArg
*/
public getChannel(channelName: string): ClientUniverseChannel {
const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
return channel.name === channelName;
});
return clientUniverseChannel;
}
/**
* remove a a achannel
* @param messageArg
*/
public removeChannel(channelNameArg, notifyServer = true) {
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
channelItemArg => {
return channelItemArg.name === channelNameArg;
}
);
}
public async start() {
await this.checkConnection();
}
public async stop() {
await this.smartsocketClient.disconnect();
}
/**
* checks the connection towards a universe server
* since password validation is done through other means, a connection should always be possible
*/
public async checkConnection(): Promise<void> {
if (!this.smartsocketClient && !this.observableIntake) {
const parsedURL = url.parse(this.options.serverAddress);
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
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();
// lets define some basic actions
/**
* should handle a forced unsubscription by the server
*/
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
funcName: 'unsubscribe',
allowedRoles: [],
funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
throw new Error('TODO');
}
});
/**
* handles message reception
*/
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<
interfaces.ISocketRequest_ProcessMessage
>({
funcName: 'processMessage',
allowedRoles: [],
funcDef: async messageDescriptorArg => {
plugins.smartlog.defaultLogger.log('info', 'Got message from server');
const clientUniverseMessage = ClientUniverseMessage.createMessageFromMessageDescriptor(
messageDescriptorArg
);
this.observableIntake.push(clientUniverseMessage);
// lets find the corresponding channel
const targetChannel = this.getChannel(clientUniverseMessage.targetChannelName);
if (targetChannel) {
await targetChannel.emitMessageLocally(clientUniverseMessage);
return {
messageStatus: 'ok'
};
} else {
return {
messageStatus: 'channel not found'
};
}
}
});
// add functions
this.smartsocketClient.addSocketFunction(socketFunctionUnsubscribe);
this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
await this.smartsocketClient.connect();
plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
await clientUniverseChannelArg.subscribe();
});
}
}
}

View File

@ -1,5 +1,5 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js'; import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
/** /**
* a cache for clients * a cache for clients
@ -7,5 +7,5 @@ import { ClientUniverseChannel } from './smartuniverse.classes.client.universech
* good for deduplication in mesh environments * good for deduplication in mesh environments
*/ */
export class ClientUniverseCache { 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.js'; import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces';
import { ClientUniverse } from './index.js'; import { ClientUniverse } from './';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage.js'; import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
import { ReactionRequest } from './smartuniverse.classes.event.reactionrequest.js'; import { ReactionRequest } from './smartuniverse.classes.reactionrequest';
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse.js'; import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
export class ClientUniverseChannel implements interfaces.IUniverseChannel { export class ClientUniverseChannel implements interfaces.IUniverseChannel {
// ====== // ======
@ -38,7 +38,7 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
public name: string; public name: string;
public passphrase: string; public passphrase: string;
public status: 'subscribed' | 'unsubscribed' = 'unsubscribed'; public status: 'subscribed' | 'unsubscribed' = 'unsubscribed';
private subject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage<any>>(); private subject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage>();
// refs // refs
public clientUniverseRef: ClientUniverse; public clientUniverseRef: ClientUniverse;
@ -53,51 +53,48 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
* subscribes to a channel * subscribes to a channel
* tells the universe about this instances interest into a channel * tells the universe about this instances interest into a channel
*/ */
public subscribe(observingFunctionArg: (messageArg: ClientUniverseMessage<any>) => void) { public async subscribe(observerArg?: plugins.smartrx.rxjs.Observer<any>) {
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 // lets make sure the channel is connected
if (this.status === 'unsubscribed') { if (this.status === 'unsubscribed') {
const response = const response = await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>(
await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>( 'subscribeChannel',
'subscribeChannel', {
{ name: this.name,
name: this.name, passphrase: this.passphrase
passphrase: this.passphrase, }
} );
);
this.status = response.subscriptionStatus; this.status = response.subscriptionStatus;
} }
if (observerArg) {
return this.subject.subscribe(observerArg);
}
} }
public async emitMessageLocally(messageArg: ClientUniverseMessage<any>) { public async emitMessageLocally(messageArg: ClientUniverseMessage) {
this.subject.next(messageArg); this.subject.next(messageArg);
} }
public askForReaction(reactionRequest: ReactionRequest): ReactionResponse {
const reactionResponse = new ReactionResponse();
return reactionResponse;
}
/** /**
* sends a message towards the server * sends a message towards the server
* @param messageArg * @param messageArg
*/ */
public async postMessage(messageArg: interfaces.IMessageCreator) { public async sendMessage(messageArg: interfaces.IMessageCreator) {
await this.clientUniverseRef.start(); // its ok to call this multiple times await this.clientUniverseRef.checkConnection();
const universeMessageToSend: interfaces.IUniverseMessage = { const universeMessageToSend: interfaces.IUniverseMessage = {
id: plugins.isounique.uni(), id: plugins.smartunique.shortId(),
timestamp: Date.now(), timestamp: Date.now(),
passphrase: this.passphrase, passphrase: this.passphrase,
targetChannelName: this.name, targetChannelName: this.name,
messageText: messageArg.messageText, messageText: messageArg.messageText,
payload: messageArg.payload, payload: messageArg.payload,
payloadStringType: messageArg.payloadStringType
}; };
await this.clientUniverseRef.smartsocketClient.serverCall( await this.clientUniverseRef.smartsocketClient.serverCall(
'processMessage', 'processMessage',

View File

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

View File

@ -1,17 +0,0 @@
import * as plugins from './smartuniverse.plugins.js';
/**
* 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,83 +0,0 @@
import * as plugins from './smartuniverse.plugins.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
import { ReactionResult } from './smartuniverse.classes.event.reactionresult.js';
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage.js';
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.isounique.uni();
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.postMessage({
messageText: 'reactionRequest',
payload,
});
}
plugins.smartdelay.delayFor(timeoutMillisArg).then(async () => {
await subscriptionMap.forEach((subscriptionArg) => {
subscriptionArg.unsubscribe();
});
reactionResult.complete();
});
return reactionResult;
}
}

View File

@ -1,63 +0,0 @@
import * as plugins from './smartuniverse.plugins.js';
import { type ICombinatorPayload } from './smartuniverse.classes.event.reactionrequest.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage.js';
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.postMessage({
messageText: 'reactionResponse',
payload,
});
}
}
}

View File

@ -1,52 +0,0 @@
import * as plugins from './smartuniverse.plugins.js';
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse.js';
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);
}
}

View File

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

View File

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

View File

@ -1,15 +1,16 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import * as pluginsTyped from './smartuniverse.pluginstyped.js';
import { UniverseCache, UniverseChannel, UniverseMessage } from './index.js'; import { Handler, Route, Server } from '@pushrocks/smartexpress';
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
import * as interfaces from './interfaces/index.js'; import * as paths from './smartuniverse.paths';
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
import { logger } from './smartuniverse.logging.js'; import * as interfaces from './interfaces';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
export interface ISmartUniverseConstructorOptions { export interface ISmartUniverseConstructorOptions {
messageExpiryInMilliseconds: number; messageExpiryInMilliseconds: number;
externalServer?: pluginsTyped.typedserver.servertools.Server; externalServer?: plugins.smartexpress.Server;
} }
/** /**
@ -25,7 +26,7 @@ export class Universe {
/** /**
* the smartexpress server used * the smartexpress server used
*/ */
private server: pluginsTyped.typedserver.servertools.Server; private smartexpressServer: plugins.smartexpress.Server;
/** /**
* the smartsocket used * the smartsocket used
@ -46,7 +47,7 @@ export class Universe {
/** /**
* get the currently running version of smartuniverse * get the currently running version of smartuniverse
*/ */
/* public getUniverseVersion() { public getUniverseVersion() {
if (this.universeVersionStore) { if (this.universeVersionStore) {
return this.universeVersionStore; return this.universeVersionStore;
} else { } else {
@ -54,83 +55,89 @@ export class Universe {
this.universeVersionStore = packageJson.version; this.universeVersionStore = packageJson.version;
return this.universeVersionStore; return this.universeVersionStore;
} }
} */ }
/** /**
* adds a channel to the Universe * adds a channel to the Universe
*/ */
public addChannel(nameArg: string, passphraseArg: string) { public addChannel(nameArg: string, passphraseArg: string) {
const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg); const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
return newChannel;
}
/**
* returns a channel
*/
public getChannel(channelNameArg: string) {
return this.universeCache.channelMap.findSync((channelArg) => {
return channelArg.name === channelNameArg;
});
} }
/** /**
* initiates a server * initiates a server
*/ */
public async start(portArg?: number) { public async start(portArg: number) {
if (!this.options.externalServer && !portArg) { // lets create the base smartexpress server
throw new Error(`You supplied an external error. You need to specify a portArg to start on.`); 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;
} }
portArg = portArg || 3000; // TODO: remove
// add websocket upgrade // add websocket upgrade
this.smartsocket = new plugins.smartsocket.Smartsocket({ this.smartsocket = new plugins.smartsocket.Smartsocket({});
alias: 'smartuniverse',
port: portArg, // add a role for the clients
const ClientRole = new plugins.smartsocket.SocketRole({
name: 'UniverseClient',
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
}); });
// lets create the base smartexpress server // add the role to smartsocket
if (this.options.externalServer) { this.smartsocket.addSocketRoles([ClientRole]);
console.log('Universe is using externally supplied server');
this.smartsocket.setExternalServer('smartexpress', this.options.externalServer);
}
const socketFunctionSubscription = new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
funcName: 'subscribeChannel',
funcDef: async (
dataArg,
socketConnectionArg
) => {
const universeConnection = new UniverseConnection({
socketConnection: socketConnectionArg,
authenticationRequests: [dataArg]
});
await UniverseConnection.addConnectionToCache(this, universeConnection);
return {
subscriptionStatus: 'subscribed'
};
}
});
const socketFunctionSubscription = const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({ allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
funcName: 'subscribeChannel',
funcDef: async (dataArg, socketConnectionArg) => {
const universeConnection = new UniverseConnection({
universe: this,
socketConnection: socketConnectionArg,
authenticationRequests: [dataArg],
});
await UniverseConnection.addConnectionToCache(this, universeConnection);
return {
subscriptionStatus: 'subscribed',
};
},
});
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<any>({
// TODO proper ITypedRequest here instead of any
funcName: 'processMessage', funcName: 'processMessage',
funcDef: async (messageDataArg: interfaces.IUniverseMessage, socketConnectionArg) => { funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection( const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
this.universeCache, this.universeCache,
socketConnectionArg socketConnectionArg
); );
if (universeConnection) { if (universeConnection) {
logger.log('ok', 'found UniverseConnection for socket for incoming message'); plugins.smartlog.defaultLogger.log(
'ok',
'found UniverseConnection for socket for incoming message'
);
} else { } else {
logger.log('warn', 'found no Authorized channel for incoming message'); plugins.smartlog.defaultLogger.log(
'warn',
'found no Authorized channel for incoming message'
);
return { return {
error: 'You need to authenticate for a channel', error: 'You need to authenticate for a channel'
}; };
} }
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload( const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
socketConnectionArg, socketConnectionArg,
messageDataArg dataArg
); );
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel( const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
this.universeCache, this.universeCache,
@ -140,16 +147,22 @@ export class Universe {
const authenticatedMessage = unauthenticatedMessage; const authenticatedMessage = unauthenticatedMessage;
await this.universeCache.addMessage(authenticatedMessage); await this.universeCache.addMessage(authenticatedMessage);
} }
}, }
}); });
// add socket functions // add socket functions
this.smartsocket.addSocketFunction(socketFunctionSubscription); this.smartsocket.addSocketFunction(socketFunctionSubscription);
this.smartsocket.addSocketFunction(socketFunctionProcessMessage); this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
// start the server
if (!this.options.externalServer) {
await this.smartexpressServer.start();
}
// add smartsocket to the running smartexpress app // add smartsocket to the running smartexpress app
await this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer);
await this.smartsocket.start(); await this.smartsocket.start();
logger.log('success', 'started universe'); plugins.smartlog.defaultLogger.log('success', 'started universe');
} }
/** /**
@ -157,5 +170,8 @@ export class Universe {
*/ */
public async stopServer() { public async stopServer() {
await this.smartsocket.stop(); await this.smartsocket.stop();
if (!this.options.externalServer) {
await this.smartexpressServer.stop();
}
} }
} }

View File

@ -1,11 +1,15 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js'; import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseMessage } from './smartuniverse.classes.universemessage.js'; import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { ObjectMap } from '@push.rocks/lik'; import { Objectmap } from '@pushrocks/lik';
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
import { Universe } from './smartuniverse.classes.universe.js'; import { Observable, from } from 'rxjs';
import { filter } from 'rxjs/operators';
import { rxjs } from '@pushrocks/smartrx';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
import { Universe } from './smartuniverse.classes.universe';
/** /**
* universe store handles the creation, storage and retrieval of messages. * universe store handles the creation, storage and retrieval of messages.
@ -15,22 +19,22 @@ export class UniverseCache {
// INSTANCE // INSTANCE
// ======== // ========
public standardMessageExpiry: number; public standardMessageExpiry: number;
public destructionTime: number = 10000; public destructionTime: number = 60000;
/** /**
* stores messages for this instance * stores messages for this instance
*/ */
public messageMap = new ObjectMap<UniverseMessage<any>>(); public messageMap = new Objectmap<UniverseMessage>();
/** /**
* stores the channels that are available within the universe * stores the channels that are available within the universe
*/ */
public channelMap = new ObjectMap<UniverseChannel>(); public channelMap = new Objectmap<UniverseChannel>();
/** /**
* stores all connections * 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 * allows messages to be processed in a blacklist mode for further analysis
@ -50,11 +54,11 @@ export class UniverseCache {
* @param messageArg * @param messageArg
* @param attachedPayloadArg * @param attachedPayloadArg
*/ */
public async addMessage(messageArg: UniverseMessage<any>) { public async addMessage(messageArg: UniverseMessage) {
messageArg.setUniverseCache(this); messageArg.setUniverseCache(this);
UniverseChannel.authorizeAMessageForAChannel(this, messageArg); UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
this.messageMap.add(messageArg); this.messageMap.add(messageArg);
messageArg.universeChannelList.forEach((universeChannel) => { messageArg.universeChannelList.forEach(universeChannel => {
universeChannel.push(messageArg); universeChannel.push(messageArg);
}); });
} }
@ -65,9 +69,9 @@ export class UniverseCache {
public readMessagesYoungerThan( public readMessagesYoungerThan(
unixTimeArg?: number, unixTimeArg?: number,
channelName?: string channelName?: string
): plugins.smartrx.rxjs.Observable<UniverseMessage<any>> { ): Observable<UniverseMessage> {
const messageObservable = plugins.smartrx.rxjs.from(this.messageMap.getArray()).pipe( const messageObservable = from(this.messageMap.getArray()).pipe(
plugins.smartrx.rxjs.ops.filter((messageArg) => { filter(messageArg => {
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime); return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
}) })
); );

View File

@ -1,11 +1,10 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces';
import { UniverseCache } from './smartuniverse.classes.universecache.js'; import { UniverseCache } from './smartuniverse.classes.universecache';
import { UniverseMessage } from './smartuniverse.classes.universemessage.js'; import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js'; import { UniverseConnection } from './smartuniverse.classes.universeconnection';
import { Universe } from './smartuniverse.classes.universe.js'; import { Universe } from './smartuniverse.classes.universe';
import { logger } from './smartuniverse.logging.js';
/** /**
* enables messages to stay within a certain scope. * enables messages to stay within a certain scope.
@ -34,7 +33,7 @@ export class UniverseChannel {
* returns boolean wether certain channel exists * returns boolean wether certain channel exists
*/ */
public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) { public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
const channel = universeCacheArg.channelMap.findSync((channelArg) => { const channel = universeCacheArg.channelMap.find(channelArg => {
return channelArg.name === channelNameArg; return channelArg.name === channelNameArg;
}); });
if (channel) { if (channel) {
@ -53,27 +52,27 @@ export class UniverseChannel {
*/ */
public static authorizeAMessageForAChannel( public static authorizeAMessageForAChannel(
universeCacheArg: UniverseCache, universeCacheArg: UniverseCache,
universeMessageArg: UniverseMessage<any> universeMessageArg: UniverseMessage
): UniverseChannel { ): UniverseChannel {
const foundChannel = universeCacheArg.channelMap.findSync((universeChannel) => { const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
const result = universeChannel.authenticate(universeMessageArg); const result = universeChannel.authenticate(universeMessageArg);
return result; return result;
}); });
if (foundChannel) { if (foundChannel) {
universeMessageArg.authenticated = true; universeMessageArg.authenticated = true;
universeMessageArg.universeChannelList.add(foundChannel); universeMessageArg.universeChannelList.add(foundChannel);
logger.log('ok', 'message authorized'); plugins.smartlog.defaultLogger.log('ok', 'message authorized');
return foundChannel; return foundChannel;
} else { } else {
universeMessageArg.authenticated = false; universeMessageArg.authenticated = false;
universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel); universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
logger.log('warn', 'message not valid'); plugins.smartlog.defaultLogger.log('warn', 'message not valid');
return null; return null;
} }
} }
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) { public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
return universeRef.universeCache.channelMap.findSync((channelArg) => { return universeRef.universeCache.channelMap.find(channelArg => {
return channelArg.name === universeChannelName; return channelArg.name === universeChannelName;
}); });
} }
@ -86,7 +85,7 @@ export class UniverseChannel {
*/ */
public name: string; public name: string;
public universeRef: Universe; public universeRef: Universe;
private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage<any>>(); private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage>();
/** /**
* the passphrase for the channel * the passphrase for the channel
@ -104,7 +103,7 @@ export class UniverseChannel {
* # the messages channelName against the unverseChannel's name * # the messages channelName against the unverseChannel's name
* # the messages password against the universeChannel's password * # the messages password against the universeChannel's password
*/ */
public authenticate(universeMessageArg: UniverseMessage<any>): boolean { public authenticate(universeMessageArg: UniverseMessage): boolean {
return ( return (
this.name === universeMessageArg.targetChannelName && this.name === universeMessageArg.targetChannelName &&
this.passphrase === universeMessageArg.passphrase this.passphrase === universeMessageArg.passphrase
@ -115,10 +114,10 @@ export class UniverseChannel {
* pushes a message to clients * pushes a message to clients
* @param messageArg * @param messageArg
*/ */
public async push(messageArg: UniverseMessage<any>) { public async push(messageArg: UniverseMessage) {
this.subject.next(messageArg); this.subject.next(messageArg);
const universeConnectionsWithChannelAccess: UniverseConnection[] = []; const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
await this.universeRef.universeCache.connectionMap.forEach(async (socketConnection) => { this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
if (socketConnection.authenticatedChannels.includes(this)) { if (socketConnection.authenticatedChannels.includes(this)) {
universeConnectionsWithChannelAccess.push(socketConnection); universeConnectionsWithChannelAccess.push(socketConnection);
} }
@ -133,6 +132,7 @@ export class UniverseChannel {
targetChannelName: this.name, targetChannelName: this.name,
messageText: messageArg.messageText, messageText: messageArg.messageText,
payload: messageArg.payload, payload: messageArg.payload,
payloadStringType: messageArg.payloadStringType
}; };
smartsocket.clientCall( smartsocket.clientCall(
'processMessage', 'processMessage',
@ -143,27 +143,23 @@ export class UniverseChannel {
} }
// functions to interact with a channel locally // functions to interact with a channel locally
public subscribe(observingFunctionArg: (messageArg: UniverseMessage<any>) => void) { public async subscribe(observer: plugins.smartrx.rxjs.Observer<any>) {
return this.subject.subscribe( return this.subject.subscribe(observer);
(messageArg) => {
observingFunctionArg(messageArg);
},
(error) => console.log(error)
);
} }
/** /**
* sends a message to the channel * sends a message to the channel
*/ */
public async postMessage(messageDescriptor: interfaces.IMessageCreator) { public async sendMessage(messageDescriptor: interfaces.IMessageCreator) {
const messageToSend = new UniverseMessage({ const messageToSend = new UniverseMessage({
id: plugins.isounique.uni(), id: plugins.smartunique.shortId(),
messageText: messageDescriptor.messageText, messageText: messageDescriptor.messageText,
payload: messageDescriptor.payload, payload: messageDescriptor.payload,
payloadStringType: messageDescriptor.payloadStringType,
targetChannelName: this.name, targetChannelName: this.name,
passphrase: this.passphrase, passphrase: this.passphrase,
timestamp: Date.now(), timestamp: Date.now()
}); });
this.universeRef.universeCache.addMessage(messageToSend); this.push(messageToSend);
} }
} }

View File

@ -1,8 +1,8 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js'; import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseCache } from './smartuniverse.classes.universecache.js'; import { UniverseCache } from './smartuniverse.classes.universecache';
import { Universe } from './smartuniverse.classes.universe.js'; import { Universe } from './smartuniverse.classes.universe';
/** /**
* represents a connection to the universe * represents a connection to the universe
@ -26,7 +26,6 @@ export class UniverseConnection {
universeConnection universeConnection
); );
universeRef.universeCache.connectionMap.add(universeConnection); universeRef.universeCache.connectionMap.add(universeConnection);
console.log('hi');
} }
/** /**
@ -37,7 +36,7 @@ export class UniverseConnection {
universeConnectionArg: UniverseConnection universeConnectionArg: UniverseConnection
): Promise<UniverseConnection> { ): Promise<UniverseConnection> {
let connectionToReturn: UniverseConnection; let connectionToReturn: UniverseConnection;
universeCache.connectionMap.forEach(async (existingConnection) => { universeCache.connectionMap.forEach(async existingConnection => {
if (existingConnection.socketConnection === universeConnectionArg.socketConnection) { if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
connectionToReturn = await this.mergeUniverseConnections( connectionToReturn = await this.mergeUniverseConnections(
existingConnection, existingConnection,
@ -87,14 +86,12 @@ export class UniverseConnection {
universeCache: UniverseCache, universeCache: UniverseCache,
socketConnectionArg: plugins.smartsocket.SocketConnection socketConnectionArg: plugins.smartsocket.SocketConnection
): UniverseConnection { ): UniverseConnection {
const universeConnection = universeCache.connectionMap.findSync((universeConnectionArg) => { const universeConnection = universeCache.connectionMap.find(universeConnectionArg => {
return universeConnectionArg.socketConnection === socketConnectionArg; return universeConnectionArg.socketConnection === socketConnectionArg;
}); });
return universeConnection; return universeConnection;
} }
// INSTANCE
public universeRef: Universe;
public terminatedDeferred = plugins.smartpromise.defer(); public terminatedDeferred = plugins.smartpromise.defer();
/** /**
@ -102,34 +99,23 @@ export class UniverseConnection {
*/ */
public socketConnection: plugins.smartsocket.SocketConnection; public socketConnection: plugins.smartsocket.SocketConnection;
public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = []; public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
public subscribedChannels: UniverseChannel[] = [];
public authenticatedChannels: UniverseChannel[] = []; public authenticatedChannels: UniverseChannel[] = [];
public failedToJoinChannels: UniverseChannel[] = []; public failedToJoinChannels: UniverseChannel[] = [];
/** /**
* disconnect the connection * terminates the connection
*/ */
public async disconnect(reason: 'upstreamevent' | 'triggered' = 'triggered') { public terminateConnection() {
if (reason === 'triggered') { this.socketConnection.socket.disconnect();
await this.socketConnection.disconnect();
}
this.universeRef.universeCache.connectionMap.remove(this);
this.terminatedDeferred.resolve(); this.terminatedDeferred.resolve();
} }
constructor(optionsArg: { constructor(optionsArg: {
universe: Universe;
socketConnection: plugins.smartsocket.SocketConnection; socketConnection: plugins.smartsocket.SocketConnection;
authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>; authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
}) { }) {
this.universeRef = optionsArg.universe;
this.authenticationRequests = optionsArg.authenticationRequests; this.authenticationRequests = optionsArg.authenticationRequests;
this.socketConnection = optionsArg.socketConnection; this.socketConnection = optionsArg.socketConnection;
this.socketConnection.eventSubject.subscribe(async (eventArg) => {
switch (eventArg) {
case 'disconnected':
await this.disconnect('upstreamevent');
break;
}
});
} }
} }

View File

@ -1,16 +1,19 @@
import * as plugins from './smartuniverse.plugins.js'; import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces';
import { Universe } from './smartuniverse.classes.universe.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js'; import { Objectmap } from '@pushrocks/lik';
import { UniverseCache } from './smartuniverse.classes.universecache.js';
import { SocketConnection } from '@push.rocks/smartsocket'; import { Timer, TimeStamp } from '@pushrocks/smarttime';
import { logger } from './smartuniverse.logging.js'; import { Universe } from './smartuniverse.classes.universe';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseCache } from './smartuniverse.classes.universecache';
import { SocketConnection } from '@pushrocks/smartsocket';
/** /**
* represents a message within a universe * represents a message within a universe
* acts as a container to save message states like authentication status * acts as a container to save message states like authentication status
*/ */
export class UniverseMessage<T> implements interfaces.IUniverseMessage { export class UniverseMessage implements interfaces.IUniverseMessage {
public static createMessageFromPayload( public static createMessageFromPayload(
socketConnectionArg: SocketConnection, socketConnectionArg: SocketConnection,
dataArg: interfaces.IUniverseMessage dataArg: interfaces.IUniverseMessage
@ -22,10 +25,11 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
public id: string; public id: string;
public timestamp: number; public timestamp: number;
public smartTimestamp: plugins.smarttime.TimeStamp; public smartTimestamp: TimeStamp;
public messageText: string; public messageText: string;
public passphrase: string; public passphrase: string;
public payload: T; public payload: any;
public payloadStringType;
public targetChannelName: string; public targetChannelName: string;
public socketConnection: SocketConnection; public socketConnection: SocketConnection;
@ -37,7 +41,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
/** /**
* enables unprotected grouping of messages for efficiency purposes. * enables unprotected grouping of messages for efficiency purposes.
*/ */
public universeChannelList = new plugins.lik.ObjectMap<UniverseChannel>(); public universeChannelList = new Objectmap<UniverseChannel>();
/** /**
* wether the message is authenticated * wether the message is authenticated
@ -47,7 +51,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
/** /**
* a destruction timer for this message * a destruction timer for this message
*/ */
public destructionTimer: plugins.smarttime.Timer; // a timer to take care of message destruction public destructionTimer: Timer; // a timer to take care of message destruction
/** /**
* the constructor to create a universe message * the constructor to create a universe message
@ -55,13 +59,13 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
* @param attachedPayloadArg * @param attachedPayloadArg
*/ */
constructor(messageDescriptor: interfaces.IUniverseMessage) { constructor(messageDescriptor: interfaces.IUniverseMessage) {
this.smartTimestamp = new plugins.smarttime.TimeStamp(this.timestamp); this.smartTimestamp = new TimeStamp(this.timestamp);
this.messageText = messageDescriptor.messageText; this.messageText = messageDescriptor.messageText;
this.targetChannelName = messageDescriptor.targetChannelName; this.targetChannelName = messageDescriptor.targetChannelName;
this.passphrase = messageDescriptor.passphrase; this.passphrase = messageDescriptor.passphrase;
this.payload = messageDescriptor.payload; this.payload = messageDescriptor.payload;
// prevent memory issues // prevent memory issues
this.setDestructionTimer(); this.fallBackDestruction();
} }
public setUniverseCache(universeCacheArg: UniverseCache) { public setUniverseCache(universeCacheArg: UniverseCache) {
@ -70,25 +74,17 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
public setTargetChannel() {} public setTargetChannel() {}
public setDestructionTimer(selfdestructAfterArg?: number) { public setDestructionTimer(selfdestructAfterArg: number) {
if (selfdestructAfterArg) { if (selfdestructAfterArg) {
this.destructionTimer = new plugins.smarttime.Timer(selfdestructAfterArg); this.destructionTimer = new Timer(selfdestructAfterArg);
this.destructionTimer.start(); this.destructionTimer.start();
// set up self destruction by removing this from the parent messageCache // set up self destruction by removing this from the parent messageCache
this.destructionTimer.completed this.destructionTimer.completed.then(async () => {
.then(async () => { this.universeCache.messageMap.remove(this);
this.universeCache.messageMap.remove(this);
})
.catch((err) => {
console.log(err);
console.log(this);
});
} else {
plugins.smartdelay.delayFor(1000).then(() => {
if (!this.destructionTimer) {
this.setDestructionTimer(6000);
}
}); });
} else {
this.fallBackDestruction();
} }
} }
@ -96,6 +92,17 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
* handles bad messages for further analysis * handles bad messages for further analysis
*/ */
public handleAsBadMessage() { public handleAsBadMessage() {
logger.log('warn', 'received a bad message'); 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);
}
});
} }
} }

View File

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

View File

@ -0,0 +1,3 @@
import * as plugins from './smartuniverse.plugins';
export const packageJson = plugins.path.join(__dirname, '../package.json');

View File

@ -1,29 +1,33 @@
// apiglobal scope // node native
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces'; import * as path from 'path';
export { typedrequestInterfaces }; export { path };
// pushrocks scope // pushrocks scope
import * as lik from '@push.rocks/lik'; import * as lik from '@pushrocks/lik';
import * as isohash from '@push.rocks/isohash'; import * as smarthash from '@pushrocks/smarthash';
import * as isounique from '@push.rocks/isounique'; import * as smartdelay from '@pushrocks/smartdelay';
import * as smartdelay from '@push.rocks/smartdelay'; import * as smartexpress from '@pushrocks/smartexpress';
import * as smartlog from '@push.rocks/smartlog'; import * as smartfile from '@pushrocks/smartfile';
import * as smartpromise from '@push.rocks/smartpromise'; import * as smartlog from '@pushrocks/smartlog';
import * as smartrx from '@push.rocks/smartrx'; import * as smartpromise from '@pushrocks/smartpromise';
import * as smartsocket from '@push.rocks/smartsocket'; import * as smartrequest from '@pushrocks/smartrequest';
import * as smarttime from '@push.rocks/smarttime'; import * as smartrx from '@pushrocks/smartrx';
import * as smarturl from '@push.rocks/smarturl'; import * as smartsocket from '@pushrocks/smartsocket';
import * as smarttime from '@pushrocks/smarttime';
import * as smartunique from '@pushrocks/smartunique';
export { export {
lik, lik,
isohash, smarthash,
isounique,
smartdelay, smartdelay,
smartexpress,
smartfile,
smartlog, smartlog,
smartpromise, smartpromise,
smartrx, smartrx,
smartrequest,
smartsocket, smartsocket,
smarttime, smarttime,
smarturl, smartunique
}; };

View File

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

View File

@ -1,14 +0,0 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

17
tslint.json Normal file
View File

@ -0,0 +1,17 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}