Compare commits

...

179 Commits

Author SHA1 Message Date
jkunz a5b08f6304 v1.0.109 2026-05-01 11:22:06 +00:00
jkunz 3ac4c2e708 fix(types,client,server): improve type safety and harden client/server message handling 2026-05-01 11:22:06 +00:00
philkunz 496fd9a81a update description 2024-05-29 14:16:55 +02:00
philkunz f7720251ff update tsconfig 2024-04-14 18:30:03 +02:00
philkunz b27c340f7d update tsconfig 2024-04-01 21:41:43 +02:00
philkunz 4cef457816 update npmextra.json: githost 2024-04-01 19:59:58 +02:00
philkunz 751d7955d1 update npmextra.json: githost 2024-03-30 21:48:58 +01:00
philkunz 466a0331f1 1.0.108 2023-07-25 11:40:12 +02:00
philkunz 38bc55d109 fix(core): update 2023-07-25 11:40:11 +02:00
philkunz b26f4076ab 1.0.107 2023-07-25 11:33:14 +02:00
philkunz 4ccbc004db fix(core): update 2023-07-25 11:33:13 +02:00
philkunz b5fcefa93b 1.0.106 2021-01-26 01:59:07 +00:00
philkunz 67f60187ae fix(core): update 2021-01-26 01:59:06 +00:00
philkunz 176c6ba261 1.0.105 2020-09-30 17:39:30 +00:00
philkunz af6c634deb fix(core): update 2020-09-30 17:39:29 +00:00
philkunz a5ce7b18e8 1.0.104 2020-09-30 00:50:44 +00:00
philkunz b6b482f7db fix(core): update 2020-09-30 00:50:43 +00:00
philkunz 39ed2dbd73 1.0.103 2020-09-30 00:33:58 +00:00
philkunz b1defd95a3 fix(core): update 2020-09-30 00:33:57 +00:00
philkunz a4ad33a0ee 1.0.102 2020-09-30 00:13:15 +00:00
philkunz 18fad25b8c fix(core): update 2020-09-30 00:13:14 +00:00
philkunz 82f4413064 1.0.101 2020-09-29 19:39:13 +00:00
philkunz 71bccf54f1 fix(core): update 2020-09-29 19:39:13 +00:00
philkunz 78ee8f2592 1.0.100 2020-09-24 18:17:53 +00:00
philkunz 820ce76fe3 fix(core): update 2020-09-24 18:17:52 +00:00
philkunz 5d8c2064e0 1.0.99 2020-09-24 18:13:49 +00:00
philkunz 9d1fc94e06 fix(core): update 2020-09-24 18:13:48 +00:00
philkunz c4640a3bc7 1.0.98 2019-11-10 16:55:18 +01:00
philkunz b6392ec6ba fix(core): update 2019-11-10 16:55:17 +01:00
philkunz bd4897f392 1.0.97 2019-11-09 18:44:34 +01:00
philkunz dbdc8a2811 fix(core): update 2019-11-09 18:44:33 +01:00
philkunz 908d00981b 1.0.96 2019-11-09 14:06:52 +01:00
philkunz 669ef262d7 fix(core): update 2019-11-09 14:06:51 +01:00
philkunz 30053fe441 1.0.95 2019-11-09 13:00:30 +01:00
philkunz afb4e3339a fix(core): update 2019-11-09 13:00:30 +01:00
philkunz e413a8116d 1.0.94 2019-11-09 12:59:51 +01:00
philkunz ffeed0565c fix(core): update 2019-11-09 12:59:51 +01:00
philkunz 736240b978 1.0.93 2019-11-09 12:23:34 +01:00
philkunz 73f4600c2a fix(core): update 2019-11-09 12:23:33 +01:00
philkunz 40beec1166 1.0.92 2019-11-07 01:02:03 +01:00
philkunz f8690fef50 1.0.91 2019-11-07 00:59:46 +01:00
philkunz 972ddbf327 fix(core): update 2019-11-07 00:59:45 +01:00
philkunz 80aacd17a6 1.0.90 2019-11-03 20:23:23 +01:00
philkunz e67b3e50cc fix(core): update 2019-11-03 20:23:22 +01:00
philkunz a4a8959b74 1.0.89 2019-09-25 18:46:18 +02:00
philkunz bab0f062f7 fix(core): update 2019-09-25 18:46:18 +02:00
philkunz 3bdfe4dcb4 1.0.88 2019-09-25 18:26:40 +02:00
philkunz fca960ad0d fix(core): update 2019-09-25 18:26:39 +02:00
philkunz e43ed3951c 1.0.87 2019-09-17 15:40:55 +02:00
philkunz 23df304535 fix(core): update 2019-09-17 15:40:54 +02:00
philkunz 9a142175aa 1.0.86 2019-09-17 14:01:24 +02:00
philkunz 09b593e192 fix(core): update 2019-09-17 14:01:24 +02:00
philkunz c27fc147b5 1.0.85 2019-09-17 13:57:35 +02:00
philkunz ddde21925a fix(core): update 2019-09-17 13:57:34 +02:00
philkunz bd849d347d 1.0.84 2019-09-17 12:46:35 +02:00
philkunz f2a85d4719 fix(core): update 2019-09-17 12:46:35 +02:00
philkunz 4e7c28ac83 1.0.83 2019-09-11 14:57:36 +02:00
philkunz 243f1a70e9 fix(core): update 2019-09-11 14:57:36 +02:00
philkunz b5a6517756 1.0.82 2019-09-11 10:11:34 +02:00
philkunz e12b128619 fix(core): update 2019-09-11 10:11:34 +02:00
philkunz 03fbab5265 1.0.81 2019-09-10 23:55:21 +02:00
philkunz 1d13bf5bcc fix(core): update 2019-09-10 23:55:20 +02:00
philkunz c2052f16a8 1.0.80 2019-09-10 19:36:11 +02:00
philkunz ff7cdc908c fix(core): update 2019-09-10 19:36:10 +02:00
philkunz f3d41b8719 1.0.79 2019-09-10 18:03:47 +02:00
philkunz f9f0fc45e2 fix(core): update 2019-09-10 18:03:46 +02:00
philkunz da6b7724b8 1.0.78 2019-09-10 10:55:11 +02:00
philkunz be7ca29e4b fix(core): update 2019-09-10 10:55:10 +02:00
philkunz f401d78c4b 1.0.77 2019-09-10 10:51:18 +02:00
philkunz 6ceec0201f fix(core): update 2019-09-10 10:51:18 +02:00
philkunz 16ce4e09a9 1.0.76 2019-09-10 10:50:56 +02:00
philkunz 2868ab686d fix(core): update 2019-09-10 10:50:55 +02:00
philkunz 5dab36382f 1.0.75 2019-09-10 09:56:33 +02:00
philkunz 02a32eb8c7 fix(core): update 2019-09-10 09:56:32 +02:00
philkunz b258979b5a 1.0.74 2019-09-10 01:39:39 +02:00
philkunz 166e29bbf6 fix(core): update 2019-09-10 01:39:38 +02:00
philkunz 870f37d403 1.0.73 2019-09-10 01:19:10 +02:00
philkunz 64c4b91678 fix(core): update 2019-09-10 01:19:10 +02:00
philkunz f3e13292d8 1.0.72 2019-09-10 00:39:18 +02:00
philkunz 7e1c405cb1 fix(core): update 2019-09-10 00:39:18 +02:00
philkunz d1b4672eff 1.0.71 2019-09-10 00:29:08 +02:00
philkunz 0dd9fee52b fix(core): update 2019-09-10 00:29:08 +02:00
philkunz 37e1ee7970 1.0.70 2019-09-01 21:34:01 +02:00
philkunz bd0bb3acf5 fix(core): update 2019-09-01 21:34:01 +02:00
philkunz f60497474e 1.0.69 2019-09-01 21:27:45 +02:00
philkunz 1d84cefa84 fix(core): update 2019-09-01 21:27:45 +02:00
philkunz 6792acd533 1.0.68 2019-09-01 18:22:44 +02:00
philkunz 9397d89cf5 fix(core): update 2019-09-01 18:22:44 +02:00
philkunz 37cf4a91f4 1.0.67 2019-09-01 17:04:25 +02:00
philkunz 52db86c929 fix(core): update 2019-09-01 17:04:25 +02:00
philkunz e8f09c1b7a 1.0.66 2019-09-01 17:01:26 +02:00
philkunz 79edea873f fix(core): update 2019-09-01 17:01:26 +02:00
philkunz 97666a623d 1.0.65 2019-09-01 16:54:36 +02:00
philkunz ef61ea9ad7 fix(core): update 2019-09-01 16:54:36 +02:00
philkunz 9c1504ef02 1.0.64 2019-08-13 18:43:33 +02:00
philkunz e8f2e04d1c fix(core): update 2019-08-13 18:43:33 +02:00
philkunz e12aa7e961 1.0.63 2019-08-13 18:41:28 +02:00
philkunz 857b7cd010 fix(core): update 2019-08-13 18:41:27 +02:00
philkunz e100dea160 1.0.62 2019-08-13 18:16:17 +02:00
philkunz e8e87fcdba fix(core): update 2019-08-13 18:16:16 +02:00
philkunz 0d18b11721 1.0.61 2019-08-13 18:06:14 +02:00
philkunz eaaefddbe3 fix(core): update 2019-08-13 18:06:13 +02:00
philkunz 8c6946ddb6 1.0.60 2019-08-13 15:55:01 +02:00
philkunz 3a7ebcdd80 fix(core): update 2019-08-13 15:55:01 +02:00
philkunz ec2afbfd55 1.0.59 2019-08-13 15:48:21 +02:00
philkunz 89feeca735 fix(core): update 2019-08-13 15:48:20 +02:00
philkunz c4261765ec 1.0.58 2019-08-13 13:04:49 +02:00
philkunz 33fe6bcd41 fix(core): update 2019-08-13 13:04:49 +02:00
philkunz 1baf1c318c 1.0.57 2019-08-12 17:23:11 +02:00
philkunz 051aba3299 fix(core): update 2019-08-12 17:23:10 +02:00
philkunz 7998d79b13 1.0.56 2019-08-12 15:12:32 +02:00
philkunz 6838a8729a fix(core): update 2019-08-12 15:12:31 +02:00
philkunz 67f4e33ca0 1.0.55 2019-08-12 15:10:40 +02:00
philkunz 8a8277ae9f fix(core): update 2019-08-12 15:10:40 +02:00
philkunz ff9cb9132c 1.0.54 2019-08-12 14:59:38 +02:00
philkunz f4ce784a59 fix(core): update 2019-08-12 14:59:37 +02:00
philkunz b34be4dcba 1.0.53 2019-07-30 10:31:36 +02:00
philkunz 6cc69efe2d fix(core): update 2019-07-30 10:31:35 +02:00
philkunz 8c30f294bc 1.0.52 2019-06-11 03:06:18 +02:00
philkunz 228eb791b7 fix(core): update 2019-06-11 03:06:17 +02:00
philkunz 057476ae66 1.0.51 2019-06-10 17:46:07 +02:00
philkunz cb80e4dc2e fix(core): update 2019-06-10 17:46:06 +02:00
philkunz 8410e09a4d 1.0.50 2019-06-07 11:49:10 +02:00
philkunz eb04abddbf fix(core): update 2019-06-07 11:49:10 +02:00
philkunz 57809d9b53 1.0.49 2019-06-06 23:23:37 +02:00
philkunz bee5231d47 fix(core): update 2019-06-06 23:23:37 +02:00
philkunz df45287026 1.0.48 2019-06-06 22:22:45 +02:00
philkunz b5b6ca81cf fix(core): update 2019-06-06 22:22:45 +02:00
philkunz dc80e3b48d 1.0.47 2019-04-30 19:16:04 +02:00
philkunz 043d795013 fix(core): update 2019-04-30 19:16:03 +02:00
philkunz 29c0c8dc23 1.0.46 2019-04-28 12:42:09 +02:00
philkunz 8157f2a56b fix(core): update 2019-04-28 12:42:08 +02:00
philkunz 2f528d1812 1.0.45 2019-04-24 23:27:58 +02:00
philkunz 139c71a451 fix(core): update 2019-04-24 23:27:57 +02:00
philkunz 4678e44d16 1.0.44 2019-04-24 18:20:32 +02:00
philkunz af9f590349 fix(core): update 2019-04-24 18:20:31 +02:00
philkunz d43ad80784 1.0.43 2019-04-23 00:28:57 +02:00
philkunz b1017121ea fix(core): update 2019-04-23 00:28:57 +02:00
philkunz a8a91b4db2 1.0.42 2019-04-22 23:23:36 +02:00
philkunz 67c4b06c4d fix(core): update 2019-04-22 23:23:36 +02:00
philkunz 7693b52066 1.0.41 2019-04-22 23:11:52 +02:00
philkunz 30a02ae48b fix(core): update 2019-04-22 23:11:51 +02:00
philkunz 241182ed2e 1.0.40 2019-04-22 22:04:53 +02:00
philkunz 3d82038ec3 fix(core): update 2019-04-22 22:04:52 +02:00
philkunz 300d62ed12 1.0.39 2019-04-22 13:06:02 +02:00
philkunz a5e849aa17 fix(core): update 2019-04-22 13:06:01 +02:00
philkunz 83807d7c5c 1.0.38 2019-04-22 09:58:36 +02:00
philkunz 39d3a0f2f8 fix(core): update 2019-04-22 09:58:36 +02:00
philkunz 904a48d414 1.0.37 2019-04-12 20:50:44 +02:00
philkunz e2acb28756 1.0.36 2019-04-11 18:59:46 +02:00
philkunz 92e4379bd2 fix(core): update 2019-04-11 18:59:45 +02:00
philkunz e0ce732ee1 1.0.35 2019-04-11 18:57:24 +02:00
philkunz 98be0f036c fix(core): update 2019-04-11 18:57:23 +02:00
philkunz 54fca17142 1.0.34 2019-04-11 18:50:43 +02:00
philkunz 1a7634e8db fix(core): update 2019-04-11 18:50:43 +02:00
philkunz 8830b825ac 1.0.33 2019-04-11 18:32:36 +02:00
philkunz 123324bf43 fix(core): update 2019-04-11 18:32:36 +02:00
philkunz 4761ff31cf 1.0.32 2019-04-11 18:31:21 +02:00
philkunz 430c3ea13a fix(core): update 2019-04-11 18:31:21 +02:00
philkunz 6dd3782b0d 1.0.31 2019-04-11 18:16:14 +02:00
philkunz 06aa721247 1.0.30 2019-04-11 17:52:02 +02:00
philkunz f728c56016 fix(core): update 2019-04-11 17:52:01 +02:00
philkunz f512acdfaa 1.0.29 2019-04-11 16:53:28 +02:00
philkunz 331a098851 fix(core): update 2019-04-11 16:53:28 +02:00
philkunz a8053a6e20 1.0.28 2019-04-11 11:36:57 +02:00
philkunz a62f3eb750 fix(core): update 2019-04-11 11:36:57 +02:00
philkunz 4b53044e8f 1.0.27 2019-04-11 11:15:09 +02:00
philkunz 2db2c80130 fix(core): update 2019-04-11 11:15:09 +02:00
philkunz 8b23eaf194 1.0.26 2019-04-11 11:11:46 +02:00
philkunz a03c54001f fix(core): update 2019-04-11 11:11:45 +02:00
philkunz 7bc404ba21 1.0.25 2019-01-31 02:52:18 +01:00
philkunz ac2a1559b0 fix(core): update 2019-01-31 02:52:18 +01:00
philkunz 57b37cb327 1.0.24 2019-01-30 11:01:49 +01:00
philkunz 8b17e814cc fix(dependencies): update 2019-01-30 11:01:48 +01:00
philkunz f4b8cde347 fix(dependencies): update 2019-01-30 10:56:31 +01:00
philkunz 3189d4d274 1.0.23 2018-05-30 16:34:07 +02:00
philkunz c2d134a6ea fix(websocket): switch to all websocket infrastructure 2018-05-30 16:34:06 +02:00
philkunz 7552dc1e9f 1.0.22 2018-05-28 12:07:26 +02:00
philkunz fe91459510 fix(core): update to transparent universe 2018-05-28 12:07:25 +02:00
47 changed files with 11731 additions and 3045 deletions
+66
View File
@@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
+124
View File
@@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
npmci command tsdoc
continue-on-error: true
+16 -2
View File
@@ -1,6 +1,20 @@
.nogit/
node_modules/
dist/
# artifacts
coverage/
public/
pages/
# installs
node_modules/
# caches
.yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom
-130
View File
@@ -1,130 +0,0 @@
# gitzone standard
image: hosttoday/ht-docker-node:npmci
cache:
paths:
- .yarn/
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 command yarn global add snyk
- npmci command yarn install --ignore-scripts
- npmci command snyk test
tags:
- docker
- notpriv
# ====================
# test stage
# ====================
testLEGACY:
stage: test
script:
- npmci node install legacy
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
allow_failure: true
testLTS:
stage: test
script:
- npmci node install lts
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
testSTABLE:
stage: test
script:
- 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 yarn global add npmpage
- npmci command npmpage
tags:
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
+38
View File
@@ -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"
}
}
+11
View File
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}
+26
View File
@@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}
+140
View File
@@ -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
+21
View File
@@ -0,0 +1,21 @@
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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
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.
+36 -5
View File
@@ -1,9 +1,40 @@
{
"npmci": {
"npmGlobalTools": [
"@gitzone/npmts",
"ts-node"
"@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",
"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"
],
"npmAccessLevel": "public"
"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"
},
"@ship.zone/szci": {
"npmGlobalTools": [],
"npmRegistryUrl": "registry.npmjs.org"
}
}
-2505
View File
File diff suppressed because it is too large Load Diff
+68 -27
View File
@@ -1,35 +1,76 @@
{
"name": "@pushrocks/smartuniverse",
"version": "1.0.21",
"private": true,
"description": "messaging service for your micro services",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"author": "Lossless GmbH",
"name": "@push.rocks/smartuniverse",
"version": "1.0.109",
"private": false,
"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": "(ts-node -O '{\"lib\": [ \"es2015\" ]}' test/test.ts)",
"build": "(npmts)",
"format": "(gitzone format)"
"test": "tstest test/ --verbose",
"testManual": "tsrun test/",
"build": "tsbuild && tsbundle",
"format": "gitzone format",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@types/node": "^9.6.0",
"tapbundle": "^2.0.0",
"ts-node": "^6.0.3",
"typescript": "^2.8.3"
"@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/smartcli": "^3.0.1",
"lik": "^2.0.5",
"nodehash": "^1.0.4",
"rxjs": "^5.5.8",
"smartdelay": "^1.0.4",
"smartexpress": "^1.0.21",
"smartfile": "^4.2.28",
"smartq": "^1.1.8",
"smartrequest": "^1.0.8",
"smartrx": "^1.0.5",
"smartsocket": "^1.1.19",
"smarttime": "^2.0.0"
}
"@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"
}
+9787
View File
File diff suppressed because it is too large Load Diff
+2
View File
@@ -0,0 +1,2 @@
onlyBuiltDependencies:
- esbuild
+1
View File
@@ -0,0 +1 @@
+119 -25
View File
@@ -1,33 +1,127 @@
# smartuniverse
# @push.rocks/smartuniverse
messaging service for your micro services
## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartuniverse)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartuniverse)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartuniverse/)
## Status for master
[![build status](https://GitLab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
[![coverage report](https://GitLab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartuniverse/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartuniverse/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartuniverse/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartuniverse)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## 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.
> licensed | **&copy;** [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';
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
// 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.
+133
View File
@@ -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();
-49
View File
@@ -1,49 +0,0 @@
// tslint:disable-next-line:no-implicit-dependencies
import { expect, tap } from 'tapbundle';
import * as smartuniverse from '../ts/index';
import { Observable } from 'rxjs';
let testUniverse: smartuniverse.Universe;
let testUniverseClient: smartuniverse.UniverseClient;
let testMessageObservable: Observable<smartuniverse.UniverseMessage>;
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.UniverseClient({
serverAddress: 'http://localhost:8765'
});
expect(testUniverseClient).to.be.instanceof(smartuniverse.UniverseClient);
});
tap.test('should send a message correctly', async () => {
await testUniverseClient.sendMessage('greeting', {
anyBool: true
});
});
tap.test('should get a observable correctly', async () => {
testMessageObservable = testUniverseClient.getMessageObservable();
});
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();
+8
View File
@@ -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.'
}
+16 -3
View File
@@ -1,3 +1,16 @@
export * from './smartuniverse.classes.universe';
export * from './smartuniverse.classes.universeclient';
export * from './smartuniverse.classes.universemessage';
// Client classes
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.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';
+15
View File
@@ -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;
}
+5
View File
@@ -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';
+26
View File
@@ -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;
}
+187
View File
@@ -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() {}
}
@@ -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);
}
}
+110 -79
View File
@@ -1,34 +1,17 @@
import * as plugins from './smartuniverse.plugins';
import * as plugins from './smartuniverse.plugins.js';
import { Handler, Route, Server } from 'smartexpress';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
import { UniverseCache } from './smartuniverse.classes.universecache';
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
@@ -37,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 {
@@ -47,74 +47,105 @@ export class Universe {
this.universeVersionStore = packageJson.version;
return this.universeVersionStore;
}
} */
/**
* adds a channel to the Universe
*/
public addChannel(nameArg: string, passphraseArg: string) {
const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
return newChannel;
}
private smartexpressServer: plugins.smartexpress.Server;
private smartsocket: plugins.smartsocket.Smartsocket;
constructor(optionsArg: ISmartUniverseConstructorOptions) {
this.options = optionsArg;
this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
/**
* 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: `smartuniverse server ${this.universeVersion}`,
forceSsl: false,
port: portArg
});
// message handling
// adds messages
const addMessageHandler = new Handler('PUT', async request => {
const requestBody: IServerPutMessageRequestBody = request.body;
const message = new UniverseMessage(
requestBody.message,
requestBody.channel,
requestBody.passphrase,
requestBody.payload
);
this.universeCache.addMessage(message);
console.log(requestBody);
return true;
});
// gets messages
const readMessageHandler = new Handler('GET', request => {
const done = plugins.smartq.defer<UniverseMessage[]>();
const requestBody = request.body;
const messageObservable = this.universeCache.readMessagesYoungerThan(requestBody.since);
messageObservable.toArray().subscribe(universeMessageArrayArg => {
done.resolve(universeMessageArrayArg);
});
return done.promise;
});
// create new Route for messages
const messageRoute = new Route(this.smartexpressServer, 'message');
messageRoute.addHandler(addMessageHandler);
messageRoute.addHandler(readMessageHandler);
const leaderElectionRoute = new Route(this.smartexpressServer, 'leadelection');
// TODO: implement Handlers for leader election
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,
});
this.smartsocket.setExternalServer('express', this.smartexpressServer as any); // should work with express as well
this.smartsocket.start();
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',
};
},
});
await this.smartexpressServer.start();
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',
};
},
});
// add socket functions
this.smartsocket.addSocketFunction(socketFunctionSubscription);
this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
// 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();
}
}
+37 -22
View File
@@ -1,60 +1,75 @@
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 'lik';
import { Observable } from 'rxjs';
import { rxjs } from '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.
*/
export class UniverseCache {
// ========
// INSTANCE
// ========
public standardMessageExpiry: number;
public destructionTime: number = 60000;
public destructionTime: number = 10000;
/**
* stores messages for this instance
*/
public messageCache = new Objectmap<UniverseMessage>();
public messageMap = new ObjectMap<UniverseMessage<any>>();
/**
* stores the channels that are available within the universe
*/
public channelCache = 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;
private lastId: number = 0; // stores the last id
public universeRef: Universe;
constructor(standardMessageExpiryArg: number) {
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.messageCache.add(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 = rxjs.Observable.from(this.messageCache.getArray()).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;
}
+96 -16
View File
@@ -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 '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.channelCache.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.channelCache.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,25 +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
);
}
/**
* 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);
}
}
@@ -1,60 +0,0 @@
import * as plugins from './smartuniverse.plugins';
import { Observable } from 'rxjs';
import { Smartsocket, SmartsocketClient } from 'smartsocket';
import * as url from 'url';
import {
IServerGetMessagesRequestBody,
IServerPutMessageRequestBody
} from './smartuniverse.classes.universe';
import { UniverseMessage } from './smartuniverse.classes.universemessage';
export interface IClientOptions {
serverAddress: string;
}
/**
* this class is for client side only!!!
* allows connecting to a universe server
*/
export class UniverseClient {
public options;
private socketClient: plugins.smartsocket.SmartsocketClient;
private observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
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.post(this.options.serverAddress, {
requestBody
});
}
public getMessageObservable() {
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();
}
return this.observableIntake.observable;
}
public close() {
this.socketClient.disconnect();
}
}
@@ -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;
}
});
}
}
+58 -72
View File
@@ -1,116 +1,102 @@
import * as plugins from './smartuniverse.plugins';
import { Objectmap } from 'lik';
import { Timer, TimeStamp } from '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.messageCache.remove(this);
this.destructionTimer.completed
.then(async () => {
this.universeCache?.messageMap.remove(this);
})
.catch((err) => {
console.log(err);
console.log(this);
});
} else {
this.fallBackDestruction();
}
}
/**
* 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);
}
});
}
}
/**
* handles bad messages for further analysis
*/
public handleAsBadMessage() {
logger.log('warn', 'received a bad message');
}
}
-14
View File
@@ -1,14 +0,0 @@
import * as plugins from './smartuniverse.plugins';
import { Universe } from './index';
process.env.CLI = 'true';
const universeCli = new plugins.smartcli.Smartcli();
universeCli.standardTask().subscribe(async argvArg => {
const standardUniverse = new Universe({
messageExpiryInMilliseconds: 60000
});
await standardUniverse.initServer(8765);
});
+2
View File
@@ -0,0 +1,2 @@
import * as plugins from './smartuniverse.plugins.js';
export const logger = new plugins.smartlog.ConsoleLog();
-3
View File
@@ -1,3 +0,0 @@
import * as plugins from './smartuniverse.plugins';
export const packageJson = plugins.path.join(__dirname, '../package.json');
+22 -20
View File
@@ -1,27 +1,29 @@
import * as smartcli from '@pushrocks/smartcli';
import * as lik from 'lik';
import * as nodehash from 'nodehash';
import * as path from 'path';
import * as smartdelay from 'smartdelay';
import * as smartexpress from 'smartexpress';
import * as smartfile from 'smartfile';
import * as smartq from 'smartq';
import * as smartrequest from 'smartrequest';
import * as smartrx from 'smartrx';
import * as smartsocket from 'smartsocket';
import * as smarttime from 'smarttime';
// apiglobal scope
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
export { typedrequestInterfaces };
// pushrocks scope
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,
nodehash,
path,
smartcli,
isohash,
isounique,
smartdelay,
smartexpress,
smartfile,
smartq,
smartlog,
smartpromise,
smartrx,
smartrequest,
smartsocket,
smarttime
smarttime,
smarturl,
};
+5
View File
@@ -0,0 +1,5 @@
import type * as typedserver from '@api.global/typedserver';
export type {
typedserver
};
+14
View File
@@ -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"]
}
-12
View File
@@ -1,12 +0,0 @@
{
"extends": [
"tslint:latest",
"tslint-config-prettier"
],
"rules": {
"semicolon": [
true,
"always"
]
}
}