Compare commits

...

52 Commits

Author SHA1 Message Date
5b21955e04 v3.0.0
Some checks failed
Default (tags) / security (push) Failing after 17s
Default (tags) / test (push) Failing after 13s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-12-03 09:22:44 +00:00
09dbb00179 BREAKING CHANGE(smartsocket): Replace setExternalServer with hooks-based SmartServe integration and refactor SocketServer to support standalone and hooks modes 2025-12-03 09:22:44 +00:00
1d62c9c695 Refactor smartsocket implementation for improved WebSocket handling and message protocol
- Updated test files to use new testing library and reduced test cycles for efficiency.
- Removed dependency on smartexpress and integrated direct WebSocket handling.
- Enhanced Smartsocket and SmartsocketClient classes to support new message types and authentication flow.
- Implemented a new message interface for structured communication between client and server.
- Added external server support for smartserve with appropriate WebSocket hooks.
- Improved connection management and error handling in SocketConnection and SocketRequest classes.
- Cleaned up code and removed deprecated socket.io references in favor of native WebSocket.
2025-12-03 02:20:38 +00:00
ee59471e14 2.1.0 2025-03-10 23:02:24 +00:00
da10b25214 feat(SmartsocketClient): Improve client reconnection logic with exponential backoff and jitter; update socket.io and @types/node dependencies 2025-03-10 23:02:24 +00:00
933f09d632 update description 2024-05-29 14:16:19 +02:00
eb330eaf7a 2.0.27 2024-04-26 15:36:09 +02:00
c2e856821d fix(core): update 2024-04-26 15:36:09 +02:00
653af3a3e7 2.0.26 2024-04-26 15:31:09 +02:00
4552a0527d fix(core): update 2024-04-26 15:31:08 +02:00
e39141e86b 2.0.25 2024-04-18 20:21:16 +02:00
bf6bda88e5 fix(core): update 2024-04-18 20:21:15 +02:00
fb555b33be update tsconfig 2024-04-14 18:20:36 +02:00
2e2826c52d update tsconfig 2024-04-01 21:41:07 +02:00
bca3bd92a5 update npmextra.json: githost 2024-04-01 19:59:41 +02:00
adc3f0935f update npmextra.json: githost 2024-03-30 21:48:42 +01:00
72430fdb0d 2.0.24 2023-09-10 10:41:41 +02:00
ee827dd5b3 fix(core): update 2023-09-10 10:41:41 +02:00
2aefae00de 2.0.23 2023-09-09 23:32:12 +02:00
6753a4fefc fix(core): update 2023-09-09 23:32:12 +02:00
8c5428baf8 2.0.22 2023-08-06 16:30:45 +02:00
69c1ad04dc fix(core): update 2023-08-06 16:30:44 +02:00
61d5301de8 2.0.21 2023-08-06 16:09:28 +02:00
72fa7f790c fix(core): update 2023-08-06 16:09:28 +02:00
dcc087c04d 2.0.20 2023-07-21 03:53:41 +02:00
c8556355c0 fix(core): update 2023-07-21 03:53:41 +02:00
9cfc41ace8 2.0.19 2023-03-29 19:02:35 +02:00
2827a1676b fix(core): update 2023-03-29 19:02:34 +02:00
424ad80b60 2.0.18 2023-03-29 16:15:31 +02:00
682a0c53ce fix(core): update 2023-03-29 16:15:30 +02:00
4fc09af779 2.0.17 2023-03-29 16:07:54 +02:00
f73d973383 fix(core): update 2023-03-29 16:07:54 +02:00
d87a942ab3 2.0.16 2023-03-20 18:51:02 +01:00
60e8657467 fix(core): update 2023-03-20 18:51:02 +01:00
5215be946e 2.0.15 2023-02-07 12:32:48 +01:00
b9c67666fa fix(core): update 2023-02-07 12:32:48 +01:00
4b0fb073e6 2.0.14 2022-12-29 13:28:11 +01:00
fc458b6827 fix(core): update 2022-12-29 13:28:11 +01:00
f27b9f8143 2.0.13 2022-12-29 11:18:16 +01:00
38058aba57 fix(core): update 2022-12-29 11:18:15 +01:00
ba38dae64f 2.0.12 2022-12-28 19:51:09 +01:00
69e862a6cf fix(core): update 2022-12-28 19:51:09 +01:00
4562ac355b 2.0.11 2022-12-28 14:02:15 +01:00
b029dc191e fix(core): update 2022-12-28 14:02:14 +01:00
2640275d04 2.0.10 2022-12-28 13:52:17 +01:00
7bbcc91300 fix(core): update 2022-12-28 13:52:16 +01:00
da39d52975 2.0.9 2022-12-28 13:51:41 +01:00
307469312f fix(core): update 2022-12-28 13:51:40 +01:00
0f3ff2b611 2.0.8 2022-12-28 13:49:03 +01:00
bce82d49b6 fix(core): update 2022-12-28 13:49:03 +01:00
0b10913995 2.0.7 2022-08-01 15:00:07 +02:00
7048585702 fix(core): update 2022-08-01 15:00:06 +02:00
27 changed files with 11878 additions and 19002 deletions

View File

@@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@@ -1,141 +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
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

View File

