Compare commits
35 Commits
Author | SHA1 | Date | |
---|---|---|---|
496fd9a81a | |||
f7720251ff | |||
b27c340f7d | |||
4cef457816 | |||
751d7955d1 | |||
466a0331f1 | |||
38bc55d109 | |||
b26f4076ab | |||
4ccbc004db | |||
b5fcefa93b | |||
67f60187ae | |||
176c6ba261 | |||
af6c634deb | |||
a5ce7b18e8 | |||
b6b482f7db | |||
39ed2dbd73 | |||
b1defd95a3 | |||
a4ad33a0ee | |||
18fad25b8c | |||
82f4413064 | |||
71bccf54f1 | |||
78ee8f2592 | |||
820ce76fe3 | |||
5d8c2064e0 | |||
9d1fc94e06 | |||
c4640a3bc7 | |||
b6392ec6ba | |||
bd4897f392 | |||
dbdc8a2811 | |||
908d00981b | |||
669ef262d7 | |||
30053fe441 | |||
afb4e3339a | |||
e413a8116d | |||
ffeed0565c |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
||||
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
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
||||
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
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
119
.gitlab-ci.yml
119
.gitlab-ci.yml
@ -1,119 +0,0 @@
|
||||
# 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
4
.snyk
@ -1,4 +0,0 @@
|
||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||
version: v1.13.5
|
||||
ignore: {}
|
||||
patch: {}
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal 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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
@ -1,17 +1,33 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartuniverse",
|
||||
"shortDescription": "messaging service for micro services",
|
||||
"npmPackagename": "@pushrocks/smartuniverse",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"npmPackagename": "@push.rocks/smartuniverse",
|
||||
"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": {
|
||||
"npmGlobalTools": [],
|
||||
"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"
|
||||
}
|
||||
}
|
3006
package-lock.json
generated
3006
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
91
package.json
91
package.json
@ -1,53 +1,72 @@
|
||||
{
|
||||
"name": "@pushrocks/smartuniverse",
|
||||
"version": "1.0.93",
|
||||
"name": "@push.rocks/smartuniverse",
|
||||
"version": "1.0.108",
|
||||
"private": false,
|
||||
"description": "messaging service for your micro services",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"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)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
||||
"format": "(gitzone format)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"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",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"rxjs": "*"
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsbundle": "^2.0.8",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.12",
|
||||
"@types/node": "^20.4.4"
|
||||
},
|
||||
"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",
|
||||
"@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"
|
||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
||||
"@apiglobal/typedserver": "^2.0.65",
|
||||
"@push.rocks/isohash": "^2.0.1",
|
||||
"@push.rocks/isounique": "^1.0.5",
|
||||
"@push.rocks/lik": "^6.0.3",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.0.3",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"@push.rocks/smartsocket": "^2.0.20",
|
||||
"@push.rocks/smarttime": "^4.0.4",
|
||||
"@push.rocks/smarturl": "^3.0.7"
|
||||
},
|
||||
"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"
|
||||
],
|
||||
"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
Normal file
4610
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
148
readme.md
148
readme.md
@ -1,55 +1,127 @@
|
||||
# @pushrocks/smartuniverse
|
||||
messaging service for micro services
|
||||
# @push.rocks/smartuniverse
|
||||
messaging service for your micro services
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartuniverse/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartuniverse/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartuniverse)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartuniverse)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
## Install
|
||||
To install `@push.rocks/smartuniverse`, use the following command with npm:
|
||||
```bash
|
||||
npm install @push.rocks/smartuniverse --save
|
||||
```
|
||||
This command adds `@push.rocks/smartuniverse` to your project's dependencies.
|
||||
|
||||
## 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.
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
### Server side setup: Creating your Universe
|
||||
|
||||
### 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.
|
||||
First, you need to set up the server side of your messaging ecosystem, which involves creating a "universe" where channels reside.
|
||||
|
||||
```typescript
|
||||
import * as smartuniverse from '@pushrocks/smartuniverse';
|
||||
import { Universe } from '@push.rocks/smartuniverse';
|
||||
|
||||
const myUniverse = new smartuniverse.Universe({
|
||||
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
|
||||
// Initialize a new Universe
|
||||
const myUniverse = new Universe({
|
||||
messageExpiryInMilliseconds: 60000, // messages expire after 60 seconds
|
||||
});
|
||||
|
||||
// create as many channels as you like
|
||||
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
|
||||
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
|
||||
// Create channels for communication within the universe
|
||||
// These channels can be thought of as topics or queues that services can subscribe to or post messages to
|
||||
myUniverse.addChannel('channel-one', 'password1');
|
||||
myUniverse.addChannel('channel-two', 'password2');
|
||||
|
||||
myUniverse.start(8765); // start the server and provide the port on which to listen on
|
||||
// Start the universe server on a specified port
|
||||
myUniverse.start(8765);
|
||||
```
|
||||
|
||||
### Client side
|
||||
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.
|
||||
|
||||
All your microservices represents clients in the universe that may talk to each other using the universe server.
|
||||
### Client side: Microservices joining the Universe
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
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.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
```typescript
|
||||
import { ClientUniverse, ClientUniverseChannel } from '@push.rocks/smartuniverse';
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
// Initialize client that connects to the universe server
|
||||
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.
|
||||
|
53
test/test.ts
53
test/test.ts
@ -1,8 +1,6 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartuniverse from '../ts/index';
|
||||
|
||||
import { Observable } from 'rxjs';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartuniverse from '../ts/index.js';
|
||||
|
||||
let testUniverse: smartuniverse.Universe;
|
||||
let testClientUniverse: smartuniverse.ClientUniverse;
|
||||
@ -10,17 +8,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,9 +29,10 @@ 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);
|
||||
expect(testClientUniverse).toBeInstanceOf(smartuniverse.ClientUniverse);
|
||||
});
|
||||
|
||||
tap.test('should add a channel to the universe', async () => {
|
||||
@ -50,22 +49,23 @@ tap.test('should start the ClientUniverse', async () => {
|
||||
|
||||
tap.test('should get a observable correctly', async () => {
|
||||
testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
|
||||
expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
|
||||
expect(testClientChannel).toBeInstanceOf(smartuniverse.ClientUniverseChannel);
|
||||
});
|
||||
|
||||
tap.test('should send a message correctly', async () => {
|
||||
await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
|
||||
messageText: 'hello'
|
||||
await testClientUniverse.getChannel(testChannelData.channelName).postMessage({
|
||||
messageText: 'hello',
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('universe should contain the sent message', async () => {
|
||||
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
|
||||
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).toEqual('hello');
|
||||
});
|
||||
|
||||
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 +76,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 +101,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);
|
||||
});
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartuniverse',
|
||||
version: '1.0.108',
|
||||
description: 'messaging service for your micro services'
|
||||
}
|
20
ts/index.ts
20
ts/index.ts
@ -1,16 +1,16 @@
|
||||
// Client classes
|
||||
export * from './smartuniverse.classes.clientuniverse';
|
||||
export * from './smartuniverse.classes.clientuniversechannel';
|
||||
export * from './smartuniverse.classes.clientuniversemessage';
|
||||
export * from './smartuniverse.classes.client.universe.js';
|
||||
export * from './smartuniverse.classes.client.universechannel.js';
|
||||
export * from './smartuniverse.classes.client.universemessage.js';
|
||||
|
||||
// Server classes
|
||||
export * from './smartuniverse.classes.universe';
|
||||
export * from './smartuniverse.classes.universecache';
|
||||
export * from './smartuniverse.classes.universechannel';
|
||||
export * from './smartuniverse.classes.universemessage';
|
||||
export * from './smartuniverse.classes.universe.js';
|
||||
export * from './smartuniverse.classes.universecache.js';
|
||||
export * from './smartuniverse.classes.universechannel.js';
|
||||
export * from './smartuniverse.classes.universemessage.js';
|
||||
|
||||
// Reaction Response
|
||||
export * from './smartuniverse.classes.reactionrequest';
|
||||
export * from './smartuniverse.classes.reactionresponse';
|
||||
export * from './smartuniverse.classes.event.reactionrequest.js';
|
||||
export * from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export * from './interfaces';
|
||||
export * from './interfaces/index.js';
|
||||
|
@ -1,5 +1,5 @@
|
||||
export * from './http.interfaces';
|
||||
export * from './socketfunctionrequests';
|
||||
export * from './universechannel.interfaces';
|
||||
export * from './universemessage.interfaces';
|
||||
export * from './universeactions.interfaces';
|
||||
export * from './http.interfaces.js';
|
||||
export * from './socketfunctionrequests.js';
|
||||
export * from './universechannel.interfaces.js';
|
||||
export * from './universemessage.interfaces.js';
|
||||
export * from './universeactions.interfaces.js';
|
||||
|
@ -1,4 +1,4 @@
|
||||
import * as interfaces from './index';
|
||||
import * as interfaces from './index.js';
|
||||
|
||||
export interface ISocketRequest_SubscribeChannel {
|
||||
method: 'subscribeChannel';
|
||||
|
@ -1,10 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
/**
|
||||
* broadcasts an event to multiple channels
|
||||
*/
|
||||
export class BroadcastEvent<T> {
|
||||
fire() {
|
||||
|
||||
}
|
||||
};
|
@ -1,5 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
export class BroadcastSUbscription {
|
||||
|
||||
}
|
@ -1,17 +1,15 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { Smartsocket, SmartsocketClient } from '@push.rocks/smartsocket';
|
||||
|
||||
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/index.js';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
|
||||
import { ClientUniverseChannel, ClientUniverseMessage } from './';
|
||||
import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
|
||||
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;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -24,6 +22,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 +54,7 @@ export class ClientUniverse {
|
||||
* @param passphraseArg
|
||||
*/
|
||||
public getChannel(channelName: string): ClientUniverseChannel {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.findSync((channel) => {
|
||||
return channel.name === channelName;
|
||||
});
|
||||
return clientUniverseChannel;
|
||||
@ -65,18 +65,22 @@ export class ClientUniverse {
|
||||
* @param messageArg
|
||||
*/
|
||||
public removeChannel(channelNameArg, notifyServer = true) {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
|
||||
channelItemArg => {
|
||||
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');
|
||||
}
|
||||
|
||||
@ -84,19 +88,17 @@ 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 parsedURL = plugins.smarturl.Smarturl.createFromUrl(this.options.serverAddress);
|
||||
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
|
||||
alias: 'universeclient',
|
||||
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');
|
||||
@ -110,31 +112,27 @@ export class ClientUniverse {
|
||||
*/
|
||||
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
|
||||
funcName: 'unsubscribe',
|
||||
allowedRoles: [],
|
||||
funcDef: async (dataArg: interfaces.IServerUnsubscribeActionPayload) => {
|
||||
const channel = this.clientUniverseCache.channelMap.find(channelArg => {
|
||||
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
|
||||
>({
|
||||
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
|
||||
);
|
||||
funcDef: async (messageDescriptorArg) => {
|
||||
logger.log('info', 'Got message from server');
|
||||
const clientUniverseMessage =
|
||||
ClientUniverseMessage.createMessageFromMessageDescriptor(messageDescriptorArg);
|
||||
this.messageRxjsSubject.next(clientUniverseMessage);
|
||||
|
||||
// lets find the corresponding channel
|
||||
@ -142,14 +140,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 +155,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();
|
||||
}
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
|
||||
|
||||
/**
|
||||
* 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>();
|
||||
}
|
@ -1,10 +1,10 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
import { ClientUniverse } from './';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
|
||||
import { ReactionRequest } from './smartuniverse.classes.reactionrequest';
|
||||
import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
|
||||
import { ClientUniverse } from './index.js';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage.js';
|
||||
import { ReactionRequest } from './smartuniverse.classes.event.reactionrequest.js';
|
||||
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
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)
|
||||
);
|
||||
}
|
||||
|
||||
@ -70,12 +69,14 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
public async populateSubscriptionToServer() {
|
||||
// lets make sure the channel is connected
|
||||
if (this.status === 'unsubscribed') {
|
||||
const response = await this.clientUniverseRef.smartsocketClient.serverCall<
|
||||
interfaces.ISocketRequest_SubscribeChannel
|
||||
>('subscribeChannel', {
|
||||
const response =
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>(
|
||||
'subscribeChannel',
|
||||
{
|
||||
name: this.name,
|
||||
passphrase: this.passphrase
|
||||
});
|
||||
passphrase: this.passphrase,
|
||||
}
|
||||
);
|
||||
this.status = response.subscriptionStatus;
|
||||
}
|
||||
}
|
||||
@ -88,15 +89,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(),
|
||||
id: plugins.isounique.uni(),
|
||||
timestamp: Date.now(),
|
||||
passphrase: this.passphrase,
|
||||
targetChannelName: this.name,
|
||||
messageText: messageArg.messageText,
|
||||
payload: messageArg.payload
|
||||
payload: messageArg.payload,
|
||||
};
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall(
|
||||
'processMessage',
|
@ -1,6 +1,6 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
export class ClientUniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
// ======
|
17
ts/smartuniverse.classes.event.broadcastevent.ts
Normal file
17
ts/smartuniverse.classes.event.broadcastevent.ts
Normal file
@ -0,0 +1,17 @@
|
||||
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);
|
||||
}
|
||||
}
|
83
ts/smartuniverse.classes.event.reactionrequest.ts
Normal file
83
ts/smartuniverse.classes.event.reactionrequest.ts
Normal file
@ -0,0 +1,83 @@
|
||||
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;
|
||||
}
|
||||
}
|
@ -1,12 +1,14 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import { ICombinatorPayload } from './smartuniverse.classes.reactionrequest';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
|
||||
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 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,
|
||||
});
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { ReactionResponse } from './smartuniverse.classes.reactionresponse';
|
||||
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']>();
|
||||
@ -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();
|
||||
});
|
@ -1,66 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
|
||||
import { ReactionResult } from './smartuniverse.classes.reactionresult';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.clientuniversemessage';
|
||||
|
||||
export interface IReactionRequestConstructorOptions<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||
method: T['method'];
|
||||
}
|
||||
|
||||
export interface ICombinatorPayload<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||
/**
|
||||
* needed for tying responses to requests
|
||||
*/
|
||||
id: string;
|
||||
typedRequestPayload: {
|
||||
method: T['method'],
|
||||
request : T['request'],
|
||||
response: T['response']
|
||||
};
|
||||
}
|
||||
|
||||
export class ReactionRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||
public method: T['method'];
|
||||
|
||||
constructor(optionsArg: IReactionRequestConstructorOptions<T>) {
|
||||
this.method = optionsArg.method;
|
||||
}
|
||||
|
||||
public async fire(channelsArg: Array<UniverseChannel | ClientUniverseChannel>, requestDataArg: T['request'], timeoutMillisArg=5000) {
|
||||
const subscriptionMap = new plugins.lik.Objectmap<plugins.smartrx.rxjs.Subscription>();
|
||||
const reactionResult = new ReactionResult<T>();
|
||||
const requestId = plugins.smartunique.shortId();
|
||||
for (const channel of channelsArg) {
|
||||
subscriptionMap.add(channel.subscribe((messageArg: UniverseMessage<ICombinatorPayload<T>> | ClientUniverseMessage<ICombinatorPayload<T>>) => {
|
||||
if (messageArg.messageText === 'reactionResponse' && messageArg.payload.typedRequestPayload.method === this.method) {
|
||||
const payload: ICombinatorPayload<T> = messageArg.payload;
|
||||
if (payload.id !== requestId) {
|
||||
return;
|
||||
}
|
||||
reactionResult.pushReactionResponse(payload.typedRequestPayload.response);
|
||||
}
|
||||
}));
|
||||
const payload: ICombinatorPayload<T> = {
|
||||
id: requestId,
|
||||
typedRequestPayload: {
|
||||
method: this.method,
|
||||
request: requestDataArg,
|
||||
response: null
|
||||
}
|
||||
};
|
||||
channel.sendMessage({
|
||||
messageText: 'reactionRequest',
|
||||
payload
|
||||
});
|
||||
}
|
||||
plugins.smartdelay.delayFor(timeoutMillisArg).then(async () => {
|
||||
await subscriptionMap.forEach(subscriptionArg => {
|
||||
subscriptionArg.unsubscribe();
|
||||
});
|
||||
reactionResult.complete();
|
||||
});
|
||||
return reactionResult;
|
||||
}
|
||||
}
|
@ -1,16 +1,15 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as pluginsTyped from './smartuniverse.pluginstyped.js';
|
||||
|
||||
import { Handler, Route, Server } from '@pushrocks/smartexpress';
|
||||
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
|
||||
import { UniverseCache, UniverseChannel, UniverseMessage } from './index.js';
|
||||
|
||||
import * as paths from './smartuniverse.paths';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
export interface ISmartUniverseConstructorOptions {
|
||||
messageExpiryInMilliseconds: number;
|
||||
externalServer?: plugins.smartexpress.Server;
|
||||
externalServer?: pluginsTyped.typedserver.servertools.Server;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -26,7 +25,7 @@ export class Universe {
|
||||
/**
|
||||
* the smartexpress server used
|
||||
*/
|
||||
private smartexpressServer: plugins.smartexpress.Server;
|
||||
private server: pluginsTyped.typedserver.servertools.Server;
|
||||
|
||||
/**
|
||||
* the smartsocket used
|
||||
@ -47,7 +46,7 @@ export class Universe {
|
||||
/**
|
||||
* get the currently running version of smartuniverse
|
||||
*/
|
||||
public getUniverseVersion() {
|
||||
/* public getUniverseVersion() {
|
||||
if (this.universeVersionStore) {
|
||||
return this.universeVersionStore;
|
||||
} else {
|
||||
@ -55,7 +54,7 @@ export class Universe {
|
||||
this.universeVersionStore = packageJson.version;
|
||||
return this.universeVersionStore;
|
||||
}
|
||||
}
|
||||
} */
|
||||
|
||||
/**
|
||||
* adds a channel to the Universe
|
||||
@ -69,7 +68,7 @@ export class Universe {
|
||||
* returns a channel
|
||||
*/
|
||||
public getChannel(channelNameArg: string) {
|
||||
return this.universeCache.channelMap.find(channelArg => {
|
||||
return this.universeCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === channelNameArg;
|
||||
});
|
||||
}
|
||||
@ -77,77 +76,61 @@ 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,
|
||||
port: portArg
|
||||
});
|
||||
} else {
|
||||
console.log('Universe is using externally supplied server');
|
||||
this.smartexpressServer = this.options.externalServer;
|
||||
public async start(portArg?: number) {
|
||||
if (!this.options.externalServer && !portArg) {
|
||||
throw new Error(`You supplied an external error. You need to specify a portArg to start on.`);
|
||||
}
|
||||
|
||||
// add websocket upgrade
|
||||
this.smartsocket = new plugins.smartsocket.Smartsocket({});
|
||||
portArg = portArg || 3000; // TODO: remove
|
||||
|
||||
// add a role for the clients
|
||||
const ClientRole = new plugins.smartsocket.SocketRole({
|
||||
name: 'UniverseClient',
|
||||
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
|
||||
// add websocket upgrade
|
||||
this.smartsocket = new plugins.smartsocket.Smartsocket({
|
||||
alias: 'smartuniverse',
|
||||
port: portArg,
|
||||
});
|
||||
|
||||
// add the role to smartsocket
|
||||
this.smartsocket.addSocketRoles([ClientRole]);
|
||||
// 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);
|
||||
}
|
||||
|
||||
const socketFunctionSubscription = new plugins.smartsocket.SocketFunction<
|
||||
interfaces.ISocketRequest_SubscribeChannel
|
||||
>({
|
||||
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||
|
||||
const socketFunctionSubscription =
|
||||
new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({
|
||||
funcName: 'subscribeChannel',
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
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({
|
||||
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<any>({
|
||||
// TODO proper ITypedRequest here instead of any
|
||||
funcName: 'processMessage',
|
||||
funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||
funcDef: async (messageDataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
|
||||
this.universeCache,
|
||||
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(
|
||||
socketConnectionArg,
|
||||
dataArg
|
||||
messageDataArg
|
||||
);
|
||||
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
|
||||
this.universeCache,
|
||||
@ -157,22 +140,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 +157,5 @@ export class Universe {
|
||||
*/
|
||||
public async stopServer() {
|
||||
await this.smartsocket.stop();
|
||||
if (!this.options.externalServer) {
|
||||
await this.smartexpressServer.stop();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,15 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
|
||||
|
||||
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';
|
||||
import { ObjectMap } from '@push.rocks/lik';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
|
||||
/**
|
||||
* universe store handles the creation, storage and retrieval of messages.
|
||||
@ -24,17 +20,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 +54,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);
|
||||
});
|
||||
}
|
||||
@ -69,9 +65,9 @@ export class UniverseCache {
|
||||
public readMessagesYoungerThan(
|
||||
unixTimeArg?: number,
|
||||
channelName?: string
|
||||
): Observable<UniverseMessage<any>> {
|
||||
const messageObservable = from(this.messageMap.getArray()).pipe(
|
||||
filter(messageArg => {
|
||||
): plugins.smartrx.rxjs.Observable<UniverseMessage<any>> {
|
||||
const messageObservable = plugins.smartrx.rxjs.from(this.messageMap.getArray()).pipe(
|
||||
plugins.smartrx.rxjs.ops.filter((messageArg) => {
|
||||
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
|
||||
})
|
||||
);
|
||||
|
@ -1,10 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
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 { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
/**
|
||||
* 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.findSync((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.findSync((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.findSync((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(),
|
||||
id: plugins.isounique.uni(),
|
||||
messageText: messageDescriptor.messageText,
|
||||
payload: messageDescriptor.payload,
|
||||
targetChannelName: this.name,
|
||||
passphrase: this.passphrase,
|
||||
timestamp: Date.now()
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
this.universeRef.universeCache.addMessage(messageToSend);
|
||||
}
|
||||
|
@ -1,8 +1,8 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||
import { Universe } from './smartuniverse.classes.universe';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
|
||||
/**
|
||||
* represents a connection to the universe
|
||||
@ -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.findSync((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');
|
||||
|
@ -1,13 +1,10 @@
|
||||
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 * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { SocketConnection } from '@push.rocks/smartsocket';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
/**
|
||||
* represents a message within a universe
|
||||
@ -25,7 +22,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
|
||||
public id: string;
|
||||
public timestamp: number;
|
||||
public smartTimestamp: TimeStamp;
|
||||
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||
public messageText: string;
|
||||
public passphrase: string;
|
||||
public payload: T;
|
||||
@ -40,7 +37,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
|
||||
@ -50,7 +47,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
/**
|
||||
* a destruction timer for this message
|
||||
*/
|
||||
public destructionTimer: Timer; // a timer to take care of message destruction
|
||||
public destructionTimer: plugins.smarttime.Timer; // a timer to take care of message destruction
|
||||
|
||||
/**
|
||||
* the constructor to create a universe message
|
||||
@ -58,7 +55,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
* @param attachedPayloadArg
|
||||
*/
|
||||
constructor(messageDescriptor: interfaces.IUniverseMessage) {
|
||||
this.smartTimestamp = new TimeStamp(this.timestamp);
|
||||
this.smartTimestamp = new plugins.smarttime.TimeStamp(this.timestamp);
|
||||
this.messageText = messageDescriptor.messageText;
|
||||
this.targetChannelName = messageDescriptor.targetChannelName;
|
||||
this.passphrase = messageDescriptor.passphrase;
|
||||
@ -75,12 +72,14 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
|
||||
public setDestructionTimer(selfdestructAfterArg?: number) {
|
||||
if (selfdestructAfterArg) {
|
||||
this.destructionTimer = new Timer(selfdestructAfterArg);
|
||||
this.destructionTimer = new plugins.smarttime.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 +96,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');
|
||||
}
|
||||
}
|
||||
|
2
ts/smartuniverse.logging.ts
Normal file
2
ts/smartuniverse.logging.ts
Normal file
@ -0,0 +1,2 @@
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
export const logger = new plugins.smartlog.ConsoleLog();
|
@ -1,3 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
export const packageJson = plugins.path.join(__dirname, '../package.json');
|
@ -1,40 +1,29 @@
|
||||
// node native
|
||||
import * as path from 'path';
|
||||
|
||||
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';
|
||||
import * as smartrequest from '@pushrocks/smartrequest';
|
||||
import * as smartrx from '@pushrocks/smartrx';
|
||||
import * as smartsocket from '@pushrocks/smartsocket';
|
||||
import * as smarttime from '@pushrocks/smarttime';
|
||||
import * as smartunique from '@pushrocks/smartunique';
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as isohash from '@push.rocks/isohash';
|
||||
import * as isounique from '@push.rocks/isounique';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartrx from '@push.rocks/smartrx';
|
||||
import * as smartsocket from '@push.rocks/smartsocket';
|
||||
import * as smarttime from '@push.rocks/smarttime';
|
||||
import * as smarturl from '@push.rocks/smarturl';
|
||||
|
||||
export {
|
||||
lik,
|
||||
smarthash,
|
||||
isohash,
|
||||
isounique,
|
||||
smartdelay,
|
||||
smartexpress,
|
||||
smartfile,
|
||||
smartlog,
|
||||
smartpromise,
|
||||
smartrx,
|
||||
smartrequest,
|
||||
smartsocket,
|
||||
smarttime,
|
||||
smartunique
|
||||
smarturl,
|
||||
};
|
||||
|
5
ts/smartuniverse.pluginstyped.ts
Normal file
5
ts/smartuniverse.pluginstyped.ts
Normal file
@ -0,0 +1,5 @@
|
||||
import type * as typedserver from '@apiglobal/typedserver';
|
||||
|
||||
export type {
|
||||
typedserver
|
||||
};
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user