Compare commits
73 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
736240b978 | |||
73f4600c2a | |||
40beec1166 | |||
f8690fef50 | |||
972ddbf327 | |||
80aacd17a6 | |||
e67b3e50cc | |||
a4a8959b74 | |||
bab0f062f7 | |||
3bdfe4dcb4 | |||
fca960ad0d | |||
e43ed3951c | |||
23df304535 | |||
9a142175aa | |||
09b593e192 | |||
c27fc147b5 | |||
ddde21925a | |||
bd849d347d | |||
f2a85d4719 | |||
4e7c28ac83 | |||
243f1a70e9 | |||
b5a6517756 | |||
e12b128619 | |||
03fbab5265 | |||
1d13bf5bcc | |||
c2052f16a8 | |||
ff7cdc908c | |||
f3d41b8719 | |||
f9f0fc45e2 | |||
da6b7724b8 | |||
be7ca29e4b | |||
f401d78c4b | |||
6ceec0201f | |||
16ce4e09a9 | |||
2868ab686d | |||
5dab36382f | |||
02a32eb8c7 | |||
b258979b5a | |||
166e29bbf6 | |||
870f37d403 | |||
64c4b91678 | |||
f3e13292d8 | |||
7e1c405cb1 | |||
d1b4672eff | |||
0dd9fee52b |
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,11 +1,12 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartuniverse",
|
||||
"shortDescription": "messaging service for micro services",
|
||||
"npmPackagename": "@pushrocks/smartuniverse",
|
||||
"description": "messaging service for micro services",
|
||||
"npmPackagename": "@push.rocks/smartuniverse",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
|
3063
package-lock.json
generated
3063
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
71
package.json
71
package.json
@ -1,52 +1,55 @@
|
||||
{
|
||||
"name": "@pushrocks/smartuniverse",
|
||||
"version": "1.0.70",
|
||||
"name": "@push.rocks/smartuniverse",
|
||||
"version": "1.0.107",
|
||||
"private": false,
|
||||
"description": "messaging service for your micro services",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"testManual": "(tsrun test/test.ts)",
|
||||
"build": "(tsbuild)",
|
||||
"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.24",
|
||||
"@pushrocks/tapbundle": "^3.0.13",
|
||||
"@types/node": "^12.7.3",
|
||||
"tslint": "^5.19.0",
|
||||
"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": {
|
||||
"@pushrocks/lik": "^3.0.11",
|
||||
"@pushrocks/smartdelay": "^2.0.3",
|
||||
"@pushrocks/smartexpress": "^3.0.40",
|
||||
"@pushrocks/smartfile": "^7.0.4",
|
||||
"@pushrocks/smarthash": "^2.0.6",
|
||||
"@pushrocks/smartlog": "^2.0.19",
|
||||
"@pushrocks/smartpromise": "^3.0.2",
|
||||
"@pushrocks/smartrequest": "^1.1.23",
|
||||
"@pushrocks/smartrx": "^2.0.3",
|
||||
"@pushrocks/smartsocket": "^1.1.46",
|
||||
"@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"
|
||||
}
|
||||
|
4610
pnpm-lock.yaml
generated
Normal file
4610
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
41
readme.md
41
readme.md
@ -1,20 +1,26 @@
|
||||
# @pushrocks/smartuniverse
|
||||
# @push.rocks/smartuniverse
|
||||
messaging service for 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/)
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartuniverse)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartuniverse)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/smartuniverse)
|
||||
* [docs (typedoc)](https://push.rocks.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/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
@ -33,7 +39,7 @@ Think Kafka, but without Kafka.
|
||||
import * as smartuniverse from '@pushrocks/smartuniverse';
|
||||
|
||||
const myUniverse = new smartuniverse.Universe({
|
||||
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
|
||||
messageExpiryInMilliseconds: 60000, // the standard time in milliseconds until a message expires
|
||||
});
|
||||
|
||||
// create as many channels as you like
|
||||
@ -47,9 +53,12 @@ myUniverse.start(8765); // start the server and provide the port on which to lis
|
||||
|
||||
All your microservices represents clients in the universe that may talk to each other using the universe server.
|
||||
|
||||
## Contribution
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
88
test/test.ts
88
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,34 +49,85 @@ 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);
|
||||
await testClientUniverse2.start();
|
||||
});
|
||||
|
||||
tap.test('should receive a message correctly', async () => {});
|
||||
|
||||
tap.test('should disconnect the client correctly', async () => {
|
||||
testClientUniverse.stop();
|
||||
tap.test('should receive a message correctly', async (tools) => {
|
||||
const done = tools.defer();
|
||||
const testChannel = testClientUniverse.getChannel(testChannelData.channelName);
|
||||
const testChannel2 = testClientUniverse2.getChannel(testChannelData.channelName);
|
||||
const subscription = testChannel2.subscribe((messageArg) => {
|
||||
if (messageArg.messageText === 'hellothere') {
|
||||
console.log('Yay##########');
|
||||
done.resolve();
|
||||
}
|
||||
});
|
||||
await testChannel.postMessage({
|
||||
messageText: 'hellothere',
|
||||
});
|
||||
await done.promise;
|
||||
});
|
||||
|
||||
tap.test('should end the server correctly', async tools => {
|
||||
interface IDemoReqRes {
|
||||
method: 'demo';
|
||||
request: {
|
||||
wowso: string;
|
||||
};
|
||||
response: {
|
||||
hereso: string;
|
||||
};
|
||||
}
|
||||
|
||||
tap.test('ReactionRequest and ReactionResponse should work', async () => {
|
||||
const reactionResponse = new smartuniverse.ReactionResponse<IDemoReqRes>({
|
||||
channels: [testUniverse.getChannel(testChannelData.channelName)],
|
||||
funcDef: async (reqData) => {
|
||||
console.log(reqData);
|
||||
return {
|
||||
hereso: 'Hello there',
|
||||
};
|
||||
},
|
||||
method: 'demo',
|
||||
});
|
||||
const reactionRequest = new smartuniverse.ReactionRequest<IDemoReqRes>({
|
||||
method: 'demo',
|
||||
});
|
||||
const reactionResult = await reactionRequest.fire(
|
||||
[testClientUniverse2.getChannel(testChannelData.channelName)],
|
||||
{
|
||||
wowso: 'wowza',
|
||||
}
|
||||
);
|
||||
const result = await reactionResult.getFirstResult();
|
||||
console.log(result);
|
||||
});
|
||||
|
||||
tap.test('should disconnect the client correctly', async (tools) => {
|
||||
await testClientUniverse.stop();
|
||||
await testClientUniverse2.stop();
|
||||
});
|
||||
|
||||
tap.test('should end the server correctly', async (tools) => {
|
||||
await testUniverse.stopServer();
|
||||
});
|
||||
|
||||
|
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.107',
|
||||
description: 'messaging service for your micro services'
|
||||
}
|
20
ts/index.ts
20
ts/index.ts
@ -1,12 +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';
|
||||
|
||||
export * from './interfaces';
|
||||
// Reaction Response
|
||||
export * from './smartuniverse.classes.event.reactionrequest.js';
|
||||
export * from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export * from './interfaces/index.js';
|
||||
|
@ -1,4 +1,5 @@
|
||||
export * from './http.interfaces';
|
||||
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';
|
||||
|
20
ts/interfaces/socketfunctionrequests.ts
Normal file
20
ts/interfaces/socketfunctionrequests.ts
Normal file
@ -0,0 +1,20 @@
|
||||
import * as interfaces from './index.js';
|
||||
|
||||
export interface ISocketRequest_SubscribeChannel {
|
||||
method: 'subscribeChannel';
|
||||
request: {
|
||||
name: string;
|
||||
passphrase: string;
|
||||
};
|
||||
response: {
|
||||
subscriptionStatus: 'subscribed' | 'unsubscribed';
|
||||
};
|
||||
}
|
||||
|
||||
export interface ISocketRequest_ProcessMessage {
|
||||
method: 'processMessage';
|
||||
request: interfaces.IUniverseMessage;
|
||||
response: {
|
||||
messageStatus: 'ok' | 'channel not found';
|
||||
};
|
||||
}
|
@ -1,17 +1,3 @@
|
||||
export type IServerCallActions =
|
||||
| 'channelSubscription'
|
||||
| 'processMessage'
|
||||
| 'channelUnsubscribe'
|
||||
| 'terminateConnection';
|
||||
|
||||
/**
|
||||
* the interface for a subscription
|
||||
*/
|
||||
export interface IServerCallSubscribeActionPayload {
|
||||
name: string;
|
||||
passphrase: string;
|
||||
}
|
||||
|
||||
export interface IServerUnsubscribeActionPayload {
|
||||
name: string;
|
||||
}
|
||||
|
@ -1,11 +1,10 @@
|
||||
export interface IMessageCreator {
|
||||
messageText: string;
|
||||
payload?: string | number | any;
|
||||
payloadStringType?: 'Buffer' | 'string' | 'object';
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* A universe
|
||||
*/
|
||||
export interface IUniverseMessage extends IMessageCreator {
|
||||
id: string;
|
||||
|
186
ts/smartuniverse.classes.client.universe.ts
Normal file
186
ts/smartuniverse.classes.client.universe.ts
Normal file
@ -0,0 +1,186 @@
|
||||
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();
|
||||
}
|
||||
}
|
||||
}
|
@ -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,7 +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 { 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 {
|
||||
// ======
|
||||
@ -34,6 +37,8 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
// properties
|
||||
public name: string;
|
||||
public passphrase: string;
|
||||
public status: 'subscribed' | 'unsubscribed' = 'unsubscribed';
|
||||
private subject = new plugins.smartrx.rxjs.Subject<ClientUniverseMessage<any>>();
|
||||
|
||||
// refs
|
||||
public clientUniverseRef: ClientUniverse;
|
||||
@ -48,32 +53,51 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
* subscribes to a channel
|
||||
* tells the universe about this instances interest into a channel
|
||||
*/
|
||||
public async subscribe() {
|
||||
const serverCallActionName: interfaces.IServerCallActions = 'channelSubscription';
|
||||
const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
|
||||
name: this.name,
|
||||
passphrase: this.passphrase
|
||||
};
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall(
|
||||
serverCallActionName,
|
||||
serverCallActionPayload
|
||||
public subscribe(observingFunctionArg: (messageArg: ClientUniverseMessage<any>) => void) {
|
||||
return this.subject.subscribe(
|
||||
(messageArg) => {
|
||||
observingFunctionArg(messageArg);
|
||||
},
|
||||
(error) => console.log(error)
|
||||
);
|
||||
}
|
||||
|
||||
public unsubscribe() {
|
||||
// TODO: unsubscribe all users
|
||||
}
|
||||
|
||||
public async populateSubscriptionToServer() {
|
||||
// lets make sure the channel is connected
|
||||
if (this.status === 'unsubscribed') {
|
||||
const response =
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>(
|
||||
'subscribeChannel',
|
||||
{
|
||||
name: this.name,
|
||||
passphrase: this.passphrase,
|
||||
}
|
||||
);
|
||||
this.status = response.subscriptionStatus;
|
||||
}
|
||||
}
|
||||
|
||||
public async emitMessageLocally(messageArg: ClientUniverseMessage<any>) {
|
||||
this.subject.next(messageArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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,
|
||||
payloadStringType: messageArg.payloadStringType
|
||||
};
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall(
|
||||
'processMessage',
|
@ -1,8 +1,8 @@
|
||||
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 implements interfaces.IUniverseMessage {
|
||||
export class ClientUniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
// ======
|
||||
// STATIC
|
||||
// ======
|
||||
@ -22,8 +22,7 @@ export class ClientUniverseMessage implements interfaces.IUniverseMessage {
|
||||
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||
public messageText: string;
|
||||
public passphrase: string;
|
||||
public payload: any;
|
||||
public payloadStringType;
|
||||
public payload: T;
|
||||
public targetChannelName: string;
|
||||
|
||||
constructor(messageArg: interfaces.IUniverseMessage) {
|
@ -1,138 +0,0 @@
|
||||
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 stop() {
|
||||
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({
|
||||
funcName: 'processMessage',
|
||||
allowedRoles: [],
|
||||
funcDef: async (messageDescriptorArg: interfaces.IUniverseMessage) => {
|
||||
plugins.smartlog.defaultLogger.log('info', 'Got message from server');
|
||||
this.observableIntake.push(
|
||||
ClientUniverseMessage.createMessageFromMessageDescriptor(messageDescriptorArg)
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
// 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();
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
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;
|
||||
}
|
||||
}
|
63
ts/smartuniverse.classes.event.reactionresponse.ts
Normal file
63
ts/smartuniverse.classes.event.reactionresponse.ts
Normal file
@ -0,0 +1,63 @@
|
||||
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,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
52
ts/smartuniverse.classes.event.reactionresult.ts
Normal file
52
ts/smartuniverse.classes.event.reactionresult.ts
Normal file
@ -0,0 +1,52 @@
|
||||
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);
|
||||
}
|
||||
}
|
@ -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,120 +54,102 @@ export class Universe {
|
||||
this.universeVersionStore = packageJson.version;
|
||||
return this.universeVersionStore;
|
||||
}
|
||||
}
|
||||
} */
|
||||
|
||||
/**
|
||||
* adds a channel to the Universe
|
||||
*/
|
||||
public addChannel(nameArg: string, passphraseArg: string) {
|
||||
const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
|
||||
return newChannel;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns a channel
|
||||
*/
|
||||
public getChannel(channelNameArg: string) {
|
||||
return this.universeCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === channelNameArg;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 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({
|
||||
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||
funcName: 'channelSubscription',
|
||||
funcDef: async (
|
||||
dataArg: interfaces.IServerCallSubscribeActionPayload,
|
||||
socketConnectionArg
|
||||
) => {
|
||||
// run in "this context" of this class
|
||||
await (async () => {
|
||||
|
||||
const 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 {
|
||||
'subscription status': 'success'
|
||||
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) => {
|
||||
// run in "this" context of this class
|
||||
await (async () => {
|
||||
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
|
||||
this.universeCache,
|
||||
socketConnectionArg
|
||||
);
|
||||
if (universeConnection) {
|
||||
plugins.smartlog.defaultLogger.log(
|
||||
'ok',
|
||||
'found UniverseConnection for socket for incoming message'
|
||||
);
|
||||
} else {
|
||||
plugins.smartlog.defaultLogger.log(
|
||||
'warn',
|
||||
'found no Authorized channel for incoming message'
|
||||
);
|
||||
return {
|
||||
error: 'You need to authenticate for a channel'
|
||||
};
|
||||
}
|
||||
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
|
||||
socketConnectionArg,
|
||||
dataArg
|
||||
);
|
||||
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
|
||||
this.universeCache,
|
||||
unauthenticatedMessage
|
||||
);
|
||||
if (foundChannel && unauthenticatedMessage.authenticated) {
|
||||
const authenticatedMessage = unauthenticatedMessage;
|
||||
await this.universeCache.addMessage(authenticatedMessage);
|
||||
}
|
||||
})();
|
||||
}
|
||||
funcDef: async (messageDataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
|
||||
this.universeCache,
|
||||
socketConnectionArg
|
||||
);
|
||||
if (universeConnection) {
|
||||
logger.log('ok', 'found UniverseConnection for socket for incoming message');
|
||||
} else {
|
||||
logger.log('warn', 'found no Authorized channel for incoming message');
|
||||
return {
|
||||
error: 'You need to authenticate for a channel',
|
||||
};
|
||||
}
|
||||
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
|
||||
socketConnectionArg,
|
||||
messageDataArg
|
||||
);
|
||||
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
|
||||
this.universeCache,
|
||||
unauthenticatedMessage
|
||||
);
|
||||
if (foundChannel && unauthenticatedMessage.authenticated) {
|
||||
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');
|
||||
}
|
||||
|
||||
/**
|
||||
@ -176,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.
|
||||
@ -19,22 +15,22 @@ export class UniverseCache {
|
||||
// INSTANCE
|
||||
// ========
|
||||
public standardMessageExpiry: number;
|
||||
public destructionTime: number = 60000;
|
||||
public destructionTime: number = 10000;
|
||||
|
||||
/**
|
||||
* stores messages for this instance
|
||||
*/
|
||||
public messageMap = new Objectmap<UniverseMessage>();
|
||||
public messageMap = new ObjectMap<UniverseMessage<any>>();
|
||||
|
||||
/**
|
||||
* stores the channels that are available within the universe
|
||||
*/
|
||||
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
|
||||
@ -54,12 +50,12 @@ export class UniverseCache {
|
||||
* @param messageArg
|
||||
* @param attachedPayloadArg
|
||||
*/
|
||||
public async addMessage(messageArg: UniverseMessage) {
|
||||
public async addMessage(messageArg: UniverseMessage<any>) {
|
||||
messageArg.setUniverseCache(this);
|
||||
UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
|
||||
this.messageMap.add(messageArg);
|
||||
messageArg.universeChannelList.forEach(universeChannel => {
|
||||
universeChannel.pushToClients(messageArg);
|
||||
messageArg.universeChannelList.forEach((universeChannel) => {
|
||||
universeChannel.push(messageArg);
|
||||
});
|
||||
}
|
||||
|
||||
@ -69,9 +65,9 @@ export class UniverseCache {
|
||||
public readMessagesYoungerThan(
|
||||
unixTimeArg?: number,
|
||||
channelName?: string
|
||||
): Observable<UniverseMessage> {
|
||||
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) {
|
||||
@ -52,27 +53,27 @@ export class UniverseChannel {
|
||||
*/
|
||||
public static authorizeAMessageForAChannel(
|
||||
universeCacheArg: UniverseCache,
|
||||
universeMessageArg: UniverseMessage
|
||||
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;
|
||||
});
|
||||
}
|
||||
@ -85,6 +86,7 @@ export class UniverseChannel {
|
||||
*/
|
||||
public name: string;
|
||||
public universeRef: Universe;
|
||||
private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage<any>>();
|
||||
|
||||
/**
|
||||
* the passphrase for the channel
|
||||
@ -102,7 +104,7 @@ export class UniverseChannel {
|
||||
* # the messages channelName against the unverseChannel's name
|
||||
* # the messages password against the universeChannel's password
|
||||
*/
|
||||
public authenticate(universeMessageArg: UniverseMessage): boolean {
|
||||
public authenticate(universeMessageArg: UniverseMessage<any>): boolean {
|
||||
return (
|
||||
this.name === universeMessageArg.targetChannelName &&
|
||||
this.passphrase === universeMessageArg.passphrase
|
||||
@ -113,9 +115,10 @@ export class UniverseChannel {
|
||||
* pushes a message to clients
|
||||
* @param messageArg
|
||||
*/
|
||||
public async pushToClients(messageArg: UniverseMessage) {
|
||||
public async push(messageArg: UniverseMessage<any>) {
|
||||
this.subject.next(messageArg);
|
||||
const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
|
||||
this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
|
||||
await this.universeRef.universeCache.connectionMap.forEach(async (socketConnection) => {
|
||||
if (socketConnection.authenticatedChannels.includes(this)) {
|
||||
universeConnectionsWithChannelAccess.push(socketConnection);
|
||||
}
|
||||
@ -130,7 +133,6 @@ export class UniverseChannel {
|
||||
targetChannelName: this.name,
|
||||
messageText: messageArg.messageText,
|
||||
payload: messageArg.payload,
|
||||
payloadStringType: messageArg.payloadStringType
|
||||
};
|
||||
smartsocket.clientCall(
|
||||
'processMessage',
|
||||
@ -139,4 +141,29 @@ export class UniverseChannel {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// functions to interact with a channel locally
|
||||
public subscribe(observingFunctionArg: (messageArg: UniverseMessage<any>) => void) {
|
||||
return this.subject.subscribe(
|
||||
(messageArg) => {
|
||||
observingFunctionArg(messageArg);
|
||||
},
|
||||
(error) => console.log(error)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* sends a message to the channel
|
||||
*/
|
||||
public async postMessage(messageDescriptor: interfaces.IMessageCreator) {
|
||||
const messageToSend = new UniverseMessage({
|
||||
id: plugins.isounique.uni(),
|
||||
messageText: messageDescriptor.messageText,
|
||||
payload: messageDescriptor.payload,
|
||||
targetChannelName: this.name,
|
||||
passphrase: this.passphrase,
|
||||
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
|
||||
@ -26,6 +26,7 @@ export class UniverseConnection {
|
||||
universeConnection
|
||||
);
|
||||
universeRef.universeCache.connectionMap.add(universeConnection);
|
||||
console.log('hi');
|
||||
}
|
||||
|
||||
/**
|
||||
@ -36,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,
|
||||
@ -86,36 +87,49 @@ 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;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
public universeRef: Universe;
|
||||
public terminatedDeferred = plugins.smartpromise.defer();
|
||||
|
||||
/**
|
||||
* the socketClient to ping
|
||||
*/
|
||||
public socketConnection: plugins.smartsocket.SocketConnection;
|
||||
public authenticationRequests: interfaces.IServerCallSubscribeActionPayload[] = [];
|
||||
public subscribedChannels: UniverseChannel[] = [];
|
||||
public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
|
||||
public authenticatedChannels: UniverseChannel[] = [];
|
||||
public failedToJoinChannels: UniverseChannel[] = [];
|
||||
|
||||
/**
|
||||
* terminates the connection
|
||||
* disconnect the connection
|
||||
*/
|
||||
public terminateConnection() {
|
||||
this.socketConnection.socket.disconnect();
|
||||
public async disconnect(reason: 'upstreamevent' | 'triggered' = 'triggered') {
|
||||
if (reason === 'triggered') {
|
||||
await this.socketConnection.disconnect();
|
||||
}
|
||||
this.universeRef.universeCache.connectionMap.remove(this);
|
||||
this.terminatedDeferred.resolve();
|
||||
}
|
||||
|
||||
constructor(optionsArg: {
|
||||
universe: Universe;
|
||||
socketConnection: plugins.smartsocket.SocketConnection;
|
||||
authenticationRequests: interfaces.IServerCallSubscribeActionPayload[];
|
||||
authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
|
||||
}) {
|
||||
this.universeRef = optionsArg.universe;
|
||||
this.authenticationRequests = optionsArg.authenticationRequests;
|
||||
this.socketConnection = optionsArg.socketConnection;
|
||||
this.socketConnection.eventSubject.subscribe(async (eventArg) => {
|
||||
switch (eventArg) {
|
||||
case 'disconnected':
|
||||
await this.disconnect('upstreamevent');
|
||||
break;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@ -1,19 +1,16 @@
|
||||
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
|
||||
* acts as a container to save message states like authentication status
|
||||
*/
|
||||
export class UniverseMessage implements interfaces.IUniverseMessage {
|
||||
export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
public static createMessageFromPayload(
|
||||
socketConnectionArg: SocketConnection,
|
||||
dataArg: interfaces.IUniverseMessage
|
||||
@ -25,11 +22,10 @@ export class UniverseMessage 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: any;
|
||||
public payloadStringType;
|
||||
public payload: T;
|
||||
public targetChannelName: string;
|
||||
public socketConnection: SocketConnection;
|
||||
|
||||
@ -41,7 +37,7 @@ export class UniverseMessage 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
|
||||
@ -51,7 +47,7 @@ export class UniverseMessage 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
|
||||
@ -59,13 +55,13 @@ export class UniverseMessage 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;
|
||||
this.payload = messageDescriptor.payload;
|
||||
// prevent memory issues
|
||||
this.fallBackDestruction();
|
||||
this.setDestructionTimer();
|
||||
}
|
||||
|
||||
public setUniverseCache(universeCacheArg: UniverseCache) {
|
||||
@ -74,17 +70,25 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
|
||||
|
||||
public setTargetChannel() {}
|
||||
|
||||
public setDestructionTimer(selfdestructAfterArg: number) {
|
||||
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.universeCache.messageMap.remove(this);
|
||||
});
|
||||
this.destructionTimer.completed
|
||||
.then(async () => {
|
||||
this.universeCache.messageMap.remove(this);
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err);
|
||||
console.log(this);
|
||||
});
|
||||
} else {
|
||||
this.fallBackDestruction();
|
||||
plugins.smartdelay.delayFor(1000).then(() => {
|
||||
if (!this.destructionTimer) {
|
||||
this.setDestructionTimer(6000);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@ -92,17 +96,6 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
|
||||
* handles bad messages for further analysis
|
||||
*/
|
||||
public handleAsBadMessage() {
|
||||
plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
|
||||
}
|
||||
|
||||
/**
|
||||
* prevents memory leaks if channels have no default
|
||||
*/
|
||||
private fallBackDestruction() {
|
||||
plugins.smartdelay.delayFor(1000).then(() => {
|
||||
if (!this.destructionTimer) {
|
||||
this.setDestructionTimer(6000);
|
||||
}
|
||||
});
|
||||
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,33 +1,29 @@
|
||||
// node native
|
||||
import * as path from 'path';
|
||||
// apiglobal scope
|
||||
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||
|
||||
export { path };
|
||||
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
|
||||
};
|
11
tsconfig.json
Normal file
11
tsconfig.json
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
}
|
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"
|
||||
}
|
Reference in New Issue
Block a user