Compare commits
172 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5b21955e04 | |||
| 09dbb00179 | |||
| 1d62c9c695 | |||
| ee59471e14 | |||
| da10b25214 | |||
| 933f09d632 | |||
| eb330eaf7a | |||
| c2e856821d | |||
| 653af3a3e7 | |||
| 4552a0527d | |||
| e39141e86b | |||
| bf6bda88e5 | |||
| fb555b33be | |||
| 2e2826c52d | |||
| bca3bd92a5 | |||
| adc3f0935f | |||
| 72430fdb0d | |||
| ee827dd5b3 | |||
| 2aefae00de | |||
| 6753a4fefc | |||
| 8c5428baf8 | |||
| 69c1ad04dc | |||
| 61d5301de8 | |||
| 72fa7f790c | |||
| dcc087c04d | |||
| c8556355c0 | |||
| 9cfc41ace8 | |||
| 2827a1676b | |||
| 424ad80b60 | |||
| 682a0c53ce | |||
| 4fc09af779 | |||
| f73d973383 | |||
| d87a942ab3 | |||
| 60e8657467 | |||
| 5215be946e | |||
| b9c67666fa | |||
| 4b0fb073e6 | |||
| fc458b6827 | |||
| f27b9f8143 | |||
| 38058aba57 | |||
| ba38dae64f | |||
| 69e862a6cf | |||
| 4562ac355b | |||
| b029dc191e | |||
| 2640275d04 | |||
| 7bbcc91300 | |||
| da39d52975 | |||
| 307469312f | |||
| 0f3ff2b611 | |||
| bce82d49b6 | |||
| 0b10913995 | |||
| 7048585702 | |||
| 92697bad82 | |||
| e1475a3342 | |||
| e3c58e7fc0 | |||
| 32d60fff0d | |||
| f33b64d625 | |||
| 6ee70ecafa | |||
| 6f3700adc0 | |||
| 3648f12358 | |||
| c239eaa9d5 | |||
| 75bd7a9175 | |||
| be9b47e73b | |||
| 966d953aff | |||
| 7f73664970 | |||
| 71452a293f | |||
| c5e60d804a | |||
| c5d52013e6 | |||
| 64195e4c78 | |||
| 01b5b3dc1a | |||
| b34d7faec2 | |||
| 7c98e19988 | |||
| 608669ec44 | |||
| a7b14cd383 | |||
| 21dc933302 | |||
| 4e7455fa26 | |||
| c424d589ea | |||
| 9435796333 | |||
| 12d7310b90 | |||
| 9fc4db1e35 | |||
| 895464115e | |||
| 00f22f9651 | |||
| 278b35c9c5 | |||
| da78da27e5 | |||
| a8aeeaaa6c | |||
| f9f6975b87 | |||
| b9a6f1d5b0 | |||
| 489ad9284b | |||
| 6fdf0d9955 | |||
| 499a1893f9 | |||
| 2754447aae | |||
| 544277cb8a | |||
| 9a23960d21 | |||
| 23cca6cce3 | |||
| 2a9e58cc35 | |||
| 7d6a9921b5 | |||
| 3ee46a31f7 | |||
| d72310ce10 | |||
| 1e14166ddb | |||
| be38e91548 | |||
| 6c2057b119 | |||
| 08d7224016 | |||
| bfa3330eb6 | |||
| 644fa2a49d | |||
| c0dad3a977 | |||
| a921033cc4 | |||
| 21e4712b04 | |||
| df43bc2974 | |||
| 564988185d | |||
| 8442f3570f | |||
| 196357c878 | |||
| bc187b7e41 | |||
| 0e54bf889f | |||
| 4c211bc82e | |||
| a1be281670 | |||
| 1a44d2027c | |||
| 4bf5456a1d | |||
| 57c748657a | |||
| 15df24bf68 | |||
| ca7470eedf | |||
| 38f017934c | |||
| 1980824540 | |||
| 09dec2071e | |||
| a1443deafe | |||
| 9eac5ad336 | |||
| cf607a79d5 | |||
| 8426c976bf | |||
| 1086065000 | |||
| 72196ec383 | |||
| c6ad490a6f | |||
| a40a83f0bf | |||
| 82fa029d05 | |||
| 0d76e7f577 | |||
| 57e6f058be | |||
| b0bf9d7c95 | |||
| 1fbc76ef30 | |||
| 424d9cca91 | |||
| d712270946 | |||
| f98c797ad8 | |||
| a23e7349be | |||
| c390881a4e | |||
| 5e64f4ca25 | |||
| 765bc73197 | |||
| 105acaf97b | |||
| 5139136af4 | |||
| bcc4ce9a87 | |||
| 20e7584eb9 | |||
| 59cbc343cc | |||
| 75aa1f6f0d | |||
| 3f073ab9b3 | |||
| 08c1618ea8 | |||
| eb181fa2f6 | |||
| c901ab75d3 | |||
| 075c59ed2c | |||
| 8d358dd93d | |||
| e576d6058a | |||
| 6546da2394 | |||
| 29597daba1 | |||
| c8b647d2fd | |||
| 1fa4aca049 | |||
| 2d4695de22 | |||
| a3f4dcbc2a | |||
| d6e81288b4 | |||
| c441d89596 | |||
| 85b69e487a | |||
| 0d94ed9345 | |||
| e188b18016 | |||
| 33c0fa3746 | |||
| 52be1415ee | |||
| e75d5eabdb | |||
| fb99848df1 | |||
| 1bd39d0755 |
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 @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
||||||
119
.gitlab-ci.yml
119
.gitlab-ci.yml
@@ -1,119 +0,0 @@
|
|||||||
# gitzone ci_default
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
|
|
||||||
cache:
|
|
||||||
paths:
|
|
||||||
- .npmci_cache/
|
|
||||||
key: "$CI_BUILD_STAGE"
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- security
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
- metadata
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
mirror:
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci git mirror
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
snyk:
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install -g snyk
|
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command snyk test
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# test stage
|
|
||||||
# ====================
|
|
||||||
|
|
||||||
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
|
|
||||||
13
.snyk
13
.snyk
@@ -1,13 +0,0 @@
|
|||||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
|
||||||
version: v1.13.5
|
|
||||||
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
|
|
||||||
ignore:
|
|
||||||
SNYK-JS-JSYAML-173999:
|
|
||||||
- '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
|
|
||||||
reason: None given
|
|
||||||
expires: '2019-05-24T15:16:11.291Z'
|
|
||||||
SNYK-JS-JSYAML-174129:
|
|
||||||
- '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
|
|
||||||
reason: None given
|
|
||||||
expires: '2019-05-24T15:16:11.291Z'
|
|
||||||
patch: {}
|
|
||||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@@ -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
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
111
README.md
111
README.md
@@ -1,111 +0,0 @@
|
|||||||
# @pushrocks/smartsocket
|
|
||||||
easy and secure websocket communication
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsocket)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsocket)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartsocket)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartsocket)
|
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartsocket)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://prettier.io/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
Under the hood we use socket.io and shortid for managed data exchange.
|
|
||||||
|
|
||||||
### Serverside
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as smartsocket from 'smartsocket';
|
|
||||||
import * as q from q; // q is a promise library
|
|
||||||
|
|
||||||
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
|
|
||||||
let mySmartsocket = new smartsocket.Smartsocket({
|
|
||||||
port: 3000 // the port smartsocket will listen on
|
|
||||||
});
|
|
||||||
|
|
||||||
// optional:
|
|
||||||
// run this with anothoer existing server like express
|
|
||||||
declare var someExpressServer; // read the express docs about how express actually works
|
|
||||||
mySmartsocket.setServer(someExpressServer);
|
|
||||||
|
|
||||||
// A "SocketRole" can be referenced by "SocketFunction"s.
|
|
||||||
// All "SocketRequest"s carry authentication data for a specific "SocketRole".
|
|
||||||
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
|
|
||||||
let mySocketRole = new smartsocket.SocketRole({
|
|
||||||
name: 'someRoleName',
|
|
||||||
passwordHash: 'someHashedString'
|
|
||||||
});
|
|
||||||
|
|
||||||
// A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
|
|
||||||
// The referenced function must return a promise and resolve with data of type any.
|
|
||||||
// Any "SocketRequest" carries a unique identifier. If the referenced function's promise resolved any passed on argument will be returned to the requesting party
|
|
||||||
let testSocketFunction1 = new smartsocket.SocketFunction({
|
|
||||||
funcName: 'testSocketFunction1',
|
|
||||||
funcDef: data => {
|
|
||||||
console.log('testSocketFunction1 executed successfully!');
|
|
||||||
},
|
|
||||||
allowedRoles: [mySocketRole] // all roles that have access to a specific function
|
|
||||||
});
|
|
||||||
|
|
||||||
// A "Smartsocket" exposes a .clientCall() that gets
|
|
||||||
// 1. the name of the "SocketFunction" on the client side
|
|
||||||
// 2. the data to pass in
|
|
||||||
// 3. And a target "SocketConnection" (there can be multiple connections at once)
|
|
||||||
// any unique id association is done internally
|
|
||||||
mySmartsocket.clientCall('restart', data, someTargetConnection).then(responseData => {});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Client side
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as smartsocket from 'smartsocket';
|
|
||||||
|
|
||||||
// A "SmartsocketClient" is different from a "Smartsocket" in that it doesn't expose any public address.
|
|
||||||
// Thus any new "SocketConnection"s must be innitiated from a "SmartsocketClient".
|
|
||||||
let testSmartsocketClient = new smartsocket.SmartsocketClient({
|
|
||||||
port: testConfig.port,
|
|
||||||
url: 'http://localhost',
|
|
||||||
password: 'testPassword',
|
|
||||||
alias: 'testClient1',
|
|
||||||
role: 'testRole1'
|
|
||||||
});
|
|
||||||
|
|
||||||
// You can .connect() and .disconnect() from a "Smartsocket"
|
|
||||||
testSmartsocketClient.connect().then(() => {
|
|
||||||
done();
|
|
||||||
});
|
|
||||||
|
|
||||||
// The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once
|
|
||||||
let testSocketFunction2 = new smartsocket.SocketFunction({
|
|
||||||
funcName: 'testSocketFunction2',
|
|
||||||
funcDef: data => {}, // the function to execute, has to return promise
|
|
||||||
allowedRoles: []
|
|
||||||
});
|
|
||||||
|
|
||||||
// A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
|
|
||||||
mySmartsocketClient.serverCall('function', functionCallData).then(functionResponseData => {
|
|
||||||
// the functionResponseData comes from the server... awesome, right?
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
> **NOTE:**
|
|
||||||
> you can easily chain dependent requests on either the server or client side with promises.
|
|
||||||
> `data` is always a js object that you can design for your specific needs.
|
|
||||||
> It supports buffers for large binary data network exchange.
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
||||||
112
changelog.md
Normal file
112
changelog.md
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-12-03 - 3.0.0 - BREAKING CHANGE(smartsocket)
|
||||||
|
Replace setExternalServer with hooks-based SmartServe integration and refactor SocketServer to support standalone and hooks modes
|
||||||
|
|
||||||
|
- Remove setExternalServer API and add getSmartserveWebSocketHooks on Smartsocket to provide SmartServe-compatible websocket hooks.
|
||||||
|
- SocketServer.start now becomes a no-op when no port is provided (hooks mode). When a port is set, it starts a standalone HTTP + ws server as before.
|
||||||
|
- Introduce an adapter (createWsLikeFromPeer) to adapt SmartServe peers to a WebSocket-like interface and route onMessage/onClose/onError via the adapter.
|
||||||
|
- Dispatch smartserve messages through the adapter: text/binary handling for onMessage, and dispatchClose/dispatchError for close/error events.
|
||||||
|
- Update tests: add smartserve integration test (test.smartserve.ts), adjust tagging test cleanup to stop client and delay before exit, remove outdated expressserver test.
|
||||||
|
|
||||||
|
## 2025-03-10 - 2.1.0 - feat(SmartsocketClient)
|
||||||
|
Improve client reconnection logic with exponential backoff and jitter; update socket.io and @types/node dependencies
|
||||||
|
|
||||||
|
- Bump engine.io from 6.5.4 to 6.6.4, socket.io and socket.io-client from 4.7.5 to 4.8.1
|
||||||
|
- Bump @types/node from ^20.12.7 to ^22.13.10
|
||||||
|
- Add new optional reconnection parameters (maxRetries, initialBackoffDelay, maxBackoffDelay) to SmartsocketClient options
|
||||||
|
- Implement exponential backoff with jitter for auto-reconnect and reset reconnection state on successful connection
|
||||||
|
|
||||||
|
## 2024-05-29 - 2.0.27 - docs
|
||||||
|
update description
|
||||||
|
|
||||||
|
## 2024-04-26 to 2024-03-30 - 2.0.26 … 2.0.24 - core & configuration
|
||||||
|
A series of internal fixes and configuration tweaks.
|
||||||
|
- fix(core): update
|
||||||
|
- update tsconfig
|
||||||
|
- update npmextra.json: githost
|
||||||
|
|
||||||
|
## 2023-09-10 to 2023-07-21 - 2.0.23 … 2.0.20 - core
|
||||||
|
Multiple minor core fixes were applied in rapid succession.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2023-07-21 to 2023-03-20 - 2.0.19 … 2.0.15 - core
|
||||||
|
Routine internal updates addressing core functionality.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2023-02-07 to 2022-03-24 - 2.0.14 … 2.0.0 - core
|
||||||
|
Further minor core updates were rolled out over several versions.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2022-03-14 - 1.2.22 - esm
|
||||||
|
A breaking change was introduced to switch the module system.
|
||||||
|
- BREAKING CHANGE(switch to esm): update
|
||||||
|
|
||||||
|
## 2022-01-20 to 2021-01-23 - 1.2.21 … 1.2.0 - core
|
||||||
|
A range of minor core fixes.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2020-12-26 - 1.1.71 - SmartsocketClient
|
||||||
|
New functionality in the socket client was added.
|
||||||
|
- feat(SmartsocketClient): socket client can now be stopped with .stop() in addition to .reconnect()
|
||||||
|
|
||||||
|
## 2020-12-26 to 2020-09-24 - 1.1.70 … 1.1.58 - core & test
|
||||||
|
A group of updates addressing both core mechanics and tests.
|
||||||
|
- fix(core): update
|
||||||
|
- fix(test): use @pushrocks/isohash instead of @pushrocks/smarthash
|
||||||
|
|
||||||
|
## 2019-11-08 to 2019-04-23 - 1.1.57 … 1.1.27 - core
|
||||||
|
Numerous versions in this period included only internal core fixes.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2019-01-31 to 2019-01-30 - 1.1.26 … 1.1.19 - build, docs & configuration
|
||||||
|
Updates went beyond the core, affecting build tooling and package metadata.
|
||||||
|
- fix(build): now building with tsbuild
|
||||||
|
- fix(readme): update
|
||||||
|
- fix(npmextra): adjust access level
|
||||||
|
- fix(scope): switch to @pushrocks
|
||||||
|
- fix(package.json): private setting
|
||||||
|
- fix(snyk): add .snyk file
|
||||||
|
- fix(structure): update to latest standards
|
||||||
|
|
||||||
|
## 2018-03-19 to 2018-03-15 - 1.1.18 … 1.1.12 - core & docs
|
||||||
|
Several improvements touching both functionality and documentation.
|
||||||
|
- now working as expected
|
||||||
|
- start transitioning to better SocketFunction handling
|
||||||
|
- add @types/node
|
||||||
|
- format and update README
|
||||||
|
- update to latest standards
|
||||||
|
|
||||||
|
## 2017-10-09 to 2017-07-07 - 1.1.11 … 1.1.07 - core & docs
|
||||||
|
Updates in this range improved both the internal mechanics and the developer‐facing materials.
|
||||||
|
- allow setting of specific server
|
||||||
|
- fix not ending error correctly
|
||||||
|
- update to newest version
|
||||||
|
- update docs and tests
|
||||||
|
- remove taskbuffer
|
||||||
|
- update to latest standards
|
||||||
|
|
||||||
|
## 2016-09-25 to 2016-09-03 - 1.1.6 … 1.1.3 - docs & core
|
||||||
|
Minor improvements in documentation and code quality.
|
||||||
|
- improve README
|
||||||
|
- added docs
|
||||||
|
- fix scoping of socket roles and perform small syntax fixes
|
||||||
|
|
||||||
|
## 2016-09-02 to 2016-08-16 - 1.1.2 … 1.1.1 - dependencies & security
|
||||||
|
Several housekeeping tasks to update dependencies and improve security.
|
||||||
|
- updated dependencies and exported socketConnection
|
||||||
|
- now authenticating sockets by checking the password hash
|
||||||
|
|
||||||
|
## 2016-08-15 - 1.1.0 - docs
|
||||||
|
A documentation update was published.
|
||||||
|
- update README
|
||||||
|
|
||||||
|
## 2016-08-15 - 1.0.7 - networking
|
||||||
|
A key update made the socket client work bi-directionally, enabling mesh setups.
|
||||||
|
- now working in both directions so mesh setups work
|
||||||
|
|
||||||
|
## 2016-08-14 to 2016-08-07 - 1.0.6 … 1.0.0 - internal changes
|
||||||
|
From the initial release onward, several internal improvements were introduced:
|
||||||
|
- updated tests and structure
|
||||||
|
- reworked reconnection logic and added a request/response abstraction for transparent function calls
|
||||||
|
- initial release features with updated documentation and structure
|
||||||
@@ -1,17 +1,33 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "code.foss.global",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "smartsocket",
|
"gitrepo": "smartsocket",
|
||||||
"shortDescription": "easy and secure websocket communication",
|
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
||||||
"npmPackagename": "@pushrocks/smartsocket",
|
"npmPackagename": "@push.rocks/smartsocket",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks"
|
"projectDomain": "push.rocks",
|
||||||
|
"keywords": [
|
||||||
|
"websocket",
|
||||||
|
"communication",
|
||||||
|
"server",
|
||||||
|
"client",
|
||||||
|
"socket.io",
|
||||||
|
"authentication",
|
||||||
|
"reconnection",
|
||||||
|
"tagging",
|
||||||
|
"function routing",
|
||||||
|
"secure"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"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"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
3290
package-lock.json
generated
3290
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
91
package.json
91
package.json
@@ -1,56 +1,75 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartsocket",
|
"name": "@push.rocks/smartsocket",
|
||||||
"version": "1.1.40",
|
"version": "3.0.0",
|
||||||
"description": "easy and secure websocket communication",
|
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "tstest test/",
|
"test": "(tstest test/ --verbose)",
|
||||||
"build": "tsbuild"
|
"build": "(tsbuild --web --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+ssh://git@gitlab.com/pushrocks/smartsocket.git"
|
"url": "https://code.foss.global/push.rocks/smartsocket.git"
|
||||||
},
|
},
|
||||||
"author": "Lossless GmbH",
|
"author": "Task Venture Capital GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/smartsocket/issues"
|
"url": "https://community.foss.global/"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
"homepage": "https://code.foss.global/push.rocks/smartsocket",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.10",
|
"@api.global/typedrequest-interfaces": "^3.0.19",
|
||||||
"@pushrocks/smartdelay": "^2.0.3",
|
"@push.rocks/isohash": "^2.0.1",
|
||||||
"@pushrocks/smartexpress": "^3.0.38",
|
"@push.rocks/isounique": "^1.0.5",
|
||||||
"@pushrocks/smarthash": "^2.0.6",
|
"@push.rocks/lik": "^6.2.2",
|
||||||
"@pushrocks/smartlog": "^2.0.19",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@push.rocks/smartenv": "^6.0.0",
|
||||||
"@types/shortid": "0.0.29",
|
"@push.rocks/smartjson": "^5.2.0",
|
||||||
"@types/socket.io": "^2.1.2",
|
"@push.rocks/smartlog": "^3.1.10",
|
||||||
"@types/socket.io-client": "^1.4.32",
|
"@push.rocks/smartpromise": "^4.2.3",
|
||||||
"shortid": "^2.2.14",
|
"@push.rocks/smartrx": "^3.0.10",
|
||||||
"socket.io": "^2.2.0",
|
"@push.rocks/smarttime": "^4.1.1",
|
||||||
"socket.io-client": "^2.2.0"
|
"ws": "^8.18.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.11",
|
"@git.zone/tsbuild": "^3.1.2",
|
||||||
"@gitzone/tsrun": "^1.2.8",
|
"@git.zone/tsbundle": "^2.6.3",
|
||||||
"@gitzone/tstest": "^1.0.24",
|
"@git.zone/tsrun": "^2.0.0",
|
||||||
"@pushrocks/tapbundle": "^3.0.11",
|
"@git.zone/tstest": "^3.1.3",
|
||||||
"@types/node": "^12.7.1",
|
"@push.rocks/smartserve": "^1.1.0",
|
||||||
"tslint": "^5.18.0",
|
"@types/node": "^24.10.1",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"@types/ws": "^8.18.1"
|
||||||
},
|
},
|
||||||
"private": false,
|
"private": false,
|
||||||
"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",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"keywords": [
|
||||||
|
"websocket",
|
||||||
|
"communication",
|
||||||
|
"server",
|
||||||
|
"client",
|
||||||
|
"native websocket",
|
||||||
|
"authentication",
|
||||||
|
"reconnection",
|
||||||
|
"tagging",
|
||||||
|
"function routing",
|
||||||
|
"secure",
|
||||||
|
"rpc"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
10416
pnpm-lock.yaml
generated
Normal file
10416
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 @@
|
|||||||
|
|
||||||
291
readme.md
Normal file
291
readme.md
Normal file
@@ -0,0 +1,291 @@
|
|||||||
|
# @push.rocks/smartsocket
|
||||||
|
|
||||||
|
Easy and secure WebSocket communication with native WebSocket support 🔌
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- 🚀 **Native WebSocket** - Uses native WebSocket API (browser) and `ws` library (Node.js)
|
||||||
|
- 🔄 **Auto Reconnection** - Exponential backoff with configurable retry limits
|
||||||
|
- 📡 **RPC-style Function Calls** - Define and call functions across server/client
|
||||||
|
- 🏷️ **Connection Tagging** - Tag connections for easy identification and routing
|
||||||
|
- 🔗 **Smartserve Integration** - Works seamlessly with `@push.rocks/smartserve`
|
||||||
|
- 🔒 **Secure Communication** - WSS support for encrypted connections
|
||||||
|
|
||||||
|
## Issue Reporting and Security
|
||||||
|
|
||||||
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm install @push.rocks/smartsocket --save
|
||||||
|
```
|
||||||
|
|
||||||
|
or with pnpm:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pnpm add @push.rocks/smartsocket
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Quick Start - Server
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartsocket, SocketFunction } from '@push.rocks/smartsocket';
|
||||||
|
|
||||||
|
// Create server
|
||||||
|
const server = new Smartsocket({
|
||||||
|
alias: 'myServer',
|
||||||
|
port: 3000
|
||||||
|
});
|
||||||
|
|
||||||
|
// Define a function that clients can call
|
||||||
|
const greetFunction = new SocketFunction({
|
||||||
|
funcName: 'greet',
|
||||||
|
funcDef: async (data, socketConnection) => {
|
||||||
|
console.log(`Received greeting from ${data.name}`);
|
||||||
|
return { message: `Hello, ${data.name}!` };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
server.addSocketFunction(greetFunction);
|
||||||
|
|
||||||
|
// Start the server
|
||||||
|
await server.start();
|
||||||
|
console.log('WebSocket server running on port 3000');
|
||||||
|
```
|
||||||
|
|
||||||
|
### Quick Start - Client
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { SmartsocketClient } from '@push.rocks/smartsocket';
|
||||||
|
|
||||||
|
// Create client
|
||||||
|
const client = new SmartsocketClient({
|
||||||
|
url: 'http://localhost',
|
||||||
|
port: 3000,
|
||||||
|
alias: 'myClient',
|
||||||
|
autoReconnect: true
|
||||||
|
});
|
||||||
|
|
||||||
|
// Connect to server
|
||||||
|
await client.connect();
|
||||||
|
|
||||||
|
// Call server function
|
||||||
|
const response = await client.serverCall('greet', { name: 'Alice' });
|
||||||
|
console.log(response.message); // "Hello, Alice!"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Connection Options
|
||||||
|
|
||||||
|
The `SmartsocketClient` supports several configuration options:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const client = new SmartsocketClient({
|
||||||
|
url: 'http://localhost', // Server URL (http/https)
|
||||||
|
port: 3000, // Server port
|
||||||
|
alias: 'myClient', // Client identifier
|
||||||
|
autoReconnect: true, // Auto-reconnect on disconnect
|
||||||
|
maxRetries: 100, // Max reconnection attempts (default: 100)
|
||||||
|
initialBackoffDelay: 1000, // Initial backoff in ms (default: 1000)
|
||||||
|
maxBackoffDelay: 60000 // Max backoff in ms (default: 60000)
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Two-Way Function Calls
|
||||||
|
|
||||||
|
Both server and client can define and call functions on each other:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Server calling client
|
||||||
|
const clientFunction = new SocketFunction({
|
||||||
|
funcName: 'clientTask',
|
||||||
|
funcDef: async (data) => {
|
||||||
|
return { result: 'Task completed' };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// On client
|
||||||
|
client.addSocketFunction(clientFunction);
|
||||||
|
|
||||||
|
// On server - call the client
|
||||||
|
const socketConnection = server.socketConnections.findSync(conn => conn.alias === 'myClient');
|
||||||
|
const result = await server.clientCall('clientTask', { task: 'doSomething' }, socketConnection);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Connection Tagging
|
||||||
|
|
||||||
|
Tag connections to identify and group them:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// On client
|
||||||
|
await client.addTag({
|
||||||
|
id: 'role',
|
||||||
|
payload: 'admin'
|
||||||
|
});
|
||||||
|
|
||||||
|
// On server - find tagged connections
|
||||||
|
const adminConnections = server.socketConnections.getArray().filter(async conn => {
|
||||||
|
const tag = await conn.getTagById('role');
|
||||||
|
return tag?.payload === 'admin';
|
||||||
|
});
|
||||||
|
|
||||||
|
// Server can also tag connections
|
||||||
|
await socketConnection.addTag({
|
||||||
|
id: 'verified',
|
||||||
|
payload: true
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration with Smartserve
|
||||||
|
|
||||||
|
Use smartsocket with `@push.rocks/smartserve` for advanced HTTP/WebSocket handling:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartserve } from '@push.rocks/smartserve';
|
||||||
|
import { Smartsocket } from '@push.rocks/smartsocket';
|
||||||
|
|
||||||
|
const smartserve = new Smartserve({ port: 3000 });
|
||||||
|
const smartsocket = new Smartsocket({ alias: 'myServer' });
|
||||||
|
|
||||||
|
// Set smartserve as external server
|
||||||
|
await smartsocket.setExternalServer('smartserve', smartserve);
|
||||||
|
|
||||||
|
// Get WebSocket hooks for smartserve
|
||||||
|
const wsHooks = smartsocket.socketServer.getSmartserveWebSocketHooks();
|
||||||
|
|
||||||
|
// Configure smartserve with the hooks
|
||||||
|
// (see smartserve documentation for integration details)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Handling Disconnections
|
||||||
|
|
||||||
|
The client automatically handles reconnection with exponential backoff:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const client = new SmartsocketClient({
|
||||||
|
url: 'http://localhost',
|
||||||
|
port: 3000,
|
||||||
|
alias: 'myClient',
|
||||||
|
autoReconnect: true,
|
||||||
|
maxRetries: 10,
|
||||||
|
initialBackoffDelay: 500,
|
||||||
|
maxBackoffDelay: 5000
|
||||||
|
});
|
||||||
|
|
||||||
|
// Listen for connection status changes
|
||||||
|
client.eventSubject.subscribe(status => {
|
||||||
|
console.log('Connection status:', status);
|
||||||
|
// Status can be: 'new', 'connecting', 'connected', 'disconnecting', 'timedOut'
|
||||||
|
});
|
||||||
|
|
||||||
|
await client.connect();
|
||||||
|
|
||||||
|
// Manually disconnect without auto-reconnect
|
||||||
|
await client.disconnect();
|
||||||
|
|
||||||
|
// Stop the client completely (disables auto-reconnect)
|
||||||
|
await client.stop();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Secure Connections (WSS)
|
||||||
|
|
||||||
|
For secure WebSocket connections, use HTTPS URLs:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const client = new SmartsocketClient({
|
||||||
|
url: 'https://secure.example.com', // HTTPS triggers WSS
|
||||||
|
port: 443,
|
||||||
|
alias: 'secureClient'
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### TypedRequest Integration
|
||||||
|
|
||||||
|
For strongly-typed RPC calls, define interfaces:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface IGreetRequest {
|
||||||
|
method: 'greet';
|
||||||
|
request: { name: string };
|
||||||
|
response: { message: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Type-safe server call
|
||||||
|
const response = await client.serverCall<IGreetRequest>('greet', { name: 'Bob' });
|
||||||
|
// response is typed as { message: string }
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
|
||||||
|
### Smartsocket (Server)
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|--------|-------------|
|
||||||
|
| `start()` | Start the WebSocket server |
|
||||||
|
| `stop()` | Stop the server and close all connections |
|
||||||
|
| `addSocketFunction(fn)` | Register a function that clients can call |
|
||||||
|
| `clientCall(funcName, data, connection)` | Call a function on a specific client |
|
||||||
|
| `setExternalServer(type, server)` | Use an external server (smartserve) |
|
||||||
|
|
||||||
|
### SmartsocketClient
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|--------|-------------|
|
||||||
|
| `connect()` | Connect to the server |
|
||||||
|
| `disconnect()` | Disconnect from the server |
|
||||||
|
| `stop()` | Disconnect and disable auto-reconnect |
|
||||||
|
| `serverCall(funcName, data)` | Call a function on the server |
|
||||||
|
| `addSocketFunction(fn)` | Register a function the server can call |
|
||||||
|
| `addTag(tag)` | Add a tag to the connection |
|
||||||
|
| `getTagById(id)` | Get a tag by its ID |
|
||||||
|
| `removeTagById(id)` | Remove a tag by its ID |
|
||||||
|
|
||||||
|
### SocketFunction
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const fn = new SocketFunction({
|
||||||
|
funcName: 'myFunction',
|
||||||
|
funcDef: async (data, socketConnection) => {
|
||||||
|
// data: the request payload
|
||||||
|
// socketConnection: the calling connection
|
||||||
|
return { result: 'response' };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────┐ WebSocket ┌─────────────────┐
|
||||||
|
│ SmartsocketClient │◄────────────────────────►│ Smartsocket │
|
||||||
|
│ (Browser/Node) │ Native WebSocket │ (Server) │
|
||||||
|
└─────────────────┘ └─────────────────┘
|
||||||
|
│ │
|
||||||
|
│ SocketFunction SocketFunction │
|
||||||
|
│ (serverCall) (clientCall) │
|
||||||
|
│ │
|
||||||
|
└──────────────── RPC-style Calls ──────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||||
|
|
||||||
|
**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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or 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.
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
// tslint:disable-next-line:no-implicit-dependencies
|
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
|
||||||
|
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
|
||||||
import * as smartexpress from '@pushrocks/smartexpress';
|
|
||||||
|
|
||||||
import socketIoClient = require('socket.io-client');
|
|
||||||
import smartsocket = require('../ts/index');
|
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
|
||||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
|
||||||
let testSocketRole1: smartsocket.SocketRole;
|
|
||||||
let testSocketFunction1: smartsocket.SocketFunction;
|
|
||||||
let myseServer: smartexpress.Server;
|
|
||||||
|
|
||||||
const testConfig = {
|
|
||||||
port: 3000
|
|
||||||
};
|
|
||||||
|
|
||||||
// class smartsocket
|
|
||||||
tap.test('should create a new smartsocket', async () => {
|
|
||||||
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
|
||||||
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('Should accept an smartExpressServer as server', async () => {
|
|
||||||
myseServer = new smartexpress.Server({
|
|
||||||
cors: true,
|
|
||||||
forceSsl: false,
|
|
||||||
port: testConfig.port
|
|
||||||
});
|
|
||||||
|
|
||||||
testSmartsocket.setExternalServer('smartexpress', myseServer);
|
|
||||||
|
|
||||||
await myseServer.start();
|
|
||||||
});
|
|
||||||
|
|
||||||
// class socketrole
|
|
||||||
tap.test('should add a socketrole', async () => {
|
|
||||||
testSocketRole1 = new smartsocket.SocketRole({
|
|
||||||
name: 'testRole1',
|
|
||||||
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
|
||||||
});
|
|
||||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// class SocketFunction
|
|
||||||
tap.test('should register a new Function', async () => {
|
|
||||||
testSocketFunction1 = new smartsocket.SocketFunction({
|
|
||||||
allowedRoles: [testSocketRole1],
|
|
||||||
funcDef: async (dataArg, socketConnectionArg) => {
|
|
||||||
return dataArg;
|
|
||||||
},
|
|
||||||
funcName: 'testFunction1'
|
|
||||||
});
|
|
||||||
testSmartsocket.addSocketFunction(testSocketFunction1);
|
|
||||||
console.log(testSmartsocket.socketFunctions);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should start listening when .started is called', async () => {
|
|
||||||
await testSmartsocket.start();
|
|
||||||
});
|
|
||||||
|
|
||||||
// class SmartsocketClient
|
|
||||||
tap.test('should react to a new websocket connection from client', async () => {
|
|
||||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
|
||||||
port: testConfig.port,
|
|
||||||
url: 'http://localhost',
|
|
||||||
password: 'testPassword',
|
|
||||||
alias: 'testClient1',
|
|
||||||
role: 'testRole1'
|
|
||||||
});
|
|
||||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
|
||||||
console.log(testSmartsocketClient.socketFunctions);
|
|
||||||
await testSmartsocketClient.connect();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('client should disconnect and reconnect', async tools => {
|
|
||||||
await testSmartsocketClient.disconnect();
|
|
||||||
await tools.delayFor(100);
|
|
||||||
await testSmartsocketClient.connect();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('2 clients should connect in parallel', async () => {
|
|
||||||
// TODO: implement parallel test
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
|
||||||
const response = await testSmartsocketClient.serverCall('testFunction1', {
|
|
||||||
value1: 'hello'
|
|
||||||
});
|
|
||||||
console.log(response);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from server to client', async () => {
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
// terminate
|
|
||||||
tap.test('should close the server', async () => {
|
|
||||||
await testSmartsocket.stop();
|
|
||||||
await myseServer.stop();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
||||||
155
test/test.reconnect.ts
Normal file
155
test/test.reconnect.ts
Normal file
@@ -0,0 +1,155 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunctionForServer: smartsocket.SocketFunction<any>;
|
||||||
|
let testSocketFunctionClient: smartsocket.SocketFunction<any>;
|
||||||
|
|
||||||
|
export interface IReqResClient {
|
||||||
|
method: 'testFunction1';
|
||||||
|
request: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IReqResServer {
|
||||||
|
method: 'testFunction2';
|
||||||
|
request: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000,
|
||||||
|
};
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should create a new smartsocket', async () => {
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver1', port: testConfig.port });
|
||||||
|
await testSmartsocket.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
|
||||||
|
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction2',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SmartsocketClient
|
||||||
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
alias: 'testClient1',
|
||||||
|
autoReconnect: true,
|
||||||
|
maxRetries: 20,
|
||||||
|
initialBackoffDelay: 500,
|
||||||
|
maxBackoffDelay: 3000,
|
||||||
|
});
|
||||||
|
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from client', async (tools) => {
|
||||||
|
await testSmartsocketClient.addTag({
|
||||||
|
id: 'awesome',
|
||||||
|
payload: 'yes',
|
||||||
|
});
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
|
await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.addTag({
|
||||||
|
id: 'awesome2',
|
||||||
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
|
expect(tagOnClientSide.payload).toEqual('absolutely');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
|
const response = await testSmartsocketClient.serverCall<IReqResClient>('testFunction1', {
|
||||||
|
value1: 'hello',
|
||||||
|
});
|
||||||
|
console.log(response);
|
||||||
|
expect(response.value1).toEqual('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
const response = await testSmartsocket.clientCall<IReqResServer>(
|
||||||
|
'testFunction2',
|
||||||
|
{
|
||||||
|
hi: 'hi there from server',
|
||||||
|
},
|
||||||
|
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
console.log(response);
|
||||||
|
expect(response.hi).toEqual('hi there from server');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect', async (toolsArg) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
await toolsArg.delayFor(2000);
|
||||||
|
expect(testSmartsocket.socketConnections.getArray().length).toEqual(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should be able to switch to a new server', async (toolsArg) => {
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||||
|
await testSmartsocket.start();
|
||||||
|
// Wait for client to reconnect with shorter backoff settings
|
||||||
|
await toolsArg.delayFor(5000);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
|
||||||
|
expect(testSmartsocket.socketConnections.getArray().length).toEqual(1);
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
// terminate
|
||||||
|
tap.test('should close the server', async (tools) => {
|
||||||
|
await testSmartsocketClient.stop();
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
tools.delayFor(1000).then(() => process.exit(0));
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
91
test/test.smartserve.ts
Normal file
91
test/test.smartserve.ts
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
import { SmartServe } from '@push.rocks/smartserve';
|
||||||
|
|
||||||
|
let smartserveInstance: SmartServe;
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunction: smartsocket.SocketFunction<any>;
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Setup smartsocket with smartserve integration
|
||||||
|
tap.test('should create smartsocket and smartserve with websocket hooks', async () => {
|
||||||
|
// Create smartsocket (no port - hooks mode for smartserve integration)
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver-smartserve' });
|
||||||
|
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
||||||
|
|
||||||
|
// Get websocket hooks from smartsocket and pass to smartserve
|
||||||
|
const wsHooks = testSmartsocket.getSmartserveWebSocketHooks();
|
||||||
|
smartserveInstance = new SmartServe({
|
||||||
|
port: testConfig.port,
|
||||||
|
websocket: wsHooks,
|
||||||
|
});
|
||||||
|
// That's it! No setExternalServer needed - hooks connect everything
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should register a socket function', async () => {
|
||||||
|
testSocketFunction = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunction);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should start smartserve', async () => {
|
||||||
|
await smartserveInstance.start();
|
||||||
|
// No need to call testSmartsocket.start() - hooks mode doesn't need it
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should connect client through smartserve', async () => {
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
alias: 'testClient1',
|
||||||
|
});
|
||||||
|
testSmartsocketClient.addSocketFunction(testSocketFunction);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
|
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||||
|
value1: 'hello from smartserve test',
|
||||||
|
});
|
||||||
|
expect(response.value1).toEqual('hello from smartserve test');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make multiple function calls', async () => {
|
||||||
|
for (let i = 0; i < 10; i++) {
|
||||||
|
const randomString = `message-${i}-${Math.random()}`;
|
||||||
|
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||||
|
value1: randomString,
|
||||||
|
});
|
||||||
|
expect(response.value1).toEqual(randomString);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect through smartserve', async (tools) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await tools.delayFor(100);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
|
||||||
|
// Verify connection still works after reconnect
|
||||||
|
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||||
|
value1: 'after reconnect',
|
||||||
|
});
|
||||||
|
expect(response.value1).toEqual('after reconnect');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Cleanup
|
||||||
|
tap.test('should close the server', async (tools) => {
|
||||||
|
await testSmartsocketClient.stop();
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
await smartserveInstance.stop();
|
||||||
|
tools.delayFor(1000).then(() => process.exit(0));
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
148
test/test.tagging.ts
Normal file
148
test/test.tagging.ts
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunctionForServer: smartsocket.SocketFunction<any>;
|
||||||
|
let testSocketFunctionClient: smartsocket.SocketFunction<any>;
|
||||||
|
|
||||||
|
export interface IReqResClient {
|
||||||
|
method: 'testFunction1';
|
||||||
|
request: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IReqResServer {
|
||||||
|
method: 'testFunction2';
|
||||||
|
request: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000,
|
||||||
|
};
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should create a new smartsocket', async () => {
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||||
|
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
|
||||||
|
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction2',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should start listening when .started is called', async () => {
|
||||||
|
await testSmartsocket.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SmartsocketClient
|
||||||
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
alias: 'testClient1',
|
||||||
|
});
|
||||||
|
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from client', async (tools) => {
|
||||||
|
await testSmartsocketClient.addTag({
|
||||||
|
id: 'awesome',
|
||||||
|
payload: 'yes',
|
||||||
|
});
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
|
await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.addTag({
|
||||||
|
id: 'awesome2',
|
||||||
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
|
expect(tagOnClientSide.payload).toEqual('absolutely');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('2 clients should connect in parallel', async () => {
|
||||||
|
// TODO: implement parallel test
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
|
const response = await testSmartsocketClient.serverCall<IReqResClient>('testFunction1', {
|
||||||
|
value1: 'hello',
|
||||||
|
});
|
||||||
|
console.log(response);
|
||||||
|
expect(response.value1).toEqual('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
const response = await testSmartsocket.clientCall<IReqResServer>(
|
||||||
|
'testFunction2',
|
||||||
|
{
|
||||||
|
hi: 'hi there from server',
|
||||||
|
},
|
||||||
|
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
console.log(response);
|
||||||
|
expect(response.hi).toEqual('hi there from server');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
|
||||||
|
console.log(testSmartsocket.socketConnections.getArray().length);
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
// terminate
|
||||||
|
tap.test('should close the server', async (tools) => {
|
||||||
|
await testSmartsocketClient.stop();
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
tools.delayFor(1000).then(() => process.exit(0));
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
91
test/test.ts
91
test/test.ts
@@ -1,91 +0,0 @@
|
|||||||
// tslint:disable-next-line:no-implicit-dependencies
|
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
|
||||||
|
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
|
||||||
|
|
||||||
import socketIoClient = require('socket.io-client');
|
|
||||||
import smartsocket = require('../ts/index');
|
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
|
||||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
|
||||||
let testSocketRole1: smartsocket.SocketRole;
|
|
||||||
let testSocketFunction1: smartsocket.SocketFunction;
|
|
||||||
|
|
||||||
const testConfig = {
|
|
||||||
port: 3000
|
|
||||||
};
|
|
||||||
|
|
||||||
// class smartsocket
|
|
||||||
tap.test('should create a new smartsocket', async () => {
|
|
||||||
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
|
||||||
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
|
||||||
});
|
|
||||||
|
|
||||||
// class socketrole
|
|
||||||
tap.test('should add a socketrole', async () => {
|
|
||||||
testSocketRole1 = new smartsocket.SocketRole({
|
|
||||||
name: 'testRole1',
|
|
||||||
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
|
||||||
});
|
|
||||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// class SocketFunction
|
|
||||||
tap.test('should register a new Function', async () => {
|
|
||||||
testSocketFunction1 = new smartsocket.SocketFunction({
|
|
||||||
allowedRoles: [testSocketRole1],
|
|
||||||
funcDef: async (dataArg, socketConnectionArg) => {
|
|
||||||
return dataArg;
|
|
||||||
},
|
|
||||||
funcName: 'testFunction1'
|
|
||||||
});
|
|
||||||
testSmartsocket.addSocketFunction(testSocketFunction1);
|
|
||||||
console.log(testSmartsocket.socketFunctions);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should start listening when .started is called', async () => {
|
|
||||||
await testSmartsocket.start();
|
|
||||||
});
|
|
||||||
|
|
||||||
// class SmartsocketClient
|
|
||||||
tap.test('should react to a new websocket connection from client', async () => {
|
|
||||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
|
||||||
port: testConfig.port,
|
|
||||||
url: 'http://localhost',
|
|
||||||
password: 'testPassword',
|
|
||||||
alias: 'testClient1',
|
|
||||||
role: 'testRole1'
|
|
||||||
});
|
|
||||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
|
||||||
console.log(testSmartsocketClient.socketFunctions);
|
|
||||||
await testSmartsocketClient.connect();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('client should disconnect and reconnect', async tools => {
|
|
||||||
await testSmartsocketClient.disconnect();
|
|
||||||
await tools.delayFor(100);
|
|
||||||
await testSmartsocketClient.connect();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('2 clients should connect in parallel', async () => {
|
|
||||||
// TODO: implement parallel test
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
|
||||||
const response = await testSmartsocketClient.serverCall('testFunction1', {
|
|
||||||
value1: 'hello'
|
|
||||||
});
|
|
||||||
console.log(response);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from server to client', async () => {
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
// terminate
|
|
||||||
tap.test('should close the server', async () => {
|
|
||||||
await testSmartsocket.stop();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
||||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartsocket',
|
||||||
|
version: '3.0.0',
|
||||||
|
description: 'Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.'
|
||||||
|
}
|
||||||
14
ts/index.ts
14
ts/index.ts
@@ -1,10 +1,10 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
|
||||||
|
|
||||||
// export main classes
|
// export main classes
|
||||||
export * from './smartsocket.classes.smartsocket';
|
export * from './smartsocket.classes.smartsocket.js';
|
||||||
export * from './smartsocket.classes.smartsocketclient';
|
export * from './smartsocket.classes.smartsocketclient.js';
|
||||||
|
|
||||||
// export further classes and objects
|
// export further classes and objects
|
||||||
export * from './smartsocket.classes.socketfunction';
|
export * from './smartsocket.classes.socketfunction.js';
|
||||||
export * from './smartsocket.classes.socketrole';
|
export * from './smartsocket.classes.socketconnection.js';
|
||||||
export * from './smartsocket.classes.socketconnection';
|
|
||||||
|
// export types so they can be referred to
|
||||||
|
export * from './interfaces/index.js';
|
||||||
11
ts/interfaces/connection.ts
Normal file
11
ts/interfaces/connection.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
export interface IRequestAuthPayload {
|
||||||
|
serverAlias: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TConnectionStatus =
|
||||||
|
| 'new'
|
||||||
|
| 'connecting'
|
||||||
|
| 'connected'
|
||||||
|
| 'disconnecting'
|
||||||
|
| 'disconnected'
|
||||||
|
| 'timedOut';
|
||||||
3
ts/interfaces/index.ts
Normal file
3
ts/interfaces/index.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
export * from './connection.js';
|
||||||
|
export * from './tag.js';
|
||||||
|
export * from './message.js';
|
||||||
67
ts/interfaces/message.ts
Normal file
67
ts/interfaces/message.ts
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
/**
|
||||||
|
* Message types for the smartsocket protocol
|
||||||
|
*/
|
||||||
|
export type TMessageType =
|
||||||
|
| 'authRequest' // Server requests authentication from client
|
||||||
|
| 'auth' // Client provides authentication data
|
||||||
|
| 'authResponse' // Server responds to authentication
|
||||||
|
| 'serverReady' // Server signals it's fully ready
|
||||||
|
| 'function' // Function call request
|
||||||
|
| 'functionResponse' // Function call response
|
||||||
|
| 'tagUpdate'; // Tag store synchronization
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base message interface for all smartsocket messages
|
||||||
|
*/
|
||||||
|
export interface ISocketMessage<T = any> {
|
||||||
|
type: TMessageType;
|
||||||
|
id?: string; // For request/response correlation
|
||||||
|
payload: T;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Authentication request payload (server -> client)
|
||||||
|
*/
|
||||||
|
export interface IAuthRequestPayload {
|
||||||
|
serverAlias: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Authentication data payload (client -> server)
|
||||||
|
*/
|
||||||
|
export interface IAuthPayload {
|
||||||
|
alias: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Authentication response payload (server -> client)
|
||||||
|
*/
|
||||||
|
export interface IAuthResponsePayload {
|
||||||
|
success: boolean;
|
||||||
|
error?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Function call payload
|
||||||
|
*/
|
||||||
|
export interface IFunctionCallPayload {
|
||||||
|
funcName: string;
|
||||||
|
funcData: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tag update payload
|
||||||
|
*/
|
||||||
|
export interface ITagUpdatePayload {
|
||||||
|
tags: { [key: string]: any };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper type for creating typed messages
|
||||||
|
*/
|
||||||
|
export type TAuthRequestMessage = ISocketMessage<IAuthRequestPayload>;
|
||||||
|
export type TAuthMessage = ISocketMessage<IAuthPayload>;
|
||||||
|
export type TAuthResponseMessage = ISocketMessage<IAuthResponsePayload>;
|
||||||
|
export type TFunctionMessage = ISocketMessage<IFunctionCallPayload>;
|
||||||
|
export type TFunctionResponseMessage = ISocketMessage<IFunctionCallPayload>;
|
||||||
|
export type TTagUpdateMessage = ISocketMessage<ITagUpdatePayload>;
|
||||||
6
ts/interfaces/tag.ts
Normal file
6
ts/interfaces/tag.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
export interface ITag<T = any> {
|
||||||
|
id: string;
|
||||||
|
payload: T;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TTagStore = { [key: string]: ITag };
|
||||||
@@ -1,48 +1,97 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
// classes
|
// classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import {
|
||||||
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
type ISocketFunctionCallDataRequest,
|
||||||
import { SocketRequest } from './smartsocket.classes.socketrequest';
|
SocketFunction,
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
type ISocketFunctionCallDataResponse,
|
||||||
import { SocketServer } from './smartsocket.classes.socketserver';
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
import { SocketRequest } from './smartsocket.classes.socketrequest.js';
|
||||||
|
import { SocketServer } from './smartsocket.classes.socketserver.js';
|
||||||
|
|
||||||
// socket.io
|
import { logger } from './smartsocket.logging.js';
|
||||||
import * as SocketIO from 'socket.io';
|
|
||||||
|
|
||||||
export interface ISmartsocketConstructorOptions {
|
export interface ISmartsocketConstructorOptions {
|
||||||
|
alias: string;
|
||||||
port?: number;
|
port?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Smartsocket {
|
export class Smartsocket {
|
||||||
|
/**
|
||||||
|
* a unique id to detect server restarts
|
||||||
|
*/
|
||||||
|
public alias: string;
|
||||||
|
public smartenv = new plugins.smartenv.Smartenv();
|
||||||
public options: ISmartsocketConstructorOptions;
|
public options: ISmartsocketConstructorOptions;
|
||||||
public io: SocketIO.Server;
|
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
public openSockets = new Objectmap<SocketConnection>();
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
public socketRoles = new Objectmap<SocketRole>();
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
public socketFunctions = new Objectmap<SocketFunction>();
|
|
||||||
public socketRequests = new Objectmap<SocketRequest>();
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
|
|
||||||
private socketServer = new SocketServer(this);
|
private socketServer = new SocketServer(this);
|
||||||
|
|
||||||
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
||||||
this.options = optionsArg;
|
this.options = optionsArg;
|
||||||
|
this.alias = plugins.isounique.uni(this.options.alias);
|
||||||
}
|
}
|
||||||
|
|
||||||
// tslint:disable-next-line:member-ordering
|
/**
|
||||||
public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
|
* Returns WebSocket hooks for integration with smartserve
|
||||||
await this.socketServer.setExternalServer(serverType, serverArg);
|
* Pass these hooks to SmartServe's websocket config
|
||||||
|
*/
|
||||||
|
public getSmartserveWebSocketHooks(): pluginsTyped.ISmartserveWebSocketHooks {
|
||||||
|
return this.socketServer.getSmartserveWebSocketHooks();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* starts smartsocket
|
* starts smartsocket
|
||||||
*/
|
*/
|
||||||
public async start() {
|
public async start() {
|
||||||
this.io = plugins.socketIo(this.socketServer.getServerForSocketIo());
|
|
||||||
await this.socketServer.start();
|
await this.socketServer.start();
|
||||||
this.io.on('connection', socketArg => {
|
}
|
||||||
this._handleSocketConnection(socketArg);
|
|
||||||
|
/**
|
||||||
|
* Handle a new WebSocket connection
|
||||||
|
* Called by SocketServer when a new connection is established
|
||||||
|
*/
|
||||||
|
public async handleNewConnection(socket: WebSocket | pluginsTyped.ws.WebSocket) {
|
||||||
|
const socketConnection: SocketConnection = new SocketConnection({
|
||||||
|
alias: undefined,
|
||||||
|
authenticated: false,
|
||||||
|
side: 'server',
|
||||||
|
smartsocketHost: this,
|
||||||
|
socket: socket,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||||
|
this.socketConnections.add(socketConnection);
|
||||||
|
|
||||||
|
// Handle disconnection
|
||||||
|
const handleClose = () => {
|
||||||
|
this.socketConnections.remove(socketConnection);
|
||||||
|
socketConnection.eventSubject.next('disconnected');
|
||||||
|
};
|
||||||
|
|
||||||
|
socket.addEventListener('close', handleClose);
|
||||||
|
socket.addEventListener('error', handleClose);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await socketConnection.authenticate();
|
||||||
|
await socketConnection.listenToFunctionRequests();
|
||||||
|
|
||||||
|
// Signal that the server is ready
|
||||||
|
socketConnection.sendMessage({
|
||||||
|
type: 'serverReady',
|
||||||
|
payload: {},
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
logger.log('warn', `Authentication failed: ${err}`);
|
||||||
|
this.socketConnections.remove(socketConnection);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -50,18 +99,19 @@ export class Smartsocket {
|
|||||||
*/
|
*/
|
||||||
public async stop() {
|
public async stop() {
|
||||||
await plugins.smartdelay.delayFor(1000);
|
await plugins.smartdelay.delayFor(1000);
|
||||||
this.openSockets.forEach((socketObjectArg: SocketConnection) => {
|
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
||||||
plugins.smartlog.defaultLogger.log(
|
if (socketObjectArg) {
|
||||||
|
logger.log(
|
||||||
'info',
|
'info',
|
||||||
`disconnect socket with >>alias ${socketObjectArg.alias}`
|
`disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`
|
||||||
);
|
);
|
||||||
socketObjectArg.socket.disconnect();
|
socketObjectArg.disconnect();
|
||||||
|
}
|
||||||
});
|
});
|
||||||
this.openSockets.wipe();
|
this.socketConnections.wipe();
|
||||||
this.io.close();
|
|
||||||
|
|
||||||
// stop the corresponging server
|
// stop the corresponding server
|
||||||
this.socketServer.stop();
|
await this.socketServer.stop();
|
||||||
}
|
}
|
||||||
|
|
||||||
// communication
|
// communication
|
||||||
@@ -69,63 +119,26 @@ export class Smartsocket {
|
|||||||
/**
|
/**
|
||||||
* allows call to specific client.
|
* allows call to specific client.
|
||||||
*/
|
*/
|
||||||
public async clientCall(
|
public async clientCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
functionNameArg: string,
|
functionNameArg: T['method'],
|
||||||
dataArg: any,
|
dataArg: T['request'],
|
||||||
targetSocketConnectionArg: SocketConnection
|
targetSocketConnectionArg: SocketConnection
|
||||||
) {
|
): Promise<T['response']> {
|
||||||
const done = plugins.smartpromise.defer();
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
const socketRequest = new SocketRequest(this, {
|
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcDataArg: dataArg,
|
funcDataArg: dataArg,
|
||||||
funcName: functionNameArg
|
funcName: functionNameArg,
|
||||||
},
|
},
|
||||||
originSocketConnection: targetSocketConnectionArg,
|
originSocketConnection: targetSocketConnectionArg,
|
||||||
shortId: plugins.shortid.generate(),
|
shortId: plugins.isounique.uni(),
|
||||||
side: 'requesting'
|
side: 'requesting',
|
||||||
});
|
});
|
||||||
socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
|
const response: ISocketFunctionCallDataResponse<T> = await socketRequest.dispatch();
|
||||||
done.resolve(dataArg2.funcDataArg);
|
const result = response.funcDataArg;
|
||||||
});
|
|
||||||
const result = await done.promise;
|
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||||
* adds socketRoles
|
|
||||||
*/
|
|
||||||
public addSocketRoles(socketRolesArray: SocketRole[]): void {
|
|
||||||
for (const socketRole of socketRolesArray) {
|
|
||||||
this.socketRoles.add(socketRole);
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
public addSocketFunction(socketFunction: SocketFunction) {
|
|
||||||
this.socketFunctions.add(socketFunction);
|
this.socketFunctions.add(socketFunction);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* the standard handler for new socket connections
|
|
||||||
*/
|
|
||||||
private _handleSocketConnection(socketArg) {
|
|
||||||
const socketConnection: SocketConnection = new SocketConnection({
|
|
||||||
alias: undefined,
|
|
||||||
authenticated: false,
|
|
||||||
role: undefined,
|
|
||||||
side: 'server',
|
|
||||||
smartsocketHost: this,
|
|
||||||
socket: socketArg
|
|
||||||
});
|
|
||||||
plugins.smartlog.defaultLogger.log('info', 'Socket connected. Trying to authenticate...');
|
|
||||||
this.openSockets.add(socketConnection);
|
|
||||||
socketConnection
|
|
||||||
.authenticate()
|
|
||||||
.then(() => {
|
|
||||||
return socketConnection.listenToFunctionRequests();
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
import {
|
||||||
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
|
type ISocketFunctionCallDataRequest,
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
SocketFunction,
|
||||||
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
import { type ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest.js';
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for class SmartsocketClient
|
* interface for class SmartsocketClient
|
||||||
@@ -11,90 +16,354 @@ import { SocketRole } from './smartsocket.classes.socketrole';
|
|||||||
export interface ISmartsocketClientOptions {
|
export interface ISmartsocketClientOptions {
|
||||||
port: number;
|
port: number;
|
||||||
url: string;
|
url: string;
|
||||||
alias: string; // an alias makes it easier to identify this client in a multo client environment
|
alias: string; // an alias makes it easier to identify this client in a multi client environment
|
||||||
role: string;
|
autoReconnect?: boolean;
|
||||||
password: string; // by setting a password access to functions can be limited
|
maxRetries?: number; // maximum number of reconnection attempts
|
||||||
|
initialBackoffDelay?: number; // initial backoff delay in ms
|
||||||
|
maxBackoffDelay?: number; // maximum backoff delay in ms
|
||||||
}
|
}
|
||||||
|
|
||||||
export class SmartsocketClient {
|
export class SmartsocketClient {
|
||||||
|
// a unique id
|
||||||
|
public shortId = plugins.isounique.uni();
|
||||||
|
|
||||||
|
// the shortId of the remote we connect to
|
||||||
|
public remoteShortId: string = null;
|
||||||
|
|
||||||
public alias: string;
|
public alias: string;
|
||||||
public role: string;
|
|
||||||
public socketConnection: SocketConnection;
|
public socketConnection: SocketConnection;
|
||||||
public serverUrl: string;
|
public serverUrl: string;
|
||||||
public serverPort: number;
|
public serverPort: number;
|
||||||
public serverPassword: string;
|
public autoReconnect: boolean;
|
||||||
|
public maxRetries: number;
|
||||||
|
public initialBackoffDelay: number;
|
||||||
|
public maxBackoffDelay: number;
|
||||||
|
public currentRetryCount = 0;
|
||||||
|
public currentBackoffDelay: number;
|
||||||
|
|
||||||
public socketFunctions = new plugins.lik.Objectmap<SocketFunction>();
|
// status handling
|
||||||
public socketRequests = new plugins.lik.Objectmap<SocketRequest>();
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
public socketRoles = new plugins.lik.Objectmap<SocketRole>();
|
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||||
|
|
||||||
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
|
|
||||||
|
// tagStore
|
||||||
|
private tagStore: { [key: string]: interfaces.ITag } = {};
|
||||||
|
private tagStoreSubscription: plugins.smartrx.rxjs.Subscription;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a tag to a connection
|
||||||
|
*/
|
||||||
|
public async addTag(tagArg: interfaces.ITag) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.addTag(tagArg);
|
||||||
|
} else {
|
||||||
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a tag by id
|
||||||
|
* @param tagIdArg
|
||||||
|
*/
|
||||||
|
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
return this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes a tag from a connection
|
||||||
|
*/
|
||||||
|
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
this.socketConnection.removeTagById(tagIdArg);
|
||||||
|
} else {
|
||||||
|
delete this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
constructor(optionsArg: ISmartsocketClientOptions) {
|
constructor(optionsArg: ISmartsocketClientOptions) {
|
||||||
this.alias = optionsArg.alias;
|
this.alias = optionsArg.alias;
|
||||||
this.role = optionsArg.role;
|
|
||||||
this.serverUrl = optionsArg.url;
|
this.serverUrl = optionsArg.url;
|
||||||
this.serverPort = optionsArg.port;
|
this.serverPort = optionsArg.port;
|
||||||
this.serverPassword = optionsArg.password;
|
this.autoReconnect = optionsArg.autoReconnect;
|
||||||
|
this.maxRetries = optionsArg.maxRetries ?? 100; // Default to 100 retries
|
||||||
|
this.initialBackoffDelay = optionsArg.initialBackoffDelay ?? 1000; // Default to 1 second
|
||||||
|
this.maxBackoffDelay = optionsArg.maxBackoffDelay ?? 60000; // Default to 1 minute
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
}
|
}
|
||||||
|
|
||||||
public addSocketFunction(socketFunction: SocketFunction) {
|
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||||
this.socketFunctions.add(socketFunction);
|
this.socketFunctions.add(socketFunction);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private isReconnecting = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* connect the client to the server
|
* connect the client to the server
|
||||||
*/
|
*/
|
||||||
public connect() {
|
public async connect() {
|
||||||
|
// Only reset retry counters on fresh connection (not during auto-reconnect)
|
||||||
|
if (!this.isReconnecting) {
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
|
}
|
||||||
|
this.isReconnecting = false;
|
||||||
|
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
plugins.smartlog.defaultLogger.log('info', 'trying to connect...');
|
const smartenvInstance = new plugins.smartenv.Smartenv();
|
||||||
const socketUrl = `${this.serverUrl}:${this.serverPort}`;
|
|
||||||
|
logger.log('info', 'trying to connect...');
|
||||||
|
|
||||||
|
// Construct WebSocket URL
|
||||||
|
const protocol = this.serverUrl.startsWith('https') ? 'wss' : 'ws';
|
||||||
|
const host = this.serverUrl.replace(/^https?:\/\//, '');
|
||||||
|
const socketUrl = `${protocol}://${host}:${this.serverPort}`;
|
||||||
|
|
||||||
|
// Get WebSocket implementation (native in browser, ws in Node)
|
||||||
|
let WebSocketClass: typeof WebSocket;
|
||||||
|
if (typeof WebSocket !== 'undefined') {
|
||||||
|
// Browser environment
|
||||||
|
WebSocketClass = WebSocket;
|
||||||
|
} else {
|
||||||
|
// Node.js environment
|
||||||
|
const wsModule = await smartenvInstance.getSafeNodeModule('ws');
|
||||||
|
WebSocketClass = wsModule.default || wsModule;
|
||||||
|
}
|
||||||
|
|
||||||
|
const socket = new WebSocketClass(socketUrl);
|
||||||
|
this.currentSocket = socket;
|
||||||
|
|
||||||
this.socketConnection = new SocketConnection({
|
this.socketConnection = new SocketConnection({
|
||||||
alias: this.alias,
|
alias: this.alias,
|
||||||
authenticated: false,
|
authenticated: false,
|
||||||
role: undefined,
|
|
||||||
side: 'client',
|
side: 'client',
|
||||||
smartsocketHost: this,
|
smartsocketHost: this,
|
||||||
socket: plugins.socketIoClient(socketUrl, { multiplex: false })
|
socket: socket as any,
|
||||||
});
|
});
|
||||||
this.socketConnection.socket.on('requestAuth', () => {
|
|
||||||
console.log('server requested authentication');
|
// Increment attempt ID to invalidate any pending timers from previous attempts
|
||||||
this.socketConnection.socket.emit('dataAuth', {
|
this.connectionAttemptId++;
|
||||||
role: this.role,
|
const currentAttemptId = this.connectionAttemptId;
|
||||||
password: this.serverPassword,
|
|
||||||
alias: this.alias
|
const timer = new plugins.smarttime.Timer(5000);
|
||||||
|
timer.start();
|
||||||
|
timer.completed.then(() => {
|
||||||
|
// Only fire timeout if this is still the current connection attempt
|
||||||
|
if (currentAttemptId === this.connectionAttemptId && this.eventStatus !== 'connected') {
|
||||||
|
this.updateStatus('timedOut');
|
||||||
|
logger.log('warn', 'connection to server timed out.');
|
||||||
|
this.disconnect(true);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
this.socketConnection.socket.on('authenticated', () => {
|
|
||||||
console.log('client is authenticated');
|
// Handle connection open
|
||||||
|
socket.addEventListener('open', () => {
|
||||||
|
timer.reset();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle messages
|
||||||
|
socket.addEventListener('message', async (event: MessageEvent | { data: string }) => {
|
||||||
|
try {
|
||||||
|
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||||
|
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||||
|
|
||||||
|
switch (message.type) {
|
||||||
|
case 'authRequest':
|
||||||
|
timer.reset();
|
||||||
|
const authRequestPayload = message.payload as interfaces.IAuthRequestPayload;
|
||||||
|
logger.log('info', `server ${authRequestPayload.serverAlias} requested authentication`);
|
||||||
|
this.remoteShortId = authRequestPayload.serverAlias;
|
||||||
|
|
||||||
|
// Send authentication data
|
||||||
|
this.socketConnection.sendMessage({
|
||||||
|
type: 'auth',
|
||||||
|
payload: { alias: this.alias },
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'authResponse':
|
||||||
|
const authResponse = message.payload as interfaces.IAuthResponsePayload;
|
||||||
|
if (authResponse.success) {
|
||||||
|
logger.log('info', 'client is authenticated');
|
||||||
this.socketConnection.authenticated = true;
|
this.socketConnection.authenticated = true;
|
||||||
this.socketConnection.listenToFunctionRequests();
|
} else {
|
||||||
|
logger.log('warn', `authentication failed: ${authResponse.error}`);
|
||||||
|
await this.disconnect();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'serverReady':
|
||||||
|
// Set up function request listening
|
||||||
|
await this.socketConnection.listenToFunctionRequests();
|
||||||
|
|
||||||
|
// Handle retagging
|
||||||
|
const oldTagStore = this.tagStore;
|
||||||
|
this.tagStoreSubscription?.unsubscribe();
|
||||||
|
for (const keyArg of Object.keys(this.tagStore)) {
|
||||||
|
this.socketConnection.addTag(this.tagStore[keyArg]);
|
||||||
|
}
|
||||||
|
this.tagStoreSubscription = this.socketConnection.tagStoreObservable.subscribe(
|
||||||
|
(tagStoreArg) => {
|
||||||
|
this.tagStore = tagStoreArg;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
for (const tag of Object.keys(oldTagStore)) {
|
||||||
|
await this.addTag(oldTagStore[tag]);
|
||||||
|
}
|
||||||
|
this.updateStatus('connected');
|
||||||
done.resolve();
|
done.resolve();
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
// Other messages are handled by SocketConnection
|
||||||
|
this.socketConnection.handleMessage(message);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
// Not a valid JSON message, ignore
|
||||||
|
}
|
||||||
});
|
});
|
||||||
});
|
|
||||||
|
// Handle disconnection and errors
|
||||||
|
const closeHandler = async () => {
|
||||||
|
// Only handle close if this is still the current socket and we're not already disconnecting
|
||||||
|
if (this.currentSocket === socket && !this.disconnectRunning) {
|
||||||
|
logger.log(
|
||||||
|
'info',
|
||||||
|
`SocketConnection with >alias ${this.alias} on >side client disconnected`
|
||||||
|
);
|
||||||
|
await this.disconnect(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const errorHandler = async () => {
|
||||||
|
if (this.currentSocket === socket && !this.disconnectRunning) {
|
||||||
|
await this.disconnect(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
socket.addEventListener('close', closeHandler);
|
||||||
|
socket.addEventListener('error', errorHandler);
|
||||||
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
public disconnect() {
|
private disconnectRunning = false;
|
||||||
const done = plugins.smartpromise.defer();
|
private currentSocket: WebSocket | null = null;
|
||||||
this.socketConnection.socket.disconnect();
|
private connectionAttemptId = 0; // Increment on each connect attempt to invalidate old timers
|
||||||
|
|
||||||
|
/**
|
||||||
|
* disconnect from the server
|
||||||
|
*/
|
||||||
|
public async disconnect(useAutoReconnectSetting = false) {
|
||||||
|
if (this.disconnectRunning) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.disconnectRunning = true;
|
||||||
|
this.updateStatus('disconnecting');
|
||||||
|
this.tagStoreSubscription?.unsubscribe();
|
||||||
|
|
||||||
|
// Store reference to current socket before cleanup
|
||||||
|
const socketToClose = this.currentSocket;
|
||||||
|
this.currentSocket = null;
|
||||||
|
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.disconnect();
|
||||||
this.socketConnection = undefined;
|
this.socketConnection = undefined;
|
||||||
plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
|
logger.log('ok', 'disconnected socket!');
|
||||||
done.resolve();
|
} else if (!socketToClose) {
|
||||||
return done.promise;
|
this.disconnectRunning = false;
|
||||||
|
logger.log('warn', 'tried to disconnect, without a SocketConnection');
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
public serverCall(functionNameArg: string, dataArg: any) {
|
logger.log('warn', `disconnected from server ${this.remoteShortId}`);
|
||||||
const done = plugins.smartpromise.defer();
|
this.remoteShortId = null;
|
||||||
const socketRequest = new SocketRequest(this, {
|
|
||||||
|
if (this.autoReconnect && useAutoReconnectSetting && this.eventStatus !== 'connecting') {
|
||||||
|
this.updateStatus('connecting');
|
||||||
|
|
||||||
|
// Check if we've exceeded the maximum number of retries
|
||||||
|
if (this.currentRetryCount >= this.maxRetries) {
|
||||||
|
logger.log('warn', `Maximum reconnection attempts (${this.maxRetries}) reached. Giving up.`);
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Increment retry counter
|
||||||
|
this.currentRetryCount++;
|
||||||
|
|
||||||
|
// Calculate backoff with jitter (±20% randomness)
|
||||||
|
const jitter = this.currentBackoffDelay * 0.2 * (Math.random() * 2 - 1);
|
||||||
|
const delay = Math.min(this.currentBackoffDelay + jitter, this.maxBackoffDelay);
|
||||||
|
|
||||||
|
logger.log('info', `Reconnect attempt ${this.currentRetryCount}/${this.maxRetries} in ${Math.round(delay)}ms`);
|
||||||
|
|
||||||
|
// Apply exponential backoff for next time (doubling with each attempt)
|
||||||
|
this.currentBackoffDelay = Math.min(this.currentBackoffDelay * 2, this.maxBackoffDelay);
|
||||||
|
|
||||||
|
await plugins.smartdelay.delayFor(delay);
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
this.isReconnecting = true;
|
||||||
|
await this.connect();
|
||||||
|
} else {
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stops the client completely
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
this.autoReconnect = false;
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
|
await this.disconnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* dispatches a server call
|
||||||
|
* @param functionNameArg
|
||||||
|
* @param dataArg
|
||||||
|
*/
|
||||||
|
public async serverCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
|
functionNameArg: T['method'],
|
||||||
|
dataArg: T['request']
|
||||||
|
): Promise<T['response']> {
|
||||||
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
side: 'requesting',
|
side: 'requesting',
|
||||||
originSocketConnection: this.socketConnection,
|
originSocketConnection: this.socketConnection,
|
||||||
shortId: plugins.shortid.generate(),
|
shortId: plugins.isounique.uni(),
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcName: functionNameArg,
|
funcName: functionNameArg,
|
||||||
funcDataArg: dataArg
|
funcDataArg: dataArg,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const response = await socketRequest.dispatch();
|
||||||
|
const result = response.funcDataArg;
|
||||||
|
return result;
|
||||||
}
|
}
|
||||||
});
|
|
||||||
socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
done.resolve(dataArg2.funcDataArg);
|
if (this.eventStatus !== statusArg) {
|
||||||
});
|
this.eventSubject.next(statusArg);
|
||||||
return done.promise;
|
}
|
||||||
|
this.eventStatus = statusArg;
|
||||||
|
|
||||||
|
// Reset reconnection state when connection is successful
|
||||||
|
if (statusArg === 'connected') {
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resets the reconnection state
|
||||||
|
*/
|
||||||
|
public resetReconnectionState() {
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,19 +1,15 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
import { SocketFunction } from './smartsocket.classes.socketfunction.js';
|
||||||
import {
|
import { SocketRequest, type ISocketRequestDataObject } from './smartsocket.classes.socketrequest.js';
|
||||||
SocketRequest,
|
|
||||||
ISocketRequestDataObject,
|
|
||||||
} from './smartsocket.classes.socketrequest';
|
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
|
||||||
|
|
||||||
// socket.io
|
// socket.io
|
||||||
import * as SocketIO from 'socket.io';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
|
|
||||||
@@ -28,23 +24,20 @@ export type TSocketConnectionSide = 'server' | 'client';
|
|||||||
export interface ISocketConnectionConstructorOptions {
|
export interface ISocketConnectionConstructorOptions {
|
||||||
alias: string;
|
alias: string;
|
||||||
authenticated: boolean;
|
authenticated: boolean;
|
||||||
role: SocketRole;
|
|
||||||
side: TSocketConnectionSide;
|
side: TSocketConnectionSide;
|
||||||
smartsocketHost: Smartsocket | SmartsocketClient;
|
smartsocketHost: Smartsocket | SmartsocketClient;
|
||||||
socket: SocketIO.Socket | SocketIOClient.Socket;
|
socket: WebSocket | pluginsTyped.ws.WebSocket;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for authentication data
|
* interface for authentication data
|
||||||
*/
|
*/
|
||||||
export interface ISocketConnectionAuthenticationObject {
|
export interface ISocketConnectionAuthenticationObject {
|
||||||
role: 'coreflowContainer';
|
alias: string;
|
||||||
password: 'somePassword';
|
|
||||||
alias: 'coreflow1';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
export let allSocketConnections = new Objectmap<SocketConnection>();
|
export let allSocketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class SocketConnection represents a websocket connection
|
* class SocketConnection represents a websocket connection
|
||||||
@@ -53,60 +46,216 @@ export class SocketConnection {
|
|||||||
public alias: string;
|
public alias: string;
|
||||||
public side: TSocketConnectionSide;
|
public side: TSocketConnectionSide;
|
||||||
public authenticated: boolean = false;
|
public authenticated: boolean = false;
|
||||||
public role: SocketRole;
|
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
public socket: SocketIO.Socket | SocketIOClient.Socket;
|
public socket: WebSocket | pluginsTyped.ws.WebSocket;
|
||||||
|
|
||||||
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
|
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||||
|
|
||||||
|
private tagStore: interfaces.TTagStore = {};
|
||||||
|
public tagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
|
||||||
|
public remoteTagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
|
||||||
|
|
||||||
constructor(optionsArg: ISocketConnectionConstructorOptions) {
|
constructor(optionsArg: ISocketConnectionConstructorOptions) {
|
||||||
this.alias = optionsArg.alias;
|
this.alias = optionsArg.alias;
|
||||||
this.authenticated = optionsArg.authenticated;
|
this.authenticated = optionsArg.authenticated;
|
||||||
this.role = optionsArg.role;
|
|
||||||
this.side = optionsArg.side;
|
this.side = optionsArg.side;
|
||||||
this.smartsocketRef = optionsArg.smartsocketHost;
|
this.smartsocketRef = optionsArg.smartsocketHost;
|
||||||
this.socket = optionsArg.socket;
|
this.socket = optionsArg.socket;
|
||||||
|
|
||||||
// standard behaviour that is always true
|
// standard behaviour that is always true
|
||||||
allSocketConnections.add(this);
|
allSocketConnections.add(this);
|
||||||
this.socket.on('disconnect', () => {
|
}
|
||||||
plugins.smartlog.defaultLogger.log(
|
|
||||||
'info',
|
/**
|
||||||
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
|
* Sends a message through the socket
|
||||||
|
*/
|
||||||
|
public sendMessage(message: interfaces.ISocketMessage): void {
|
||||||
|
if (this.socket.readyState === 1) { // WebSocket.OPEN
|
||||||
|
this.socket.send(JSON.stringify(message));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles incoming messages
|
||||||
|
*/
|
||||||
|
public handleMessage(messageData: interfaces.ISocketMessage): void {
|
||||||
|
switch (messageData.type) {
|
||||||
|
case 'function':
|
||||||
|
this.handleFunctionCall(messageData);
|
||||||
|
break;
|
||||||
|
case 'functionResponse':
|
||||||
|
this.handleFunctionResponse(messageData);
|
||||||
|
break;
|
||||||
|
case 'tagUpdate':
|
||||||
|
this.handleTagUpdate(messageData);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
// Authentication messages are handled by the server/client classes
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleFunctionCall(messageData: interfaces.ISocketMessage): void {
|
||||||
|
const requestData: ISocketRequestDataObject<any> = {
|
||||||
|
funcCallData: {
|
||||||
|
funcName: messageData.payload.funcName,
|
||||||
|
funcDataArg: messageData.payload.funcData,
|
||||||
|
},
|
||||||
|
shortId: messageData.id,
|
||||||
|
};
|
||||||
|
|
||||||
|
const referencedFunction: SocketFunction<any> =
|
||||||
|
this.smartsocketRef.socketFunctions.findSync((socketFunctionArg) => {
|
||||||
|
return socketFunctionArg.name === requestData.funcCallData.funcName;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (referencedFunction) {
|
||||||
|
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
||||||
|
side: 'responding',
|
||||||
|
originSocketConnection: this,
|
||||||
|
shortId: requestData.shortId,
|
||||||
|
funcCallData: requestData.funcCallData,
|
||||||
|
});
|
||||||
|
localSocketRequest.createResponse();
|
||||||
|
} else {
|
||||||
|
logger.log('warn', `function ${requestData.funcCallData.funcName} not found or out of scope`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleFunctionResponse(messageData: interfaces.ISocketMessage): void {
|
||||||
|
const responseData: ISocketRequestDataObject<any> = {
|
||||||
|
funcCallData: {
|
||||||
|
funcName: messageData.payload.funcName,
|
||||||
|
funcDataArg: messageData.payload.funcData,
|
||||||
|
},
|
||||||
|
shortId: messageData.id,
|
||||||
|
};
|
||||||
|
|
||||||
|
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
||||||
|
this.smartsocketRef,
|
||||||
|
responseData.shortId
|
||||||
);
|
);
|
||||||
this.socket.disconnect();
|
if (targetSocketRequest) {
|
||||||
allSocketConnections.remove(this);
|
targetSocketRequest.handleResponse(responseData);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleTagUpdate(messageData: interfaces.ISocketMessage): void {
|
||||||
|
const tagStoreArg = messageData.payload.tags as interfaces.TTagStore;
|
||||||
|
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
|
||||||
|
this.tagStore = tagStoreArg;
|
||||||
|
// Echo back to confirm
|
||||||
|
this.sendMessage({
|
||||||
|
type: 'tagUpdate',
|
||||||
|
payload: { tags: this.tagStore },
|
||||||
|
});
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
}
|
||||||
|
this.remoteTagStoreObservable.next(tagStoreArg);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a tag to a connection
|
||||||
|
*/
|
||||||
|
public async addTag(tagArg: interfaces.ITag) {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
|
||||||
|
if (!remoteTagStore[tagArg.id]) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const localTagString = plugins.smartjson.stringify(tagArg);
|
||||||
|
const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
|
||||||
|
if (localTagString === remoteTagString) {
|
||||||
|
remoteSubscription.unsubscribe();
|
||||||
|
done.resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
this.sendMessage({
|
||||||
|
type: 'tagUpdate',
|
||||||
|
payload: { tags: this.tagStore },
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a tag by id
|
||||||
|
* @param tagIdArg
|
||||||
|
*/
|
||||||
|
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
return this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes a tag from a connection
|
||||||
|
*/
|
||||||
|
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
delete this.tagStore[tagIdArg];
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
this.sendMessage({
|
||||||
|
type: 'tagUpdate',
|
||||||
|
payload: { tags: this.tagStore },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// authenticating --------------------------
|
// authenticating --------------------------
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* authenticate the socket
|
* authenticate the socket (server side)
|
||||||
*/
|
*/
|
||||||
public authenticate() {
|
public authenticate(): Promise<SocketConnection> {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer<SocketConnection>();
|
||||||
this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
|
|
||||||
plugins.smartlog.defaultLogger.log(
|
// Set up message handler for authentication
|
||||||
'info',
|
const messageHandler = (event: MessageEvent | { data: string }) => {
|
||||||
'received authentication data. now hashing and comparing...'
|
try {
|
||||||
);
|
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||||
this.socket.removeListener('dataAuth', () => {});
|
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||||
if (SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
|
|
||||||
// TODO: authenticate password
|
if (message.type === 'auth') {
|
||||||
this.alias = dataArg.alias;
|
const authData = message.payload as interfaces.IAuthPayload;
|
||||||
|
logger.log('info', 'received authentication data...');
|
||||||
|
|
||||||
|
if (authData.alias) {
|
||||||
|
this.alias = authData.alias;
|
||||||
this.authenticated = true;
|
this.authenticated = true;
|
||||||
this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
|
|
||||||
this.socket.emit('authenticated');
|
// Send authentication response
|
||||||
plugins.smartlog.defaultLogger.log(
|
this.sendMessage({
|
||||||
'ok',
|
type: 'authResponse',
|
||||||
`socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`
|
payload: { success: true },
|
||||||
);
|
});
|
||||||
|
|
||||||
|
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
|
||||||
done.resolve(this);
|
done.resolve(this);
|
||||||
} else {
|
} else {
|
||||||
this.authenticated = false;
|
this.authenticated = false;
|
||||||
this.socket.disconnect();
|
this.sendMessage({
|
||||||
done.reject('not authenticated');
|
type: 'authResponse',
|
||||||
}
|
payload: { success: false, error: 'No alias provided' },
|
||||||
});
|
});
|
||||||
this.socket.emit('requestAuth');
|
this.disconnect();
|
||||||
|
done.reject('a socket tried to connect, but could not authenticate.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
// Not a valid message, ignore
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
this.socket.addEventListener('message', messageHandler as any);
|
||||||
|
|
||||||
|
// Request authentication
|
||||||
|
const requestAuthPayload: interfaces.TAuthRequestMessage = {
|
||||||
|
type: 'authRequest',
|
||||||
|
payload: {
|
||||||
|
serverAlias: (this.smartsocketRef as Smartsocket).alias,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
this.sendMessage(requestAuthPayload);
|
||||||
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -118,50 +267,45 @@ export class SocketConnection {
|
|||||||
public listenToFunctionRequests() {
|
public listenToFunctionRequests() {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
if (this.authenticated) {
|
if (this.authenticated) {
|
||||||
this.socket.on('function', (dataArg: ISocketRequestDataObject) => {
|
// Set up message handler for all messages
|
||||||
// check if requested function is available to the socket's scope
|
const messageHandler = (event: MessageEvent | { data: string }) => {
|
||||||
plugins.smartlog.defaultLogger.log('info', 'function request received');
|
try {
|
||||||
const referencedFunction: SocketFunction = this.role.allowedFunctions.find(
|
const data = typeof event.data === 'string' ? event.data : event.data.toString();
|
||||||
socketFunctionArg => {
|
const message: interfaces.ISocketMessage = JSON.parse(data);
|
||||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
this.handleMessage(message);
|
||||||
|
} catch (err) {
|
||||||
|
// Not a valid JSON message, ignore
|
||||||
}
|
}
|
||||||
);
|
};
|
||||||
if (referencedFunction !== undefined) {
|
|
||||||
plugins.smartlog.defaultLogger.log('ok', 'function in access scope');
|
this.socket.addEventListener('message', messageHandler as any);
|
||||||
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
|
||||||
side: 'responding',
|
logger.log(
|
||||||
originSocketConnection: this,
|
|
||||||
shortId: dataArg.shortId,
|
|
||||||
funcCallData: dataArg.funcCallData
|
|
||||||
});
|
|
||||||
localSocketRequest.createResponse(); // takes care of creating response and sending it back
|
|
||||||
} else {
|
|
||||||
plugins.smartlog.defaultLogger.log(
|
|
||||||
'warn',
|
|
||||||
'function not existent or out of access scope'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject) => {
|
|
||||||
plugins.smartlog.defaultLogger.log(
|
|
||||||
'info',
|
'info',
|
||||||
`received response for request with id ${dataArg.shortId}`
|
`now listening to function requests for ${this.alias} on side ${this.side}`
|
||||||
);
|
|
||||||
const targetSocketRequest = SocketRequest.getSocketRequestById(this.smartsocketRef, dataArg.shortId);
|
|
||||||
targetSocketRequest.handleResponse(dataArg);
|
|
||||||
});
|
|
||||||
plugins.smartlog.defaultLogger.log(
|
|
||||||
'info',
|
|
||||||
`now listening to function requests for ${this.alias}`
|
|
||||||
);
|
);
|
||||||
done.resolve(this);
|
done.resolve(this);
|
||||||
} else {
|
} else {
|
||||||
const errMessage = 'socket needs to be authenticated first';
|
const errMessage = 'socket needs to be authenticated first';
|
||||||
plugins.smartlog.defaultLogger.log('error', errMessage);
|
logger.log('error', errMessage);
|
||||||
done.reject(errMessage);
|
done.reject(errMessage);
|
||||||
}
|
}
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
// sending ----------------------
|
// disconnecting ----------------------
|
||||||
|
public async disconnect() {
|
||||||
|
if (this.socket.readyState === 1 || this.socket.readyState === 0) {
|
||||||
|
this.socket.close();
|
||||||
|
}
|
||||||
|
allSocketConnections.remove(this);
|
||||||
|
this.updateStatus('disconnected');
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
|
if (this.eventStatus !== statusArg) {
|
||||||
|
this.eventSubject.next(statusArg);
|
||||||
|
}
|
||||||
|
this.eventStatus = statusArg;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,90 +1,93 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface of the contructor options of class SocketFunction
|
* interface of the contructor options of class SocketFunction
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionConstructorOptions {
|
export interface ISocketFunctionConstructorOptions<
|
||||||
funcName: string;
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
funcDef: TFuncDef;
|
> {
|
||||||
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
funcName: T['method'];
|
||||||
|
funcDef: TFuncDef<T>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface of the Socket Function call, in other words the object that routes a call to a function
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionCall {
|
export interface ISocketFunctionCallDataRequest<
|
||||||
funcName: string;
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
funcDataArg: any;
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['request'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
|
*/
|
||||||
|
export interface ISocketFunctionCallDataResponse<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['response'];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for function definition of SocketFunction
|
* interface for function definition of SocketFunction
|
||||||
*/
|
*/
|
||||||
export type TFuncDef = (dataArg: any, connectionArg: SocketConnection) => PromiseLike<any>;
|
export type TFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
|
||||||
|
dataArg: T['request'],
|
||||||
|
connectionArg: SocketConnection
|
||||||
|
) => PromiseLike<T['response']>;
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class that respresents a function that can be transparently called using a SocketConnection
|
* class that respresents a function that can be transparently called using a SocketConnection
|
||||||
*/
|
*/
|
||||||
export class SocketFunction {
|
export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
// STATIC
|
// STATIC
|
||||||
public static getSocketFunctionByName (smartsocketRefArg: Smartsocket | SmartsocketClient, functionNameArg: string): SocketFunction {
|
public static getSocketFunctionByName<Q extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
console.log(smartsocketRefArg.socketFunctions);
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
return smartsocketRefArg.socketFunctions.find(socketFunctionArg => {
|
functionNameArg: string
|
||||||
|
): SocketFunction<Q> {
|
||||||
|
return smartsocketRefArg.socketFunctions.findSync((socketFunctionArg) => {
|
||||||
return socketFunctionArg.name === functionNameArg;
|
return socketFunctionArg.name === functionNameArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// INSTANCE
|
// INSTANCE
|
||||||
public name: string;
|
public name: string;
|
||||||
public funcDef: TFuncDef;
|
public funcDef: TFuncDef<T>;
|
||||||
public roles: SocketRole[];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the constructor for SocketFunction
|
* the constructor for SocketFunction
|
||||||
*/
|
*/
|
||||||
constructor(optionsArg: ISocketFunctionConstructorOptions) {
|
constructor(optionsArg: ISocketFunctionConstructorOptions<T>) {
|
||||||
this.name = optionsArg.funcName;
|
this.name = optionsArg.funcName;
|
||||||
this.funcDef = optionsArg.funcDef;
|
this.funcDef = optionsArg.funcDef;
|
||||||
this.roles = optionsArg.allowedRoles;
|
|
||||||
for (const socketRoleArg of this.roles) {
|
|
||||||
this._notifyRole(socketRoleArg);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* invokes the function of this SocketFunction
|
* invokes the function of this SocketFunction
|
||||||
*/
|
*/
|
||||||
public invoke(dataArg: ISocketFunctionCall, socketConnectionArg: SocketConnection): Promise<any> {
|
public async invoke(
|
||||||
const done = plugins.smartpromise.defer();
|
dataArg: ISocketFunctionCallDataRequest<T>,
|
||||||
|
socketConnectionArg: SocketConnection
|
||||||
|
): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
if (dataArg.funcName === this.name) {
|
if (dataArg.funcName === this.name) {
|
||||||
this.funcDef(dataArg.funcDataArg, socketConnectionArg).then((resultData: any) => {
|
const funcResponseData: ISocketFunctionCallDataResponse<T> = {
|
||||||
const funcResponseData: ISocketFunctionCall = {
|
|
||||||
funcName: this.name,
|
funcName: this.name,
|
||||||
funcDataArg: resultData
|
funcDataArg: await this.funcDef(dataArg.funcDataArg, socketConnectionArg),
|
||||||
};
|
};
|
||||||
done.resolve(funcResponseData);
|
return funcResponseData;
|
||||||
});
|
|
||||||
} else {
|
} else {
|
||||||
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
||||||
}
|
}
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* notifies a role about access to this SocketFunction
|
|
||||||
*/
|
|
||||||
private _notifyRole(socketRoleArg: SocketRole) {
|
|
||||||
socketRoleArg.addSocketFunction(this);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,18 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
// import interfaces
|
// import interfaces
|
||||||
import { SocketFunction, ISocketFunctionCall } from './smartsocket.classes.socketfunction';
|
import {
|
||||||
|
SocketFunction,
|
||||||
|
type ISocketFunctionCallDataRequest,
|
||||||
|
type ISocketFunctionCallDataResponse,
|
||||||
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { logger } from './smartsocket.logging.js';
|
||||||
import { defaultLogger } from '@pushrocks/smartlog';
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
|
export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
|
||||||
@@ -17,30 +21,32 @@ export type TSocketRequestSide = 'requesting' | 'responding';
|
|||||||
/**
|
/**
|
||||||
* interface of constructor of class SocketRequest
|
* interface of constructor of class SocketRequest
|
||||||
*/
|
*/
|
||||||
export interface SocketRequestConstructorOptions {
|
export interface ISocketRequestConstructorOptions<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
side: TSocketRequestSide;
|
side: TSocketRequestSide;
|
||||||
originSocketConnection: SocketConnection;
|
originSocketConnection: SocketConnection;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
funcCallData?: ISocketFunctionCall;
|
funcCallData?: ISocketFunctionCallDataRequest<T>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* request object that is sent initially and may or may not receive a response
|
* request object that is sent initially and may or may not receive a response
|
||||||
*/
|
*/
|
||||||
export interface ISocketRequestDataObject {
|
export interface ISocketRequestDataObject<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
funcCallData: ISocketFunctionCall;
|
funcCallData: ISocketFunctionCallDataRequest<T> | ISocketFunctionCallDataResponse<T>;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
responseTimeout?: number;
|
responseTimeout?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
export class SocketRequest {
|
export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
// STATIC
|
// STATIC
|
||||||
public static getSocketRequestById(
|
public static getSocketRequestById(
|
||||||
smartsocketRef: Smartsocket | SmartsocketClient,
|
smartsocketRef: Smartsocket | SmartsocketClient,
|
||||||
shortIdArg: string
|
shortIdArg: string
|
||||||
): SocketRequest {
|
): SocketRequest<any> {
|
||||||
return smartsocketRef.socketRequests.find(socketRequestArg => {
|
return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
|
||||||
return socketRequestArg.shortid === shortIdArg;
|
return socketRequestArg.shortid === shortIdArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -50,13 +56,15 @@ export class SocketRequest {
|
|||||||
public side: TSocketRequestSide;
|
public side: TSocketRequestSide;
|
||||||
public shortid: string;
|
public shortid: string;
|
||||||
public originSocketConnection: SocketConnection;
|
public originSocketConnection: SocketConnection;
|
||||||
public funcCallData: ISocketFunctionCall;
|
public funcCallData: ISocketFunctionCallDataRequest<T>;
|
||||||
public done = plugins.smartpromise.defer();
|
public done = plugins.smartpromise.defer<ISocketFunctionCallDataResponse<T>>();
|
||||||
|
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
|
|
||||||
|
constructor(
|
||||||
constructor(smartsocketRefArg: Smartsocket | SmartsocketClient, optionsArg: SocketRequestConstructorOptions) {
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
|
optionsArg: ISocketRequestConstructorOptions<T>
|
||||||
|
) {
|
||||||
this.smartsocketRef = smartsocketRefArg;
|
this.smartsocketRef = smartsocketRefArg;
|
||||||
this.side = optionsArg.side;
|
this.side = optionsArg.side;
|
||||||
this.shortid = optionsArg.shortId;
|
this.shortid = optionsArg.shortId;
|
||||||
@@ -70,20 +78,23 @@ export class SocketRequest {
|
|||||||
/**
|
/**
|
||||||
* dispatches a socketrequest from the requesting to the receiving side
|
* dispatches a socketrequest from the requesting to the receiving side
|
||||||
*/
|
*/
|
||||||
public dispatch() {
|
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
const requestData: ISocketRequestDataObject = {
|
const message: interfaces.ISocketMessage<interfaces.IFunctionCallPayload> = {
|
||||||
funcCallData: this.funcCallData,
|
type: 'function',
|
||||||
shortId: this.shortid
|
id: this.shortid,
|
||||||
|
payload: {
|
||||||
|
funcName: this.funcCallData.funcName,
|
||||||
|
funcData: this.funcCallData.funcDataArg,
|
||||||
|
},
|
||||||
};
|
};
|
||||||
this.originSocketConnection.socket.emit('function', requestData);
|
this.originSocketConnection.sendMessage(message);
|
||||||
return this.done.promise;
|
return this.done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* handles the response that is received by the requesting side
|
* handles the response that is received by the requesting side
|
||||||
*/
|
*/
|
||||||
public handleResponse(responseDataArg: ISocketRequestDataObject) {
|
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
||||||
plugins.smartlog.defaultLogger.log('info', 'handling response!');
|
|
||||||
this.done.resolve(responseDataArg.funcCallData);
|
this.done.resolve(responseDataArg.funcCallData);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
}
|
}
|
||||||
@@ -94,27 +105,28 @@ export class SocketRequest {
|
|||||||
* creates the response on the responding side
|
* creates the response on the responding side
|
||||||
*/
|
*/
|
||||||
public async createResponse(): Promise<void> {
|
public async createResponse(): Promise<void> {
|
||||||
const targetSocketFunction: SocketFunction = SocketFunction.getSocketFunctionByName(
|
const targetSocketFunction: SocketFunction<T> = SocketFunction.getSocketFunctionByName(
|
||||||
this.smartsocketRef,
|
this.smartsocketRef,
|
||||||
this.funcCallData.funcName
|
this.funcCallData.funcName
|
||||||
);
|
);
|
||||||
|
|
||||||
if (!targetSocketFunction) {
|
if (!targetSocketFunction) {
|
||||||
defaultLogger.log(
|
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
||||||
'warn',
|
|
||||||
`There is no SocketFunction defined for ${this.funcCallData.funcName}`
|
|
||||||
);
|
|
||||||
defaultLogger.log('warn', `So now response is being sent.`);
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
plugins.smartlog.defaultLogger.log('info', `invoking ${targetSocketFunction.name}`);
|
|
||||||
targetSocketFunction.invoke(this.funcCallData, this.originSocketConnection).then(resultData => {
|
targetSocketFunction
|
||||||
plugins.smartlog.defaultLogger.log('info', 'got resultData. Sending it to requesting party.');
|
.invoke(this.funcCallData, this.originSocketConnection)
|
||||||
const requestData: ISocketRequestDataObject = {
|
.then((resultData) => {
|
||||||
funcCallData: resultData,
|
const message: interfaces.ISocketMessage<interfaces.IFunctionCallPayload> = {
|
||||||
shortId: this.shortid
|
type: 'functionResponse',
|
||||||
|
id: this.shortid,
|
||||||
|
payload: {
|
||||||
|
funcName: resultData.funcName,
|
||||||
|
funcData: resultData.funcDataArg,
|
||||||
|
},
|
||||||
};
|
};
|
||||||
this.originSocketConnection.socket.emit('functionResponse', requestData);
|
this.originSocketConnection.sendMessage(message);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
|
||||||
|
|
||||||
|
|
||||||
// import classes
|
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
|
||||||
import { ISocketConnectionAuthenticationObject } from './smartsocket.classes.socketconnection';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* interface for class SocketRole
|
|
||||||
*/
|
|
||||||
export interface SocketRoleOptions {
|
|
||||||
name: string;
|
|
||||||
passwordHash: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A socketrole defines access to certain routines.
|
|
||||||
*/
|
|
||||||
export class SocketRole {
|
|
||||||
// STATIC
|
|
||||||
public static getSocketRoleByName(
|
|
||||||
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
|
||||||
socketRoleNameArg: string,
|
|
||||||
): SocketRole{
|
|
||||||
return referenceSmartsocket.socketRoles.find(socketRoleArg => {
|
|
||||||
return socketRoleArg.name === socketRoleNameArg;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
public static checkPasswordForRole (
|
|
||||||
dataArg: ISocketConnectionAuthenticationObject,
|
|
||||||
referenceSmartsocket: Smartsocket | SmartsocketClient
|
|
||||||
): boolean {
|
|
||||||
const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role).passwordHash;
|
|
||||||
const computedCompareHash = plugins.smarthash.sha256FromStringSync(dataArg.password);
|
|
||||||
return targetPasswordHash === computedCompareHash;
|
|
||||||
}
|
|
||||||
|
|
||||||
// INSTANCE
|
|
||||||
public name: string;
|
|
||||||
public passwordHash: string;
|
|
||||||
public allowedFunctions = new Objectmap<SocketFunction>();
|
|
||||||
constructor(optionsArg: SocketRoleOptions) {
|
|
||||||
this.name = optionsArg.name;
|
|
||||||
this.passwordHash = optionsArg.passwordHash;
|
|
||||||
}
|
|
||||||
public addSocketFunction(socketFunctionArg: SocketFunction) {
|
|
||||||
this.allowedFunctions.add(socketFunctionArg);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,77 +1,203 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
|
||||||
// used in case no other server is supplied
|
// used in case no other server is supplied
|
||||||
import * as http from 'http';
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class socketServer
|
* class SocketServer
|
||||||
* handles the attachment of socketIo to whatever server is in play
|
* handles the WebSocket server in standalone mode, or provides hooks for smartserve integration
|
||||||
*/
|
*/
|
||||||
export class SocketServer {
|
export class SocketServer {
|
||||||
private smartsocket: Smartsocket;
|
private smartsocket: Smartsocket;
|
||||||
private httpServer: http.Server;
|
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
||||||
// wether httpServer is standalone
|
private wsServer: pluginsTyped.ws.WebSocketServer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* whether httpServer is standalone (created by us)
|
||||||
|
*/
|
||||||
private standaloneServer = false;
|
private standaloneServer = false;
|
||||||
private expressServer: any;
|
|
||||||
|
|
||||||
constructor(smartSocketInstance: Smartsocket) {
|
constructor(smartSocketInstance: Smartsocket) {
|
||||||
this.smartsocket = smartSocketInstance;
|
this.smartsocket = smartSocketInstance;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* starts the server with another server
|
* Starts listening to incoming websocket connections (standalone mode).
|
||||||
* also works with an express style server
|
* If no port is specified, this is a no-op (hooks mode via smartserve).
|
||||||
*/
|
|
||||||
public async setExternalServer(
|
|
||||||
serverType: 'smartexpress',
|
|
||||||
serverArg: plugins.smartexpress.Server
|
|
||||||
) {
|
|
||||||
await serverArg.startedPromise;
|
|
||||||
this.httpServer = serverArg.httpServer;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* gets the server for socket.io
|
|
||||||
*/
|
|
||||||
public getServerForSocketIo() {
|
|
||||||
if (this.httpServer) {
|
|
||||||
return this.httpServer;
|
|
||||||
} else {
|
|
||||||
this.httpServer = new http.Server();
|
|
||||||
this.standaloneServer = true;
|
|
||||||
return this.httpServer;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* starts listening to incoming sockets:
|
|
||||||
*/
|
*/
|
||||||
public async start() {
|
public async start() {
|
||||||
const done = plugins.smartpromise.defer();
|
// If no port specified, we're in hooks mode - nothing to start
|
||||||
|
|
||||||
// handle http servers
|
|
||||||
// in case an external server has been set "this.standaloneServer" should be false
|
|
||||||
if (this.httpServer && this.standaloneServer) {
|
|
||||||
if (!this.smartsocket.options.port) {
|
if (!this.smartsocket.options.port) {
|
||||||
console.log('there should be a port specifed for smartsocket!');
|
return;
|
||||||
throw new Error('there should be a port specified for smartsocket');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Standalone mode - create our own HTTP server and WebSocket server
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
const httpModule = await this.smartsocket.smartenv.getSafeNodeModule('http');
|
||||||
|
const wsModule = await this.smartsocket.smartenv.getSafeNodeModule('ws');
|
||||||
|
|
||||||
|
this.httpServer = httpModule.createServer();
|
||||||
|
this.standaloneServer = true;
|
||||||
|
|
||||||
|
// Create WebSocket server attached to HTTP server
|
||||||
|
this.wsServer = new wsModule.WebSocketServer({ server: this.httpServer });
|
||||||
|
|
||||||
|
this.wsServer.on('connection', (ws: pluginsTyped.ws.WebSocket) => {
|
||||||
|
this.smartsocket.handleNewConnection(ws);
|
||||||
|
});
|
||||||
|
|
||||||
this.httpServer.listen(this.smartsocket.options.port, () => {
|
this.httpServer.listen(this.smartsocket.options.port, () => {
|
||||||
console.log(`Server started in standalone mode on ${this.smartsocket.options.port}`);
|
logger.log(
|
||||||
|
'success',
|
||||||
|
`Server started in standalone mode on port ${this.smartsocket.options.port}`
|
||||||
|
);
|
||||||
done.resolve();
|
done.resolve();
|
||||||
});
|
});
|
||||||
} else {
|
|
||||||
done.resolve();
|
|
||||||
}
|
|
||||||
|
|
||||||
// nothing else to do if express server is set
|
|
||||||
await done.promise;
|
await done.promise;
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* closes the server
|
* closes the server
|
||||||
*/
|
*/
|
||||||
public async stop() {}
|
public async stop() {
|
||||||
|
const done = plugins.smartpromise.defer<void>();
|
||||||
|
let resolved = false;
|
||||||
|
|
||||||
|
if (this.wsServer) {
|
||||||
|
// Close all WebSocket connections
|
||||||
|
this.wsServer.clients.forEach((client) => {
|
||||||
|
client.terminate();
|
||||||
|
});
|
||||||
|
this.wsServer.close();
|
||||||
|
this.wsServer = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.httpServer && this.standaloneServer) {
|
||||||
|
const resolveOnce = () => {
|
||||||
|
if (!resolved) {
|
||||||
|
resolved = true;
|
||||||
|
this.httpServer = null;
|
||||||
|
this.standaloneServer = false;
|
||||||
|
done.resolve();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
this.httpServer.close(() => {
|
||||||
|
resolveOnce();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Add a timeout in case close callback doesn't fire
|
||||||
|
const timeoutId = setTimeout(() => {
|
||||||
|
resolveOnce();
|
||||||
|
}, 2000);
|
||||||
|
|
||||||
|
// Ensure timeout doesn't keep process alive
|
||||||
|
if (timeoutId.unref) {
|
||||||
|
timeoutId.unref();
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
done.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
await done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns WebSocket hooks for integration with smartserve.
|
||||||
|
* Pass these hooks to SmartServe's websocket config.
|
||||||
|
*/
|
||||||
|
public getSmartserveWebSocketHooks(): pluginsTyped.ISmartserveWebSocketHooks {
|
||||||
|
return {
|
||||||
|
onOpen: async (peer: pluginsTyped.ISmartserveWebSocketPeer) => {
|
||||||
|
// Create a wrapper that adapts ISmartserveWebSocketPeer to WebSocket-like interface
|
||||||
|
const wsLikeSocket = this.createWsLikeFromPeer(peer);
|
||||||
|
await this.smartsocket.handleNewConnection(wsLikeSocket as any);
|
||||||
|
},
|
||||||
|
onMessage: async (peer: pluginsTyped.ISmartserveWebSocketPeer, message: pluginsTyped.ISmartserveWebSocketMessage) => {
|
||||||
|
// Dispatch message to the SocketConnection via the adapter
|
||||||
|
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||||
|
if (adapter) {
|
||||||
|
let textData: string | undefined;
|
||||||
|
if (message.type === 'text' && message.text) {
|
||||||
|
textData = message.text;
|
||||||
|
} else if (message.type === 'binary' && message.data) {
|
||||||
|
// Convert binary to text (Buffer/Uint8Array to string)
|
||||||
|
textData = new TextDecoder().decode(message.data);
|
||||||
|
}
|
||||||
|
if (textData) {
|
||||||
|
adapter.dispatchMessage(textData);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onClose: async (peer: pluginsTyped.ISmartserveWebSocketPeer, code: number, reason: string) => {
|
||||||
|
// Dispatch close to the SocketConnection via the adapter
|
||||||
|
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||||
|
if (adapter) {
|
||||||
|
adapter.dispatchClose();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onError: async (peer: pluginsTyped.ISmartserveWebSocketPeer, error: Error) => {
|
||||||
|
// Dispatch error to the SocketConnection via the adapter
|
||||||
|
const adapter = peer.data.get('smartsocket_adapter') as any;
|
||||||
|
if (adapter) {
|
||||||
|
adapter.dispatchError();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a WebSocket-like object from a smartserve peer
|
||||||
|
* This allows our SocketConnection to work with both native WebSocket and smartserve peers
|
||||||
|
*/
|
||||||
|
private createWsLikeFromPeer(peer: pluginsTyped.ISmartserveWebSocketPeer): any {
|
||||||
|
const messageListeners: Array<(event: any) => void> = [];
|
||||||
|
const closeListeners: Array<() => void> = [];
|
||||||
|
const errorListeners: Array<() => void> = [];
|
||||||
|
|
||||||
|
// Store the adapter on the peer for message routing
|
||||||
|
peer.data.set('smartsocket_adapter', {
|
||||||
|
dispatchMessage: (data: string) => {
|
||||||
|
messageListeners.forEach((listener) => {
|
||||||
|
listener({ data });
|
||||||
|
});
|
||||||
|
},
|
||||||
|
dispatchClose: () => {
|
||||||
|
closeListeners.forEach((listener) => listener());
|
||||||
|
},
|
||||||
|
dispatchError: () => {
|
||||||
|
errorListeners.forEach((listener) => listener());
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
readyState: peer.readyState,
|
||||||
|
send: (data: string) => peer.send(data),
|
||||||
|
close: (code?: number, reason?: string) => peer.close(code, reason),
|
||||||
|
addEventListener: (event: string, listener: any) => {
|
||||||
|
if (event === 'message') {
|
||||||
|
messageListeners.push(listener);
|
||||||
|
} else if (event === 'close') {
|
||||||
|
closeListeners.push(listener);
|
||||||
|
} else if (event === 'error') {
|
||||||
|
errorListeners.push(listener);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
removeEventListener: (event: string, listener: any) => {
|
||||||
|
if (event === 'message') {
|
||||||
|
const idx = messageListeners.indexOf(listener);
|
||||||
|
if (idx >= 0) messageListeners.splice(idx, 1);
|
||||||
|
} else if (event === 'close') {
|
||||||
|
const idx = closeListeners.indexOf(listener);
|
||||||
|
if (idx >= 0) closeListeners.splice(idx, 1);
|
||||||
|
} else if (event === 'error') {
|
||||||
|
const idx = errorListeners.indexOf(listener);
|
||||||
|
if (idx >= 0) errorListeners.splice(idx, 1);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
3
ts/smartsocket.logging.ts
Normal file
3
ts/smartsocket.logging.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
|
||||||
|
export const logger = new plugins.smartlog.ConsoleLog();
|
||||||
@@ -1,21 +1,29 @@
|
|||||||
import * as lik from '@pushrocks/lik';
|
// apiglobal scope
|
||||||
import * as smartlog from '@pushrocks/smartlog';
|
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
export { typedrequestInterfaces };
|
||||||
import * as smartexpress from '@pushrocks/smartexpress';
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
// pushrocks scope
|
||||||
import * as shortid from 'shortid';
|
import * as isohash from '@push.rocks/isohash';
|
||||||
import socketIo from 'socket.io';
|
import * as isounique from '@push.rocks/isounique';
|
||||||
import socketIoClient from 'socket.io-client';
|
import * as lik from '@push.rocks/lik';
|
||||||
|
import * as smartenv from '@push.rocks/smartenv';
|
||||||
|
import * as smartjson from '@push.rocks/smartjson';
|
||||||
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
|
|
||||||
export {
|
export {
|
||||||
|
isohash,
|
||||||
|
isounique,
|
||||||
lik,
|
lik,
|
||||||
|
smartenv,
|
||||||
|
smartjson,
|
||||||
smartlog,
|
smartlog,
|
||||||
smarthash,
|
|
||||||
smartdelay,
|
smartdelay,
|
||||||
smartexpress,
|
|
||||||
smartpromise,
|
smartpromise,
|
||||||
shortid,
|
smarttime,
|
||||||
socketIo,
|
smartrx,
|
||||||
socketIoClient
|
|
||||||
};
|
};
|
||||||
|
|||||||
46
ts/smartsocket.pluginstyped.ts
Normal file
46
ts/smartsocket.pluginstyped.ts
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
// node native
|
||||||
|
import type * as http from 'http';
|
||||||
|
import type * as https from 'https';
|
||||||
|
|
||||||
|
export type { http, https };
|
||||||
|
|
||||||
|
// third party scope - ws types
|
||||||
|
import type * as wsTypes from 'ws';
|
||||||
|
|
||||||
|
export namespace ws {
|
||||||
|
export type WebSocket = wsTypes.WebSocket;
|
||||||
|
export type WebSocketServer = wsTypes.WebSocketServer;
|
||||||
|
export type RawData = wsTypes.RawData;
|
||||||
|
}
|
||||||
|
|
||||||
|
// smartserve compatibility interface (for setExternalServer)
|
||||||
|
// This mirrors the IWebSocketPeer interface from smartserve
|
||||||
|
export interface ISmartserveWebSocketPeer {
|
||||||
|
id: string;
|
||||||
|
url: string;
|
||||||
|
readyState: 0 | 1 | 2 | 3;
|
||||||
|
protocol: string;
|
||||||
|
extensions: string;
|
||||||
|
send(data: string): void;
|
||||||
|
sendBinary(data: Uint8Array | ArrayBuffer): void;
|
||||||
|
close(code?: number, reason?: string): void;
|
||||||
|
ping(data?: Uint8Array): void;
|
||||||
|
terminate(): void;
|
||||||
|
context: any;
|
||||||
|
data: Map<string, unknown>;
|
||||||
|
tags: Set<string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ISmartserveWebSocketMessage {
|
||||||
|
type: 'text' | 'binary';
|
||||||
|
text?: string;
|
||||||
|
data?: Uint8Array;
|
||||||
|
size: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ISmartserveWebSocketHooks {
|
||||||
|
onOpen?: (peer: ISmartserveWebSocketPeer) => void | Promise<void>;
|
||||||
|
onMessage?: (peer: ISmartserveWebSocketPeer, message: ISmartserveWebSocketMessage) => void | Promise<void>;
|
||||||
|
onClose?: (peer: ISmartserveWebSocketPeer, code: number, reason: string) => void | Promise<void>;
|
||||||
|
onError?: (peer: ISmartserveWebSocketPeer, error: Error) => void | Promise<void>;
|
||||||
|
}
|
||||||
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"
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user