Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 496fd9a81a | |||
| f7720251ff | |||
| b27c340f7d | |||
| 4cef457816 | |||
| 751d7955d1 | |||
| 466a0331f1 | |||
| 38bc55d109 | |||
| b26f4076ab | |||
| 4ccbc004db | |||
| b5fcefa93b | |||
| 67f60187ae | |||
| 176c6ba261 | |||
| af6c634deb | |||
| a5ce7b18e8 | |||
| b6b482f7db |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @gitzone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
137
.gitlab-ci.yml
137
.gitlab-ci.yml
@ -1,137 +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
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
4
.snyk
4
.snyk
@ -1,4 +0,0 @@
|
||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||
version: v1.13.5
|
||||
ignore: {}
|
||||
patch: {}
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -2,17 +2,32 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartuniverse",
|
||||
"shortDescription": "messaging service for micro services",
|
||||
"npmPackagename": "@pushrocks/smartuniverse",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"npmPackagename": "@push.rocks/smartuniverse",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"microservices",
|
||||
"messaging",
|
||||
"reactive programming",
|
||||
"event-driven",
|
||||
"channel-based communication",
|
||||
"client-server architecture",
|
||||
"message encryption",
|
||||
"typescript",
|
||||
"websocket",
|
||||
"scalability"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
11358
package-lock.json
generated
11358
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
73
package.json
73
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@pushrocks/smartuniverse",
|
||||
"version": "1.0.103",
|
||||
"name": "@push.rocks/smartuniverse",
|
||||
"version": "1.0.108",
|
||||
"private": false,
|
||||
"description": "messaging service for your micro services",
|
||||
"description": "A messaging service enabling secure, reactive communication between microservices.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
@ -10,34 +10,31 @@
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"testManual": "(tsrun test/test.ts)",
|
||||
"build": "(tsbuild --web && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
||||
"format": "(gitzone format)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tstest": "^1.0.48",
|
||||
"@pushrocks/tapbundle": "^3.2.9",
|
||||
"@types/node": "^14.11.2",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"rxjs": "*"
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsbundle": "^2.0.8",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.12",
|
||||
"@types/node": "^20.4.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@apiglobal/typedrequest-interfaces": "^1.0.15",
|
||||
"@pushrocks/lik": "^4.0.17",
|
||||
"@pushrocks/smartdelay": "^2.0.10",
|
||||
"@pushrocks/smartexpress": "^3.0.76",
|
||||
"@pushrocks/smartfile": "^8.0.0",
|
||||
"@pushrocks/smarthash": "^2.1.6",
|
||||
"@pushrocks/smartlog": "^2.0.39",
|
||||
"@pushrocks/smartpromise": "^3.0.6",
|
||||
"@pushrocks/smartrequest": "^1.1.51",
|
||||
"@pushrocks/smartrx": "^2.0.19",
|
||||
"@pushrocks/smartsocket": "^1.1.67",
|
||||
"@pushrocks/smarttime": "^3.0.35",
|
||||
"@pushrocks/smartunique": "^3.0.3"
|
||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
||||
"@apiglobal/typedserver": "^2.0.65",
|
||||
"@push.rocks/isohash": "^2.0.1",
|
||||
"@push.rocks/isounique": "^1.0.5",
|
||||
"@push.rocks/lik": "^6.0.3",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.0.3",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"@push.rocks/smartsocket": "^2.0.20",
|
||||
"@push.rocks/smarttime": "^4.0.4",
|
||||
"@push.rocks/smarturl": "^3.0.7"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -53,5 +50,23 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
],
|
||||
"type": "module",
|
||||
"keywords": [
|
||||
"microservices",
|
||||
"messaging",
|
||||
"reactive programming",
|
||||
"event-driven",
|
||||
"channel-based communication",
|
||||
"client-server architecture",
|
||||
"message encryption",
|
||||
"typescript",
|
||||
"websocket",
|
||||
"scalability"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartuniverse",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartuniverse.git"
|
||||
}
|
||||
}
|
||||
4610
pnpm-lock.yaml
generated
Normal file
4610
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
155
readme.md
155
readme.md
@ -1,66 +1,127 @@
|
||||
# @pushrocks/smartuniverse
|
||||
messaging service for micro services
|
||||
# @push.rocks/smartuniverse
|
||||
messaging service for your micro services
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
## Install
|
||||
To install `@push.rocks/smartuniverse`, use the following command with npm:
|
||||
```bash
|
||||
npm install @push.rocks/smartuniverse --save
|
||||
```
|
||||
This command adds `@push.rocks/smartuniverse` to your project's dependencies.
|
||||
|
||||
## Usage
|
||||
`@push.rocks/smartuniverse` is designed to enable messaging services for microservices, allowing them to communicate in a structured and secure manner. Below are examples and scenarios illustrating how to use `@push.rocks/smartuniverse` for both server (managing messages across services) and client (microservices communicating within the universe) aspects.
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
### Server side setup: Creating your Universe
|
||||
|
||||
### What is smartuniverse all about?
|
||||
|
||||
Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
|
||||
|
||||
### Server side
|
||||
|
||||
every universe has a server that manages messages.
|
||||
Think Kafka, but without Kafka.
|
||||
First, you need to set up the server side of your messaging ecosystem, which involves creating a "universe" where channels reside.
|
||||
|
||||
```typescript
|
||||
import * as smartuniverse from '@pushrocks/smartuniverse';
|
||||
import { Universe } from '@push.rocks/smartuniverse';
|
||||
|
||||
const myUniverse = new smartuniverse.Universe({
|
||||
messageExpiryInMilliseconds: 60000, // the standard time in milliseconds until a message expires
|
||||
// Initialize a new Universe
|
||||
const myUniverse = new Universe({
|
||||
messageExpiryInMilliseconds: 60000, // messages expire after 60 seconds
|
||||
});
|
||||
|
||||
// create as many channels as you like
|
||||
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
|
||||
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
|
||||
// Create channels for communication within the universe
|
||||
// These channels can be thought of as topics or queues that services can subscribe to or post messages to
|
||||
myUniverse.addChannel('channel-one', 'password1');
|
||||
myUniverse.addChannel('channel-two', 'password2');
|
||||
|
||||
myUniverse.start(8765); // start the server and provide the port on which to listen on
|
||||
// Start the universe server on a specified port
|
||||
myUniverse.start(8765);
|
||||
```
|
||||
|
||||
### Client side
|
||||
By starting the universe, you've established a messaging hub for your microservices. Ensure that the services know the universe's address and the channels and passwords they should use for communication.
|
||||
|
||||
All your microservices represents clients in the universe that may talk to each other using the universe server.
|
||||
### Client side: Microservices joining the Universe
|
||||
|
||||
## Contribution
|
||||
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.
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
```typescript
|
||||
import { ClientUniverse, ClientUniverseChannel } from '@push.rocks/smartuniverse';
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
// Initialize client that connects to the universe server
|
||||
const clientUniverse = new ClientUniverse({
|
||||
serverAddress: 'http://your-universe-server:8765',
|
||||
autoReconnect: true,
|
||||
});
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
// Define a channel to subscribe to (the channel must be created in the universe server)
|
||||
const channel = clientUniverse.addChannel('channel-one', 'password1');
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
// 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.
|
||||
|
||||
12
test/test.ts
12
test/test.ts
@ -1,8 +1,6 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartuniverse from '../ts/index';
|
||||
|
||||
import { Observable } from 'rxjs';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartuniverse from '../ts/index.js';
|
||||
|
||||
let testUniverse: smartuniverse.Universe;
|
||||
let testClientUniverse: smartuniverse.ClientUniverse;
|
||||
@ -34,7 +32,7 @@ tap.test('create smartuniverse client', async () => {
|
||||
serverAddress: testServerData.serverAddress,
|
||||
autoReconnect: true,
|
||||
});
|
||||
expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
|
||||
expect(testClientUniverse).toBeInstanceOf(smartuniverse.ClientUniverse);
|
||||
});
|
||||
|
||||
tap.test('should add a channel to the universe', async () => {
|
||||
@ -51,7 +49,7 @@ tap.test('should start the ClientUniverse', async () => {
|
||||
|
||||
tap.test('should get a observable correctly', async () => {
|
||||
testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
|
||||
expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
|
||||
expect(testClientChannel).toBeInstanceOf(smartuniverse.ClientUniverseChannel);
|
||||
});
|
||||
|
||||
tap.test('should send a message correctly', async () => {
|
||||
@ -61,7 +59,7 @@ tap.test('should send a message correctly', async () => {
|
||||
});
|
||||
|
||||
tap.test('universe should contain the sent message', async () => {
|
||||
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
|
||||
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).toEqual('hello');
|
||||
});
|
||||
|
||||
tap.test('a second client should be able to subscibe', async () => {
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartuniverse',
|
||||
version: '1.0.108',
|
||||
description: 'messaging service for your micro services'
|
||||
}
|
||||
20
ts/index.ts
20
ts/index.ts
@ -1,16 +1,16 @@
|
||||
// Client classes
|
||||
export * from './smartuniverse.classes.client.universe';
|
||||
export * from './smartuniverse.classes.client.universechannel';
|
||||
export * from './smartuniverse.classes.client.universemessage';
|
||||
export * from './smartuniverse.classes.client.universe.js';
|
||||
export * from './smartuniverse.classes.client.universechannel.js';
|
||||
export * from './smartuniverse.classes.client.universemessage.js';
|
||||
|
||||
// Server classes
|
||||
export * from './smartuniverse.classes.universe';
|
||||
export * from './smartuniverse.classes.universecache';
|
||||
export * from './smartuniverse.classes.universechannel';
|
||||
export * from './smartuniverse.classes.universemessage';
|
||||
export * from './smartuniverse.classes.universe.js';
|
||||
export * from './smartuniverse.classes.universecache.js';
|
||||
export * from './smartuniverse.classes.universechannel.js';
|
||||
export * from './smartuniverse.classes.universemessage.js';
|
||||
|
||||
// Reaction Response
|
||||
export * from './smartuniverse.classes.event.reactionrequest';
|
||||
export * from './smartuniverse.classes.event.reactionresponse';
|
||||
export * from './smartuniverse.classes.event.reactionrequest.js';
|
||||
export * from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export * from './interfaces';
|
||||
export * from './interfaces/index.js';
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
export * from './http.interfaces';
|
||||
export * from './socketfunctionrequests';
|
||||
export * from './universechannel.interfaces';
|
||||
export * from './universemessage.interfaces';
|
||||
export * from './universeactions.interfaces';
|
||||
export * from './http.interfaces.js';
|
||||
export * from './socketfunctionrequests.js';
|
||||
export * from './universechannel.interfaces.js';
|
||||
export * from './universemessage.interfaces.js';
|
||||
export * from './universeactions.interfaces.js';
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as interfaces from './index';
|
||||
import * as interfaces from './index.js';
|
||||
|
||||
export interface ISocketRequest_SubscribeChannel {
|
||||
method: 'subscribeChannel';
|
||||
|
||||
@ -1,14 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { Smartsocket, SmartsocketClient } from '@push.rocks/smartsocket';
|
||||
|
||||
import { Observable } from 'rxjs';
|
||||
import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
|
||||
import * as url from 'url';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
|
||||
import { ClientUniverseChannel, ClientUniverseMessage } from '.';
|
||||
import { ClientUniverseCache } from './smartuniverse.classes.client.universecache';
|
||||
import { logger } from './smartuniverse.logging';
|
||||
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;
|
||||
@ -57,7 +54,7 @@ export class ClientUniverse {
|
||||
* @param passphraseArg
|
||||
*/
|
||||
public getChannel(channelName: string): ClientUniverseChannel {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.find((channel) => {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.findSync((channel) => {
|
||||
return channel.name === channelName;
|
||||
});
|
||||
return clientUniverseChannel;
|
||||
@ -68,7 +65,7 @@ export class ClientUniverse {
|
||||
* @param messageArg
|
||||
*/
|
||||
public removeChannel(channelNameArg, notifyServer = true) {
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
|
||||
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemoveSync(
|
||||
(channelItemArg) => {
|
||||
return channelItemArg.name === channelNameArg;
|
||||
}
|
||||
@ -93,12 +90,10 @@ export class ClientUniverse {
|
||||
*/
|
||||
private async checkConnection(): Promise<void> {
|
||||
if (!this.smartsocketClient) {
|
||||
const parsedURL = url.parse(this.options.serverAddress);
|
||||
const parsedURL = plugins.smarturl.Smarturl.createFromUrl(this.options.serverAddress);
|
||||
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
|
||||
alias: 'universeclient',
|
||||
password: 'UniverseClient',
|
||||
port: parseInt(parsedURL.port, 10),
|
||||
role: 'UniverseClient',
|
||||
url: parsedURL.protocol + '//' + parsedURL.hostname,
|
||||
};
|
||||
this.smartsocketClient = new SmartsocketClient(socketConfig);
|
||||
@ -117,9 +112,8 @@ export class ClientUniverse {
|
||||
*/
|
||||
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
|
||||
funcName: 'unsubscribe',
|
||||
allowedRoles: [],
|
||||
funcDef: async (dataArg: interfaces.IServerUnsubscribeActionPayload) => {
|
||||
const channel = this.clientUniverseCache.channelMap.find((channelArg) => {
|
||||
const channel = this.clientUniverseCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === dataArg.name;
|
||||
});
|
||||
if (channel) {
|
||||
@ -132,32 +126,29 @@ export class ClientUniverse {
|
||||
/**
|
||||
* handles message reception
|
||||
*/
|
||||
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<
|
||||
interfaces.ISocketRequest_ProcessMessage
|
||||
>({
|
||||
funcName: 'processMessage',
|
||||
allowedRoles: [],
|
||||
funcDef: async (messageDescriptorArg) => {
|
||||
logger.log('info', 'Got message from server');
|
||||
const clientUniverseMessage = ClientUniverseMessage.createMessageFromMessageDescriptor(
|
||||
messageDescriptorArg
|
||||
);
|
||||
this.messageRxjsSubject.next(clientUniverseMessage);
|
||||
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',
|
||||
};
|
||||
}
|
||||
},
|
||||
});
|
||||
// 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);
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel.js';
|
||||
|
||||
/**
|
||||
* a cache for clients
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
import { ClientUniverse } from '.';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
|
||||
import { ReactionRequest } from './smartuniverse.classes.event.reactionrequest';
|
||||
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse';
|
||||
import { ClientUniverse } from './index.js';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage.js';
|
||||
import { ReactionRequest } from './smartuniverse.classes.event.reactionrequest.js';
|
||||
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
// ======
|
||||
@ -69,12 +69,14 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
public async populateSubscriptionToServer() {
|
||||
// lets make sure the channel is connected
|
||||
if (this.status === 'unsubscribed') {
|
||||
const response = await this.clientUniverseRef.smartsocketClient.serverCall<
|
||||
interfaces.ISocketRequest_SubscribeChannel
|
||||
>('subscribeChannel', {
|
||||
name: this.name,
|
||||
passphrase: this.passphrase,
|
||||
});
|
||||
const response =
|
||||
await this.clientUniverseRef.smartsocketClient.serverCall<interfaces.ISocketRequest_SubscribeChannel>(
|
||||
'subscribeChannel',
|
||||
{
|
||||
name: this.name,
|
||||
passphrase: this.passphrase,
|
||||
}
|
||||
);
|
||||
this.status = response.subscriptionStatus;
|
||||
}
|
||||
}
|
||||
@ -90,7 +92,7 @@ export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||
public async postMessage(messageArg: interfaces.IMessageCreator) {
|
||||
await this.clientUniverseRef.start(); // its ok to call this multiple times
|
||||
const universeMessageToSend: interfaces.IUniverseMessage = {
|
||||
id: plugins.smartunique.shortId(),
|
||||
id: plugins.isounique.uni(),
|
||||
timestamp: Date.now(),
|
||||
passphrase: this.passphrase,
|
||||
targetChannelName: this.name,
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
export class ClientUniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
// ======
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
/**
|
||||
* broadcasts an event to multiple channels
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
|
||||
import { ReactionResult } from './smartuniverse.classes.event.reactionresult';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
|
||||
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
|
||||
@ -37,7 +37,7 @@ export class ReactionRequest<T extends plugins.typedrequestInterfaces.ITypedRequ
|
||||
) {
|
||||
const subscriptionMap = new plugins.lik.ObjectMap<plugins.smartrx.rxjs.Subscription>();
|
||||
const reactionResult = new ReactionResult<T>();
|
||||
const requestId = plugins.smartunique.shortId();
|
||||
const requestId = plugins.isounique.uni();
|
||||
for (const channel of channelsArg) {
|
||||
subscriptionMap.add(
|
||||
channel.subscribe(
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import { ICombinatorPayload } from './smartuniverse.classes.event.reactionrequest';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { ClientUniverseChannel } from './smartuniverse.classes.client.universechannel';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { ClientUniverseMessage } from './smartuniverse.classes.client.universemessage';
|
||||
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']
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import { ReactionResponse } from './smartuniverse.classes.event.reactionresponse.js';
|
||||
|
||||
export class ReactionResult<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||
private resultReplaySubject = new plugins.smartrx.rxjs.ReplaySubject<T['response']>();
|
||||
|
||||
@ -1,18 +1,15 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as pluginsTyped from './smartuniverse.pluginstyped';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as pluginsTyped from './smartuniverse.pluginstyped.js';
|
||||
|
||||
import { Handler, Route, Server } from '@pushrocks/smartexpress';
|
||||
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
|
||||
import { UniverseCache, UniverseChannel, UniverseMessage } from './index.js';
|
||||
|
||||
import * as paths from './smartuniverse.paths';
|
||||
|
||||
import * as interfaces from './interfaces';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||
import { logger } from './smartuniverse.logging';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
export interface ISmartUniverseConstructorOptions {
|
||||
messageExpiryInMilliseconds: number;
|
||||
externalServer?: pluginsTyped.smartexpress.Server;
|
||||
externalServer?: pluginsTyped.typedserver.servertools.Server;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -28,7 +25,7 @@ export class Universe {
|
||||
/**
|
||||
* the smartexpress server used
|
||||
*/
|
||||
private smartexpressServer: pluginsTyped.smartexpress.Server;
|
||||
private server: pluginsTyped.typedserver.servertools.Server;
|
||||
|
||||
/**
|
||||
* the smartsocket used
|
||||
@ -49,7 +46,7 @@ export class Universe {
|
||||
/**
|
||||
* get the currently running version of smartuniverse
|
||||
*/
|
||||
public getUniverseVersion() {
|
||||
/* public getUniverseVersion() {
|
||||
if (this.universeVersionStore) {
|
||||
return this.universeVersionStore;
|
||||
} else {
|
||||
@ -57,7 +54,7 @@ export class Universe {
|
||||
this.universeVersionStore = packageJson.version;
|
||||
return this.universeVersionStore;
|
||||
}
|
||||
}
|
||||
} */
|
||||
|
||||
/**
|
||||
* adds a channel to the Universe
|
||||
@ -71,7 +68,7 @@ export class Universe {
|
||||
* returns a channel
|
||||
*/
|
||||
public getChannel(channelNameArg: string) {
|
||||
return this.universeCache.channelMap.find((channelArg) => {
|
||||
return this.universeCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === channelNameArg;
|
||||
});
|
||||
}
|
||||
@ -79,49 +76,46 @@ export class Universe {
|
||||
/**
|
||||
* initiates a server
|
||||
*/
|
||||
public async start(portArg: number) {
|
||||
public async start(portArg?: number) {
|
||||
if (!this.options.externalServer && !portArg) {
|
||||
throw new Error(`You supplied an external error. You need to specify a portArg to start on.`);
|
||||
}
|
||||
|
||||
portArg = portArg || 3000; // TODO: remove
|
||||
|
||||
// add websocket upgrade
|
||||
this.smartsocket = new plugins.smartsocket.Smartsocket({
|
||||
port: portArg
|
||||
alias: 'smartuniverse',
|
||||
port: portArg,
|
||||
});
|
||||
|
||||
// lets create the base smartexpress server
|
||||
if (this.options.externalServer) {
|
||||
console.log('Universe is using externally supplied server');
|
||||
this.smartsocket.setExternalServer('smartexpress' ,this.options.externalServer);
|
||||
this.smartsocket.setExternalServer('smartexpress', this.options.externalServer);
|
||||
}
|
||||
|
||||
// add a role for the clients
|
||||
const ClientRole = new plugins.smartsocket.SocketRole({
|
||||
name: 'UniverseClient',
|
||||
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient'), // authentication happens on another level
|
||||
});
|
||||
|
||||
// add the role to smartsocket
|
||||
this.smartsocket.addSocketRoles([ClientRole]);
|
||||
const socketFunctionSubscription =
|
||||
new plugins.smartsocket.SocketFunction<interfaces.ISocketRequest_SubscribeChannel>({
|
||||
funcName: 'subscribeChannel',
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
const universeConnection = new UniverseConnection({
|
||||
universe: this,
|
||||
socketConnection: socketConnectionArg,
|
||||
authenticationRequests: [dataArg],
|
||||
});
|
||||
await UniverseConnection.addConnectionToCache(this, universeConnection);
|
||||
return {
|
||||
subscriptionStatus: 'subscribed',
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
const socketFunctionSubscription = new plugins.smartsocket.SocketFunction<
|
||||
interfaces.ISocketRequest_SubscribeChannel
|
||||
>({
|
||||
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||
funcName: 'subscribeChannel',
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
const universeConnection = new UniverseConnection({
|
||||
universe: this,
|
||||
socketConnection: socketConnectionArg,
|
||||
authenticationRequests: [dataArg],
|
||||
});
|
||||
await UniverseConnection.addConnectionToCache(this, universeConnection);
|
||||
return {
|
||||
subscriptionStatus: 'subscribed',
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
|
||||
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction<any>({
|
||||
// TODO proper ITypedRequest here instead of any
|
||||
funcName: 'processMessage',
|
||||
funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||
funcDef: async (messageDataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
|
||||
this.universeCache,
|
||||
socketConnectionArg
|
||||
@ -136,7 +130,7 @@ export class Universe {
|
||||
}
|
||||
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
|
||||
socketConnectionArg,
|
||||
dataArg
|
||||
messageDataArg
|
||||
);
|
||||
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
|
||||
this.universeCache,
|
||||
|
||||
@ -1,14 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
|
||||
|
||||
import { ObjectMap } from '@pushrocks/lik';
|
||||
|
||||
import { Observable, from } from 'rxjs';
|
||||
import { filter } from 'rxjs/operators';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||
import { Universe } from './smartuniverse.classes.universe';
|
||||
import { ObjectMap } from '@push.rocks/lik';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
|
||||
/**
|
||||
* universe store handles the creation, storage and retrieval of messages.
|
||||
@ -68,9 +65,9 @@ export class UniverseCache {
|
||||
public readMessagesYoungerThan(
|
||||
unixTimeArg?: number,
|
||||
channelName?: string
|
||||
): Observable<UniverseMessage<any>> {
|
||||
const messageObservable = from(this.messageMap.getArray()).pipe(
|
||||
filter((messageArg) => {
|
||||
): plugins.smartrx.rxjs.Observable<UniverseMessage<any>> {
|
||||
const messageObservable = plugins.smartrx.rxjs.from(this.messageMap.getArray()).pipe(
|
||||
plugins.smartrx.rxjs.ops.filter((messageArg) => {
|
||||
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
|
||||
})
|
||||
);
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||
import { Universe } from './smartuniverse.classes.universe';
|
||||
import { logger } from './smartuniverse.logging';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { UniverseMessage } from './smartuniverse.classes.universemessage.js';
|
||||
import { UniverseConnection } from './smartuniverse.classes.universeconnection.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
/**
|
||||
* enables messages to stay within a certain scope.
|
||||
@ -34,7 +34,7 @@ export class UniverseChannel {
|
||||
* returns boolean wether certain channel exists
|
||||
*/
|
||||
public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
|
||||
const channel = universeCacheArg.channelMap.find((channelArg) => {
|
||||
const channel = universeCacheArg.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === channelNameArg;
|
||||
});
|
||||
if (channel) {
|
||||
@ -55,7 +55,7 @@ export class UniverseChannel {
|
||||
universeCacheArg: UniverseCache,
|
||||
universeMessageArg: UniverseMessage<any>
|
||||
): UniverseChannel {
|
||||
const foundChannel = universeCacheArg.channelMap.find((universeChannel) => {
|
||||
const foundChannel = universeCacheArg.channelMap.findSync((universeChannel) => {
|
||||
const result = universeChannel.authenticate(universeMessageArg);
|
||||
return result;
|
||||
});
|
||||
@ -73,7 +73,7 @@ export class UniverseChannel {
|
||||
}
|
||||
|
||||
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
|
||||
return universeRef.universeCache.channelMap.find((channelArg) => {
|
||||
return universeRef.universeCache.channelMap.findSync((channelArg) => {
|
||||
return channelArg.name === universeChannelName;
|
||||
});
|
||||
}
|
||||
@ -157,7 +157,7 @@ export class UniverseChannel {
|
||||
*/
|
||||
public async postMessage(messageDescriptor: interfaces.IMessageCreator) {
|
||||
const messageToSend = new UniverseMessage({
|
||||
id: plugins.smartunique.shortId(),
|
||||
id: plugins.isounique.uni(),
|
||||
messageText: messageDescriptor.messageText,
|
||||
payload: messageDescriptor.payload,
|
||||
targetChannelName: this.name,
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||
import { Universe } from './smartuniverse.classes.universe';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
|
||||
/**
|
||||
* represents a connection to the universe
|
||||
@ -87,7 +87,7 @@ export class UniverseConnection {
|
||||
universeCache: UniverseCache,
|
||||
socketConnectionArg: plugins.smartsocket.SocketConnection
|
||||
): UniverseConnection {
|
||||
const universeConnection = universeCache.connectionMap.find((universeConnectionArg) => {
|
||||
const universeConnection = universeCache.connectionMap.findSync((universeConnectionArg) => {
|
||||
return universeConnectionArg.socketConnection === socketConnectionArg;
|
||||
});
|
||||
return universeConnection;
|
||||
|
||||
@ -1,12 +1,10 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as interfaces from './interfaces';
|
||||
|
||||
import { Timer, TimeStamp } from '@pushrocks/smarttime';
|
||||
import { Universe } from './smartuniverse.classes.universe';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||
import { SocketConnection } from '@pushrocks/smartsocket';
|
||||
import { logger } from './smartuniverse.logging';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
import * as interfaces from './interfaces/index.js';
|
||||
import { Universe } from './smartuniverse.classes.universe.js';
|
||||
import { UniverseChannel } from './smartuniverse.classes.universechannel.js';
|
||||
import { UniverseCache } from './smartuniverse.classes.universecache.js';
|
||||
import { SocketConnection } from '@push.rocks/smartsocket';
|
||||
import { logger } from './smartuniverse.logging.js';
|
||||
|
||||
/**
|
||||
* represents a message within a universe
|
||||
@ -24,7 +22,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
|
||||
public id: string;
|
||||
public timestamp: number;
|
||||
public smartTimestamp: TimeStamp;
|
||||
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||
public messageText: string;
|
||||
public passphrase: string;
|
||||
public payload: T;
|
||||
@ -49,7 +47,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
/**
|
||||
* a destruction timer for this message
|
||||
*/
|
||||
public destructionTimer: Timer; // a timer to take care of message destruction
|
||||
public destructionTimer: plugins.smarttime.Timer; // a timer to take care of message destruction
|
||||
|
||||
/**
|
||||
* the constructor to create a universe message
|
||||
@ -57,7 +55,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
* @param attachedPayloadArg
|
||||
*/
|
||||
constructor(messageDescriptor: interfaces.IUniverseMessage) {
|
||||
this.smartTimestamp = new TimeStamp(this.timestamp);
|
||||
this.smartTimestamp = new plugins.smarttime.TimeStamp(this.timestamp);
|
||||
this.messageText = messageDescriptor.messageText;
|
||||
this.targetChannelName = messageDescriptor.targetChannelName;
|
||||
this.passphrase = messageDescriptor.passphrase;
|
||||
@ -74,7 +72,7 @@ export class UniverseMessage<T> implements interfaces.IUniverseMessage {
|
||||
|
||||
public setDestructionTimer(selfdestructAfterArg?: number) {
|
||||
if (selfdestructAfterArg) {
|
||||
this.destructionTimer = new Timer(selfdestructAfterArg);
|
||||
this.destructionTimer = new plugins.smarttime.Timer(selfdestructAfterArg);
|
||||
this.destructionTimer.start();
|
||||
// set up self destruction by removing this from the parent messageCache
|
||||
this.destructionTimer.completed
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
import * as plugins from './smartuniverse.plugins.js';
|
||||
export const logger = new plugins.smartlog.ConsoleLog();
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
import * as plugins from './smartuniverse.plugins';
|
||||
|
||||
export const packageJson = plugins.path.join(__dirname, '../package.json');
|
||||
@ -1,36 +1,29 @@
|
||||
// node native
|
||||
import * as path from 'path';
|
||||
|
||||
export { path };
|
||||
|
||||
// apiglobal scope
|
||||
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||
|
||||
export { typedrequestInterfaces };
|
||||
|
||||
// pushrocks scope
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smarthash from '@pushrocks/smarthash';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartlog from '@pushrocks/smartlog';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartrequest from '@pushrocks/smartrequest';
|
||||
import * as smartrx from '@pushrocks/smartrx';
|
||||
import * as smartsocket from '@pushrocks/smartsocket';
|
||||
import * as smarttime from '@pushrocks/smarttime';
|
||||
import * as smartunique from '@pushrocks/smartunique';
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as isohash from '@push.rocks/isohash';
|
||||
import * as isounique from '@push.rocks/isounique';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartrx from '@push.rocks/smartrx';
|
||||
import * as smartsocket from '@push.rocks/smartsocket';
|
||||
import * as smarttime from '@push.rocks/smarttime';
|
||||
import * as smarturl from '@push.rocks/smarturl';
|
||||
|
||||
export {
|
||||
lik,
|
||||
smarthash,
|
||||
isohash,
|
||||
isounique,
|
||||
smartdelay,
|
||||
smartfile,
|
||||
smartlog,
|
||||
smartpromise,
|
||||
smartrx,
|
||||
smartrequest,
|
||||
smartsocket,
|
||||
smarttime,
|
||||
smartunique,
|
||||
smarturl,
|
||||
};
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import type * as smartexpress from '@pushrocks/smartexpress';
|
||||
import type * as typedserver from '@apiglobal/typedserver';
|
||||
|
||||
export {
|
||||
smartexpress
|
||||
};
|
||||
export type {
|
||||
typedserver
|
||||
};
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user