@@ -22,6 +22,5 @@
} }
} }
} }
], ]
"typescript.tsdk": "node_modules/typescript/lib"
} }

112
changelog.md Normal file
View 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 developerfacing 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

View File

@@ -2,17 +2,32 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartsocket", "gitrepo": "smartsocket",
"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.",
"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"
} }
} }

18329
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,46 +1,47 @@
{ {
"name": "@pushrocks/smartsocket", "name": "@push.rocks/smartsocket",
"version": "2.0.6", "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_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/ --verbose)",
"build": "(tsbuild --web --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)" "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": {
"@apiglobal/typedrequest-interfaces": "^1.0.15", "@api.global/typedrequest-interfaces": "^3.0.19",
"@pushrocks/isohash": "^2.0.0", "@push.rocks/isohash": "^2.0.1",
"@pushrocks/isounique": "^1.0.5", "@push.rocks/isounique": "^1.0.5",
"@pushrocks/lik": "^5.0.4", "@push.rocks/lik": "^6.2.2",
"@pushrocks/smartdelay": "^2.0.13", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartenv": "^5.0.0", "@push.rocks/smartenv": "^6.0.0",
"@pushrocks/smartexpress": "^4.0.2", "@push.rocks/smartjson": "^5.2.0",
"@pushrocks/smartjson": "^4.0.6", "@push.rocks/smartlog": "^3.1.10",
"@pushrocks/smartlog": "^2.0.44", "@push.rocks/smartpromise": "^4.2.3",
"@pushrocks/smartpromise": "^3.1.7", "@push.rocks/smartrx": "^3.0.10",
"@pushrocks/smartrx": "^2.0.25", "@push.rocks/smarttime": "^4.1.1",
"@pushrocks/smarttime": "^3.0.45", "ws": "^8.18.3"
"socket.io": "^4.4.1",
"socket.io-client": "^4.4.1"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.61", "@git.zone/tsbuild": "^3.1.2",
"@gitzone/tsrun": "^1.2.32", "@git.zone/tsbundle": "^2.6.3",
"@gitzone/tstest": "^1.0.69", "@git.zone/tsrun": "^2.0.0",
"@pushrocks/tapbundle": "^5.0.3", "@git.zone/tstest": "^3.1.3",
"@types/node": "^17.0.23" "@push.rocks/smartserve": "^1.1.0",
"@types/node": "^24.10.1",
"@types/ws": "^8.18.1"
}, },
"private": false, "private": false,
"files": [ "files": [
@@ -57,5 +58,18 @@
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "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

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@@ -0,0 +1 @@

349
readme.md
View File

@@ -1,122 +1,291 @@
# @pushrocks/smartsocket # @push.rocks/smartsocket
easy and secure websocket communication
## Availabililty and Links Easy and secure WebSocket communication with native WebSocket support 🔌
* [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 ## Features
Status Category | Status Badge - 🚀 **Native WebSocket** - Uses native WebSocket API (browser) and `ws` library (Node.js)
-- | -- - 🔄 **Auto Reconnection** - Exponential backoff with configurable retry limits
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartsocket/badges/master/pipeline.svg)](https://lossless.cloud) - 📡 **RPC-style Function Calls** - Define and call functions across server/client
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartsocket/badges/master/coverage.svg)](https://lossless.cloud) - 🏷️ **Connection Tagging** - Tag connections for easy identification and routing
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartsocket)](https://lossless.cloud) - 🔗 **Smartserve Integration** - Works seamlessly with `@push.rocks/smartserve`
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartsocket)](https://lossless.cloud) - 🔒 **Secure Communication** - WSS support for encrypted connections
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) ## Issue Reporting and Security
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartsocket)](https://lossless.cloud) 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.
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartsocket)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartsocket)](https://lossless.cloud) ## Install
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
```shell
npm install @push.rocks/smartsocket --save
```
or with pnpm:
```shell
pnpm add @push.rocks/smartsocket
```
## Usage ## Usage
Use TypeScript for best in class instellisense. ### Quick Start - Server
Under the hood we use socket.io and shortid for managed data exchange.
### Serverside
```typescript ```typescript
import * as smartsocket from 'smartsocket'; import { Smartsocket, SocketFunction } from '@push.rocks/smartsocket';
import * as q from q; // q is a promise library
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests. // Create server
let mySmartsocket = new smartsocket.Smartsocket({ const server = new Smartsocket({
port: 3000, // the port smartsocket will listen on alias: 'myServer',
port: 3000
}); });
// optional: // Define a function that clients can call
// run this with anothoer existing server like express const greetFunction = new SocketFunction({
declare var someExpressServer; // read the express docs about how express actually works funcName: 'greet',
mySmartsocket.setServer(someExpressServer); funcDef: async (data, socketConnection) => {
console.log(`Received greeting from ${data.name}`);
// A "SocketRole" can be referenced by "SocketFunction"s. return { message: `Hello, ${data.name}!` };
// 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". server.addSocketFunction(greetFunction);
// 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 // Start the server
// 1. the name of the "SocketFunction" on the client side await server.start();
// 2. the data to pass in console.log('WebSocket server running on port 3000');
// 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 ### Quick Start - Client
```typescript ```typescript
import * as smartsocket from 'smartsocket'; import { SmartsocketClient } from '@push.rocks/smartsocket';
// A "SmartsocketClient" is different from a "Smartsocket" in that it doesn't expose any public address. // Create client
// Thus any new "SocketConnection"s must be innitiated from a "SmartsocketClient". const client = new SmartsocketClient({
let testSmartsocketClient = new smartsocket.SmartsocketClient({
port: testConfig.port,
url: 'http://localhost', url: 'http://localhost',
password: 'testPassword', port: 3000,
alias: 'testClient1', alias: 'myClient',
role: 'testRole1', autoReconnect: true
}); });
// You can .connect() and .disconnect() from a "Smartsocket" // Connect to server
testSmartsocketClient.connect().then(() => { await client.connect();
done();
});
// The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once // Call server function
let testSocketFunction2 = new smartsocket.SocketFunction({ const response = await client.serverCall('greet', { name: 'Alice' });
funcName: 'testSocketFunction2', console.log(response.message); // "Hello, Alice!"
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. ### Connection Options
mySmartsocketClient.serverCall('function', functionCallData).then((functionResponseData) => {
// the functionResponseData comes from the server... awesome, right? 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)
}); });
``` ```
> **NOTE:** ### Two-Way Function Calls
> 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.
## Contribution Both server and client can define and call functions on each other:
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) ```typescript
// Server calling client
const clientFunction = new SocketFunction({
funcName: 'clientTask',
funcDef: async (data) => {
return { result: 'Task completed' };
}
});
For further information read the linked docs at the top of this readme. // On client
client.addSocketFunction(clientFunction);
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) // On server - call the client
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) const socketConnection = server.socketConnections.findSync(conn => conn.alias === 'myClient');
const result = await server.clientCall('clientTask', { task: 'doSomething' }, socketConnection);
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) ### 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.

View File

@@ -1,104 +0,0 @@
// tslint:disable-next-line:no-implicit-dependencies
import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
import * as isohash from '@pushrocks/isohash';
import * as smartexpress from '@pushrocks/smartexpress';
import * as smartsocket from '../ts/index.js';
let testSmartsocket: smartsocket.Smartsocket;
let testSmartsocketClient: smartsocket.SmartsocketClient;
let testSocketFunction1: smartsocket.SocketFunction<any>;
let myseServer: smartexpress.Server;
const testConfig = {
port: 3000,
};
// class smartsocket
tap.test('should create a new smartsocket', async () => {
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver', port: testConfig.port });
expect(testSmartsocket).toBeInstanceOf(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 SocketFunction
tap.test('should register a new Function', async () => {
testSocketFunction1 = new smartsocket.SocketFunction({
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',
alias: 'testClient1',
});
testSmartsocketClient.addSocketFunction(testSocketFunction1);
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 totalCycles = 20000;
let counter = 0;
let startTime = Date.now();
while (counter < totalCycles) {
const randomString = `hello ${Math.random()}`;
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
value1: randomString,
});
expect(response.value1).toEqual(randomString);
if (counter % 100 === 0) {
console.log(
`processed 100 more messages in ${Date.now() - startTime}ms. ${
totalCycles - counter
} messages to go.`
);
startTime = Date.now();
}
counter++;
}
});
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();

View File

@@ -1,5 +1,4 @@
// tslint:disable-next-line:no-implicit-dependencies import { expect, tap } from '@git.zone/tstest/tapbundle';
import { expect, tap } from '@pushrocks/tapbundle';
import * as smartsocket from '../ts/index.js'; import * as smartsocket from '../ts/index.js';
@@ -64,6 +63,9 @@ tap.test('should react to a new websocket connection from client', async () => {
url: 'http://localhost', url: 'http://localhost',
alias: 'testClient1', alias: 'testClient1',
autoReconnect: true, autoReconnect: true,
maxRetries: 20,
initialBackoffDelay: 500,
maxBackoffDelay: 3000,
}); });
testSmartsocketClient.addSocketFunction(testSocketFunctionClient); testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
await testSmartsocketClient.connect(); await testSmartsocketClient.connect();
@@ -129,7 +131,8 @@ tap.test('should be able to switch to a new server', async (toolsArg) => {
await testSmartsocket.stop(); await testSmartsocket.stop();
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port }); testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
await testSmartsocket.start(); await testSmartsocket.start();
await toolsArg.delayFor(30000); // 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) => { tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
@@ -149,4 +152,4 @@ tap.test('should close the server', async (tools) => {
tools.delayFor(1000).then(() => process.exit(0)); tools.delayFor(1000).then(() => process.exit(0));
}); });
tap.start(); export default tap.start();

91
test/test.smartserve.ts Normal file
View 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();

View File

@@ -1,5 +1,4 @@
// tslint:disable-next-line:no-implicit-dependencies import { expect, tap } from '@git.zone/tstest/tapbundle';
import { expect, tap } from '@pushrocks/tapbundle';
import * as smartsocket from '../ts/index.js'; import * as smartsocket from '../ts/index.js';
@@ -140,8 +139,10 @@ tap.test('should be able to locate a connection tag after reconnect', async (too
}); });
// terminate // terminate
tap.test('should close the server', async () => { tap.test('should close the server', async (tools) => {
await testSmartsocketClient.stop();
await testSmartsocket.stop(); await testSmartsocket.stop();
tools.delayFor(1000).then(() => process.exit(0));
}); });
tap.start(); export default tap.start();

8
ts/00_commitinfo_data.ts Normal file
View 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.'
}

View File

@@ -5,3 +5,6 @@ export * from './smartsocket.classes.smartsocketclient.js';
// export further classes and objects // export further classes and objects
export * from './smartsocket.classes.socketfunction.js'; export * from './smartsocket.classes.socketfunction.js';
export * from './smartsocket.classes.socketconnection.js'; export * from './smartsocket.classes.socketconnection.js';
// export types so they can be referred to
export * from './interfaces/index.js';

View File

@@ -1,2 +1,3 @@
export * from './connection.js'; export * from './connection.js';
export * from './tag.js'; export * from './tag.js';
export * from './message.js';

67
ts/interfaces/message.ts Normal file
View 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>;

View File

@@ -1,12 +1,13 @@
import * as plugins from './smartsocket.plugins.js'; import * as plugins from './smartsocket.plugins.js';
import * as pluginsTyped from './smartsocket.pluginstyped.js'; import * as pluginsTyped from './smartsocket.pluginstyped.js';
import * as interfaces from './interfaces/index.js';
// classes // classes
import { SocketConnection } from './smartsocket.classes.socketconnection.js'; import { SocketConnection } from './smartsocket.classes.socketconnection.js';
import { import {
ISocketFunctionCallDataRequest, type ISocketFunctionCallDataRequest,
SocketFunction, SocketFunction,
ISocketFunctionCallDataResponse, type ISocketFunctionCallDataResponse,
} from './smartsocket.classes.socketfunction.js'; } from './smartsocket.classes.socketfunction.js';
import { SocketRequest } from './smartsocket.classes.socketrequest.js'; import { SocketRequest } from './smartsocket.classes.socketrequest.js';
import { SocketServer } from './smartsocket.classes.socketserver.js'; import { SocketServer } from './smartsocket.classes.socketserver.js';
@@ -25,11 +26,12 @@ export class Smartsocket {
public alias: string; public alias: string;
public smartenv = new plugins.smartenv.Smartenv(); public smartenv = new plugins.smartenv.Smartenv();
public options: ISmartsocketConstructorOptions; public options: ISmartsocketConstructorOptions;
public io: pluginsTyped.socketIo.Server;
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>(); public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>(); public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>(); public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
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) {
@@ -37,21 +39,59 @@ export class Smartsocket {
this.alias = plugins.isounique.uni(this.options.alias); 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() {
const socketIoModule = await this.smartenv.getSafeNodeModule('socket.io');
this.io = new socketIoModule.Server(await 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);
}
} }
/** /**
@@ -61,15 +101,17 @@ export class Smartsocket {
await plugins.smartdelay.delayFor(1000); await plugins.smartdelay.delayFor(1000);
this.socketConnections.forEach((socketObjectArg: SocketConnection) => { this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
if (socketObjectArg) { if (socketObjectArg) {
logger.log('info', `disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`); logger.log(
'info',
`disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`
);
socketObjectArg.disconnect(); socketObjectArg.disconnect();
} }
}); });
this.socketConnections.wipe(); this.socketConnections.wipe();
this.io.close();
// stop the corresponging server // stop the corresponding server
this.socketServer.stop(); await this.socketServer.stop();
} }
// communication // communication
@@ -99,28 +141,4 @@ export class Smartsocket {
public addSocketFunction(socketFunction: SocketFunction<any>) { public addSocketFunction(socketFunction: SocketFunction<any>) {
this.socketFunctions.add(socketFunction); this.socketFunctions.add(socketFunction);
} }
/**
* the standard handler for new socket connections
*/
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
const socketConnection: SocketConnection = new SocketConnection({
alias: undefined,
authenticated: false,
side: 'server',
smartsocketHost: this,
socket: socketArg,
});
logger.log('info', 'Socket connected. Trying to authenticate...');
this.socketConnections.add(socketConnection);
const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
if (eventArg === 'disconnected') {
this.socketConnections.remove(socketConnection);
disconnectSubscription.unsubscribe();
}
});
await socketConnection.authenticate();
await socketConnection.listenToFunctionRequests();
await socketConnection.socket.emit('serverFullyReactive');
}
} }

View File

@@ -4,10 +4,10 @@ import * as interfaces from './interfaces/index.js';
import { SocketConnection } from './smartsocket.classes.socketconnection.js'; import { SocketConnection } from './smartsocket.classes.socketconnection.js';
import { import {
ISocketFunctionCallDataRequest, type ISocketFunctionCallDataRequest,
SocketFunction, SocketFunction,
} from './smartsocket.classes.socketfunction.js'; } from './smartsocket.classes.socketfunction.js';
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest.js'; import { type ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest.js';
import { logger } from './smartsocket.logging.js'; import { logger } from './smartsocket.logging.js';
/** /**
@@ -16,8 +16,11 @@ import { logger } from './smartsocket.logging.js';
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
autoReconnect?: boolean; autoReconnect?: boolean;
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 {
@@ -32,6 +35,11 @@ export class SmartsocketClient {
public serverUrl: string; public serverUrl: string;
public serverPort: number; public serverPort: number;
public autoReconnect: boolean; public autoReconnect: boolean;
public maxRetries: number;
public initialBackoffDelay: number;
public maxBackoffDelay: number;
public currentRetryCount = 0;
public currentBackoffDelay: number;
// status handling // status handling
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>(); public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
@@ -79,113 +87,172 @@ export class SmartsocketClient {
this.serverUrl = optionsArg.url; this.serverUrl = optionsArg.url;
this.serverPort = optionsArg.port; this.serverPort = optionsArg.port;
this.autoReconnect = optionsArg.autoReconnect; 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<any>) { 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 async 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();
const smartenvInstance = new plugins.smartenv.Smartenv(); const smartenvInstance = new plugins.smartenv.Smartenv();
const socketIoClient: any = await smartenvInstance.getEnvAwareModule({
nodeModuleName: 'socket.io-client',
webUrlArg: 'https://cdn.jsdelivr.net/npm/socket.io-client@4/dist/socket.io.js',
getFunction: () => {
return (globalThis as any).io;
},
});
logger.log('info', 'trying to connect...'); logger.log('info', 'trying to connect...');
const socketUrl = `${this.serverUrl}:${this.serverPort}`;
// 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,
side: 'client', side: 'client',
smartsocketHost: this, smartsocketHost: this,
socket: await socketIoClient socket: socket as any,
.connect(socketUrl, {
multiplex: false,
autoConnect: false,
reconnectionAttempts: 0,
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
})
.open(),
}); });
// Increment attempt ID to invalidate any pending timers from previous attempts
this.connectionAttemptId++;
const currentAttemptId = this.connectionAttemptId;
const timer = new plugins.smarttime.Timer(5000); const timer = new plugins.smarttime.Timer(5000);
timer.start(); timer.start();
timer.completed.then(() => { timer.completed.then(() => {
this.updateStatus('timedOut'); // Only fire timeout if this is still the current connection attempt
logger.log('warn', 'connection to server timed out.'); if (currentAttemptId === this.connectionAttemptId && this.eventStatus !== 'connected') {
this.disconnect(true); this.updateStatus('timedOut');
logger.log('warn', 'connection to server timed out.');
this.disconnect(true);
}
}); });
// authentication flow // Handle connection open
this.socketConnection.socket.on('requestAuth', (dataArg: interfaces.IRequestAuthPayload) => { socket.addEventListener('open', () => {
timer.reset(); timer.reset();
logger.log('info', `server ${dataArg.serverAlias} requested authentication`); });
// lets register the authenticated event // Handle messages
this.socketConnection.socket.on('authenticated', async () => { socket.addEventListener('message', async (event: MessageEvent | { data: string }) => {
this.remoteShortId = dataArg.serverAlias; try {
logger.log('info', 'client is authenticated'); const data = typeof event.data === 'string' ? event.data : event.data.toString();
this.socketConnection.authenticated = true; const message: interfaces.ISocketMessage = JSON.parse(data);
await this.socketConnection.listenToFunctionRequests();
});
this.socketConnection.socket.on('serverFullyReactive', async () => { switch (message.type) {
// lets take care of retagging case 'authRequest':
const oldTagStore = this.tagStore; timer.reset();
this.tagStoreSubscription?.unsubscribe(); const authRequestPayload = message.payload as interfaces.IAuthRequestPayload;
for (const keyArg of Object.keys(this.tagStore)) { logger.log('info', `server ${authRequestPayload.serverAlias} requested authentication`);
this.socketConnection.addTag(this.tagStore[keyArg]); 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;
} 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();
break;
default:
// Other messages are handled by SocketConnection
this.socketConnection.handleMessage(message);
break;
} }
this.tagStoreSubscription = this.socketConnection.tagStoreObservable.subscribe( } catch (err) {
(tagStoreArg) => { // Not a valid JSON message, ignore
this.tagStore = tagStoreArg; }
} });
// 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);
}
};
for (const tag of Object.keys(oldTagStore)) { const errorHandler = async () => {
await this.addTag(oldTagStore[tag]); if (this.currentSocket === socket && !this.disconnectRunning) {
} await this.disconnect(true);
this.updateStatus('connected'); }
done.resolve(); };
});
// lets register the forbidden event socket.addEventListener('close', closeHandler);
this.socketConnection.socket.on('forbidden', async () => { socket.addEventListener('error', errorHandler);
logger.log('warn', `disconnecting due to being forbidden to use the ressource`);
await this.disconnect();
});
// lets provide the actual auth data
this.socketConnection.socket.emit('dataAuth', {
alias: this.alias,
});
});
// handle connection
this.socketConnection.socket.on('connect', async () => {});
// handle disconnection and errors
this.socketConnection.socket.on('disconnect', async () => {
await this.disconnect(true);
});
this.socketConnection.socket.on('reconnect_failed', async () => {
await this.disconnect(true);
});
this.socketConnection.socket.on('connect_error', async () => {
await this.disconnect(true);
});
return done.promise; return done.promise;
} }
private disconnectRunning = false; private disconnectRunning = false;
private currentSocket: WebSocket | null = null;
private connectionAttemptId = 0; // Increment on each connect attempt to invalidate old timers
/** /**
* disconnect from the server * disconnect from the server
@@ -197,11 +264,16 @@ export class SmartsocketClient {
this.disconnectRunning = true; this.disconnectRunning = true;
this.updateStatus('disconnecting'); this.updateStatus('disconnecting');
this.tagStoreSubscription?.unsubscribe(); this.tagStoreSubscription?.unsubscribe();
// Store reference to current socket before cleanup
const socketToClose = this.currentSocket;
this.currentSocket = null;
if (this.socketConnection) { if (this.socketConnection) {
await this.socketConnection.disconnect(); await this.socketConnection.disconnect();
this.socketConnection = undefined; this.socketConnection = undefined;
logger.log('ok', 'disconnected socket!'); logger.log('ok', 'disconnected socket!');
} else { } else if (!socketToClose) {
this.disconnectRunning = false; this.disconnectRunning = false;
logger.log('warn', 'tried to disconnect, without a SocketConnection'); logger.log('warn', 'tried to disconnect, without a SocketConnection');
return; return;
@@ -212,9 +284,29 @@ export class SmartsocketClient {
if (this.autoReconnect && useAutoReconnectSetting && this.eventStatus !== 'connecting') { if (this.autoReconnect && useAutoReconnectSetting && this.eventStatus !== 'connecting') {
this.updateStatus('connecting'); this.updateStatus('connecting');
console.log('debounced reconnect!');
await plugins.smartdelay.delayForRandom(10000, 20000); // 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.disconnectRunning = false;
this.isReconnecting = true;
await this.connect(); await this.connect();
} else { } else {
this.disconnectRunning = false; this.disconnectRunning = false;
@@ -226,6 +318,8 @@ export class SmartsocketClient {
*/ */
public async stop() { public async stop() {
this.autoReconnect = false; this.autoReconnect = false;
this.currentRetryCount = 0;
this.currentBackoffDelay = this.initialBackoffDelay;
await this.disconnect(); await this.disconnect();
} }
@@ -238,7 +332,6 @@ export class SmartsocketClient {
functionNameArg: T['method'], functionNameArg: T['method'],
dataArg: T['request'] dataArg: T['request']
): Promise<T['response']> { ): Promise<T['response']> {
const done = plugins.smartpromise.defer();
const socketRequest = new SocketRequest<T>(this, { const socketRequest = new SocketRequest<T>(this, {
side: 'requesting', side: 'requesting',
originSocketConnection: this.socketConnection, originSocketConnection: this.socketConnection,
@@ -258,5 +351,19 @@ export class SmartsocketClient {
this.eventSubject.next(statusArg); this.eventSubject.next(statusArg);
} }
this.eventStatus = statusArg; 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;
} }
} }

View File

@@ -5,7 +5,7 @@ import * as interfaces from './interfaces/index.js';
// import classes // import classes
import { Smartsocket } from './smartsocket.classes.smartsocket.js'; import { Smartsocket } from './smartsocket.classes.smartsocket.js';
import { SocketFunction } from './smartsocket.classes.socketfunction.js'; import { SocketFunction } from './smartsocket.classes.socketfunction.js';
import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.socketrequest.js'; import { SocketRequest, type ISocketRequestDataObject } from './smartsocket.classes.socketrequest.js';
// socket.io // socket.io
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js'; import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
@@ -26,7 +26,7 @@ export interface ISocketConnectionConstructorOptions {
authenticated: boolean; authenticated: boolean;
side: TSocketConnectionSide; side: TSocketConnectionSide;
smartsocketHost: Smartsocket | SmartsocketClient; smartsocketHost: Smartsocket | SmartsocketClient;
socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket; socket: WebSocket | pluginsTyped.ws.WebSocket;
} }
/** /**
@@ -47,7 +47,7 @@ export class SocketConnection {
public side: TSocketConnectionSide; public side: TSocketConnectionSide;
public authenticated: boolean = false; public authenticated: boolean = false;
public smartsocketRef: Smartsocket | SmartsocketClient; public smartsocketRef: Smartsocket | SmartsocketClient;
public socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket; public socket: WebSocket | pluginsTyped.ws.WebSocket;
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>(); public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
public eventStatus: interfaces.TConnectionStatus = 'new'; public eventStatus: interfaces.TConnectionStatus = 'new';
@@ -65,20 +65,94 @@ export class SocketConnection {
// standard behaviour that is always true // standard behaviour that is always true
allSocketConnections.add(this); allSocketConnections.add(this);
}
// handle connection /**
this.socket.on('connect', async () => { * Sends a message through the socket
this.updateStatus('connected'); */
}); public sendMessage(message: interfaces.ISocketMessage): void {
this.socket.on('disconnect', async () => { if (this.socket.readyState === 1) { // WebSocket.OPEN
logger.log( this.socket.send(JSON.stringify(message));
'info', }
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected` }
);
await this.disconnect(); /**
allSocketConnections.remove(this); * Handles incoming messages
this.eventSubject.next('disconnected'); */
}); 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
);
if (targetSocketRequest) {
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);
} }
/** /**
@@ -99,7 +173,10 @@ export class SocketConnection {
done.resolve(); done.resolve();
} }
}); });
this.socket.emit('updateTagStore', this.tagStore); this.sendMessage({
type: 'tagUpdate',
payload: { tags: this.tagStore },
});
await done.promise; await done.promise;
} }
@@ -117,36 +194,68 @@ export class SocketConnection {
public async removeTagById(tagIdArg: interfaces.ITag['id']) { public async removeTagById(tagIdArg: interfaces.ITag['id']) {
delete this.tagStore[tagIdArg]; delete this.tagStore[tagIdArg];
this.tagStoreObservable.next(this.tagStore); this.tagStoreObservable.next(this.tagStore);
this.socket.emit('updateTagStore', 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', async (dataArg: ISocketConnectionAuthenticationObject) => {
logger.log('info', 'received authentication data...'); // Set up message handler for authentication
this.socket.removeAllListeners('dataAuth'); const messageHandler = (event: MessageEvent | { data: string }) => {
if (dataArg.alias) { try {
// TODO: authenticate password const data = typeof event.data === 'string' ? event.data : event.data.toString();
this.alias = dataArg.alias; const message: interfaces.ISocketMessage = JSON.parse(data);
this.authenticated = true;
this.socket.emit('authenticated'); if (message.type === 'auth') {
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`); const authData = message.payload as interfaces.IAuthPayload;
done.resolve(this); logger.log('info', 'received authentication data...');
} else {
this.authenticated = false; if (authData.alias) {
await this.disconnect(); this.alias = authData.alias;
done.reject('a socket tried to connect, but could not authenticated.'); this.authenticated = true;
// Send authentication response
this.sendMessage({
type: 'authResponse',
payload: { success: true },
});
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
done.resolve(this);
} else {
this.authenticated = false;
this.sendMessage({
type: 'authResponse',
payload: { success: false, error: 'No alias provided' },
});
this.disconnect();
done.reject('a socket tried to connect, but could not authenticate.');
}
}
} catch (err) {
// Not a valid message, ignore
} }
});
const requestAuthPayload: interfaces.IRequestAuthPayload = {
serverAlias: this.smartsocketRef.alias,
}; };
this.socket.emit('requestAuth', requestAuthPayload);
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;
} }
@@ -158,46 +267,23 @@ 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<any>) => { // Set up message handler for all messages
// check if requested function is available to the socket's scope const messageHandler = (event: MessageEvent | { data: string }) => {
// logger.log('info', 'function request received'); try {
const referencedFunction: SocketFunction<any> = this.smartsocketRef.socketFunctions.findSync( 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) {
// logger.log('ok', 'function in access scope');
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
side: 'responding',
originSocketConnection: this,
shortId: dataArg.shortId,
funcCallData: dataArg.funcCallData,
});
localSocketRequest.createResponse(); // takes care of creating response and sending it back
} else {
logger.log('warn', 'function not existent or out of access scope');
} }
}); };
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
// logger.log('info', `received response for request with id ${dataArg.shortId}`);
const targetSocketRequest = SocketRequest.getSocketRequestById(
this.smartsocketRef,
dataArg.shortId
);
targetSocketRequest.handleResponse(dataArg);
});
this.socket.on('updateTagStore', async (tagStoreArg: interfaces.TTagStore) => { this.socket.addEventListener('message', messageHandler as any);
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
this.tagStore = tagStoreArg;
this.socket.emit('updateTagStore', this.tagStore);
this.tagStoreObservable.next(this.tagStore);
}
this.remoteTagStoreObservable.next(tagStoreArg);
});
logger.log('info', `now listening to function requests for ${this.alias} on side ${this.side}`); logger.log(
'info',
`now listening to function requests for ${this.alias} on side ${this.side}`
);
done.resolve(this); done.resolve(this);
} else { } else {
const errMessage = 'socket needs to be authenticated first'; const errMessage = 'socket needs to be authenticated first';
@@ -209,7 +295,10 @@ export class SocketConnection {
// disconnecting ---------------------- // disconnecting ----------------------
public async disconnect() { public async disconnect() {
this.socket.disconnect(true); if (this.socket.readyState === 1 || this.socket.readyState === 0) {
this.socket.close();
}
allSocketConnections.remove(this);
this.updateStatus('disconnected'); this.updateStatus('disconnected');
} }

View File

@@ -1,10 +1,11 @@
import * as plugins from './smartsocket.plugins.js'; import * as plugins from './smartsocket.plugins.js';
import * as interfaces from './interfaces/index.js';
// import interfaces // import interfaces
import { import {
SocketFunction, SocketFunction,
ISocketFunctionCallDataRequest, type ISocketFunctionCallDataRequest,
ISocketFunctionCallDataResponse, type ISocketFunctionCallDataResponse,
} from './smartsocket.classes.socketfunction.js'; } from './smartsocket.classes.socketfunction.js';
// import classes // import classes
@@ -78,11 +79,15 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
* dispatches a socketrequest from the requesting to the receiving side * dispatches a socketrequest from the requesting to the receiving side
*/ */
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> { public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
const requestData: ISocketRequestDataObject<T> = { 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;
} }
@@ -90,7 +95,6 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
* handles the response that is received by the requesting side * handles the response that is received by the requesting side
*/ */
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) { public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
// logger.log('info', 'handling response!');
this.done.resolve(responseDataArg.funcCallData); this.done.resolve(responseDataArg.funcCallData);
this.smartsocketRef.socketRequests.remove(this); this.smartsocketRef.socketRequests.remove(this);
} }
@@ -110,16 +114,19 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`); logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
return; return;
} }
// logger.log('info', `invoking ${targetSocketFunction.name}`);
targetSocketFunction targetSocketFunction
.invoke(this.funcCallData, this.originSocketConnection) .invoke(this.funcCallData, this.originSocketConnection)
.then((resultData) => { .then((resultData) => {
// logger.log('info', 'got resultData. Sending it to requesting party.'); const message: interfaces.ISocketMessage<interfaces.IFunctionCallPayload> = {
const responseData: ISocketRequestDataObject<T> = { type: 'functionResponse',
funcCallData: resultData, id: this.shortid,
shortId: this.shortid, payload: {
funcName: resultData.funcName,
funcData: resultData.funcDataArg,
},
}; };
this.originSocketConnection.socket.emit('functionResponse', responseData); this.originSocketConnection.sendMessage(message);
this.smartsocketRef.socketRequests.remove(this); this.smartsocketRef.socketRequests.remove(this);
}); });
} }

View File

@@ -6,16 +6,16 @@ import { Smartsocket } from './smartsocket.classes.smartsocket.js';
import { logger } from './smartsocket.logging.js'; 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 httpServerDeferred: plugins.smartpromise.Deferred<any>;
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server; private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
private wsServer: pluginsTyped.ws.WebSocketServer;
/** /**
* wether httpServer is standalone * whether httpServer is standalone (created by us)
*/ */
private standaloneServer = false; private standaloneServer = false;
@@ -24,71 +24,180 @@ export class SocketServer {
} }
/** /**
* 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: pluginsTyped.smartexpress.Server
) {
this.httpServerDeferred = plugins.smartpromise.defer();
await serverArg.startedPromise;
this.httpServer = serverArg.httpServer;
this.httpServerDeferred.resolve();
}
/**
* gets the server for socket.io
*/
public async getServerForSocketIo() {
if (this.httpServerDeferred) {
await this.httpServerDeferred.promise;
}
if (this.httpServer) {
return this.httpServer;
} else {
const httpModule = await this.smartsocket.smartenv.getSafeNodeModule('http');
this.httpServer = new httpModule.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
if (!this.smartsocket.options.port) {
// handle http servers return;
// in case an external server has been set "this.standaloneServer" should be false
if (this.httpServer && this.standaloneServer) {
if (!this.smartsocket.options.port) {
logger.log('error', 'there should be a port specifed for smartsocket!');
throw new Error('there should be a port specified for smartsocket');
}
this.httpServer.listen(this.smartsocket.options.port, () => {
logger.log(
'success',
`Server started in standalone mode on ${this.smartsocket.options.port}`
);
done.resolve();
});
} else {
done.resolve();
} }
// nothing else to do if express server is set // 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, () => {
logger.log(
'success',
`Server started in standalone mode on port ${this.smartsocket.options.port}`
);
done.resolve();
});
await done.promise; await done.promise;
return;
} }
/** /**
* closes the server * closes the server
*/ */
public async stop() { public async stop() {
if (this.httpServer) { const done = plugins.smartpromise.defer<void>();
this.httpServer.close(); 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);
}
},
};
} }
} }

View File

@@ -1,19 +1,19 @@
// apiglobal scope // apiglobal scope
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces'; import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
export { typedrequestInterfaces }; export { typedrequestInterfaces };
// pushrocks scope // pushrocks scope
import * as isohash from '@pushrocks/isohash'; import * as isohash from '@push.rocks/isohash';
import * as isounique from '@pushrocks/isounique'; import * as isounique from '@push.rocks/isounique';
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartenv from '@pushrocks/smartenv'; import * as smartenv from '@push.rocks/smartenv';
import * as smartjson from '@pushrocks/smartjson'; import * as smartjson from '@push.rocks/smartjson';
import * as smartlog from '@pushrocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smarttime from '@pushrocks/smarttime'; import * as smarttime from '@push.rocks/smarttime';
import * as smartrx from '@pushrocks/smartrx'; import * as smartrx from '@push.rocks/smartrx';
export { export {
isohash, isohash,

View File

@@ -2,22 +2,45 @@
import type * as http from 'http'; import type * as http from 'http';
import type * as https from 'https'; import type * as https from 'https';
export { http, https }; export type { http, https };
// pushrocks scope // third party scope - ws types
import type * as smartexpress from '@pushrocks/smartexpress'; import type * as wsTypes from 'ws';
export { smartexpress }; export namespace ws {
export type WebSocket = wsTypes.WebSocket;
// third party scope export type WebSocketServer = wsTypes.WebSocketServer;
import type { Socket as ServerSocket, Server as ServerServer} from 'socket.io'; export type RawData = wsTypes.RawData;
import type { Socket as ClientSocket, connect as ClientIo } from 'socket.io-client';
export namespace socketIo {
export type Socket = ServerSocket;
export type Server = ServerServer;
} }
export namespace socketIoClient {
export type Socket = ClientSocket; // smartserve compatibility interface (for setExternalServer)
export type connect = typeof ClientIo; // 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>;
} }

View File

@@ -1,7 +1,14 @@
{ {
"compilerOptions": { "compilerOptions": {
"module": "ES2020", "experimentalDecorators": true,
"moduleResolution": "node12", "useDefineForClassFields": false,
"esModuleInterop": true "target": "ES2022",
} "module": "NodeNext",
} "moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}