Compare commits

..

90 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
47 changed files with 11382 additions and 3879 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
+1 -3
View File
@@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom
-119
View File
@@ -1,119 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: "$CI_BUILD_STAGE"
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
tags:
- docker
- notpriv
snyk:
stage: security
script:
- npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags:
- docker
- notpriv
# ====================
# test stage
# ====================
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
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install lts
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
release:
stage: release
script:
- npmci node install lts
- npmci npm publish
only:
- tags
tags:
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
script:
- npmci command npm install -g tslint typescript
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- docker
- notpriv
pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:18-dind
stage: metadata
script:
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true
+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"
}
}
-4
View File
@@ -1,4 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
ignore: {}
patch: {}
+3 -21
View File
@@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }
+26
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
+3 -1
View File
@@ -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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
+31 -8
View File
@@ -1,17 +1,40 @@
{ {
"gitzone": { "@git.zone/cli": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartuniverse", "gitrepo": "smartuniverse",
"shortDescription": "messaging service for micro services", "description": "A messaging service enabling secure, reactive communication between microservices.",
"npmPackagename": "@pushrocks/smartuniverse", "npmPackagename": "@push.rocks/smartuniverse",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks",
"keywords": [
"microservices",
"messaging",
"reactive programming",
"event-driven",
"channel-based communication",
"client-server architecture",
"message encryption",
"typescript",
"websocket",
"scalability"
]
},
"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": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmRegistryUrl": "registry.npmjs.org"
} }
} }
-3063
View File
File diff suppressed because it is too large Load Diff
+62 -38
View File
@@ -1,52 +1,76 @@
{ {
"name": "@pushrocks/smartuniverse", "name": "@push.rocks/smartuniverse",
"version": "1.0.66", "version": "1.0.109",
"private": false, "private": false,
"description": "messaging service for your micro services", "description": "A messaging service enabling secure, reactive communication between microservices.",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Task Venture Capital GmbH <hello@task.vc>",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "tstest test/ --verbose",
"testManual": "(tsrun test/test.ts)", "testManual": "tsrun test/",
"build": "(tsbuild)", "build": "tsbuild && tsbundle",
"format": "(gitzone format)" "format": "gitzone format",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@git.zone/tsbuild": "^4.4.0",
"@gitzone/tstest": "^1.0.24", "@git.zone/tsbundle": "^2.10.1",
"@pushrocks/tapbundle": "^3.0.13", "@git.zone/tsrun": "^2.0.3",
"@types/node": "^12.7.3", "@git.zone/tstest": "^3.6.3",
"tslint": "^5.19.0", "@types/lodash.clonedeep": "^4.5.9",
"tslint-config-prettier": "^1.18.0" "@types/node": "^25.6.0",
}, "@types/picomatch": "^4.0.3"
"peerDependencies": {
"rxjs": "*"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.11", "@api.global/typedrequest-interfaces": "^3.0.19",
"@pushrocks/smartdelay": "^2.0.3", "@api.global/typedserver": "^8.4.6",
"@pushrocks/smartexpress": "^3.0.40", "@push.rocks/isohash": "^2.0.1",
"@pushrocks/smartfile": "^7.0.4", "@push.rocks/isounique": "^1.0.5",
"@pushrocks/smarthash": "^2.0.6", "@push.rocks/lik": "^6.4.1",
"@pushrocks/smartlog": "^2.0.19", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartpromise": "^3.0.2", "@push.rocks/smartlog": "^3.2.2",
"@pushrocks/smartrequest": "^1.1.23", "@push.rocks/smartpromise": "^4.2.3",
"@pushrocks/smartrx": "^2.0.3", "@push.rocks/smartrx": "^3.0.6",
"@pushrocks/smartsocket": "^1.1.45", "@push.rocks/smartsocket": "^4.0.1",
"@pushrocks/smarttime": "^3.0.12", "@push.rocks/smarttime": "^4.2.3",
"@pushrocks/smartunique": "^3.0.1" "@push.rocks/smarturl": "^3.0.7"
}, },
"files": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"dist_ts_web/*", "dist_ts/**/*",
"assets/*", "dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
".smartconfig.json",
"license",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
] ],
"browserslist": [
"last 1 chrome versions"
],
"type": "module",
"keywords": [
"microservices",
"messaging",
"reactive programming",
"event-driven",
"channel-based communication",
"client-server architecture",
"message encryption",
"typescript",
"websocket",
"scalability"
],
"homepage": "https://code.foss.global/push.rocks/smartuniverse",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartuniverse.git"
},
"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 @@
+110 -38
View File
@@ -1,55 +1,127 @@
# @pushrocks/smartuniverse # @push.rocks/smartuniverse
messaging service for micro services messaging service for your micro services
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse) To install `@push.rocks/smartuniverse`, use the following command with npm:
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse) ```bash
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse) npm install @push.rocks/smartuniverse --save
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/) ```
This command adds `@push.rocks/smartuniverse` to your project's dependencies.
## Status for master
[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
## Usage ## Usage
`@push.rocks/smartuniverse` is designed to enable messaging services for microservices, allowing them to communicate in a structured and secure manner. Below are examples and scenarios illustrating how to use `@push.rocks/smartuniverse` for both server (managing messages across services) and client (microservices communicating within the universe) aspects.
Use TypeScript for best in class instellisense. ### Server side setup: Creating your Universe
### What is smartuniverse all about? First, you need to set up the server side of your messaging ecosystem, which involves creating a "universe" where channels reside.
Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
### Server side
every universe has a server that manages messages.
Think Kafka, but without Kafka.
```typescript ```typescript
import * as smartuniverse from '@pushrocks/smartuniverse'; import { Universe } from '@push.rocks/smartuniverse';
const myUniverse = new smartuniverse.Universe({ // Initialize a new Universe
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires const myUniverse = new Universe({
messageExpiryInMilliseconds: 60000, // messages expire after 60 seconds
}); });
// create as many channels as you like // Create channels for communication within the universe
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass'); // These channels can be thought of as topics or queues that services can subscribe to or post messages to
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9'); myUniverse.addChannel('channel-one', 'password1');
myUniverse.addChannel('channel-two', 'password2');
myUniverse.start(8765); // start the server and provide the port on which to listen on // Start the universe server on a specified port
myUniverse.start(8765);
``` ```
### Client side By starting the universe, you've established a messaging hub for your microservices. Ensure that the services know the universe's address and the channels and passwords they should use for communication.
All your microservices represents clients in the universe that may talk to each other using the universe server. ### Client side: Microservices joining the Universe
For further information read the linked docs at the top of this readme. On the client side, your microservices will join the universe, subscribing to channels to listen for messages or post their messages to be consumed by other services.
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh) ```typescript
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) import { ClientUniverse, ClientUniverseChannel } from '@push.rocks/smartuniverse';
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com) // Initialize client that connects to the universe server
const clientUniverse = new ClientUniverse({
serverAddress: 'http://your-universe-server:8765',
autoReconnect: true,
});
// Define a channel to subscribe to (the channel must be created in the universe server)
const channel = clientUniverse.addChannel('channel-one', 'password1');
// Start the client to enable communication
clientUniverse.start();
// Posting a message to the channel
channel.postMessage({
messageText: 'Hello, universe!',
payload: { some: 'data' },
});
// Listening for messages from the channel
channel.subscribe((message) => {
console.log('Received message:', message);
});
```
### Reaction Patterns: Request and Response Within the Universe
`@push.rocks/smartuniverse` supports reactive programming. Microservices can emit "reaction requests" and listen for "reaction responses" tied to specific actions or commands.
```typescript
import { ReactionRequest, ReactionResponse } from '@push.rocks/smartuniverse';
// Define a request-response type
interface MyRequestResponse {
method: 'greet';
request: { name: string };
response: { message: string };
};
// Creating a reaction request on client side
const reactionRequest = new ReactionRequest<MyRequestResponse>({ method: 'greet' });
// Emitting a reaction request and handling responses
reactionRequest.fire([channel], { name: 'World' }).then((reactionResult) => {
reactionResult.getFirstResult().then((response) => {
console.log(response.message); // Output: Hello, World!
});
});
// Handling reaction requests on server side or another client
const reactionResponse = new ReactionResponse<MyRequestResponse>({
channels: [myUniverse.getChannel('channel-one')],
funcDef: async (requestData) => {
return { message: `Hello, ${requestData.name}!` };
},
method: 'greet',
});
```
This pattern enables a powerful, flexible communication system where services can asynchronously request information or trigger actions across the microservices architecture without direct coupling.
### Conclusion
`@push.rocks/smartuniverse` provides a robust platform for facilitating communication between microservices. By setting up a universe and defining channels, your services can securely exchange messages, supporting both direct communications and reactive programming patterns. Whether sharing updates, events, or performing request-response interactions, `@push.rocks/smartuniverse` simplifies the process of building a cohesive microservices ecosystem.
For more advanced use cases and configuration options, refer to the complete documentation.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
+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();
-84
View File
@@ -1,84 +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 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
});
expect(testClientUniverse).to.be.instanceof(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).to.be.instanceof(smartuniverse.ClientUniverseChannel);
});
tap.test('should send a message correctly', async () => {
await (testClientUniverse.getChannel(testChannelData.channelName)).sendMessage({
messageText: 'hello'
});
});
tap.test('universe should contain the sent message', async () => {
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
});
tap.test('a second client should be able to subscibe', async () => {
testClientUniverse2 = new smartuniverse.ClientUniverse({
serverAddress: testServerData.serverAddress
});
testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
});
tap.test('should receive a message correctly', async () => {});
tap.test('should disconnect the client correctly', async () => {
testClientUniverse.stop();
});
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.'
}
+12 -8
View File
@@ -1,12 +1,16 @@
// Client classes // Client classes
export * from './smartuniverse.classes.clientuniverse'; export * from './smartuniverse.classes.client.universe.js';
export * from './smartuniverse.classes.clientuniversechannel'; export * from './smartuniverse.classes.client.universechannel.js';
export * from './smartuniverse.classes.clientuniversemessage'; export * from './smartuniverse.classes.client.universemessage.js';
// Server classes // Server classes
export * from './smartuniverse.classes.universe'; export * from './smartuniverse.classes.universe.js';
export * from './smartuniverse.classes.universecache'; export * from './smartuniverse.classes.universecache.js';
export * from './smartuniverse.classes.universechannel'; export * from './smartuniverse.classes.universechannel.js';
export * from './smartuniverse.classes.universemessage'; export * from './smartuniverse.classes.universemessage.js';
export * from './interfaces'; // Reaction Response
export * from './smartuniverse.classes.event.reactionrequest.js';
export * from './smartuniverse.classes.event.reactionresponse.js';
export * from './interfaces/index.js';
+5 -4
View File
@@ -1,4 +1,5 @@
export * from './http.interfaces'; export * from './http.interfaces.js';
export * from './universechannel.interfaces'; export * from './socketfunctionrequests.js';
export * from './universemessage.interfaces'; export * from './universechannel.interfaces.js';
export * from './universeactions.interfaces'; 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: {};
}
@@ -1,17 +1,3 @@
export type IServerCallActions =
| 'channelSubscription'
| 'processMessage'
| 'channelUnsubscribe'
| 'terminateConnection';
/**
* the interface for a subscription
*/
export interface IServerCallSubscribeActionPayload {
name: string;
passphrase: string;
}
export interface IServerUnsubscribeActionPayload { export interface IServerUnsubscribeActionPayload {
name: string; name: string;
} }
+4 -5
View File
@@ -1,13 +1,12 @@
export interface IMessageCreator { export interface IMessageCreator<T = any> {
messageText: string; messageText: string;
payload?: string | number | any; payload?: T;
payloadStringType?: 'Buffer' | 'string' | 'object';
} }
/** /**
* * A universe
*/ */
export interface IUniverseMessage extends IMessageCreator { export interface IUniverseMessage<T = any> extends IMessageCreator<T> {
id: string; id: string;
/** /**
* time of creation * time of creation
+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();
}
}
}
@@ -1,5 +1,5 @@
import * as plugins from './smartuniverse.plugins'; import * as plugins from './smartuniverse.plugins.js';
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel'; import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
/** /**
* a cache for clients * a cache for clients
@@ -7,5 +7,5 @@ import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversecha
* good for deduplication in mesh environments * good for deduplication in mesh environments
*/ */
export class ClientUniverseCache { export class ClientUniverseCache {
public channelMap = new plugins.lik.Objectmap<ClientUniverseChannel>(); public channelMap = new plugins.lik.ObjectMap<ClientUniverseChannel>();
} }
@@ -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() {}
}
-130
View File
@@ -1,130 +0,0 @@
import * as plugins from './smartuniverse.plugins';
import { Objectmap } from '@pushrocks/lik';
import { Observable } from 'rxjs';
import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
import * as url from 'url';
import * as interfaces from './interfaces';
import { ClientUniverseChannel, ClientUniverseMessage } from './';
import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
export interface IClientOptions {
serverAddress: string;
}
/**
* this class is for client side only!!!
* allows connecting to a universe server
*/
export class ClientUniverse {
public options;
public smartsocketClient: plugins.smartsocket.SmartsocketClient;
public observableIntake: plugins.smartrx.ObservableIntake<ClientUniverseMessage>;
public clientUniverseCache = new ClientUniverseCache();
constructor(optionsArg: IClientOptions) {
this.options = optionsArg;
}
/**
* adds a channel to the channelcache
* TODO: verify channel before adding it to the channel cache
*/
public addChannel(channelNameArg: string, passphraseArg: string) {
const existingChannel = this.getChannel(channelNameArg);
if (existingChannel) {
throw new Error('channel exists');
}
// lets create the channel
const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(this, channelNameArg, passphraseArg);
return clientUniverseChannel;
}
/**
* gets a channel from the channelcache
* @param channelName
* @param passphraseArg
*/
public getChannel(channelName: string): ClientUniverseChannel {
const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
return channel.name === channelName;
});
return clientUniverseChannel;
}
/**
* remove a a achannel
* @param messageArg
*/
public removeChannel(channelNameArg, notifyServer = true) {
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(channelItemArg => {
return channelItemArg.name === channelNameArg;
});
}
public async start() {
await this.checkConnection();
}
public stop() {
this.smartsocketClient.disconnect();
}
/**
* checks the connection towards a universe server
* since password validation is done through other means, a connection should always be possible
*/
public async checkConnection(): Promise<void> {
if (!this.smartsocketClient && !this.observableIntake) {
const parsedURL = url.parse(this.options.serverAddress);
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
alias: process.env.SOCKET_ALIAS || 'someclient',
password: 'UniverseClient',
port: parseInt(parsedURL.port, 10),
role: 'UniverseClient',
url: parsedURL.protocol + '//' + parsedURL.hostname
};
this.smartsocketClient = new SmartsocketClient(socketConfig);
this.observableIntake = new plugins.smartrx.ObservableIntake();
// lets define some basic actions
/**
* should handle a forced unsubscription by the server
*/
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
funcName: 'unsubscribe',
allowedRoles: [],
funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
throw new Error('TODO');
}
});
/**
* handles message reception
*/
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
funcName: 'processMessage',
allowedRoles: [],
funcDef: async (messageDescriptorArg: interfaces.IUniverseMessage) => {
plugins.smartlog.defaultLogger.log('info', 'Got message from server');
this.observableIntake.push(ClientUniverseMessage.createMessageFromMessageDescriptor(messageDescriptorArg));
}
});
// add functions
this.smartsocketClient.addSocketFunction(socketFunctionUnsubscribe);
this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
await this.smartsocketClient.connect();
plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
await clientUniverseChannelArg.subscribe();
});
}
}
}
@@ -1,77 +0,0 @@
import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces';
import { ClientUniverse } from './';
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;
// 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 async subscribe() {
const serverCallActionName: interfaces.IServerCallActions = 'channelSubscription';
const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
name: this.name,
passphrase: this.passphrase
};
await this.clientUniverseRef.smartsocketClient.serverCall(serverCallActionName, serverCallActionPayload);
}
/**
* sends a message towards the server
* @param messageArg
*/
public async sendMessage(messageArg: interfaces.IMessageCreator) {
await this.clientUniverseRef.checkConnection();
const universeMessageToSend: interfaces.IUniverseMessage = {
id: plugins.smartunique.shortId(),
timestamp: Date.now(),
passphrase: this.passphrase,
targetChannelName: this.name,
messageText: messageArg.messageText,
payload: messageArg.payload,
payloadStringType: messageArg.payloadStringType
};
await this.clientUniverseRef.smartsocketClient.serverCall('processMessage', universeMessageToSend);
}
}
@@ -1,39 +0,0 @@
import * as plugins from './smartuniverse.plugins';
import * as interfaces from './interfaces';
export class ClientUniverseMessage implements interfaces.IUniverseMessage {
// ======
// STATIC
// ======
public static createMessageFromMessageDescriptor(messageDescriptor: interfaces.IUniverseMessage) {
const clientuniverseMessage = new ClientUniverseMessage(messageDescriptor);
return clientuniverseMessage;
}
// ========
// INSTANCE
// ========
// properties
public id: string;
public timestamp: number;
public smartTimestamp: plugins.smarttime.TimeStamp;
public messageText: string;
public passphrase: string;
public payload: any;
public payloadStringType;
public targetChannelName: string;
constructor(messageArg: interfaces.IUniverseMessage) {
for (const key of Object.keys(messageArg)) {
this[key] = messageArg[key];
}
}
/**
* 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);
}
}
+55 -76
View File
@@ -1,16 +1,13 @@
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 './index.js';
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
import * as paths from './smartuniverse.paths'; import * as interfaces from './interfaces/index.js';
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
import * as interfaces from './interfaces'; import { logger } from './smartuniverse.logging.js';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
export interface ISmartUniverseConstructorOptions { export interface ISmartUniverseConstructorOptions {
messageExpiryInMilliseconds: number; messageExpiryInMilliseconds: number;
externalServer?: plugins.smartexpress.Server;
} }
/** /**
@@ -23,15 +20,10 @@ export class Universe {
// options // options
private options: ISmartUniverseConstructorOptions; private options: ISmartUniverseConstructorOptions;
/**
* the smartexpress server used
*/
private smartexpressServer: plugins.smartexpress.Server;
/** /**
* the smartsocket used * the smartsocket used
*/ */
private smartsocket: plugins.smartsocket.Smartsocket; private smartsocket?: plugins.smartsocket.Smartsocket;
constructor(optionsArg: ISmartUniverseConstructorOptions) { constructor(optionsArg: ISmartUniverseConstructorOptions) {
this.options = optionsArg; this.options = optionsArg;
@@ -42,12 +34,12 @@ export class Universe {
* stores the version of the universe server running * 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. * this is done since the version is exposed through the api and multiple fs actions are avoided this way.
*/ */
private universeVersionStore: string; private universeVersionStore = '';
/** /**
* get the currently running version of smartuniverse * get the currently running version of smartuniverse
*/ */
public getUniverseVersion() { /* public getUniverseVersion() {
if (this.universeVersionStore) { if (this.universeVersionStore) {
return this.universeVersionStore; return this.universeVersionStore;
} else { } else {
@@ -55,85 +47,75 @@ export class Universe {
this.universeVersionStore = packageJson.version; this.universeVersionStore = packageJson.version;
return this.universeVersionStore; return this.universeVersionStore;
} }
} } */
/** /**
* adds a channel to the Universe * adds a channel to the Universe
*/ */
public addChannel(nameArg: string, passphraseArg: string) { public addChannel(nameArg: string, passphraseArg: string) {
const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg); const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
return newChannel;
}
/**
* returns a channel
*/
public getChannel(channelNameArg: string) {
return this.universeCache.channelMap.findSync((channelArg) => {
return channelArg.name === channelNameArg;
});
} }
/** /**
* initiates a server * initiates a server
*/ */
public async start(portArg: number) { public async start(portArg?: number) {
// lets create the base smartexpress server if (!portArg) {
if (!this.options.externalServer) { throw new Error(`You need to specify a portArg to start on.`);
this.smartexpressServer = new plugins.smartexpress.Server({
cors: true,
defaultAnswer: async () => {
return `smartuniverse server ${this.getUniverseVersion()}`;
},
forceSsl: false,
port: portArg
});
} else {
this.smartexpressServer = this.options.externalServer;
} }
// add websocket upgrade // add websocket upgrade
this.smartsocket = new plugins.smartsocket.Smartsocket({}); this.smartsocket = new plugins.smartsocket.Smartsocket({
alias: 'smartuniverse',
// add a role for the clients port: portArg,
const ClientRole = new plugins.smartsocket.SocketRole({
name: 'UniverseClient',
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
}); });
// add the role to smartsocket const socketFunctionSubscription =
this.smartsocket.addSocketRoles([ClientRole]); new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({
funcName: 'subscribeChannel',
const socketFunctionSubscription = new plugins.smartsocket.SocketFunction({ funcDef: async (dataArg, socketConnectionArg) => {
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
funcName: 'channelSubscription',
funcDef: async (
dataArg: interfaces.IServerCallSubscribeActionPayload,
socketConnectionArg
) => {
// run in "this context" of this class
await (async () => {
const universeConnection = new UniverseConnection({ const universeConnection = new UniverseConnection({
universe: this,
socketConnection: socketConnectionArg, socketConnection: socketConnectionArg,
authenticationRequests: [dataArg] authenticationRequests: [dataArg],
}); });
await UniverseConnection.addConnectionToCache(this, universeConnection); await UniverseConnection.addConnectionToCache(this, universeConnection);
return { return {
'subscription status': 'success' subscriptionStatus: 'subscribed',
}; };
})(); },
} });
});
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({ const socketFunctionProcessMessage =
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_ProcessMessage>({
funcName: 'processMessage', funcName: 'processMessage',
funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => { funcDef: async (messageDataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
// run in "this" context of this class
await (async () => {
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection( const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
this.universeCache, this.universeCache,
socketConnectionArg socketConnectionArg
); );
if (universeConnection) { if (universeConnection) {
plugins.smartlog.defaultLogger.log('ok', 'found UniverseConnection for socket for incoming message'); logger.log('ok', 'found UniverseConnection for socket for incoming message');
} else { } else {
plugins.smartlog.defaultLogger.log('warn', 'found no Authorized channel for incoming message'); logger.log('warn', 'found no Authorized channel for incoming message');
return { return {
error: 'You need to authenticate for a channel' messageStatus: 'authentication required',
}; };
} }
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(socketConnectionArg, dataArg); const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
socketConnectionArg,
messageDataArg
);
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel( const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
this.universeCache, this.universeCache,
unauthenticatedMessage unauthenticatedMessage
@@ -141,32 +123,29 @@ export class Universe {
if (foundChannel && unauthenticatedMessage.authenticated) { if (foundChannel && unauthenticatedMessage.authenticated) {
const authenticatedMessage = unauthenticatedMessage; const authenticatedMessage = unauthenticatedMessage;
await this.universeCache.addMessage(authenticatedMessage); await this.universeCache.addMessage(authenticatedMessage);
return {
messageStatus: 'ok',
};
} }
})(); return {
} messageStatus: 'channel not found',
}); };
},
});
// add socket functions // add socket functions
this.smartsocket.addSocketFunction(socketFunctionSubscription); this.smartsocket.addSocketFunction(socketFunctionSubscription);
this.smartsocket.addSocketFunction(socketFunctionProcessMessage); this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
// add smartsocket to the running smartexpress app // add smartsocket to the running smartexpress app
this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer as any);
// start everything
if (!this.options.externalServer) {
await this.smartexpressServer.start();
}
await this.smartsocket.start(); await this.smartsocket.start();
plugins.smartlog.defaultLogger.log('success', 'started universe'); logger.log('success', 'started universe');
} }
/** /**
* stop everything * stop everything
*/ */
public async stopServer() { public async stopServer() {
await this.smartsocket.stop(); await this.smartsocket?.stop();
if (!this.options.externalServer) {
await this.smartexpressServer.stop();
}
} }
} }
+16 -20
View File
@@ -1,15 +1,11 @@
import * as plugins from './smartuniverse.plugins'; import * as plugins from './smartuniverse.plugins.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel'; import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
import { UniverseMessage } from './smartuniverse.classes.universemessage'; import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
import { Objectmap } from '@pushrocks/lik'; import { ObjectMap } from '@push.rocks/lik';
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
import { Observable, from } from 'rxjs'; import { Universe } from './smartuniverse.classes.universe.js';
import { filter } from 'rxjs/operators';
import { rxjs } from '@pushrocks/smartrx';
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
import { Universe } from './smartuniverse.classes.universe';
/** /**
* universe store handles the creation, storage and retrieval of messages. * universe store handles the creation, storage and retrieval of messages.
@@ -19,22 +15,22 @@ export class UniverseCache {
// INSTANCE // INSTANCE
// ======== // ========
public standardMessageExpiry: number; public standardMessageExpiry: number;
public destructionTime: number = 60000; public destructionTime: number = 10000;
/** /**
* stores messages for this instance * 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 * stores the channels that are available within the universe
*/ */
public channelMap = new Objectmap<UniverseChannel>(); public channelMap = new ObjectMap<UniverseChannel>();
/** /**
* stores all connections * stores all connections
*/ */
public connectionMap = new plugins.lik.Objectmap<UniverseConnection>(); public connectionMap = new plugins.lik.ObjectMap<UniverseConnection>();
/** /**
* allows messages to be processed in a blacklist mode for further analysis * allows messages to be processed in a blacklist mode for further analysis
@@ -54,12 +50,12 @@ export class UniverseCache {
* @param messageArg * @param messageArg
* @param attachedPayloadArg * @param attachedPayloadArg
*/ */
public async addMessage(messageArg: UniverseMessage) { public async addMessage(messageArg: UniverseMessage<any>) {
messageArg.setUniverseCache(this); messageArg.setUniverseCache(this);
UniverseChannel.authorizeAMessageForAChannel(this, messageArg); UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
this.messageMap.add(messageArg); this.messageMap.add(messageArg);
messageArg.universeChannelList.forEach(universeChannel => { messageArg.universeChannelList.forEach((universeChannel) => {
universeChannel.pushToClients(messageArg); universeChannel.push(messageArg);
}); });
} }
@@ -69,9 +65,9 @@ export class UniverseCache {
public readMessagesYoungerThan( public readMessagesYoungerThan(
unixTimeArg?: number, unixTimeArg?: number,
channelName?: string channelName?: string
): Observable<UniverseMessage> { ): plugins.smartrx.rxjs.Observable<UniverseMessage<any>> {
const messageObservable = from(this.messageMap.getArray()).pipe( const messageObservable = plugins.smartrx.rxjs.from(this.messageMap.getArray()).pipe(
filter(messageArg => { plugins.smartrx.rxjs.ops.filter((messageArg) => {
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime); return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
}) })
); );
+51 -19
View File
@@ -1,10 +1,11 @@
import * as plugins from './smartuniverse.plugins'; import * as plugins from './smartuniverse.plugins.js';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces/index.js';
import { UniverseCache } from './smartuniverse.classes.universecache'; import { UniverseCache } from './smartuniverse.classes.universecache.js';
import { UniverseMessage } from './smartuniverse.classes.universemessage'; import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
import { UniverseConnection } from './smartuniverse.classes.universeconnection'; import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
import { Universe } from './smartuniverse.classes.universe'; import { Universe } from './smartuniverse.classes.universe.js';
import { logger } from './smartuniverse.logging.js';
/** /**
* enables messages to stay within a certain scope. * enables messages to stay within a certain scope.
@@ -33,7 +34,7 @@ export class UniverseChannel {
* returns boolean wether certain channel exists * returns boolean wether certain channel exists
*/ */
public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) { public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
const channel = universeCacheArg.channelMap.find(channelArg => { const channel = universeCacheArg.channelMap.findSync((channelArg) => {
return channelArg.name === channelNameArg; return channelArg.name === channelNameArg;
}); });
if (channel) { if (channel) {
@@ -52,27 +53,27 @@ export class UniverseChannel {
*/ */
public static authorizeAMessageForAChannel( public static authorizeAMessageForAChannel(
universeCacheArg: UniverseCache, universeCacheArg: UniverseCache,
universeMessageArg: UniverseMessage universeMessageArg: UniverseMessage<any>
): UniverseChannel { ): UniverseChannel | null {
const foundChannel = universeCacheArg.channelMap.find(universeChannel => { const foundChannel = universeCacheArg.channelMap.findSync((universeChannel) => {
const result = universeChannel.authenticate(universeMessageArg); const result = universeChannel.authenticate(universeMessageArg);
return result; return result;
}); });
if (foundChannel) { if (foundChannel) {
universeMessageArg.authenticated = true; universeMessageArg.authenticated = true;
universeMessageArg.universeChannelList.add(foundChannel); universeMessageArg.universeChannelList.add(foundChannel);
plugins.smartlog.defaultLogger.log('ok', 'message authorized'); logger.log('ok', 'message authorized');
return foundChannel; return foundChannel;
} else { } else {
universeMessageArg.authenticated = false; universeMessageArg.authenticated = false;
universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel); universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
plugins.smartlog.defaultLogger.log('warn', 'message not valid'); logger.log('warn', 'message not valid');
return null; return null;
} }
} }
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) { public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
return universeRef.universeCache.channelMap.find(channelArg => { return universeRef.universeCache.channelMap.findSync((channelArg) => {
return channelArg.name === universeChannelName; return channelArg.name === universeChannelName;
}); });
} }
@@ -85,6 +86,7 @@ export class UniverseChannel {
*/ */
public name: string; public name: string;
public universeRef: Universe; public universeRef: Universe;
private subject = new plugins.smartrx.rxjs.Subject<UniverseMessage<any>>();
/** /**
* the passphrase for the channel * the passphrase for the channel
@@ -102,7 +104,7 @@ export class UniverseChannel {
* # the messages channelName against the unverseChannel's name * # the messages channelName against the unverseChannel's name
* # the messages password against the universeChannel's password * # the messages password against the universeChannel's password
*/ */
public authenticate(universeMessageArg: UniverseMessage): boolean { public authenticate(universeMessageArg: UniverseMessage<any>): boolean {
return ( return (
this.name === universeMessageArg.targetChannelName && this.name === universeMessageArg.targetChannelName &&
this.passphrase === universeMessageArg.passphrase this.passphrase === universeMessageArg.passphrase
@@ -113,15 +115,17 @@ export class UniverseChannel {
* pushes a message to clients * pushes a message to clients
* @param messageArg * @param messageArg
*/ */
public async pushToClients(messageArg: UniverseMessage) { public async push(messageArg: UniverseMessage<any>) {
this.subject.next(messageArg);
const universeConnectionsWithChannelAccess: UniverseConnection[] = []; const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
this.universeRef.universeCache.connectionMap.forEach(async socketConnection => { await this.universeRef.universeCache.connectionMap.forEach(async (socketConnection) => {
if (socketConnection.authenticatedChannels.includes(this)) { if (socketConnection.authenticatedChannels.includes(this)) {
universeConnectionsWithChannelAccess.push(socketConnection); universeConnectionsWithChannelAccess.push(socketConnection);
} }
}); });
for (const universeConnection of universeConnectionsWithChannelAccess) { for (const universeConnection of universeConnectionsWithChannelAccess) {
const smartsocket = universeConnection.socketConnection.smartsocketRef as plugins.smartsocket.Smartsocket; const smartsocket = universeConnection.socketConnection
.smartsocketRef as plugins.smartsocket.Smartsocket;
const universeMessageToSend: interfaces.IUniverseMessage = { const universeMessageToSend: interfaces.IUniverseMessage = {
id: messageArg.id, id: messageArg.id,
timestamp: messageArg.timestamp, timestamp: messageArg.timestamp,
@@ -129,9 +133,37 @@ export class UniverseChannel {
targetChannelName: this.name, targetChannelName: this.name,
messageText: messageArg.messageText, messageText: messageArg.messageText,
payload: messageArg.payload, payload: messageArg.payload,
payloadStringType: messageArg.payloadStringType
}; };
smartsocket.clientCall('processMessage', universeMessageToSend, universeConnection.socketConnection); 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);
}
} }
+34 -17
View File
@@ -1,8 +1,8 @@
import * as plugins from './smartuniverse.plugins'; import * as plugins from './smartuniverse.plugins.js';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces/index.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel'; import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
import { UniverseCache } from './smartuniverse.classes.universecache'; import { UniverseCache } from './smartuniverse.classes.universecache.js';
import { Universe } from './smartuniverse.classes.universe'; import { Universe } from './smartuniverse.classes.universe.js';
/** /**
* represents a connection to the universe * represents a connection to the universe
@@ -26,6 +26,7 @@ export class UniverseConnection {
universeConnection universeConnection
); );
universeRef.universeCache.connectionMap.add(universeConnection); universeRef.universeCache.connectionMap.add(universeConnection);
console.log('hi');
} }
/** /**
@@ -35,8 +36,8 @@ export class UniverseConnection {
universeCache: UniverseCache, universeCache: UniverseCache,
universeConnectionArg: UniverseConnection universeConnectionArg: UniverseConnection
): Promise<UniverseConnection> { ): Promise<UniverseConnection> {
let connectionToReturn: UniverseConnection; let connectionToReturn: UniverseConnection | undefined;
universeCache.connectionMap.forEach(async existingConnection => { universeCache.connectionMap.forEach(async (existingConnection) => {
if (existingConnection.socketConnection === universeConnectionArg.socketConnection) { if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
connectionToReturn = await this.mergeUniverseConnections( connectionToReturn = await this.mergeUniverseConnections(
existingConnection, existingConnection,
@@ -58,8 +59,11 @@ export class UniverseConnection {
universeConnectionArg: UniverseConnection universeConnectionArg: UniverseConnection
): Promise<UniverseConnection> { ): Promise<UniverseConnection> {
for (const authenticationRequest of universeConnectionArg.authenticationRequests) { for (const authenticationRequest of universeConnectionArg.authenticationRequests) {
const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(universeRef, authenticationRequest.name); const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(
if (universeChannelToAuthenticateAgainst.passphrase === authenticationRequest.passphrase) { universeRef,
authenticationRequest.name
);
if (universeChannelToAuthenticateAgainst?.passphrase === authenticationRequest.passphrase) {
universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst); universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst);
} }
} }
@@ -82,37 +86,50 @@ export class UniverseConnection {
public static findUniverseConnectionBySocketConnection( public static findUniverseConnectionBySocketConnection(
universeCache: UniverseCache, universeCache: UniverseCache,
socketConnectionArg: plugins.smartsocket.SocketConnection socketConnectionArg: plugins.smartsocket.SocketConnection
): UniverseConnection { ): UniverseConnection | undefined {
const universeConnection = universeCache.connectionMap.find(universeConnectionArg => { const universeConnection = universeCache.connectionMap.findSync((universeConnectionArg) => {
return universeConnectionArg.socketConnection === socketConnectionArg; return universeConnectionArg.socketConnection === socketConnectionArg;
}); });
return universeConnection; return universeConnection;
} }
// INSTANCE
public universeRef: Universe;
public terminatedDeferred = plugins.smartpromise.defer(); public terminatedDeferred = plugins.smartpromise.defer();
/** /**
* the socketClient to ping * the socketClient to ping
*/ */
public socketConnection: plugins.smartsocket.SocketConnection; public socketConnection: plugins.smartsocket.SocketConnection;
public authenticationRequests: interfaces.IServerCallSubscribeActionPayload[] = []; public authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']> = [];
public subscribedChannels: UniverseChannel[] = [];
public authenticatedChannels: UniverseChannel[] = []; public authenticatedChannels: UniverseChannel[] = [];
public failedToJoinChannels: UniverseChannel[] = []; public failedToJoinChannels: UniverseChannel[] = [];
/** /**
* terminates the connection * disconnect the connection
*/ */
public terminateConnection() { public async disconnect(reason: 'upstreamevent' | 'triggered' = 'triggered') {
this.socketConnection.socket.disconnect(); if (reason === 'triggered') {
await this.socketConnection.disconnect();
}
this.universeRef.universeCache.connectionMap.remove(this);
this.terminatedDeferred.resolve(); this.terminatedDeferred.resolve();
} }
constructor(optionsArg: { constructor(optionsArg: {
universe: Universe;
socketConnection: plugins.smartsocket.SocketConnection; socketConnection: plugins.smartsocket.SocketConnection;
authenticationRequests: interfaces.IServerCallSubscribeActionPayload[]; authenticationRequests: Array<interfaces.ISocketRequest_SubscribeChannel['request']>;
}) { }) {
this.universeRef = optionsArg.universe;
this.authenticationRequests = optionsArg.authenticationRequests; this.authenticationRequests = optionsArg.authenticationRequests;
this.socketConnection = optionsArg.socketConnection; this.socketConnection = optionsArg.socketConnection;
this.socketConnection.eventSubject.subscribe(async (eventArg) => {
switch (eventArg) {
case 'disconnected':
await this.disconnect('upstreamevent');
break;
}
});
} }
} }
+41 -46
View File
@@ -1,44 +1,42 @@
import * as plugins from './smartuniverse.plugins'; import * as plugins from './smartuniverse.plugins.js';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces/index.js';
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
import { Objectmap } from '@pushrocks/lik'; import { UniverseCache } from './smartuniverse.classes.universecache.js';
import { SocketConnection } from '@push.rocks/smartsocket';
import { Timer, TimeStamp } from '@pushrocks/smarttime'; import { logger } from './smartuniverse.logging.js';
import { Universe } from './smartuniverse.classes.universe';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseCache } from './smartuniverse.classes.universecache';
import { SocketConnection } from '@pushrocks/smartsocket';
/** /**
* represents a message within a universe * represents a message within a universe
* acts as a container to save message states like authentication status * acts as a container to save message states like authentication status
*/ */
export class UniverseMessage implements interfaces.IUniverseMessage { export class UniverseMessage<T = any> implements interfaces.IUniverseMessage<T> {
public static createMessageFromPayload(socketConnectionArg: SocketConnection, dataArg: interfaces.IUniverseMessage) { public static createMessageFromPayload<T = any>(
const universeMessageInstance = new UniverseMessage(dataArg); socketConnectionArg: SocketConnection,
dataArg: interfaces.IUniverseMessage<T>
) {
const universeMessageInstance = new UniverseMessage<T>(dataArg);
universeMessageInstance.socketConnection = socketConnectionArg; universeMessageInstance.socketConnection = socketConnectionArg;
return universeMessageInstance; return universeMessageInstance;
} }
public id: string; public id: string;
public timestamp: number; public timestamp: number;
public smartTimestamp: TimeStamp; public smartTimestamp: plugins.smarttime.TimeStamp;
public messageText: string; public messageText: string;
public passphrase: string; public passphrase: string;
public payload: any; public payload: T;
public payloadStringType;
public targetChannelName: string; public targetChannelName: string;
public socketConnection: SocketConnection; public socketConnection?: SocketConnection;
/** /**
* the UniverseCache the message is attached to * the UniverseCache the message is attached to
*/ */
public universeCache: UniverseCache; public universeCache?: UniverseCache;
/** /**
* enables unprotected grouping of messages for efficiency purposes. * 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 * wether the message is authenticated
@@ -48,42 +46,50 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
/** /**
* a destruction timer for this message * a destruction timer for this message
*/ */
public destructionTimer: Timer; // a timer to take care of message destruction public destructionTimer?: plugins.smarttime.Timer; // a timer to take care of message destruction
/** /**
* the constructor to create a universe message * the constructor to create a universe message
* @param messageArg * @param messageArg
* @param attachedPayloadArg * @param attachedPayloadArg
*/ */
constructor(messageDescriptor: interfaces.IUniverseMessage) { constructor(messageDescriptor: interfaces.IUniverseMessage<T>) {
this.smartTimestamp = new TimeStamp(this.timestamp); this.id = messageDescriptor.id;
this.timestamp = messageDescriptor.timestamp;
this.smartTimestamp = new plugins.smarttime.TimeStamp(this.timestamp);
this.messageText = messageDescriptor.messageText; this.messageText = messageDescriptor.messageText;
this.targetChannelName = messageDescriptor.targetChannelName; this.targetChannelName = messageDescriptor.targetChannelName;
this.passphrase = messageDescriptor.passphrase; this.passphrase = messageDescriptor.passphrase;
this.payload = messageDescriptor.payload; this.payload = messageDescriptor.payload as T;
// prevent memory issues // prevent memory issues
this.fallBackDestruction(); this.setDestructionTimer();
} }
public setUniverseCache(universeCacheArg: UniverseCache) { public setUniverseCache(universeCacheArg: UniverseCache) {
this.universeCache = universeCacheArg; this.universeCache = universeCacheArg;
} }
public setTargetChannel() { public setTargetChannel() {}
} public setDestructionTimer(selfdestructAfterArg?: number) {
public setDestructionTimer(selfdestructAfterArg: number) {
if (selfdestructAfterArg) { if (selfdestructAfterArg) {
this.destructionTimer = new Timer(selfdestructAfterArg); this.destructionTimer = new plugins.smarttime.Timer(selfdestructAfterArg);
this.destructionTimer.start(); this.destructionTimer.start();
// set up self destruction by removing this from the parent messageCache // set up self destruction by removing this from the parent messageCache
this.destructionTimer.completed.then(async () => { this.destructionTimer.completed
this.universeCache.messageMap.remove(this); .then(async () => {
}); this.universeCache?.messageMap.remove(this);
})
.catch((err) => {
console.log(err);
console.log(this);
});
} else { } else {
this.fallBackDestruction(); plugins.smartdelay.delayFor(1000).then(() => {
if (!this.destructionTimer) {
this.setDestructionTimer(6000);
}
});
} }
} }
@@ -91,17 +97,6 @@ export class UniverseMessage implements interfaces.IUniverseMessage {
* handles bad messages for further analysis * handles bad messages for further analysis
*/ */
public handleAsBadMessage() { public handleAsBadMessage() {
plugins.smartlog.defaultLogger.log('warn', 'received a bad message'); logger.log('warn', 'received a bad message');
}
/**
* prevents memory leaks if channels have no default
*/
private fallBackDestruction() {
plugins.smartdelay.delayFor(1000).then(() => {
if (!this.destructionTimer) {
this.setDestructionTimer(6000);
}
});
} }
} }
+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');
+16 -20
View File
@@ -1,33 +1,29 @@
// node native // apiglobal scope
import * as path from 'path'; import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
export { path }; export { typedrequestInterfaces };
// pushrocks scope // pushrocks scope
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smarthash from '@pushrocks/smarthash'; import * as isohash from '@push.rocks/isohash';
import * as smartdelay from '@pushrocks/smartdelay'; import * as isounique from '@push.rocks/isounique';
import * as smartexpress from '@pushrocks/smartexpress'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartfile from '@pushrocks/smartfile'; import * as smartlog from '@push.rocks/smartlog';
import * as smartlog from '@pushrocks/smartlog'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartrx from '@push.rocks/smartrx';
import * as smartrequest from '@pushrocks/smartrequest'; import * as smartsocket from '@push.rocks/smartsocket';
import * as smartrx from '@pushrocks/smartrx'; import * as smarttime from '@push.rocks/smarttime';
import * as smartsocket from '@pushrocks/smartsocket'; import * as smarturl from '@push.rocks/smarturl';
import * as smarttime from '@pushrocks/smarttime';
import * as smartunique from '@pushrocks/smartunique';
export { export {
lik, lik,
smarthash, isohash,
isounique,
smartdelay, smartdelay,
smartexpress,
smartfile,
smartlog, smartlog,
smartpromise, smartpromise,
smartrx, smartrx,
smartrequest,
smartsocket, smartsocket,
smarttime, smarttime,
smartunique 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"]
}
-17
View File
@@ -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"
}