Compare commits
162 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a5b08f6304 | |||
| 3ac4c2e708 | |||
| 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 | |||
| 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 | |||
| 37e1ee7970 | |||
| bd0bb3acf5 | |||
| f60497474e | |||
| 1d84cefa84 | |||
| 6792acd533 | |||
| 9397d89cf5 | |||
| 37cf4a91f4 | |||
| 52db86c929 | |||
| e8f09c1b7a | |||
| 79edea873f | |||
| 97666a623d | |||
| ef61ea9ad7 | |||
| 9c1504ef02 | |||
| e8f2e04d1c | |||
| e12aa7e961 | |||
| 857b7cd010 | |||
| e100dea160 | |||
| e8e87fcdba | |||
| 0d18b11721 | |||
| eaaefddbe3 | |||
| 8c6946ddb6 | |||
| 3a7ebcdd80 | |||
| ec2afbfd55 | |||
| 89feeca735 | |||
| c4261765ec | |||
| 33fe6bcd41 | |||
| 1baf1c318c | |||
| 051aba3299 | |||
| 7998d79b13 | |||
| 6838a8729a | |||
| 67f4e33ca0 | |||
| 8a8277ae9f | |||
| ff9cb9132c | |||
| f4ce784a59 | |||
| b34be4dcba | |||
| 6cc69efe2d | |||
| 8c30f294bc | |||
| 228eb791b7 | |||
| 057476ae66 | |||
| cb80e4dc2e | |||
| 8410e09a4d | |||
| eb04abddbf | |||
| 57809d9b53 | |||
| bee5231d47 | |||
| df45287026 | |||
| b5b6ca81cf | |||
| dc80e3b48d | |||
| 043d795013 | |||
| 29c0c8dc23 | |||
| 8157f2a56b | |||
| 2f528d1812 | |||
| 139c71a451 | |||
| 4678e44d16 | |||
| af9f590349 | |||
| d43ad80784 | |||
| b1017121ea | |||
| a8a91b4db2 | |||
| 67c4b06c4d | |||
| 7693b52066 | |||
| 30a02ae48b | |||
| 241182ed2e | |||
| 3d82038ec3 | |||
| 300d62ed12 | |||
| a5e849aa17 | |||
| 83807d7c5c | |||
| 39d3a0f2f8 | |||
| 904a48d414 | |||
| e2acb28756 | |||
| 92e4379bd2 | |||
| e0ce732ee1 | |||
| 98be0f036c | |||
| 54fca17142 | |||
| 1a7634e8db | |||
| 8830b825ac | |||
| 123324bf43 | |||
| 4761ff31cf | |||
| 430c3ea13a | |||
| 6dd3782b0d | |||
| 06aa721247 | |||
| f728c56016 |
@@ -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
|
||||
@@ -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
|
||||
+16
-2
@@ -1,6 +1,20 @@
|
||||
.nogit/
|
||||
node_modules/
|
||||
dist/
|
||||
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
|
||||
# caches
|
||||
.yarn/
|
||||
.cache/
|
||||
.rpt2_cache
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
# gitzone standard
|
||||
image: 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
|
||||
# ====================
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
image: docker:stable
|
||||
allow_failure: true
|
||||
services:
|
||||
- docker:stable-dind
|
||||
script:
|
||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||
- docker run
|
||||
--env SOURCE_CODE="$PWD"
|
||||
--volume "$PWD":/code
|
||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||
artifacts:
|
||||
paths: [codeclimate.json]
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci command npm install -g typedoc typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartuniverse",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"npmPackagename": "@push.rocks/smartuniverse",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/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"
|
||||
},
|
||||
"@git.zone/tsbundle": {
|
||||
"bundles": [
|
||||
{
|
||||
"from": "./ts/index.ts",
|
||||
"to": "./dist_bundle/bundle.js",
|
||||
"outputMode": "bundle",
|
||||
"bundler": "esbuild"
|
||||
}
|
||||
]
|
||||
},
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
}
|
||||
}
|
||||
Vendored
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
Vendored
+26
@@ -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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
+140
@@ -0,0 +1,140 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-05-01 - 1.0.109 - fix(types,client,server)
|
||||
improve type safety and harden client/server message handling
|
||||
|
||||
- add explicit unsubscribe socket request typing and typed processMessage responses for authenticated, missing-channel, and unauthenticated cases
|
||||
- guard client channel subscription and message posting when no socket connection is available
|
||||
- tighten generic message typing and optional state handling across universe, client message, and reaction request classes
|
||||
- modernize package and tooling configuration, including renamed dependencies, pnpm workspace metadata, and updated node-based tests
|
||||
|
||||
## 2024-05-29 - 1.0.108 - maintenance
|
||||
Repository metadata and TypeScript configuration were updated across the latest release cycle.
|
||||
|
||||
- Updated project description
|
||||
- Updated TypeScript configuration
|
||||
- Updated `npmextra.json` githost settings
|
||||
|
||||
## 2023-07-25 - 1.0.106 - 1.0.107 - core
|
||||
This version range contains repeated trivial core update fixes with no further detail.
|
||||
|
||||
- Applied minor `core` update fixes across versions `1.0.106` and `1.0.107`
|
||||
|
||||
## 2020-09-24 - 1.0.98 - 1.0.105 - core
|
||||
This version range contains repeated trivial core update fixes with no further detail.
|
||||
|
||||
- Applied minor `core` update fixes across versions `1.0.98` through `1.0.105`
|
||||
|
||||
## 2019-08-13 - 1.0.57 - 1.0.97 - core
|
||||
This version range contains repeated trivial core update fixes with no further detail.
|
||||
|
||||
- Applied minor `core` update fixes across versions `1.0.57` through `1.0.97`
|
||||
|
||||
## 2019-06-06 - 1.0.47 - 1.0.56 - core
|
||||
This version range contains repeated trivial core update fixes with no further detail.
|
||||
|
||||
- Applied minor `core` update fixes across versions `1.0.47` through `1.0.56`
|
||||
|
||||
## 2019-04-11 - 1.0.25 - 1.0.46 - core
|
||||
This version range contains repeated trivial core update fixes with no further detail.
|
||||
|
||||
- Applied minor `core` update fixes across versions `1.0.25` through `1.0.46`
|
||||
|
||||
## 2019-01-30 - 1.0.23 - dependencies
|
||||
Dependency maintenance updates were made in this release cycle.
|
||||
|
||||
- Updated project dependencies
|
||||
|
||||
## 2018-05-30 - 1.0.22 - websocket
|
||||
The websocket infrastructure was reworked.
|
||||
|
||||
- Switched to the complete websocket infrastructure
|
||||
|
||||
## 2018-05-28 - 1.0.21 - core
|
||||
Core behavior was updated to support a transparent universe model.
|
||||
|
||||
- Updated core to transparent universe handling
|
||||
|
||||
## 2018-05-26 - 1.0.20 - UniverseMessage / UniverseChannel
|
||||
Authentication handling for channel-based messages was improved.
|
||||
|
||||
- Improved authentication for messages associated with channels
|
||||
|
||||
## 2018-05-24 - 1.0.19 - dependencies
|
||||
Dependency maintenance updates were made.
|
||||
|
||||
- Updated project dependencies
|
||||
|
||||
## 2018-05-24 - 1.0.18 - UniverseChannel
|
||||
Channel handling was improved.
|
||||
|
||||
- Improved `UniverseChannel` handling
|
||||
|
||||
## 2018-05-23 - 1.0.17 - core
|
||||
Core channel handling was improved across the release.
|
||||
|
||||
- Improved channel handling in core
|
||||
|
||||
## 2018-05-23 - 1.0.16 - structure
|
||||
Project structure and formatting were cleaned up.
|
||||
|
||||
- Formatted the TypeScript codebase
|
||||
|
||||
## 2018-05-19 - 1.0.15 - core
|
||||
Release preparation work was completed.
|
||||
|
||||
- Prepared core for release
|
||||
|
||||
## 2018-05-07 - 1.0.14 - message
|
||||
The message layer was refactored.
|
||||
|
||||
- Refactored message-related functionality
|
||||
|
||||
## 2018-04-29 - 1.0.9 - 1.0.13 - maintenance
|
||||
This version range mainly contains standards, CI, and general maintenance updates.
|
||||
|
||||
- Moved the project toward TypeScript predominance
|
||||
- Updated the project to latest standards
|
||||
- Updated CI and CI configuration
|
||||
- Included general maintenance updates with limited detail
|
||||
|
||||
## 2018-04-05 - 1.0.8 - documentation
|
||||
Documentation was improved.
|
||||
|
||||
- Added a better README
|
||||
|
||||
## 2018-04-05 - 1.0.7 - package
|
||||
Package publishing configuration was updated.
|
||||
|
||||
- Added npm access level configuration
|
||||
|
||||
## 2018-04-04 - 1.0.5 - scope
|
||||
Project package scope was updated.
|
||||
|
||||
- Migrated to the new pushrocks scope
|
||||
|
||||
## 2018-03-27 - 1.0.4 - networking
|
||||
Connection lifecycle handling was improved.
|
||||
|
||||
- Fixed opening and closing behavior on both server and client sides
|
||||
|
||||
## 2018-03-17 - 1.0.3 - messaging
|
||||
Message delivery and compatibility issues were addressed.
|
||||
|
||||
- Fixed RxJS incompatibility
|
||||
- Corrected message sending behavior
|
||||
|
||||
## 2018-03-15 - 1.0.2 - core
|
||||
Initial runtime functionality was established.
|
||||
|
||||
- Got the project running
|
||||
|
||||
## 2018-03-08 - 1.0.1 - testing
|
||||
Initial test setup was updated.
|
||||
|
||||
- Updated the initial test
|
||||
|
||||
## 2018-03-07 - 1.0.1 - project
|
||||
Initial project setup.
|
||||
|
||||
- Initial commit
|
||||
@@ -1,4 +1,6 @@
|
||||
Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2026 Task Venture Capital GmbH
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
@@ -16,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
SOFTWARE.
|
||||
|
||||
+32
-9
@@ -1,17 +1,40 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"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"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"@git.zone/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"
|
||||
},
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
-3027
File diff suppressed because it is too large
Load Diff
+67
-29
@@ -1,38 +1,76 @@
|
||||
{
|
||||
"name": "@pushrocks/smartuniverse",
|
||||
"version": "1.0.29",
|
||||
"name": "@push.rocks/smartuniverse",
|
||||
"version": "1.0.109",
|
||||
"private": false,
|
||||
"description": "messaging service for your micro services",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Task Venture Capital GmbH <hello@task.vc>",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"format": "(gitzone format)"
|
||||
"test": "tstest test/ --verbose",
|
||||
"testManual": "tsrun test/",
|
||||
"build": "tsbuild && tsbundle",
|
||||
"format": "gitzone format",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.8",
|
||||
"@gitzone/tstest": "^1.0.20",
|
||||
"@pushrocks/tapbundle": "^3.0.9",
|
||||
"@types/node": "^11.13.4",
|
||||
"tslint": "^5.15.0",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"rxjs": "*"
|
||||
"@git.zone/tsbuild": "^4.4.0",
|
||||
"@git.zone/tsbundle": "^2.10.1",
|
||||
"@git.zone/tsrun": "^2.0.3",
|
||||
"@git.zone/tstest": "^3.6.3",
|
||||
"@types/lodash.clonedeep": "^4.5.9",
|
||||
"@types/node": "^25.6.0",
|
||||
"@types/picomatch": "^4.0.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/lik": "^3.0.5",
|
||||
"@pushrocks/smartdelay": "^2.0.3",
|
||||
"@pushrocks/smartexpress": "^3.0.18",
|
||||
"@pushrocks/smartfile": "^7.0.2",
|
||||
"@pushrocks/smarthash": "^2.0.4",
|
||||
"@pushrocks/smartpromise": "^3.0.2",
|
||||
"@pushrocks/smartrequest": "^1.1.14",
|
||||
"@pushrocks/smartrx": "^2.0.3",
|
||||
"@pushrocks/smartsocket": "^1.1.27",
|
||||
"@pushrocks/smarttime": "^3.0.7"
|
||||
}
|
||||
"@api.global/typedrequest-interfaces": "^3.0.19",
|
||||
"@api.global/typedserver": "^8.4.6",
|
||||
"@push.rocks/isohash": "^2.0.1",
|
||||
"@push.rocks/isounique": "^1.0.5",
|
||||
"@push.rocks/lik": "^6.4.1",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.2.2",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"@push.rocks/smartsocket": "^4.0.1",
|
||||
"@push.rocks/smarttime": "^4.2.3",
|
||||
"@push.rocks/smarturl": "^3.0.7"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
".smartconfig.json",
|
||||
"license",
|
||||
"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"
|
||||
},
|
||||
"packageManager": "pnpm@10.28.2"
|
||||
}
|
||||
|
||||
Generated
+9787
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,2 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
@@ -0,0 +1 @@
|
||||
|
||||
@@ -1,28 +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
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
First, you need to set up the server side of your messaging ecosystem, which involves creating a "universe" where channels reside.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
```typescript
|
||||
import { Universe } from '@push.rocks/smartuniverse';
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
// Initialize a new Universe
|
||||
const myUniverse = new Universe({
|
||||
messageExpiryInMilliseconds: 60000, // messages expire after 60 seconds
|
||||
});
|
||||
|
||||
// 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');
|
||||
|
||||
// Start the universe server on a specified port
|
||||
myUniverse.start(8765);
|
||||
```
|
||||
|
||||
By starting the universe, you've established a messaging hub for your microservices. Ensure that the services know the universe's address and the channels and passwords they should use for communication.
|
||||
|
||||
### Client side: Microservices joining the Universe
|
||||
|
||||
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.
|
||||
|
||||
```typescript
|
||||
import { ClientUniverse, ClientUniverseChannel } from '@push.rocks/smartuniverse';
|
||||
|
||||
// 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.
|
||||
|
||||
@@ -0,0 +1,133 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartuniverse from '../ts/index.js';
|
||||
|
||||
let testUniverse: smartuniverse.Universe;
|
||||
let testClientUniverse: smartuniverse.ClientUniverse;
|
||||
let testClientUniverse2: smartuniverse.ClientUniverse;
|
||||
let testClientChannel: smartuniverse.ClientUniverseChannel;
|
||||
|
||||
const testServerData = {
|
||||
serverAddress: 'http://localhost:8765',
|
||||
};
|
||||
|
||||
const testChannelData = {
|
||||
channelName: 'awesomeTestChannel',
|
||||
channelPass: 'awesomeChannelPass',
|
||||
};
|
||||
|
||||
tap.test('first test', async () => {
|
||||
testUniverse = new smartuniverse.Universe({
|
||||
messageExpiryInMilliseconds: 1000,
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('add a message to the SmartUniverse', async () => {
|
||||
await testUniverse.start(8765);
|
||||
});
|
||||
|
||||
// testing message handling
|
||||
tap.test('create smartuniverse client', async () => {
|
||||
testClientUniverse = new smartuniverse.ClientUniverse({
|
||||
serverAddress: testServerData.serverAddress,
|
||||
autoReconnect: true,
|
||||
});
|
||||
expect(testClientUniverse).toBeInstanceOf(smartuniverse.ClientUniverse);
|
||||
});
|
||||
|
||||
tap.test('should add a channel to the universe', async () => {
|
||||
testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||
});
|
||||
|
||||
tap.test('should add the same channel to the client universe in the same way', async () => {
|
||||
testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||
});
|
||||
|
||||
tap.test('should start the ClientUniverse', async () => {
|
||||
await testClientUniverse.start();
|
||||
});
|
||||
|
||||
tap.test('should get a observable correctly', async () => {
|
||||
testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
|
||||
expect(testClientChannel).toBeInstanceOf(smartuniverse.ClientUniverseChannel);
|
||||
});
|
||||
|
||||
tap.test('should send a message correctly', async () => {
|
||||
await testClientUniverse.getChannel(testChannelData.channelName).postMessage({
|
||||
messageText: 'hello',
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('universe should contain the sent message', async () => {
|
||||
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,
|
||||
autoReconnect: true,
|
||||
});
|
||||
|
||||
testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||
await testClientUniverse2.start();
|
||||
});
|
||||
|
||||
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;
|
||||
});
|
||||
|
||||
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();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -1,54 +0,0 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartuniverse from '../ts/index';
|
||||
|
||||
import { Observable } from 'rxjs';
|
||||
|
||||
let testUniverse: smartuniverse.Universe;
|
||||
let testUniverseClient: smartuniverse.ClientUniverse;
|
||||
let testClientChannel: smartuniverse.ClientUniverseChannel;
|
||||
|
||||
tap.test('first test', async () => {
|
||||
testUniverse = new smartuniverse.Universe({
|
||||
messageExpiryInMilliseconds: 1000
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('add a message to the SmartUniverse', async () => {
|
||||
await testUniverse.initServer(8765);
|
||||
});
|
||||
|
||||
// testing message handling
|
||||
tap.test('create smartuniverse client', async () => {
|
||||
testUniverseClient = new smartuniverse.ClientUniverse({
|
||||
serverAddress: 'http://localhost:8765'
|
||||
});
|
||||
expect(testUniverseClient).to.be.instanceof(smartuniverse.ClientUniverse);
|
||||
});
|
||||
|
||||
tap.test('should add a channel to the universe', async () => {
|
||||
await testUniverse.addChannel('testChannel', 'testPassword');
|
||||
});
|
||||
|
||||
tap.test('should get a observable correctly', async () => {
|
||||
testClientChannel = await testUniverseClient.getChannel('testChannel');
|
||||
expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
|
||||
});
|
||||
|
||||
tap.test('should send a message correctly', async () => {
|
||||
await testUniverseClient.sendMessage('greeting', {
|
||||
anyBool: true
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('should receive a message correctly', async () => {});
|
||||
|
||||
tap.test('should disconnect the client correctly', async () => {
|
||||
testUniverseClient.close();
|
||||
});
|
||||
|
||||
tap.test('should end the server correctly', async tools => {
|
||||
await testUniverse.stopServer();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartuniverse',
|
||||
version: '1.0.109',
|
||||
description: 'A messaging service enabling secure, reactive communication between microservices.'
|
||||
}
|
||||
+13
-7
@@ -1,10 +1,16 @@
|
||||
// Client classes
|
||||
export * from './smartuniverse.classes.clientuniverse';
|
||||
export * from './smartuniverse.classes.clientuniversechannel';
|
||||
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.interfaces';
|
||||
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.event.reactionrequest.js';
|
||||
export * from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export * from './interfaces/index.js';
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
export interface IServerGetMessagesRequestBody {
|
||||
channel: string;
|
||||
topic?: string;
|
||||
youngerThan: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* the interface for a standard request
|
||||
*/
|
||||
export interface IServerPutMessageRequestBody {
|
||||
channel: string;
|
||||
passphrase: string;
|
||||
message: string;
|
||||
payload: any;
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
export * from './http.interfaces.js';
|
||||
export * from './socketfunctionrequests.js';
|
||||
export * from './universechannel.interfaces.js';
|
||||
export * from './universemessage.interfaces.js';
|
||||
export * from './universeactions.interfaces.js';
|
||||
@@ -0,0 +1,26 @@
|
||||
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' | 'authentication required';
|
||||
};
|
||||
}
|
||||
|
||||
export interface ISocketRequest_Unsubscribe {
|
||||
method: 'unsubscribe';
|
||||
request: interfaces.IServerUnsubscribeActionPayload;
|
||||
response: {};
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
export interface IServerUnsubscribeActionPayload {
|
||||
name: string;
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export interface IUniverseChannel {}
|
||||
@@ -0,0 +1,17 @@
|
||||
export interface IMessageCreator<T = any> {
|
||||
messageText: string;
|
||||
payload?: T;
|
||||
}
|
||||
|
||||
/**
|
||||
* A universe
|
||||
*/
|
||||
export interface IUniverseMessage<T = any> extends IMessageCreator<T> {
|
||||
id: string;
|
||||
/**
|
||||
* time of creation
|
||||
*/
|
||||
timestamp: number;
|
||||
passphrase: string;
|
||||
targetChannelName: string;
|
||||
}
|
||||
@@ -0,0 +1,187 @@
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { 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: string, 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<interfaces.ISocketRequest_Unsubscribe>({
|
||||
funcName: 'unsubscribe',
|
||||
funcDef: async (dataArg) => {
|
||||
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 = undefined; // 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();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
|
||||
|
||||
/**
|
||||
* a cache for clients
|
||||
* keeps track of which messages have already been received
|
||||
* good for deduplication in mesh environments
|
||||
*/
|
||||
export class ClientUniverseCache {
|
||||
public channelMap = new plugins.lik.ObjectMap<ClientUniverseChannel>();
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
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 {
|
||||
// ======
|
||||
// STATIC
|
||||
// ======
|
||||
/**
|
||||
* creates a channel and adds it to the cache of clientUniverseArg
|
||||
* @param clientUniverseArg
|
||||
* @param channelNameArg
|
||||
* @param passphraseArg
|
||||
*/
|
||||
public static createClientUniverseChannel(
|
||||
clientUniverseArg: ClientUniverse,
|
||||
channelNameArg: string,
|
||||
passphraseArg: string
|
||||
): ClientUniverseChannel {
|
||||
const clientChannel = new ClientUniverseChannel(
|
||||
clientUniverseArg,
|
||||
channelNameArg,
|
||||
passphraseArg
|
||||
);
|
||||
clientUniverseArg.clientUniverseCache.channelMap.add(clientChannel);
|
||||
return clientChannel;
|
||||
}
|
||||
|
||||
// ========
|
||||
// INSTANCE
|
||||
// ========
|
||||
|
||||
// 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;
|
||||
|
||||
constructor(clientUniverseArg: ClientUniverse, nameArg: string, passphraseArg: string) {
|
||||
this.clientUniverseRef = clientUniverseArg;
|
||||
this.name = nameArg;
|
||||
this.passphrase = passphraseArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* subscribes to a channel
|
||||
* tells the universe about this instances interest into a channel
|
||||
*/
|
||||
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 smartsocketClient = this.clientUniverseRef.smartsocketClient;
|
||||
if (!smartsocketClient) {
|
||||
throw new Error('Cannot subscribe channel before the smartuniverse client is connected.');
|
||||
}
|
||||
const response =
|
||||
await 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 postMessage(messageArg: interfaces.IMessageCreator) {
|
||||
await this.clientUniverseRef.start(); // its ok to call this multiple times
|
||||
const smartsocketClient = this.clientUniverseRef.smartsocketClient;
|
||||
if (!smartsocketClient) {
|
||||
throw new Error('Cannot post message before the smartuniverse client is connected.');
|
||||
}
|
||||
const universeMessageToSend: interfaces.IUniverseMessage = {
|
||||
id: plugins.isounique.uni(),
|
||||
timestamp: Date.now(),
|
||||
passphrase: this.passphrase,
|
||||
targetChannelName: this.name,
|
||||
messageText: messageArg.messageText,
|
||||
payload: messageArg.payload,
|
||||
};
|
||||
await smartsocketClient.serverCall<interfaces.ISocketRequest_ProcessMessage>(
|
||||
'processMessage',
|
||||
universeMessageToSend
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
export class ClientUniverseMessage<T = any> implements interfaces.IUniverseMessage<T> {
|
||||
// ======
|
||||
// STATIC
|
||||
// ======
|
||||
public static createMessageFromMessageDescriptor<T = any>(messageDescriptor: interfaces.IUniverseMessage<T>) {
|
||||
const clientuniverseMessage = new ClientUniverseMessage<T>(messageDescriptor);
|
||||
return clientuniverseMessage;
|
||||
}
|
||||
|
||||
// ========
|
||||
// INSTANCE
|
||||
// ========
|
||||
|
||||
// properties
|
||||
public id: string;
|
||||
|
||||
public timestamp: number;
|
||||
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||
public messageText: string;
|
||||
public passphrase: string;
|
||||
public payload: T;
|
||||
public targetChannelName: string;
|
||||
|
||||
constructor(messageArg: interfaces.IUniverseMessage<T>) {
|
||||
this.id = messageArg.id;
|
||||
this.timestamp = messageArg.timestamp;
|
||||
this.smartTimestamp = new plugins.smarttime.TimeStamp(this.timestamp);
|
||||
this.messageText = messageArg.messageText;
|
||||
this.passphrase = messageArg.passphrase;
|
||||
this.payload = messageArg.payload as T;
|
||||
this.targetChannelName = messageArg.targetChannelName;
|
||||
}
|
||||
|
||||
/**
|
||||
* gets json for payload
|
||||
*/
|
||||
getAsJsonForPayload() {}
|
||||
}
|
||||
@@ -1,73 +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 {
|
||||
ClientUniverseChannel,
|
||||
IServerGetMessagesRequestBody,
|
||||
IServerPutMessageRequestBody,
|
||||
UniverseMessage
|
||||
} from './';
|
||||
|
||||
export interface IClientOptions {
|
||||
serverAddress: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* this class is for client side only!!!
|
||||
* allows connecting to a universe server
|
||||
*/
|
||||
export class ClientUniverse {
|
||||
public options;
|
||||
public socketClient: plugins.smartsocket.SmartsocketClient;
|
||||
public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
|
||||
|
||||
public channelCache = new Objectmap<ClientUniverseChannel>();
|
||||
|
||||
constructor(optionsArg: IClientOptions) {
|
||||
this.options = optionsArg;
|
||||
}
|
||||
|
||||
public async sendMessage(messageArg, payloadArg) {
|
||||
const requestBody = {
|
||||
message: messageArg,
|
||||
payload: payloadArg
|
||||
};
|
||||
// TODO: User websocket connection if available
|
||||
await plugins.smartrequest.postJson(this.options.serverAddress, {
|
||||
requestBody
|
||||
});
|
||||
}
|
||||
|
||||
public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
|
||||
await this.checkConnection();
|
||||
const clientUniverseChannel = await ClientUniverseChannel.createClientUniverseChannel(
|
||||
this,
|
||||
channelName
|
||||
);
|
||||
this.channelCache.add(clientUniverseChannel);
|
||||
return clientUniverseChannel;
|
||||
}
|
||||
|
||||
public close() {
|
||||
this.socketClient.disconnect();
|
||||
}
|
||||
|
||||
private async checkConnection() {
|
||||
if (!this.socketClient && !this.observableIntake) {
|
||||
const parsedURL = url.parse(this.options.serverAddress);
|
||||
this.socketClient = new SmartsocketClient({
|
||||
alias: process.env.SOCKET_ALIAS || 'someclient',
|
||||
password: 'UniverseClient',
|
||||
port: parseInt(parsedURL.port, 10),
|
||||
role: 'UniverseClient',
|
||||
url: parsedURL.hostname
|
||||
});
|
||||
this.observableIntake = new plugins.smartrx.ObservableIntake();
|
||||
this.socketClient.connect();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
import { ClientUniverse, IUniverseChannel } from './';
|
||||
|
||||
export class ClientUniverseChannel implements IUniverseChannel {
|
||||
// ======
|
||||
// STATIC
|
||||
// ======
|
||||
public static async createClientUniverseChannel(
|
||||
clientUniverseArg: ClientUniverse,
|
||||
channelName: string
|
||||
): Promise<ClientUniverseChannel> {
|
||||
const clientChannel = new ClientUniverseChannel(clientUniverseArg);
|
||||
await clientChannel.transmitSubscription();
|
||||
return clientChannel;
|
||||
}
|
||||
|
||||
// ========
|
||||
// INSTANCE
|
||||
// ========
|
||||
|
||||
public clientUniverse: ClientUniverse;
|
||||
|
||||
constructor(clientUniverseArg: ClientUniverse) {
|
||||
this.clientUniverse = clientUniverseArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* tells the universe about this instances interest into a channel
|
||||
*/
|
||||
public async transmitSubscription() {
|
||||
this.clientUniverse.socketClient;
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
import { IUniverseMessage } from './';
|
||||
|
||||
export class ClientUniverseMessage implements IUniverseMessage {
|
||||
// ======
|
||||
// STATIC
|
||||
// ======
|
||||
createMessage(messageArg: string, payloadArg: any) {}
|
||||
|
||||
// ========
|
||||
// INSTANCE
|
||||
// ========
|
||||
constructor(messageArg, payloadArg) {}
|
||||
}
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
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'] | null;
|
||||
};
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
if (payload.typedRequestPayload.response !== null) {
|
||||
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;
|
||||
}
|
||||
}
|
||||
@@ -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,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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,32 +1,17 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.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/index.js';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
export interface ISmartUniverseConstructorOptions {
|
||||
messageExpiryInMilliseconds: number;
|
||||
}
|
||||
|
||||
export interface IServerGetMessagesRequestBody {
|
||||
channel: string;
|
||||
topic?: string;
|
||||
youngerThan: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* the interface for a standard request
|
||||
*/
|
||||
export interface IServerPutMessageRequestBody {
|
||||
channel: string;
|
||||
passphrase: string;
|
||||
message: string;
|
||||
payload: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* main class that setsup a Universe
|
||||
* main class that setups a Universe
|
||||
*/
|
||||
export class Universe {
|
||||
// subinstances
|
||||
@@ -35,9 +20,26 @@ export class Universe {
|
||||
// options
|
||||
private options: ISmartUniverseConstructorOptions;
|
||||
|
||||
// Store version handling
|
||||
private universeVersionStore: string;
|
||||
private get universeVersion() {
|
||||
/**
|
||||
* the smartsocket used
|
||||
*/
|
||||
private smartsocket?: plugins.smartsocket.Smartsocket;
|
||||
|
||||
constructor(optionsArg: ISmartUniverseConstructorOptions) {
|
||||
this.options = optionsArg;
|
||||
this.universeCache = new UniverseCache(this, this.options.messageExpiryInMilliseconds);
|
||||
}
|
||||
|
||||
/**
|
||||
* stores the version of the universe server running
|
||||
* this is done since the version is exposed through the api and multiple fs actions are avoided this way.
|
||||
*/
|
||||
private universeVersionStore = '';
|
||||
|
||||
/**
|
||||
* get the currently running version of smartuniverse
|
||||
*/
|
||||
/* public getUniverseVersion() {
|
||||
if (this.universeVersionStore) {
|
||||
return this.universeVersionStore;
|
||||
} else {
|
||||
@@ -45,64 +47,105 @@ export class Universe {
|
||||
this.universeVersionStore = packageJson.version;
|
||||
return this.universeVersionStore;
|
||||
}
|
||||
}
|
||||
|
||||
private smartexpressServer: plugins.smartexpress.Server;
|
||||
private smartsocket: plugins.smartsocket.Smartsocket;
|
||||
|
||||
constructor(optionsArg: ISmartUniverseConstructorOptions) {
|
||||
this.options = optionsArg;
|
||||
this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
|
||||
}
|
||||
} */
|
||||
|
||||
/**
|
||||
* adds a channel to the Universe
|
||||
*/
|
||||
public async addChannel(nameArg: string, passphraseArg: string) {
|
||||
const newChannel = new UniverseChannel(this.universeCache, nameArg, passphraseArg);
|
||||
this.universeCache.channelMap.add(newChannel);
|
||||
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 initServer(portArg: number | string) {
|
||||
this.smartexpressServer = new plugins.smartexpress.Server({
|
||||
cors: true,
|
||||
defaultAnswer: async () => {
|
||||
return `smartuniverse server ${this.universeVersion}`;
|
||||
},
|
||||
forceSsl: false,
|
||||
port: portArg
|
||||
});
|
||||
public async start(portArg?: number) {
|
||||
if (!portArg) {
|
||||
throw new Error(`You need to specify a portArg to start on.`);
|
||||
}
|
||||
|
||||
// add websocket upgrade
|
||||
this.smartsocket = new plugins.smartsocket.Smartsocket({
|
||||
port: 12345 // fix this within smartsocket
|
||||
alias: 'smartuniverse',
|
||||
port: portArg,
|
||||
});
|
||||
|
||||
const ClientRole = new plugins.smartsocket.SocketRole({
|
||||
name: 'clientuniverse',
|
||||
passwordHash: 'clientuniverse' // 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],
|
||||
});
|
||||
await UniverseConnection.addConnectionToCache(this, universeConnection);
|
||||
return {
|
||||
subscriptionStatus: 'subscribed',
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
this.smartsocket.addSocketRoles([ClientRole]);
|
||||
const socketFunctionProcessMessage =
|
||||
new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_ProcessMessage>({
|
||||
funcName: 'processMessage',
|
||||
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 {
|
||||
messageStatus: 'authentication required',
|
||||
};
|
||||
}
|
||||
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);
|
||||
return {
|
||||
messageStatus: 'ok',
|
||||
};
|
||||
}
|
||||
return {
|
||||
messageStatus: 'channel not found',
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
|
||||
allowedRoles: [ClientRole],
|
||||
funcName: 'channelSubscription',
|
||||
funcDef: () => {}
|
||||
});
|
||||
// add socket functions
|
||||
this.smartsocket.addSocketFunction(socketFunctionSubscription);
|
||||
this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
|
||||
|
||||
this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
|
||||
// should work with express as well
|
||||
this.smartsocket.start();
|
||||
|
||||
await this.smartexpressServer.start();
|
||||
// add smartsocket to the running smartexpress app
|
||||
await this.smartsocket.start();
|
||||
logger.log('success', 'started universe');
|
||||
}
|
||||
|
||||
/**
|
||||
* stop everything
|
||||
*/
|
||||
public async stopServer() {
|
||||
await this.smartsocket.stop();
|
||||
await this.smartexpressServer.stop();
|
||||
await this.smartsocket?.stop();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +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 { 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.
|
||||
@@ -17,45 +15,60 @@ 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>();
|
||||
|
||||
/**
|
||||
* allows messages to be processed in a blacklist mode for further analysis
|
||||
*/
|
||||
public blackListChannel = new UniverseChannel(this, 'blacklist', 'nada');
|
||||
public blackListChannel: UniverseChannel;
|
||||
|
||||
constructor(standardMessageExpiryArg: number) {
|
||||
public universeRef: Universe;
|
||||
|
||||
constructor(universeArg: Universe, standardMessageExpiryArg: number) {
|
||||
this.universeRef = universeArg;
|
||||
this.standardMessageExpiry = standardMessageExpiryArg;
|
||||
this.blackListChannel = new UniverseChannel(this.universeRef, 'blacklist', 'nada');
|
||||
}
|
||||
|
||||
/**
|
||||
* add a message to the UniverseStore
|
||||
* add a message to the 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.push(messageArg);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Read a message from the UniverseStore
|
||||
* Read a message from the UniverseCache
|
||||
*/
|
||||
public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
|
||||
const messageObservable = from(this.messageMap.getArray()).pipe(
|
||||
filter(messageArg => {
|
||||
return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
|
||||
public readMessagesYoungerThan(
|
||||
unixTimeArg?: number,
|
||||
channelName?: string
|
||||
): 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);
|
||||
})
|
||||
);
|
||||
return messageObservable;
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
import { Objectmap } from '@pushrocks/lik';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
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.
|
||||
@@ -18,11 +21,12 @@ export class UniverseChannel {
|
||||
* @param passphraseArg the secret thats used for a certain topic.
|
||||
*/
|
||||
public static createChannel(
|
||||
universeCacheArg: UniverseCache,
|
||||
universeArg: Universe,
|
||||
channelNameArg: string,
|
||||
passphraseArg: string
|
||||
) {
|
||||
const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
|
||||
const newChannel = new UniverseChannel(universeArg, channelNameArg, passphraseArg);
|
||||
universeArg.universeCache.channelMap.add(newChannel);
|
||||
return newChannel;
|
||||
}
|
||||
|
||||
@@ -30,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) {
|
||||
@@ -40,24 +44,40 @@ export class UniverseChannel {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* a static message authorization function that takes the UniverseCache
|
||||
* (where messages and channels are stored and their lifetime is managed)
|
||||
* and the universemessage to find a fitting channel for the message
|
||||
* @param universeCacheArg
|
||||
* @param universeMessageArg
|
||||
*/
|
||||
public static authorizeAMessageForAChannel(
|
||||
universeCacheArg: UniverseCache,
|
||||
universeMessageArg: UniverseMessage
|
||||
) {
|
||||
const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
|
||||
universeMessageArg: UniverseMessage<any>
|
||||
): UniverseChannel | null {
|
||||
const foundChannel = universeCacheArg.channelMap.findSync((universeChannel) => {
|
||||
const result = universeChannel.authenticate(universeMessageArg);
|
||||
return result;
|
||||
});
|
||||
if (foundChannel) {
|
||||
universeMessageArg.authenticated = true;
|
||||
universeMessageArg.universeChannelList.add(foundChannel);
|
||||
logger.log('ok', 'message authorized');
|
||||
return foundChannel;
|
||||
} else {
|
||||
universeMessageArg.authenticated = false;
|
||||
universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
|
||||
logger.log('warn', 'message not valid');
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
|
||||
return universeRef.universeCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === universeChannelName;
|
||||
});
|
||||
}
|
||||
|
||||
// ========
|
||||
// INSTANCE
|
||||
// ========
|
||||
@@ -65,27 +85,85 @@ export class UniverseChannel {
|
||||
* the name of the channel
|
||||
*/
|
||||
public name: string;
|
||||
public universeCacheInstance: UniverseCache;
|
||||
public universeRef: Universe;
|
||||
private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage<any>>();
|
||||
|
||||
/**
|
||||
* the passphrase for the channel
|
||||
*/
|
||||
public passphrase: string;
|
||||
|
||||
constructor(universeCacheArg: UniverseCache, channelNameArg: string, passphraseArg: string) {
|
||||
constructor(universeArg: Universe, channelNameArg: string, passphraseArg: string) {
|
||||
this.universeRef = universeArg;
|
||||
this.name = channelNameArg;
|
||||
this.passphrase = passphraseArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* authenticates a client on the server side
|
||||
* authenticates a client on the server side by matching
|
||||
* # 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.requestedChannelName &&
|
||||
this.passphrase === universeMessageArg.requestedChannelPassphrase
|
||||
this.name === universeMessageArg.targetChannelName &&
|
||||
this.passphrase === universeMessageArg.passphrase
|
||||
);
|
||||
}
|
||||
|
||||
public pushToClients(messageArg: UniverseMessage) {}
|
||||
/**
|
||||
* pushes a message to clients
|
||||
* @param messageArg
|
||||
*/
|
||||
public async push(messageArg: UniverseMessage<any>) {
|
||||
this.subject.next(messageArg);
|
||||
const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
|
||||
await this.universeRef.universeCache.connectionMap.forEach(async (socketConnection) => {
|
||||
if (socketConnection.authenticatedChannels.includes(this)) {
|
||||
universeConnectionsWithChannelAccess.push(socketConnection);
|
||||
}
|
||||
});
|
||||
for (const universeConnection of universeConnectionsWithChannelAccess) {
|
||||
const smartsocket = universeConnection.socketConnection
|
||||
.smartsocketRef as plugins.smartsocket.Smartsocket;
|
||||
const universeMessageToSend: interfaces.IUniverseMessage = {
|
||||
id: messageArg.id,
|
||||
timestamp: messageArg.timestamp,
|
||||
passphrase: messageArg.passphrase,
|
||||
targetChannelName: this.name,
|
||||
messageText: messageArg.messageText,
|
||||
payload: messageArg.payload,
|
||||
};
|
||||
smartsocket.clientCall(
|
||||
'processMessage',
|
||||
universeMessageToSend,
|
||||
universeConnection.socketConnection
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// 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);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
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
|
||||
*/
|
||||
export class UniverseConnection {
|
||||
/**
|
||||
*
|
||||
* @param universeConnectionArg
|
||||
*/
|
||||
public static async addConnectionToCache(
|
||||
universeRef: Universe,
|
||||
universeConnectionArg: UniverseConnection
|
||||
) {
|
||||
let universeConnection = universeConnectionArg;
|
||||
universeConnection = await UniverseConnection.deduplicateUniverseConnection(
|
||||
universeRef.universeCache,
|
||||
universeConnection
|
||||
);
|
||||
universeConnection = await UniverseConnection.authenticateAuthenticationRequests(
|
||||
universeRef,
|
||||
universeConnection
|
||||
);
|
||||
universeRef.universeCache.connectionMap.add(universeConnection);
|
||||
console.log('hi');
|
||||
}
|
||||
|
||||
/**
|
||||
* deduplicates UniverseConnections
|
||||
*/
|
||||
public static async deduplicateUniverseConnection(
|
||||
universeCache: UniverseCache,
|
||||
universeConnectionArg: UniverseConnection
|
||||
): Promise<UniverseConnection> {
|
||||
let connectionToReturn: UniverseConnection | undefined;
|
||||
universeCache.connectionMap.forEach(async (existingConnection) => {
|
||||
if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
|
||||
connectionToReturn = await this.mergeUniverseConnections(
|
||||
existingConnection,
|
||||
universeConnectionArg
|
||||
);
|
||||
}
|
||||
});
|
||||
if (!connectionToReturn) {
|
||||
connectionToReturn = universeConnectionArg;
|
||||
}
|
||||
return connectionToReturn;
|
||||
}
|
||||
|
||||
/**
|
||||
* authenticate AuthenticationRequests
|
||||
*/
|
||||
public static async authenticateAuthenticationRequests(
|
||||
universeRef: Universe,
|
||||
universeConnectionArg: UniverseConnection
|
||||
): Promise<UniverseConnection> {
|
||||
for (const authenticationRequest of universeConnectionArg.authenticationRequests) {
|
||||
const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(
|
||||
universeRef,
|
||||
authenticationRequest.name
|
||||
);
|
||||
if (universeChannelToAuthenticateAgainst?.passphrase === authenticationRequest.passphrase) {
|
||||
universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst);
|
||||
}
|
||||
}
|
||||
return universeConnectionArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* merges two UniverseConnections
|
||||
*/
|
||||
public static mergeUniverseConnections(
|
||||
connectionArg1: UniverseConnection,
|
||||
connectionArg2: UniverseConnection
|
||||
) {
|
||||
return connectionArg1;
|
||||
}
|
||||
|
||||
/**
|
||||
* finds a UniverseConnection by providing a socket connection
|
||||
*/
|
||||
public static findUniverseConnectionBySocketConnection(
|
||||
universeCache: UniverseCache,
|
||||
socketConnectionArg: plugins.smartsocket.SocketConnection
|
||||
): UniverseConnection | undefined {
|
||||
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: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
|
||||
public authenticatedChannels: UniverseChannel[] = [];
|
||||
public failedToJoinChannels: UniverseChannel[] = [];
|
||||
|
||||
/**
|
||||
* disconnect the connection
|
||||
*/
|
||||
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: 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,115 +1,102 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
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 * 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 { 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 {
|
||||
/**
|
||||
* public and unique id
|
||||
* numeric ascending
|
||||
* adheres to time in milliseconds
|
||||
* avoids duplications though
|
||||
*/
|
||||
public id: number;
|
||||
export class UniverseMessage<T = any> implements interfaces.IUniverseMessage<T> {
|
||||
public static createMessageFromPayload<T = any>(
|
||||
socketConnectionArg: SocketConnection,
|
||||
dataArg: interfaces.IUniverseMessage<T>
|
||||
) {
|
||||
const universeMessageInstance = new UniverseMessage<T>(dataArg);
|
||||
universeMessageInstance.socketConnection = socketConnectionArg;
|
||||
return universeMessageInstance;
|
||||
}
|
||||
|
||||
public id: string;
|
||||
public timestamp: number;
|
||||
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||
public messageText: string;
|
||||
public passphrase: string;
|
||||
public payload: T;
|
||||
public targetChannelName: string;
|
||||
public socketConnection?: SocketConnection;
|
||||
|
||||
/**
|
||||
* the UniverseCache the message is attached to
|
||||
*/
|
||||
public universeCache: UniverseCache;
|
||||
|
||||
/**
|
||||
* requestedChannelName
|
||||
*/
|
||||
public requestedChannelName: string;
|
||||
public requestedChannelPassphrase: string;
|
||||
public universeCache?: UniverseCache;
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public authenticated: boolean = null;
|
||||
public authenticated: boolean = false;
|
||||
|
||||
/**
|
||||
* time of creation
|
||||
* a destruction timer for this message
|
||||
*/
|
||||
public timestamp: TimeStamp;
|
||||
|
||||
/**
|
||||
* the actual message
|
||||
*/
|
||||
public message: string;
|
||||
|
||||
/**
|
||||
* any attached payloads. Can be of binary format.
|
||||
*/
|
||||
public attachedPayload: any;
|
||||
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
|
||||
* @param messageArg
|
||||
* @param attachedPayloadArg
|
||||
*/
|
||||
constructor(
|
||||
messageArg: string,
|
||||
requestedChannelNameArg: string,
|
||||
passphraseArg: string,
|
||||
attachedPayloadArg: any
|
||||
) {
|
||||
this.timestamp = new TimeStamp();
|
||||
this.message = messageArg;
|
||||
this.requestedChannelName = requestedChannelNameArg;
|
||||
this.requestedChannelPassphrase = passphraseArg;
|
||||
this.attachedPayload = attachedPayloadArg;
|
||||
constructor(messageDescriptor: interfaces.IUniverseMessage<T>) {
|
||||
this.id = messageDescriptor.id;
|
||||
this.timestamp = messageDescriptor.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 as T;
|
||||
// prevent memory issues
|
||||
this.fallBackDestruction();
|
||||
this.setDestructionTimer();
|
||||
}
|
||||
|
||||
public setUniverseCache(universeCacheArg: UniverseCache) {
|
||||
this.universeCache = universeCacheArg;
|
||||
}
|
||||
|
||||
public setDestructionTimer(selfdestructAfterArg: number) {
|
||||
if (selfdestructAfterArg) {
|
||||
this.destructionTimer = new Timer(selfdestructAfterArg);
|
||||
this.destructionTimer.start();
|
||||
public setTargetChannel() {}
|
||||
|
||||
public setDestructionTimer(selfdestructAfterArg?: number) {
|
||||
if (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);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* handles bad messages for further analysis
|
||||
*/
|
||||
handleAsBadMessage() {
|
||||
console.log('received a bad message');
|
||||
}
|
||||
|
||||
/**
|
||||
* prevents memory leaks if channels have no default
|
||||
*/
|
||||
private fallBackDestruction() {
|
||||
plugins.smartdelay.delayFor(1000).then(() => {
|
||||
if (!this.destructionTimer) {
|
||||
this.setDestructionTimer(6000);
|
||||
}
|
||||
});
|
||||
public handleAsBadMessage() {
|
||||
logger.log('warn', 'received a bad message');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
export interface IUniverseChannel {}
|
||||
|
||||
export interface IUniverseMessage {}
|
||||
@@ -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');
|
||||
+18
-18
@@ -1,29 +1,29 @@
|
||||
// node native
|
||||
import * as path from 'path';
|
||||
// apiglobal scope
|
||||
import * as typedrequestInterfaces from '@api.global/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 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 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
|
||||
smarttime,
|
||||
smarturl,
|
||||
};
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
import type * as typedserver from '@api.global/typedserver';
|
||||
|
||||
export type {
|
||||
typedserver
|
||||
};
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noImplicitAny": true,
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
"types": ["node"]
|
||||
},
|
||||
"exclude": ["dist_*/**/*.d.ts"]
|
||||
}
|
||||
-17
@@ -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