Compare commits
274 Commits
Author | SHA1 | Date | |
---|---|---|---|
ee59471e14 | |||
da10b25214 | |||
933f09d632 | |||
eb330eaf7a | |||
c2e856821d | |||
653af3a3e7 | |||
4552a0527d | |||
e39141e86b | |||
bf6bda88e5 | |||
fb555b33be | |||
2e2826c52d | |||
bca3bd92a5 | |||
adc3f0935f | |||
72430fdb0d | |||
ee827dd5b3 | |||
2aefae00de | |||
6753a4fefc | |||
8c5428baf8 | |||
69c1ad04dc | |||
61d5301de8 | |||
72fa7f790c | |||
dcc087c04d | |||
c8556355c0 | |||
9cfc41ace8 | |||
2827a1676b | |||
424ad80b60 | |||
682a0c53ce | |||
4fc09af779 | |||
f73d973383 | |||
d87a942ab3 | |||
60e8657467 | |||
5215be946e | |||
b9c67666fa | |||
4b0fb073e6 | |||
fc458b6827 | |||
f27b9f8143 | |||
38058aba57 | |||
ba38dae64f | |||
69e862a6cf | |||
4562ac355b | |||
b029dc191e | |||
2640275d04 | |||
7bbcc91300 | |||
da39d52975 | |||
307469312f | |||
0f3ff2b611 | |||
bce82d49b6 | |||
0b10913995 | |||
7048585702 | |||
92697bad82 | |||
e1475a3342 | |||
e3c58e7fc0 | |||
32d60fff0d | |||
f33b64d625 | |||
6ee70ecafa | |||
6f3700adc0 | |||
3648f12358 | |||
c239eaa9d5 | |||
75bd7a9175 | |||
be9b47e73b | |||
966d953aff | |||
7f73664970 | |||
71452a293f | |||
c5e60d804a | |||
c5d52013e6 | |||
64195e4c78 | |||
01b5b3dc1a | |||
b34d7faec2 | |||
7c98e19988 | |||
608669ec44 | |||
a7b14cd383 | |||
21dc933302 | |||
4e7455fa26 | |||
c424d589ea | |||
9435796333 | |||
12d7310b90 | |||
9fc4db1e35 | |||
895464115e | |||
00f22f9651 | |||
278b35c9c5 | |||
da78da27e5 | |||
a8aeeaaa6c | |||
f9f6975b87 | |||
b9a6f1d5b0 | |||
489ad9284b | |||
6fdf0d9955 | |||
499a1893f9 | |||
2754447aae | |||
544277cb8a | |||
9a23960d21 | |||
23cca6cce3 | |||
2a9e58cc35 | |||
7d6a9921b5 | |||
3ee46a31f7 | |||
d72310ce10 | |||
1e14166ddb | |||
be38e91548 | |||
6c2057b119 | |||
08d7224016 | |||
bfa3330eb6 | |||
644fa2a49d | |||
c0dad3a977 | |||
a921033cc4 | |||
21e4712b04 | |||
df43bc2974 | |||
564988185d | |||
8442f3570f | |||
196357c878 | |||
bc187b7e41 | |||
0e54bf889f | |||
4c211bc82e | |||
a1be281670 | |||
1a44d2027c | |||
4bf5456a1d | |||
57c748657a | |||
15df24bf68 | |||
ca7470eedf | |||
38f017934c | |||
1980824540 | |||
09dec2071e | |||
a1443deafe | |||
9eac5ad336 | |||
cf607a79d5 | |||
8426c976bf | |||
1086065000 | |||
72196ec383 | |||
c6ad490a6f | |||
a40a83f0bf | |||
82fa029d05 | |||
0d76e7f577 | |||
57e6f058be | |||
b0bf9d7c95 | |||
1fbc76ef30 | |||
424d9cca91 | |||
d712270946 | |||
f98c797ad8 | |||
a23e7349be | |||
c390881a4e | |||
5e64f4ca25 | |||
765bc73197 | |||
105acaf97b | |||
5139136af4 | |||
bcc4ce9a87 | |||
20e7584eb9 | |||
59cbc343cc | |||
75aa1f6f0d | |||
3f073ab9b3 | |||
08c1618ea8 | |||
eb181fa2f6 | |||
c901ab75d3 | |||
075c59ed2c | |||
8d358dd93d | |||
e576d6058a | |||
6546da2394 | |||
29597daba1 | |||
c8b647d2fd | |||
1fa4aca049 | |||
2d4695de22 | |||
a3f4dcbc2a | |||
d6e81288b4 | |||
c441d89596 | |||
85b69e487a | |||
0d94ed9345 | |||
e188b18016 | |||
33c0fa3746 | |||
52be1415ee | |||
e75d5eabdb | |||
fb99848df1 | |||
1bd39d0755 | |||
d24c5f628c | |||
33fbabdd72 | |||
9d26fff986 | |||
41151e5436 | |||
109c5197f3 | |||
c3d47c1f50 | |||
1b45fb45e9 | |||
c22adc9b57 | |||
35e87306dd | |||
1b20aa5992 | |||
a63f14da47 | |||
86cf94c5dc | |||
0d39d6f237 | |||
1856ad5cfc | |||
b5dab810e8 | |||
f145b85b1c | |||
a8c647c5c7 | |||
22472e0adf | |||
333ddb4d9c | |||
126f020bf8 | |||
7677b1bb48 | |||
114379c5b3 | |||
79ae7d2039 | |||
d2cb6a3045 | |||
963619b2ed | |||
976abaaed7 | |||
ef322c32ac | |||
475911a968 | |||
5530e29da4 | |||
5f1d2c83c6 | |||
b84dd36885 | |||
c2d64ba39a | |||
85a5d7cdaf | |||
69380a2dbc | |||
fc292d83b9 | |||
b29961df95 | |||
f774a82ad5 | |||
5a45f4750b | |||
fc6227ef96 | |||
873aba3e0b | |||
f9bed9da8a | |||
d296064bfa | |||
1b0922759a | |||
aef4f9c591 | |||
abf546eec3 | |||
483cb38175 | |||
b2bd66a6a6 | |||
cfc3e8788d | |||
23c14c032c | |||
c92dae809f | |||
7200464e4b | |||
eaa97f0598 | |||
cde8270313 | |||
1b073ac8f6 | |||
3f3857df1e | |||
02e17a52c3 | |||
287c2a73c5 | |||
dea3746bb0 | |||
fc2a55bb0d | |||
99eca912d3 | |||
0b6929af8f | |||
0aa073f2a7 | |||
7170e58457 | |||
cccee35f2c | |||
118ec84ec5 | |||
dd31eea263 | |||
477429143d | |||
ea6fa14133 | |||
02065e36a6 | |||
f34358db81 | |||
fddf54b2b1 | |||
e1dbdc1a15 | |||
f3031a1d4e | |||
47ca497d48 | |||
c7e3c4537b | |||
62b36ab859 | |||
4563aade16 | |||
47596bfa59 | |||
6543d60019 | |||
f0aba45cec | |||
f327fa2784 | |||
983b4672fd | |||
c81a41b365 | |||
abe4d22226 | |||
87cc238345 | |||
475cd12904 | |||
84f33fa447 | |||
180ae23c9a | |||
7f0fff0bf4 | |||
24310b6709 | |||
bd8697ac6e | |||
7b2b2bd151 | |||
8dfc39be75 | |||
ab2196fd5f | |||
3afede95fc | |||
da510eb87a | |||
cb3d7f4d7b | |||
19a883c641 | |||
1f8e1fc7cb | |||
5109964247 | |||
f670cae1f8 | |||
fee54dfb95 | |||
8d58e0b2f3 | |||
fc530ba37e | |||
62abfda156 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,3 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
public/
|
||||||
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
@ -1,36 +0,0 @@
|
|||||||
image: hosttoday/ht-docker-node:npmts
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
|
|
||||||
testLEGACY:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test legacy
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testLTS:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test lts
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test stable
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
release:
|
|
||||||
stage: release
|
|
||||||
environment: npmjs-com_registry
|
|
||||||
script:
|
|
||||||
- npmci publish
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
64
README.md
64
README.md
@ -1,64 +0,0 @@
|
|||||||
# smartsocket
|
|
||||||
easy and secure websocket communication, Typescript ready
|
|
||||||
|
|
||||||
## Status
|
|
||||||
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
We recommend the use of typescript.
|
|
||||||
Under the hood we use socket.io and shortid for managed data exchange.
|
|
||||||
|
|
||||||
### Serverside
|
|
||||||
```typescript
|
|
||||||
import * as smartsocket from "smartsocket";
|
|
||||||
|
|
||||||
let mySmartsocket = new smartsocket.Smartsocket({
|
|
||||||
port: 3000 // the port smartsocket will listen on
|
|
||||||
});
|
|
||||||
|
|
||||||
let mySocketRole = new smartsocket.SocketRole({
|
|
||||||
name: "someRoleName",
|
|
||||||
passwordHash: "someHashedString"
|
|
||||||
});
|
|
||||||
|
|
||||||
let mySocketFunction = new smartsocket.SocketFunction({
|
|
||||||
name:"newService",
|
|
||||||
func:(data) => {
|
|
||||||
|
|
||||||
}, the function to execute
|
|
||||||
roles:[mySocketRole] // all roles that have access to a specific function
|
|
||||||
});
|
|
||||||
|
|
||||||
mySmartsocket.registerRole(mySocketRole);
|
|
||||||
mySmartsocket.clientCall.select("client1","restart",data)
|
|
||||||
.then((responseData) => {
|
|
||||||
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Client side
|
|
||||||
```typescript
|
|
||||||
import * as smartsocket from "smartsocket";
|
|
||||||
|
|
||||||
let mySmartsocketClient = new smartsocket.SmartsocketClient({
|
|
||||||
url: "somedomain.com", // url, note: will only work over https, no http supported.
|
|
||||||
port: 3000
|
|
||||||
role:"dockerhost", // some role, in this example a dockerhost vm,
|
|
||||||
password:"somePassword",
|
|
||||||
alias:"client1"
|
|
||||||
});
|
|
||||||
|
|
||||||
let mySocketFunction2 = new smartsocket.SocketFunction({
|
|
||||||
name:"restart",
|
|
||||||
func:(data) => {}, the function to execute
|
|
||||||
});
|
|
||||||
|
|
||||||
mySmartsocketClient.registerFunction(mySocketFunction2);
|
|
||||||
|
|
||||||
mySmartsocketClient.serverCall("newService",data)
|
|
||||||
.then((responseData) => {
|
|
||||||
|
|
||||||
});;
|
|
||||||
```
|
|
||||||
|
|
||||||
> **NOTE:** you can easily chain dependent requests on eiter the server or client side with promises. `data` is always a js object that you can design for your specific. It supports buffers for large binary data network exchange.
|
|
103
changelog.md
Normal file
103
changelog.md
Normal file
@ -0,0 +1,103 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-03-10 - 2.1.0 - feat(SmartsocketClient)
|
||||||
|
Improve client reconnection logic with exponential backoff and jitter; update socket.io and @types/node dependencies
|
||||||
|
|
||||||
|
- Bump engine.io from 6.5.4 to 6.6.4, socket.io and socket.io-client from 4.7.5 to 4.8.1
|
||||||
|
- Bump @types/node from ^20.12.7 to ^22.13.10
|
||||||
|
- Add new optional reconnection parameters (maxRetries, initialBackoffDelay, maxBackoffDelay) to SmartsocketClient options
|
||||||
|
- Implement exponential backoff with jitter for auto-reconnect and reset reconnection state on successful connection
|
||||||
|
|
||||||
|
## 2024-05-29 - 2.0.27 - docs
|
||||||
|
update description
|
||||||
|
|
||||||
|
## 2024-04-26 to 2024-03-30 - 2.0.26 … 2.0.24 - core & configuration
|
||||||
|
A series of internal fixes and configuration tweaks.
|
||||||
|
- fix(core): update
|
||||||
|
- update tsconfig
|
||||||
|
- update npmextra.json: githost
|
||||||
|
|
||||||
|
## 2023-09-10 to 2023-07-21 - 2.0.23 … 2.0.20 - core
|
||||||
|
Multiple minor core fixes were applied in rapid succession.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2023-07-21 to 2023-03-20 - 2.0.19 … 2.0.15 - core
|
||||||
|
Routine internal updates addressing core functionality.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2023-02-07 to 2022-03-24 - 2.0.14 … 2.0.0 - core
|
||||||
|
Further minor core updates were rolled out over several versions.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2022-03-14 - 1.2.22 - esm
|
||||||
|
A breaking change was introduced to switch the module system.
|
||||||
|
- BREAKING CHANGE(switch to esm): update
|
||||||
|
|
||||||
|
## 2022-01-20 to 2021-01-23 - 1.2.21 … 1.2.0 - core
|
||||||
|
A range of minor core fixes.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2020-12-26 - 1.1.71 - SmartsocketClient
|
||||||
|
New functionality in the socket client was added.
|
||||||
|
- feat(SmartsocketClient): socket client can now be stopped with .stop() in addition to .reconnect()
|
||||||
|
|
||||||
|
## 2020-12-26 to 2020-09-24 - 1.1.70 … 1.1.58 - core & test
|
||||||
|
A group of updates addressing both core mechanics and tests.
|
||||||
|
- fix(core): update
|
||||||
|
- fix(test): use @pushrocks/isohash instead of @pushrocks/smarthash
|
||||||
|
|
||||||
|
## 2019-11-08 to 2019-04-23 - 1.1.57 … 1.1.27 - core
|
||||||
|
Numerous versions in this period included only internal core fixes.
|
||||||
|
- fix(core): update
|
||||||
|
|
||||||
|
## 2019-01-31 to 2019-01-30 - 1.1.26 … 1.1.19 - build, docs & configuration
|
||||||
|
Updates went beyond the core, affecting build tooling and package metadata.
|
||||||
|
- fix(build): now building with tsbuild
|
||||||
|
- fix(readme): update
|
||||||
|
- fix(npmextra): adjust access level
|
||||||
|
- fix(scope): switch to @pushrocks
|
||||||
|
- fix(package.json): private setting
|
||||||
|
- fix(snyk): add .snyk file
|
||||||
|
- fix(structure): update to latest standards
|
||||||
|
|
||||||
|
## 2018-03-19 to 2018-03-15 - 1.1.18 … 1.1.12 - core & docs
|
||||||
|
Several improvements touching both functionality and documentation.
|
||||||
|
- now working as expected
|
||||||
|
- start transitioning to better SocketFunction handling
|
||||||
|
- add @types/node
|
||||||
|
- format and update README
|
||||||
|
- update to latest standards
|
||||||
|
|
||||||
|
## 2017-10-09 to 2017-07-07 - 1.1.11 … 1.1.07 - core & docs
|
||||||
|
Updates in this range improved both the internal mechanics and the developer‐facing materials.
|
||||||
|
- allow setting of specific server
|
||||||
|
- fix not ending error correctly
|
||||||
|
- update to newest version
|
||||||
|
- update docs and tests
|
||||||
|
- remove taskbuffer
|
||||||
|
- update to latest standards
|
||||||
|
|
||||||
|
## 2016-09-25 to 2016-09-03 - 1.1.6 … 1.1.3 - docs & core
|
||||||
|
Minor improvements in documentation and code quality.
|
||||||
|
- improve README
|
||||||
|
- added docs
|
||||||
|
- fix scoping of socket roles and perform small syntax fixes
|
||||||
|
|
||||||
|
## 2016-09-02 to 2016-08-16 - 1.1.2 … 1.1.1 - dependencies & security
|
||||||
|
Several housekeeping tasks to update dependencies and improve security.
|
||||||
|
- updated dependencies and exported socketConnection
|
||||||
|
- now authenticating sockets by checking the password hash
|
||||||
|
|
||||||
|
## 2016-08-15 - 1.1.0 - docs
|
||||||
|
A documentation update was published.
|
||||||
|
- update README
|
||||||
|
|
||||||
|
## 2016-08-15 - 1.0.7 - networking
|
||||||
|
A key update made the socket client work bi-directionally, enabling mesh setups.
|
||||||
|
- now working in both directions so mesh setups work
|
||||||
|
|
||||||
|
## 2016-08-14 to 2016-08-07 - 1.0.6 … 1.0.0 - internal changes
|
||||||
|
From the initial release onward, several internal improvements were introduced:
|
||||||
|
- updated tests and structure
|
||||||
|
- reworked reconnection logic and added a request/response abstraction for transparent function calls
|
||||||
|
- initial release features with updated documentation and structure
|
2
dist/index.d.ts
vendored
2
dist/index.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
export * from "./smartsocket.classes.smartsocket";
|
|
||||||
export * from "./smartsocket.classes.smartsocketclient";
|
|
7
dist/index.js
vendored
7
dist/index.js
vendored
@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
__export(require("./smartsocket.classes.smartsocket"));
|
|
||||||
__export(require("./smartsocket.classes.smartsocketclient"));
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsbUNBQW1DLENBQUMsRUFBQTtBQUNsRCxpQkFBYyx5Q0FBeUMsQ0FBQyxFQUFBIn0=
|
|
29
dist/smartsocket.classes.smartsocket.d.ts
vendored
29
dist/smartsocket.classes.smartsocket.d.ts
vendored
@ -1,29 +0,0 @@
|
|||||||
/// <reference types="socket.io" />
|
|
||||||
import { Objectmap } from "lik";
|
|
||||||
import { SocketRole } from "./smartsocket.classes.socketrole";
|
|
||||||
export interface ISocketObject {
|
|
||||||
alias?: string;
|
|
||||||
authenticated: boolean;
|
|
||||||
role?: string;
|
|
||||||
socket: SocketIO.Socket;
|
|
||||||
}
|
|
||||||
export interface ISmartsocketConstructorOptions {
|
|
||||||
port: number;
|
|
||||||
}
|
|
||||||
export declare class Smartsocket {
|
|
||||||
options: ISmartsocketConstructorOptions;
|
|
||||||
io: SocketIO.Server;
|
|
||||||
openSockets: Objectmap;
|
|
||||||
registeredRoles: Objectmap;
|
|
||||||
constructor(optionsArg: ISmartsocketConstructorOptions);
|
|
||||||
/**
|
|
||||||
* the standard handler for new socket connections
|
|
||||||
*/
|
|
||||||
private _handleSocket(socket);
|
|
||||||
registerFunctions(socketRoleArg: SocketRole): void;
|
|
||||||
/**
|
|
||||||
* starts listening to incling sockets:
|
|
||||||
*/
|
|
||||||
startServer: () => void;
|
|
||||||
closeServer: () => void;
|
|
||||||
}
|
|
51
dist/smartsocket.classes.smartsocket.js
vendored
51
dist/smartsocket.classes.smartsocket.js
vendored
@ -1,51 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./smartsocket.plugins");
|
|
||||||
const helpers = require("./smartsocket.helpers");
|
|
||||||
// classes
|
|
||||||
const lik_1 = require("lik");
|
|
||||||
;
|
|
||||||
;
|
|
||||||
class Smartsocket {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.openSockets = new lik_1.Objectmap();
|
|
||||||
this.registeredRoles = new lik_1.Objectmap();
|
|
||||||
/**
|
|
||||||
* starts listening to incling sockets:
|
|
||||||
*/
|
|
||||||
this.startServer = () => {
|
|
||||||
this.io = plugins.socketIo(this.options.port);
|
|
||||||
this.io.on('connection', (socketArg) => {
|
|
||||||
this._handleSocket(socketArg);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
this.closeServer = () => {
|
|
||||||
this.openSockets.forEach((socketObjectArg) => {
|
|
||||||
plugins.beautylog.log(`disconnect socket with >>alias ${socketObjectArg.alias}`);
|
|
||||||
socketObjectArg.socket.disconnect();
|
|
||||||
});
|
|
||||||
this.openSockets.wipe();
|
|
||||||
this.io.close();
|
|
||||||
};
|
|
||||||
this.options = optionsArg;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
/**
|
|
||||||
* the standard handler for new socket connections
|
|
||||||
*/
|
|
||||||
_handleSocket(socket) {
|
|
||||||
let socketObject = {
|
|
||||||
socket: socket,
|
|
||||||
authenticated: false
|
|
||||||
};
|
|
||||||
plugins.beautylog.log("Socket connected. Trying to authenticate...");
|
|
||||||
this.openSockets.add(socketObject);
|
|
||||||
helpers.authenticateSocket(socketObject)
|
|
||||||
.then();
|
|
||||||
}
|
|
||||||
registerFunctions(socketRoleArg) {
|
|
||||||
this.registeredRoles.add(socketRoleArg);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
exports.Smartsocket = Smartsocket;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFDakQsTUFBWSxPQUFPLFdBQU0sdUJBQXVCLENBQUMsQ0FBQTtBQUVqRCxVQUFVO0FBQ1Ysc0JBQTBCLEtBQUssQ0FBQyxDQUFBO0FBVS9CLENBQUM7QUFLRCxDQUFDO0FBRUY7SUFLSSxZQUFZLFVBQTBDO1FBRnRELGdCQUFXLEdBQUcsSUFBSSxlQUFTLEVBQUUsQ0FBQztRQUM5QixvQkFBZSxHQUFHLElBQUksZUFBUyxFQUFFLENBQUM7UUF3QmxDOztXQUVHO1FBRUgsZ0JBQVcsR0FBRztZQUNWLElBQUksQ0FBQyxFQUFFLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzlDLElBQUksQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLFlBQVksRUFBRSxDQUFDLFNBQVM7Z0JBQy9CLElBQUksQ0FBQyxhQUFhLENBQUMsU0FBUyxDQUFDLENBQUM7WUFDbEMsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUE7UUFDRCxnQkFBVyxHQUFHO1lBQ1YsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxlQUE4QjtnQkFDcEQsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLGVBQWUsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDO2dCQUNqRixlQUFlLENBQUMsTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO1lBQ3hDLENBQUMsQ0FBQyxDQUFDO1lBQ0gsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUN4QixJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3BCLENBQUMsQ0FBQTtRQXZDRyxJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQztJQUM5QixDQUFDOztJQUVEOztPQUVHO0lBQ0ssYUFBYSxDQUFDLE1BQU07UUFDeEIsSUFBSSxZQUFZLEdBQWtCO1lBQzlCLE1BQU0sRUFBRSxNQUFNO1lBQ2QsYUFBYSxFQUFFLEtBQUs7U0FDdkIsQ0FBQztRQUNGLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxDQUFDLENBQUE7UUFDcEUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDbkMsT0FBTyxDQUFDLGtCQUFrQixDQUFDLFlBQVksQ0FBQzthQUNuQyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDO0lBRUQsaUJBQWlCLENBQUMsYUFBd0I7UUFDdEMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDNUMsQ0FBQzs7QUFxQkwsQ0FBQztBQTlDWSxtQkFBVyxjQThDdkIsQ0FBQSJ9
|
|
10
dist/smartsocket.classes.smartsocketclient.d.ts
vendored
10
dist/smartsocket.classes.smartsocketclient.d.ts
vendored
@ -1,10 +0,0 @@
|
|||||||
/**
|
|
||||||
* interface for class SmartsocketClient
|
|
||||||
*/
|
|
||||||
export interface ISmartsocketClientOptions {
|
|
||||||
port: number;
|
|
||||||
url: string;
|
|
||||||
}
|
|
||||||
export declare class SmartsocketClient {
|
|
||||||
constructor();
|
|
||||||
}
|
|
@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
class SmartsocketClient {
|
|
||||||
constructor() {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.SmartsocketClient = SmartsocketClient;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldGNsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXRjbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQVVBO0lBQ0k7SUFFQSxDQUFDO0FBQ0wsQ0FBQztBQUpZLHlCQUFpQixvQkFJN0IsQ0FBQSJ9
|
|
12
dist/smartsocket.classes.socketfunction.d.ts
vendored
12
dist/smartsocket.classes.socketfunction.d.ts
vendored
@ -1,12 +0,0 @@
|
|||||||
import { SocketRole } from "./smartsocket.classes.socketrole";
|
|
||||||
export interface SocketFunctionOptions {
|
|
||||||
name: string;
|
|
||||||
func: any;
|
|
||||||
roles: SocketRole[];
|
|
||||||
}
|
|
||||||
export declare class SocketFunction {
|
|
||||||
name: string;
|
|
||||||
func: any;
|
|
||||||
roles: SocketRole[];
|
|
||||||
constructor(optionsArg: SocketFunctionOptions);
|
|
||||||
}
|
|
12
dist/smartsocket.classes.socketfunction.js
vendored
12
dist/smartsocket.classes.socketfunction.js
vendored
@ -1,12 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
;
|
|
||||||
class SocketFunction {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.name = optionsArg.name;
|
|
||||||
this.func = optionsArg.func;
|
|
||||||
this.roles = optionsArg.roles;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
exports.SocketFunction = SocketFunction;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRmdW5jdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc29ja2V0ZnVuY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQVlDLENBQUM7QUFFRjtJQUlJLFlBQVksVUFBaUM7UUFDekMsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO1FBQzVCLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQztRQUM1QixJQUFJLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUM7SUFDbEMsQ0FBQzs7QUFDTCxDQUFDO0FBVFksc0JBQWMsaUJBUzFCLENBQUEifQ==
|
|
15
dist/smartsocket.classes.socketrole.d.ts
vendored
15
dist/smartsocket.classes.socketrole.d.ts
vendored
@ -1,15 +0,0 @@
|
|||||||
/**
|
|
||||||
* interface for class SocketRole
|
|
||||||
*/
|
|
||||||
export interface SocketRoleOptions {
|
|
||||||
name: string;
|
|
||||||
passwordHash: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* A socketrole defines access to certain routines.
|
|
||||||
*/
|
|
||||||
export declare class SocketRole {
|
|
||||||
name: string;
|
|
||||||
passwordHash: string;
|
|
||||||
constructor(optionsArg: SocketRoleOptions);
|
|
||||||
}
|
|
12
dist/smartsocket.classes.socketrole.js
vendored
12
dist/smartsocket.classes.socketrole.js
vendored
@ -1,12 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
/**
|
|
||||||
* A socketrole defines access to certain routines.
|
|
||||||
*/
|
|
||||||
class SocketRole {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.name = optionsArg.name;
|
|
||||||
this.passwordHash = optionsArg.passwordHash;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.SocketRole = SocketRole;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFjQTs7R0FFRztBQUNIO0lBR0ksWUFBWSxVQUE0QjtRQUNwQyxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFlBQVksR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO0lBQ2hELENBQUM7QUFDTCxDQUFDO0FBUFksa0JBQVUsYUFPdEIsQ0FBQSJ9
|
|
7
dist/smartsocket.helpers.d.ts
vendored
7
dist/smartsocket.helpers.d.ts
vendored
@ -1,7 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as plugins from "./smartsocket.plugins";
|
|
||||||
import { ISocketObject } from "./smartsocket.classes.smartsocket";
|
|
||||||
/**
|
|
||||||
* authenticate a socket
|
|
||||||
*/
|
|
||||||
export declare let authenticateSocket: (socketObjectArg: ISocketObject) => plugins.q.Promise<{}>;
|
|
28
dist/smartsocket.helpers.js
vendored
28
dist/smartsocket.helpers.js
vendored
@ -1,28 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./smartsocket.plugins");
|
|
||||||
/**
|
|
||||||
* authenticate a socket
|
|
||||||
*/
|
|
||||||
exports.authenticateSocket = (socketObjectArg) => {
|
|
||||||
let done = plugins.q.defer();
|
|
||||||
socketObjectArg.socket.on("dataAuth", dataArg => {
|
|
||||||
plugins.beautylog.log("received authentication data. now hashing and comparing...");
|
|
||||||
socketObjectArg.socket.removeListener("dataAuth", () => { });
|
|
||||||
if ((true)) {
|
|
||||||
socketObjectArg.alias = dataArg.alias;
|
|
||||||
socketObjectArg.authenticated = true;
|
|
||||||
socketObjectArg.role = dataArg.role;
|
|
||||||
socketObjectArg.socket.emit("authenticated");
|
|
||||||
plugins.beautylog.ok(`socket with >>alias ${socketObjectArg.alias} >>role ${socketObjectArg.role} is authenticated!`);
|
|
||||||
done.resolve(socketObjectArg);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
socketObjectArg.socket.disconnect();
|
|
||||||
done.reject("not authenticated");
|
|
||||||
}
|
|
||||||
;
|
|
||||||
});
|
|
||||||
socketObjectArg.socket.emit("requestAuth");
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmhlbHBlcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFRakQ7O0dBRUc7QUFDUSwwQkFBa0IsR0FBRyxDQUFDLGVBQThCO0lBQzNELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsZUFBZSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxFQUFFLE9BQU87UUFDekMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsNERBQTRELENBQUMsQ0FBQztRQUNwRixlQUFlLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQztRQUM3RCxFQUFFLENBQUEsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNQLGVBQWUsQ0FBQyxLQUFLLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQTtZQUNyQyxlQUFlLENBQUMsYUFBYSxHQUFHLElBQUksQ0FBQztZQUNyQyxlQUFlLENBQUMsSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7WUFDcEMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7WUFDN0MsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsdUJBQXVCLGVBQWUsQ0FBQyxLQUFLLFdBQVcsZUFBZSxDQUFDLElBQUksb0JBQW9CLENBQUMsQ0FBQTtZQUNySCxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ2xDLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLGVBQWUsQ0FBQyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDcEMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBQ3JDLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQyxDQUFDLENBQUM7SUFDSCxlQUFlLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUMzQyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUMifQ==
|
|
7
dist/smartsocket.plugins.d.ts
vendored
7
dist/smartsocket.plugins.d.ts
vendored
@ -1,7 +0,0 @@
|
|||||||
import "typings-global";
|
|
||||||
export import beautylog = require("beautylog");
|
|
||||||
export import lik = require("lik");
|
|
||||||
export import q = require("q");
|
|
||||||
export import socketIo = require("socket.io");
|
|
||||||
export import socketIoClient = require("socket.io-client");
|
|
||||||
export import taskbuffer = require("taskbuffer");
|
|
9
dist/smartsocket.plugins.js
vendored
9
dist/smartsocket.plugins.js
vendored
@ -1,9 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
||||||
exports.beautylog = require("beautylog");
|
|
||||||
exports.lik = require("lik");
|
|
||||||
exports.q = require("q");
|
|
||||||
exports.socketIo = require("socket.io");
|
|
||||||
exports.socketIoClient = require("socket.io-client");
|
|
||||||
exports.taskbuffer = require("taskbuffer");
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsV0FBRyxXQUFZLEtBQUssQ0FBQyxDQUFDO0FBQ3RCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixnQkFBUSxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2hDLHNCQUFjLFdBQVcsa0JBQWtCLENBQUMsQ0FBQztBQUM3QyxrQkFBVSxXQUFXLFlBQVksQ0FBQyxDQUFDIn0=
|
|
33
npmextra.json
Normal file
33
npmextra.json
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
{
|
||||||
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "code.foss.global",
|
||||||
|
"gitscope": "push.rocks",
|
||||||
|
"gitrepo": "smartsocket",
|
||||||
|
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
||||||
|
"npmPackagename": "@push.rocks/smartsocket",
|
||||||
|
"license": "MIT",
|
||||||
|
"projectDomain": "push.rocks",
|
||||||
|
"keywords": [
|
||||||
|
"websocket",
|
||||||
|
"communication",
|
||||||
|
"server",
|
||||||
|
"client",
|
||||||
|
"socket.io",
|
||||||
|
"authentication",
|
||||||
|
"reconnection",
|
||||||
|
"tagging",
|
||||||
|
"function routing",
|
||||||
|
"secure"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"npmci": {
|
||||||
|
"npmGlobalTools": [],
|
||||||
|
"npmAccessLevel": "public"
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
|
}
|
||||||
|
}
|
82
package.json
82
package.json
@ -1,36 +1,76 @@
|
|||||||
{
|
{
|
||||||
"name": "smartsocket",
|
"name": "@push.rocks/smartsocket",
|
||||||
"version": "1.0.3",
|
"version": "2.1.0",
|
||||||
"description": "easy and secure websocket communication, Typescript ready",
|
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(tstest test/)",
|
||||||
|
"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": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/smartsocket/issues"
|
"url": "https://gitlab.com/pushrocks/smartsocket/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
"homepage": "https://code.foss.global/push.rocks/smartsocket",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/q": "0.x.x",
|
"@api.global/typedrequest-interfaces": "^3.0.18",
|
||||||
"@types/socket.io": "^1.4.26",
|
"@api.global/typedserver": "^3.0.27",
|
||||||
"@types/socket.io-client": "^1.4.26",
|
"@push.rocks/isohash": "^2.0.0",
|
||||||
"beautylog": "^5.0.20",
|
"@push.rocks/isounique": "^1.0.5",
|
||||||
"lik": "^1.0.10",
|
"@push.rocks/lik": "^6.0.14",
|
||||||
"q": "^1.4.1",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"socket.io": "^1.4.8",
|
"@push.rocks/smartenv": "^5.0.12",
|
||||||
"socket.io-client": "^1.4.8",
|
"@push.rocks/smartjson": "^5.0.19",
|
||||||
"taskbuffer": "^1.0.7"
|
"@push.rocks/smartlog": "^3.0.3",
|
||||||
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
|
"@push.rocks/smartrx": "^3.0.7",
|
||||||
|
"@push.rocks/smarttime": "^4.0.6",
|
||||||
|
"engine.io": "6.6.4",
|
||||||
|
"socket.io": "4.8.1",
|
||||||
|
"socket.io-client": "4.8.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts-g": "^5.2.8",
|
"@git.zone/tsbuild": "^2.1.66",
|
||||||
"should": "^10.0.0",
|
"@git.zone/tsbundle": "^2.0.8",
|
||||||
"typings-test": "^1.0.1"
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
}
|
"@git.zone/tstest": "^1.0.77",
|
||||||
|
"@push.rocks/tapbundle": "^5.0.23",
|
||||||
|
"@types/node": "^22.13.10"
|
||||||
|
},
|
||||||
|
"private": false,
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"keywords": [
|
||||||
|
"websocket",
|
||||||
|
"communication",
|
||||||
|
"server",
|
||||||
|
"client",
|
||||||
|
"socket.io",
|
||||||
|
"authentication",
|
||||||
|
"reconnection",
|
||||||
|
"tagging",
|
||||||
|
"function routing",
|
||||||
|
"secure"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
10031
pnpm-lock.yaml
generated
Normal file
10031
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
|
149
readme.md
Normal file
149
readme.md
Normal file
@ -0,0 +1,149 @@
|
|||||||
|
# @push.rocks/smartsocket
|
||||||
|
easy and secure websocket communication
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
To install @push.rocks/smartsocket, you can use npm or yarn as follows:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm install @push.rocks/smartsocket --save
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```shell
|
||||||
|
yarn add @push.rocks/smartsocket
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
@push.rocks/smartsocket offers a robust solution for easy and secure WebSocket communication, utilizing Typescript for clean and maintainable code. Below are comprehensive examples covering various scenarios and features provided by the module.
|
||||||
|
|
||||||
|
### Getting Started
|
||||||
|
|
||||||
|
First, ensure you've installed the module as shown in the "Install" section. Once installed, you can start using @push.rocks/smartsocket in your project.
|
||||||
|
|
||||||
|
### Setting Up a WebSocket Server
|
||||||
|
|
||||||
|
To create a WebSocket server that clients can connect to:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartsocket } from '@push.rocks/smartsocket';
|
||||||
|
|
||||||
|
// Create a new instance of Smartsocket for the server.
|
||||||
|
const server = new Smartsocket({ alias: 'myServer' });
|
||||||
|
|
||||||
|
// Define a SocketFunction that clients can call
|
||||||
|
server.addSocketFunction({
|
||||||
|
funcName: 'greet',
|
||||||
|
funcDef: async (data) => {
|
||||||
|
console.log(`Server received: ${data.message}`);
|
||||||
|
return { reply: `Hello, ${data.name}!` };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Start the Smartsocket server
|
||||||
|
server.start().then(() => {
|
||||||
|
console.log('WebSocket server is running...');
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Creating a WebSocket Client
|
||||||
|
|
||||||
|
Create a client that connects to the WebSocket server and interacts with it:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { SmartsocketClient } from '@push.rocks/smartsocket';
|
||||||
|
|
||||||
|
// Create a SmartsocketClient instance and connect to the server
|
||||||
|
const client = new SmartsocketClient({
|
||||||
|
url: 'ws://localhost',
|
||||||
|
port: 3000,
|
||||||
|
alias: 'myClient'
|
||||||
|
});
|
||||||
|
|
||||||
|
client.connect().then(() => {
|
||||||
|
console.log('Connected to WebSocket server');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Define a function to call the server's 'greet' function
|
||||||
|
async function greetServer(name) {
|
||||||
|
const response = await client.serverCall('greet', { name: name, message: 'Hello!' });
|
||||||
|
console.log(`Server replied: ${response.reply}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use the function
|
||||||
|
greetServer('Alice');
|
||||||
|
```
|
||||||
|
|
||||||
|
### Handling Disconnections and Reconnections
|
||||||
|
|
||||||
|
@push.rocks/smartsocket provides mechanisms to handle client disconnections and attempt reconnections:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
client.on('disconnect', () => {
|
||||||
|
console.log('Disconnected from server. Attempting to reconnect...');
|
||||||
|
client.connect();
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sending Binary Data
|
||||||
|
|
||||||
|
The library supports the transmission of binary data efficiently:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import fs from 'fs';
|
||||||
|
|
||||||
|
// Function to send a binary file to the server
|
||||||
|
async function sendBinaryData(filePath) {
|
||||||
|
const fileBuffer = fs.readFileSync(filePath);
|
||||||
|
await client.serverCall('sendFile', { file: fileBuffer });
|
||||||
|
}
|
||||||
|
|
||||||
|
sendBinaryData('./path/to/your/file.png');
|
||||||
|
```
|
||||||
|
|
||||||
|
### Securing Your WebSocket Communication
|
||||||
|
|
||||||
|
@push.rocks/smartsocket leverages secure WebSocket (WSS) connections to ensure that data transferred between the client and server is encrypted. When setting up your Smartsocket server or client, use `wss://` in your URL to enable secure communication.
|
||||||
|
|
||||||
|
### Advanced Usage
|
||||||
|
|
||||||
|
#### Mesh Networking
|
||||||
|
|
||||||
|
@push.rocks/smartsocket allows for the creation of complex mesh network configurations, enabling servers to communicate with other servers, forming a robust network with multiple nodes.
|
||||||
|
|
||||||
|
#### Scaling with @push.rocks/smartsocket
|
||||||
|
|
||||||
|
To scale your WebSocket services, you can utilize load balancers and ensure your @push.rocks/smartsocket instances are stateless to allow for horizontal scaling.
|
||||||
|
|
||||||
|
### Conclusion
|
||||||
|
|
||||||
|
This guide has covered how to set up basic WebSocket communication with @push.rocks/smartsocket, handle disconnections/reconnections, secure your communication, send binary data, and briefly touched on advanced concepts like mesh networking and scaling.
|
||||||
|
|
||||||
|
For more detailed documentation, visit [the official @push.rocks/smartsocket GitLab repository](https://gitlab.com/pushrocks/smartsocket).
|
||||||
|
|
||||||
|
Remember, WebSocket communication with @push.rocks/smartsocket is not only about sending and receiving messages. It's about creating a fast, reliable, and secure communication channel for your real-time applications.
|
||||||
|
|
||||||
|
Happy coding!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Please note, the documentation above is a starting point. Depending on the complexity and requirements of your application, you may need to explore more features and configurations provided by @push.rocks/smartsocket. Always refer to the official documentation for the most current information and best practices.
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
2
test/test.d.ts
vendored
2
test/test.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import "typings-test";
|
|
||||||
import "should";
|
|
103
test/test.expressserver.ts
Normal file
103
test/test.expressserver.ts
Normal file
@ -0,0 +1,103 @@
|
|||||||
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
|
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
|
||||||
|
|
||||||
|
import * as isohash from '@push.rocks/isohash';
|
||||||
|
import * as smartexpress from '@api.global/typedserver';
|
||||||
|
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunction1: smartsocket.SocketFunction<any>;
|
||||||
|
let myseServer: smartexpress.servertools.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.servertools.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();
|
37
test/test.js
37
test/test.js
@ -1,37 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-test");
|
|
||||||
require("should");
|
|
||||||
const socketIoClient = require("socket.io-client");
|
|
||||||
const smartsocket = require("../dist/index");
|
|
||||||
let testSmartsocket;
|
|
||||||
describe("smartsocket", function () {
|
|
||||||
it("should create a new smartsocket", function () {
|
|
||||||
testSmartsocket = new smartsocket.Smartsocket({ port: 3000 });
|
|
||||||
testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
|
|
||||||
});
|
|
||||||
it("should register a new Function", function () {
|
|
||||||
});
|
|
||||||
it("should start listening when .started is called", function () {
|
|
||||||
testSmartsocket.startServer();
|
|
||||||
});
|
|
||||||
it("should react to a new websocket connection", function (done) {
|
|
||||||
this.timeout(10000);
|
|
||||||
let socket = socketIoClient("http://localhost:3000", {});
|
|
||||||
socket.on("requestAuth", function () {
|
|
||||||
console.log("server requested authentication");
|
|
||||||
socket.emit("dataAuth", {
|
|
||||||
role: "coreflowContainer",
|
|
||||||
password: "somePassword",
|
|
||||||
alias: "coreflow1"
|
|
||||||
});
|
|
||||||
socket.on("authenticated", () => {
|
|
||||||
console.log("client is authenticated");
|
|
||||||
done();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
it("should close the server", function () {
|
|
||||||
testSmartsocket.closeServer();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQixNQUFPLGNBQWMsV0FBVyxrQkFBa0IsQ0FBQyxDQUFDO0FBQ3BELE1BQU8sV0FBVyxXQUFXLGVBQWUsQ0FBQyxDQUFDO0FBRTlDLElBQUksZUFBd0MsQ0FBQztBQUU3QyxRQUFRLENBQUMsYUFBYSxFQUFFO0lBQ3BCLEVBQUUsQ0FBQyxpQ0FBaUMsRUFBRTtRQUNsQyxlQUFlLEdBQUcsSUFBSSxXQUFXLENBQUMsV0FBVyxDQUFDLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7UUFDOUQsZUFBZSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNsRSxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBQztJQUVwQyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxnREFBZ0QsRUFBQztRQUNoRCxlQUFlLENBQUMsV0FBVyxFQUFFLENBQUM7SUFDbEMsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNENBQTRDLEVBQUUsVUFBVSxJQUFJO1FBQzNELElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDcEIsSUFBSSxNQUFNLEdBQUcsY0FBYyxDQUFDLHVCQUF1QixFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sQ0FBQyxFQUFFLENBQUMsYUFBYSxFQUFFO1lBQ3JCLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLENBQUMsQ0FBQztZQUMvQyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDcEIsSUFBSSxFQUFFLG1CQUFtQjtnQkFDekIsUUFBUSxFQUFFLGNBQWM7Z0JBQ3hCLEtBQUssRUFBRSxXQUFXO2FBQ3JCLENBQUMsQ0FBQztZQUNILE1BQU0sQ0FBQyxFQUFFLENBQUMsZUFBZSxFQUFDO2dCQUN0QixPQUFPLENBQUMsR0FBRyxDQUFDLHlCQUF5QixDQUFDLENBQUM7Z0JBQ3ZDLElBQUksRUFBRSxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUMsQ0FBQztJQUNQLENBQUMsQ0FBQyxDQUFDO0lBQ0gsRUFBRSxDQUFDLHlCQUF5QixFQUFDO1FBQ3pCLGVBQWUsQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUNsQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFDIn0=
|
|
152
test/test.reconnect.ts
Normal file
152
test/test.reconnect.ts
Normal file
@ -0,0 +1,152 @@
|
|||||||
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
|
import { expect, tap } from '@push.rocks/tapbundle';
|
||||||
|
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunctionForServer: smartsocket.SocketFunction<any>;
|
||||||
|
let testSocketFunctionClient: smartsocket.SocketFunction<any>;
|
||||||
|
|
||||||
|
export interface IReqResClient {
|
||||||
|
method: 'testFunction1';
|
||||||
|
request: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IReqResServer {
|
||||||
|
method: 'testFunction2';
|
||||||
|
request: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000,
|
||||||
|
};
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should create a new smartsocket', async () => {
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver1', port: testConfig.port });
|
||||||
|
await testSmartsocket.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
|
||||||
|
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction2',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SmartsocketClient
|
||||||
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
alias: 'testClient1',
|
||||||
|
autoReconnect: true,
|
||||||
|
});
|
||||||
|
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from client', async (tools) => {
|
||||||
|
await testSmartsocketClient.addTag({
|
||||||
|
id: 'awesome',
|
||||||
|
payload: 'yes',
|
||||||
|
});
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
|
await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.addTag({
|
||||||
|
id: 'awesome2',
|
||||||
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
|
expect(tagOnClientSide.payload).toEqual('absolutely');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
|
const response = await testSmartsocketClient.serverCall<IReqResClient>('testFunction1', {
|
||||||
|
value1: 'hello',
|
||||||
|
});
|
||||||
|
console.log(response);
|
||||||
|
expect(response.value1).toEqual('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
const response = await testSmartsocket.clientCall<IReqResServer>(
|
||||||
|
'testFunction2',
|
||||||
|
{
|
||||||
|
hi: 'hi there from server',
|
||||||
|
},
|
||||||
|
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
console.log(response);
|
||||||
|
expect(response.hi).toEqual('hi there from server');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect', async (toolsArg) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
await toolsArg.delayFor(2000);
|
||||||
|
expect(testSmartsocket.socketConnections.getArray().length).toEqual(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should be able to switch to a new server', async (toolsArg) => {
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||||
|
await testSmartsocket.start();
|
||||||
|
await toolsArg.delayFor(30000);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
|
||||||
|
expect(testSmartsocket.socketConnections.getArray().length).toEqual(1);
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
// terminate
|
||||||
|
tap.test('should close the server', async (tools) => {
|
||||||
|
await testSmartsocketClient.stop();
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
tools.delayFor(1000).then(() => process.exit(0));
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
147
test/test.tagging.ts
Normal file
147
test/test.tagging.ts
Normal file
@ -0,0 +1,147 @@
|
|||||||
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
|
import { expect, tap } from '@push.rocks/tapbundle';
|
||||||
|
|
||||||
|
import * as smartsocket from '../ts/index.js';
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketFunctionForServer: smartsocket.SocketFunction<any>;
|
||||||
|
let testSocketFunctionClient: smartsocket.SocketFunction<any>;
|
||||||
|
|
||||||
|
export interface IReqResClient {
|
||||||
|
method: 'testFunction1';
|
||||||
|
request: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
value1: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IReqResServer {
|
||||||
|
method: 'testFunction2';
|
||||||
|
request: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
response: {
|
||||||
|
hi: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000,
|
||||||
|
};
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should create a new smartsocket', async () => {
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||||
|
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
|
||||||
|
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction2',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should start listening when .started is called', async () => {
|
||||||
|
await testSmartsocket.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SmartsocketClient
|
||||||
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
alias: 'testClient1',
|
||||||
|
});
|
||||||
|
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from client', async (tools) => {
|
||||||
|
await testSmartsocketClient.addTag({
|
||||||
|
id: 'awesome',
|
||||||
|
payload: 'yes',
|
||||||
|
});
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
|
await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.addTag({
|
||||||
|
id: 'awesome2',
|
||||||
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
|
expect(tagOnClientSide.payload).toEqual('absolutely');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('2 clients should connect in parallel', async () => {
|
||||||
|
// TODO: implement parallel test
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
|
const response = await testSmartsocketClient.serverCall<IReqResClient>('testFunction1', {
|
||||||
|
value1: 'hello',
|
||||||
|
});
|
||||||
|
console.log(response);
|
||||||
|
expect(response.value1).toEqual('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
const response = await testSmartsocket.clientCall<IReqResServer>(
|
||||||
|
'testFunction2',
|
||||||
|
{
|
||||||
|
hi: 'hi there from server',
|
||||||
|
},
|
||||||
|
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
console.log(response);
|
||||||
|
expect(response.hi).toEqual('hi there from server');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to locate a connection tag after reconnect', async (tools) => {
|
||||||
|
console.log(testSmartsocket.socketConnections.getArray().length);
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.findSync((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).toEqual('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
// terminate
|
||||||
|
tap.test('should close the server', async () => {
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
38
test/test.ts
38
test/test.ts
@ -1,38 +0,0 @@
|
|||||||
import "typings-test";
|
|
||||||
import "should";
|
|
||||||
import socketIoClient = require("socket.io-client");
|
|
||||||
import smartsocket = require("../dist/index");
|
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
|
||||||
|
|
||||||
describe("smartsocket", function () {
|
|
||||||
it("should create a new smartsocket", function () {
|
|
||||||
testSmartsocket = new smartsocket.Smartsocket({ port: 3000 });
|
|
||||||
testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
|
|
||||||
});
|
|
||||||
it("should register a new Function",function(){
|
|
||||||
|
|
||||||
})
|
|
||||||
it("should start listening when .started is called",function(){
|
|
||||||
testSmartsocket.startServer();
|
|
||||||
})
|
|
||||||
it("should react to a new websocket connection", function (done) {
|
|
||||||
this.timeout(10000);
|
|
||||||
let socket = socketIoClient("http://localhost:3000", {});
|
|
||||||
socket.on("requestAuth", function () {
|
|
||||||
console.log("server requested authentication");
|
|
||||||
socket.emit("dataAuth", {
|
|
||||||
role: "coreflowContainer",
|
|
||||||
password: "somePassword",
|
|
||||||
alias: "coreflow1"
|
|
||||||
});
|
|
||||||
socket.on("authenticated",() => {
|
|
||||||
console.log("client is authenticated");
|
|
||||||
done();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
it("should close the server",function(){
|
|
||||||
testSmartsocket.closeServer();
|
|
||||||
})
|
|
||||||
});
|
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartsocket',
|
||||||
|
version: '2.1.0',
|
||||||
|
description: 'Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.'
|
||||||
|
}
|
12
ts/index.ts
12
ts/index.ts
@ -1,4 +1,10 @@
|
|||||||
import * as plugins from "./smartsocket.plugins";
|
// export main classes
|
||||||
|
export * from './smartsocket.classes.smartsocket.js';
|
||||||
|
export * from './smartsocket.classes.smartsocketclient.js';
|
||||||
|
|
||||||
export * from "./smartsocket.classes.smartsocket";
|
// export further classes and objects
|
||||||
export * from "./smartsocket.classes.smartsocketclient";
|
export * from './smartsocket.classes.socketfunction.js';
|
||||||
|
export * from './smartsocket.classes.socketconnection.js';
|
||||||
|
|
||||||
|
// export types so they can be referred to
|
||||||
|
export * from './interfaces/index.js';
|
11
ts/interfaces/connection.ts
Normal file
11
ts/interfaces/connection.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
export interface IRequestAuthPayload {
|
||||||
|
serverAlias: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TConnectionStatus =
|
||||||
|
| 'new'
|
||||||
|
| 'connecting'
|
||||||
|
| 'connected'
|
||||||
|
| 'disconnecting'
|
||||||
|
| 'disconnected'
|
||||||
|
| 'timedOut';
|
2
ts/interfaces/index.ts
Normal file
2
ts/interfaces/index.ts
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from './connection.js';
|
||||||
|
export * from './tag.js';
|
6
ts/interfaces/tag.ts
Normal file
6
ts/interfaces/tag.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
export interface ITag<T = any> {
|
||||||
|
id: string;
|
||||||
|
payload: T;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TTagStore = { [key: string]: ITag };
|
@ -1,68 +1,137 @@
|
|||||||
import * as plugins from "./smartsocket.plugins";
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
import * as helpers from "./smartsocket.helpers";
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
// classes
|
// classes
|
||||||
import { Objectmap } from "lik";
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import {SocketRole} from "./smartsocket.classes.socketrole";
|
import {
|
||||||
import {SocketFunction} from "./smartsocket.classes.socketfunction";
|
type ISocketFunctionCallDataRequest,
|
||||||
|
SocketFunction,
|
||||||
|
type ISocketFunctionCallDataResponse,
|
||||||
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
import { SocketRequest } from './smartsocket.classes.socketrequest.js';
|
||||||
|
import { SocketServer } from './smartsocket.classes.socketserver.js';
|
||||||
|
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
export interface ISocketObject {
|
|
||||||
alias?:string;
|
|
||||||
authenticated: boolean
|
|
||||||
role?:string,
|
|
||||||
socket: SocketIO.Socket,
|
|
||||||
};
|
|
||||||
|
|
||||||
export interface ISmartsocketConstructorOptions {
|
export interface ISmartsocketConstructorOptions {
|
||||||
port: number;
|
alias: string;
|
||||||
|
port?: number;
|
||||||
};
|
}
|
||||||
|
|
||||||
export class Smartsocket {
|
export class Smartsocket {
|
||||||
options:ISmartsocketConstructorOptions
|
/**
|
||||||
io: SocketIO.Server;
|
* a unique id to detect server restarts
|
||||||
openSockets = new Objectmap();
|
*/
|
||||||
registeredRoles = new Objectmap();
|
public alias: string;
|
||||||
|
public smartenv = new plugins.smartenv.Smartenv();
|
||||||
|
public options: ISmartsocketConstructorOptions;
|
||||||
|
public io: pluginsTyped.socketIo.Server;
|
||||||
|
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
|
|
||||||
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
|
|
||||||
|
private socketServer = new SocketServer(this);
|
||||||
|
|
||||||
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
||||||
this.options = optionsArg;
|
this.options = optionsArg;
|
||||||
};
|
this.alias = plugins.isounique.uni(this.options.alias);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
|
||||||
|
await this.socketServer.setExternalServer(serverType, serverArg);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* starts smartsocket
|
||||||
|
*/
|
||||||
|
public async start() {
|
||||||
|
const socketIoModule = await this.smartenv.getSafeNodeModule('socket.io');
|
||||||
|
this.io = new socketIoModule.Server(await this.socketServer.getServerForSocketIo(), {
|
||||||
|
cors: {
|
||||||
|
allowedHeaders: '*',
|
||||||
|
methods: '*',
|
||||||
|
origin: '*',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await this.socketServer.start();
|
||||||
|
this.io.on('connection', (socketArg) => {
|
||||||
|
this._handleSocketConnection(socketArg);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stops smartsocket
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
await plugins.smartdelay.delayFor(1000);
|
||||||
|
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
||||||
|
if (socketObjectArg) {
|
||||||
|
logger.log(
|
||||||
|
'info',
|
||||||
|
`disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`
|
||||||
|
);
|
||||||
|
socketObjectArg.disconnect();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
this.socketConnections.wipe();
|
||||||
|
this.io.close();
|
||||||
|
|
||||||
|
// stop the corresponging server
|
||||||
|
this.socketServer.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
// communication
|
||||||
|
|
||||||
|
/**
|
||||||
|
* allows call to specific client.
|
||||||
|
*/
|
||||||
|
public async clientCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
|
functionNameArg: T['method'],
|
||||||
|
dataArg: T['request'],
|
||||||
|
targetSocketConnectionArg: SocketConnection
|
||||||
|
): Promise<T['response']> {
|
||||||
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
|
funcCallData: {
|
||||||
|
funcDataArg: dataArg,
|
||||||
|
funcName: functionNameArg,
|
||||||
|
},
|
||||||
|
originSocketConnection: targetSocketConnectionArg,
|
||||||
|
shortId: plugins.isounique.uni(),
|
||||||
|
side: 'requesting',
|
||||||
|
});
|
||||||
|
const response: ISocketFunctionCallDataResponse<T> = await socketRequest.dispatch();
|
||||||
|
const result = response.funcDataArg;
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||||
|
this.socketFunctions.add(socketFunction);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the standard handler for new socket connections
|
* the standard handler for new socket connections
|
||||||
*/
|
*/
|
||||||
private _handleSocket(socket) {
|
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
|
||||||
let socketObject: ISocketObject = {
|
const socketConnection: SocketConnection = new SocketConnection({
|
||||||
socket: socket,
|
alias: undefined,
|
||||||
authenticated: false
|
authenticated: false,
|
||||||
};
|
side: 'server',
|
||||||
plugins.beautylog.log("Socket connected. Trying to authenticate...")
|
smartsocketHost: this,
|
||||||
this.openSockets.add(socketObject);
|
socket: socketArg,
|
||||||
helpers.authenticateSocket(socketObject)
|
|
||||||
.then();
|
|
||||||
}
|
|
||||||
|
|
||||||
registerFunctions(socketRoleArg:SocketRole){
|
|
||||||
this.registeredRoles.add(socketRoleArg);
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* starts listening to incling sockets:
|
|
||||||
*/
|
|
||||||
|
|
||||||
startServer = () => {
|
|
||||||
this.io = plugins.socketIo(this.options.port);
|
|
||||||
this.io.on('connection', (socketArg) => {
|
|
||||||
this._handleSocket(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();
|
||||||
}
|
}
|
||||||
closeServer = () => {
|
|
||||||
this.openSockets.forEach((socketObjectArg: ISocketObject) => {
|
|
||||||
plugins.beautylog.log(`disconnect socket with >>alias ${socketObjectArg.alias}`);
|
|
||||||
socketObjectArg.socket.disconnect();
|
|
||||||
});
|
});
|
||||||
this.openSockets.wipe();
|
await socketConnection.authenticate();
|
||||||
this.io.close();
|
await socketConnection.listenToFunctionRequests();
|
||||||
|
await socketConnection.socket.emit('serverFullyReactive');
|
||||||
}
|
}
|
||||||
}
|
}
|
@ -1,15 +1,317 @@
|
|||||||
import * as plugins from "./smartsocket.plugins"
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
|
import {
|
||||||
|
type ISocketFunctionCallDataRequest,
|
||||||
|
SocketFunction,
|
||||||
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
import { type ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest.js';
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for class SmartsocketClient
|
* interface for class SmartsocketClient
|
||||||
*/
|
*/
|
||||||
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
|
||||||
|
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 {
|
||||||
constructor(){
|
// a unique id
|
||||||
|
public shortId = plugins.isounique.uni();
|
||||||
|
|
||||||
|
// the shortId of the remote we connect to
|
||||||
|
public remoteShortId: string = null;
|
||||||
|
|
||||||
|
public alias: string;
|
||||||
|
public socketConnection: SocketConnection;
|
||||||
|
public serverUrl: string;
|
||||||
|
public serverPort: number;
|
||||||
|
public autoReconnect: boolean;
|
||||||
|
public maxRetries: number;
|
||||||
|
public initialBackoffDelay: number;
|
||||||
|
public maxBackoffDelay: number;
|
||||||
|
public currentRetryCount = 0;
|
||||||
|
public currentBackoffDelay: number;
|
||||||
|
|
||||||
|
// status handling
|
||||||
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
|
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||||
|
|
||||||
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
|
|
||||||
|
// tagStore
|
||||||
|
private tagStore: { [key: string]: interfaces.ITag } = {};
|
||||||
|
private tagStoreSubscription: plugins.smartrx.rxjs.Subscription;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a tag to a connection
|
||||||
|
*/
|
||||||
|
public async addTag(tagArg: interfaces.ITag) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.addTag(tagArg);
|
||||||
|
} else {
|
||||||
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a tag by id
|
||||||
|
* @param tagIdArg
|
||||||
|
*/
|
||||||
|
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
return this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes a tag from a connection
|
||||||
|
*/
|
||||||
|
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
this.socketConnection.removeTagById(tagIdArg);
|
||||||
|
} else {
|
||||||
|
delete this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
constructor(optionsArg: ISmartsocketClientOptions) {
|
||||||
|
this.alias = optionsArg.alias;
|
||||||
|
this.serverUrl = optionsArg.url;
|
||||||
|
this.serverPort = optionsArg.port;
|
||||||
|
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>) {
|
||||||
|
this.socketFunctions.add(socketFunction);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* connect the client to the server
|
||||||
|
*/
|
||||||
|
public async connect() {
|
||||||
|
// Reset retry counters on new connection attempt
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
|
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
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: () => {
|
||||||
|
const socketIoBrowserModule = (globalThis as any).io;
|
||||||
|
// console.log('loaded socket.io for browser');
|
||||||
|
return socketIoBrowserModule;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
// console.log(socketIoClient);
|
||||||
|
logger.log('info', 'trying to connect...');
|
||||||
|
const socketUrl = `${this.serverUrl}:${this.serverPort}`;
|
||||||
|
this.socketConnection = new SocketConnection({
|
||||||
|
alias: this.alias,
|
||||||
|
authenticated: false,
|
||||||
|
side: 'client',
|
||||||
|
smartsocketHost: this,
|
||||||
|
socket: await socketIoClient
|
||||||
|
.connect(socketUrl, {
|
||||||
|
multiplex: true,
|
||||||
|
rememberUpgrade: true,
|
||||||
|
autoConnect: false,
|
||||||
|
reconnectionAttempts: 0,
|
||||||
|
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
|
||||||
|
})
|
||||||
|
.open(),
|
||||||
|
});
|
||||||
|
|
||||||
|
const timer = new plugins.smarttime.Timer(5000);
|
||||||
|
timer.start();
|
||||||
|
timer.completed.then(() => {
|
||||||
|
this.updateStatus('timedOut');
|
||||||
|
logger.log('warn', 'connection to server timed out.');
|
||||||
|
this.disconnect(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
// authentication flow
|
||||||
|
this.socketConnection.socket.on('requestAuth', (dataArg: interfaces.IRequestAuthPayload) => {
|
||||||
|
timer.reset();
|
||||||
|
logger.log('info', `server ${dataArg.serverAlias} requested authentication`);
|
||||||
|
|
||||||
|
// lets register the authenticated event
|
||||||
|
this.socketConnection.socket.on('authenticated', async () => {
|
||||||
|
this.remoteShortId = dataArg.serverAlias;
|
||||||
|
logger.log('info', 'client is authenticated');
|
||||||
|
this.socketConnection.authenticated = true;
|
||||||
|
await this.socketConnection.listenToFunctionRequests();
|
||||||
|
});
|
||||||
|
|
||||||
|
this.socketConnection.socket.on('serverFullyReactive', async () => {
|
||||||
|
// lets take care of 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();
|
||||||
|
});
|
||||||
|
|
||||||
|
// lets register the forbidden event
|
||||||
|
this.socketConnection.socket.on('forbidden', async () => {
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
private disconnectRunning = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* disconnect from the server
|
||||||
|
*/
|
||||||
|
public async disconnect(useAutoReconnectSetting = false) {
|
||||||
|
if (this.disconnectRunning) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.disconnectRunning = true;
|
||||||
|
this.updateStatus('disconnecting');
|
||||||
|
this.tagStoreSubscription?.unsubscribe();
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.disconnect();
|
||||||
|
this.socketConnection = undefined;
|
||||||
|
logger.log('ok', 'disconnected socket!');
|
||||||
|
} else {
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
logger.log('warn', 'tried to disconnect, without a SocketConnection');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.log('warn', `disconnected from server ${this.remoteShortId}`);
|
||||||
|
this.remoteShortId = null;
|
||||||
|
|
||||||
|
if (this.autoReconnect && useAutoReconnectSetting && this.eventStatus !== 'connecting') {
|
||||||
|
this.updateStatus('connecting');
|
||||||
|
|
||||||
|
// Check if we've exceeded the maximum number of retries
|
||||||
|
if (this.currentRetryCount >= this.maxRetries) {
|
||||||
|
logger.log('warn', `Maximum reconnection attempts (${this.maxRetries}) reached. Giving up.`);
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Increment retry counter
|
||||||
|
this.currentRetryCount++;
|
||||||
|
|
||||||
|
// Calculate backoff with jitter (±20% randomness)
|
||||||
|
const jitter = this.currentBackoffDelay * 0.2 * (Math.random() * 2 - 1);
|
||||||
|
const delay = Math.min(this.currentBackoffDelay + jitter, this.maxBackoffDelay);
|
||||||
|
|
||||||
|
logger.log('info', `Reconnect attempt ${this.currentRetryCount}/${this.maxRetries} in ${Math.round(delay)}ms`);
|
||||||
|
|
||||||
|
// Apply exponential backoff for next time (doubling with each attempt)
|
||||||
|
this.currentBackoffDelay = Math.min(this.currentBackoffDelay * 2, this.maxBackoffDelay);
|
||||||
|
|
||||||
|
await plugins.smartdelay.delayFor(delay);
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
await this.connect();
|
||||||
|
} else {
|
||||||
|
this.disconnectRunning = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stops the client completely
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
this.autoReconnect = false;
|
||||||
|
this.currentRetryCount = 0;
|
||||||
|
this.currentBackoffDelay = this.initialBackoffDelay;
|
||||||
|
await this.disconnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* dispatches a server call
|
||||||
|
* @param functionNameArg
|
||||||
|
* @param dataArg
|
||||||
|
*/
|
||||||
|
public async serverCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
|
functionNameArg: T['method'],
|
||||||
|
dataArg: T['request']
|
||||||
|
): Promise<T['response']> {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
|
side: 'requesting',
|
||||||
|
originSocketConnection: this.socketConnection,
|
||||||
|
shortId: plugins.isounique.uni(),
|
||||||
|
funcCallData: {
|
||||||
|
funcName: functionNameArg,
|
||||||
|
funcDataArg: dataArg,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const response = await socketRequest.dispatch();
|
||||||
|
const result = response.funcDataArg;
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
|
if (this.eventStatus !== statusArg) {
|
||||||
|
this.eventSubject.next(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;
|
||||||
}
|
}
|
||||||
}
|
}
|
224
ts/smartsocket.classes.socketconnection.ts
Normal file
224
ts/smartsocket.classes.socketconnection.ts
Normal file
@ -0,0 +1,224 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
// import classes
|
||||||
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
|
import { SocketFunction } from './smartsocket.classes.socketfunction.js';
|
||||||
|
import { SocketRequest, type ISocketRequestDataObject } from './smartsocket.classes.socketrequest.js';
|
||||||
|
|
||||||
|
// socket.io
|
||||||
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
|
// export interfaces
|
||||||
|
|
||||||
|
/**
|
||||||
|
* defines is a SocketConnection is server or client side. Important for mesh setups.
|
||||||
|
*/
|
||||||
|
export type TSocketConnectionSide = 'server' | 'client';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface for constructor of class SocketConnection
|
||||||
|
*/
|
||||||
|
export interface ISocketConnectionConstructorOptions {
|
||||||
|
alias: string;
|
||||||
|
authenticated: boolean;
|
||||||
|
side: TSocketConnectionSide;
|
||||||
|
smartsocketHost: Smartsocket | SmartsocketClient;
|
||||||
|
socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface for authentication data
|
||||||
|
*/
|
||||||
|
export interface ISocketConnectionAuthenticationObject {
|
||||||
|
alias: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
// export classes
|
||||||
|
export let allSocketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* class SocketConnection represents a websocket connection
|
||||||
|
*/
|
||||||
|
export class SocketConnection {
|
||||||
|
public alias: string;
|
||||||
|
public side: TSocketConnectionSide;
|
||||||
|
public authenticated: boolean = false;
|
||||||
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
|
public socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
||||||
|
|
||||||
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
|
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||||
|
|
||||||
|
private tagStore: interfaces.TTagStore = {};
|
||||||
|
public tagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
|
||||||
|
public remoteTagStoreObservable = new plugins.smartrx.rxjs.Subject<interfaces.TTagStore>();
|
||||||
|
|
||||||
|
constructor(optionsArg: ISocketConnectionConstructorOptions) {
|
||||||
|
this.alias = optionsArg.alias;
|
||||||
|
this.authenticated = optionsArg.authenticated;
|
||||||
|
this.side = optionsArg.side;
|
||||||
|
this.smartsocketRef = optionsArg.smartsocketHost;
|
||||||
|
this.socket = optionsArg.socket;
|
||||||
|
|
||||||
|
// standard behaviour that is always true
|
||||||
|
allSocketConnections.add(this);
|
||||||
|
|
||||||
|
// handle connection
|
||||||
|
this.socket.on('connect', async () => {
|
||||||
|
this.updateStatus('connected');
|
||||||
|
});
|
||||||
|
this.socket.on('disconnect', async () => {
|
||||||
|
logger.log(
|
||||||
|
'info',
|
||||||
|
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
|
||||||
|
);
|
||||||
|
await this.disconnect();
|
||||||
|
allSocketConnections.remove(this);
|
||||||
|
this.eventSubject.next('disconnected');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a tag to a connection
|
||||||
|
*/
|
||||||
|
public async addTag(tagArg: interfaces.ITag) {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
|
||||||
|
if (!remoteTagStore[tagArg.id]) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const localTagString = plugins.smartjson.stringify(tagArg);
|
||||||
|
const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
|
||||||
|
if (localTagString === remoteTagString) {
|
||||||
|
remoteSubscription.unsubscribe();
|
||||||
|
done.resolve();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
this.socket.emit('updateTagStore', this.tagStore);
|
||||||
|
await done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a tag by id
|
||||||
|
* @param tagIdArg
|
||||||
|
*/
|
||||||
|
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
return this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes a tag from a connection
|
||||||
|
*/
|
||||||
|
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
delete this.tagStore[tagIdArg];
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
this.socket.emit('updateTagStore', this.tagStore);
|
||||||
|
}
|
||||||
|
|
||||||
|
// authenticating --------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* authenticate the socket
|
||||||
|
*/
|
||||||
|
public authenticate() {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
|
||||||
|
logger.log('info', 'received authentication data...');
|
||||||
|
this.socket.removeAllListeners('dataAuth');
|
||||||
|
if (dataArg.alias) {
|
||||||
|
// TODO: authenticate password
|
||||||
|
this.alias = dataArg.alias;
|
||||||
|
this.authenticated = true;
|
||||||
|
this.socket.emit('authenticated');
|
||||||
|
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
|
||||||
|
done.resolve(this);
|
||||||
|
} else {
|
||||||
|
this.authenticated = false;
|
||||||
|
await this.disconnect();
|
||||||
|
done.reject('a socket tried to connect, but could not authenticated.');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
const requestAuthPayload: interfaces.IRequestAuthPayload = {
|
||||||
|
serverAlias: this.smartsocketRef.alias,
|
||||||
|
};
|
||||||
|
this.socket.emit('requestAuth', requestAuthPayload);
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
// listening -------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* listen to function requests
|
||||||
|
*/
|
||||||
|
public listenToFunctionRequests() {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
if (this.authenticated) {
|
||||||
|
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
||||||
|
// check if requested function is available to the socket's scope
|
||||||
|
// logger.log('info', 'function request received');
|
||||||
|
const referencedFunction: SocketFunction<any> =
|
||||||
|
this.smartsocketRef.socketFunctions.findSync((socketFunctionArg) => {
|
||||||
|
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||||
|
});
|
||||||
|
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) => {
|
||||||
|
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}`
|
||||||
|
);
|
||||||
|
done.resolve(this);
|
||||||
|
} else {
|
||||||
|
const errMessage = 'socket needs to be authenticated first';
|
||||||
|
logger.log('error', errMessage);
|
||||||
|
done.reject(errMessage);
|
||||||
|
}
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
// disconnecting ----------------------
|
||||||
|
public async disconnect() {
|
||||||
|
this.socket.disconnect(true);
|
||||||
|
this.updateStatus('disconnected');
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
|
if (this.eventStatus !== statusArg) {
|
||||||
|
this.eventSubject.next(statusArg);
|
||||||
|
}
|
||||||
|
this.eventStatus = statusArg;
|
||||||
|
}
|
||||||
|
}
|
@ -1,24 +1,93 @@
|
|||||||
import * as plugins from "./smartsocket.plugins";
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Stringmap } from "lik";
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
import { SocketRole } from "./smartsocket.classes.socketrole";
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
|
|
||||||
|
// export interfaces
|
||||||
|
|
||||||
|
/**
|
||||||
export interface SocketFunctionOptions {
|
* interface of the contructor options of class SocketFunction
|
||||||
name: string;
|
*/
|
||||||
func: any;
|
export interface ISocketFunctionConstructorOptions<
|
||||||
roles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
};
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
export class SocketFunction {
|
funcDef: TFuncDef<T>;
|
||||||
name: string;
|
}
|
||||||
func: any;
|
|
||||||
roles: SocketRole[];
|
/**
|
||||||
constructor(optionsArg: SocketFunctionOptions) {
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
this.name = optionsArg.name;
|
*/
|
||||||
this.func = optionsArg.func;
|
export interface ISocketFunctionCallDataRequest<
|
||||||
this.roles = optionsArg.roles;
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
};
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['request'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
|
*/
|
||||||
|
export interface ISocketFunctionCallDataResponse<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['response'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface for function definition of SocketFunction
|
||||||
|
*/
|
||||||
|
export type TFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
|
||||||
|
dataArg: T['request'],
|
||||||
|
connectionArg: SocketConnection
|
||||||
|
) => PromiseLike<T['response']>;
|
||||||
|
|
||||||
|
// export classes
|
||||||
|
|
||||||
|
/**
|
||||||
|
* class that respresents a function that can be transparently called using a SocketConnection
|
||||||
|
*/
|
||||||
|
export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
|
// STATIC
|
||||||
|
public static getSocketFunctionByName<Q extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
|
functionNameArg: string
|
||||||
|
): SocketFunction<Q> {
|
||||||
|
return smartsocketRefArg.socketFunctions.findSync((socketFunctionArg) => {
|
||||||
|
return socketFunctionArg.name === functionNameArg;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// INSTANCE
|
||||||
|
public name: string;
|
||||||
|
public funcDef: TFuncDef<T>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the constructor for SocketFunction
|
||||||
|
*/
|
||||||
|
constructor(optionsArg: ISocketFunctionConstructorOptions<T>) {
|
||||||
|
this.name = optionsArg.funcName;
|
||||||
|
this.funcDef = optionsArg.funcDef;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* invokes the function of this SocketFunction
|
||||||
|
*/
|
||||||
|
public async invoke(
|
||||||
|
dataArg: ISocketFunctionCallDataRequest<T>,
|
||||||
|
socketConnectionArg: SocketConnection
|
||||||
|
): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
|
if (dataArg.funcName === this.name) {
|
||||||
|
const funcResponseData: ISocketFunctionCallDataResponse<T> = {
|
||||||
|
funcName: this.name,
|
||||||
|
funcDataArg: await this.funcDef(dataArg.funcDataArg, socketConnectionArg),
|
||||||
|
};
|
||||||
|
return funcResponseData;
|
||||||
|
} else {
|
||||||
|
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
126
ts/smartsocket.classes.socketrequest.ts
Normal file
126
ts/smartsocket.classes.socketrequest.ts
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
|
||||||
|
// import interfaces
|
||||||
|
import {
|
||||||
|
SocketFunction,
|
||||||
|
type ISocketFunctionCallDataRequest,
|
||||||
|
type ISocketFunctionCallDataResponse,
|
||||||
|
} from './smartsocket.classes.socketfunction.js';
|
||||||
|
|
||||||
|
// import classes
|
||||||
|
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
||||||
|
|
||||||
|
// export interfaces
|
||||||
|
export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
|
||||||
|
export type TSocketRequestSide = 'requesting' | 'responding';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface of constructor of class SocketRequest
|
||||||
|
*/
|
||||||
|
export interface ISocketRequestConstructorOptions<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
|
side: TSocketRequestSide;
|
||||||
|
originSocketConnection: SocketConnection;
|
||||||
|
shortId: string;
|
||||||
|
funcCallData?: ISocketFunctionCallDataRequest<T>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* request object that is sent initially and may or may not receive a response
|
||||||
|
*/
|
||||||
|
export interface ISocketRequestDataObject<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
|
funcCallData: ISocketFunctionCallDataRequest<T> | ISocketFunctionCallDataResponse<T>;
|
||||||
|
shortId: string;
|
||||||
|
responseTimeout?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
// export classes
|
||||||
|
export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
|
// STATIC
|
||||||
|
public static getSocketRequestById(
|
||||||
|
smartsocketRef: Smartsocket | SmartsocketClient,
|
||||||
|
shortIdArg: string
|
||||||
|
): SocketRequest<any> {
|
||||||
|
return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
|
||||||
|
return socketRequestArg.shortid === shortIdArg;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// INSTANCE
|
||||||
|
public status: TSocketRequestStatus = 'new';
|
||||||
|
public side: TSocketRequestSide;
|
||||||
|
public shortid: string;
|
||||||
|
public originSocketConnection: SocketConnection;
|
||||||
|
public funcCallData: ISocketFunctionCallDataRequest<T>;
|
||||||
|
public done = plugins.smartpromise.defer<ISocketFunctionCallDataResponse<T>>();
|
||||||
|
|
||||||
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
|
optionsArg: ISocketRequestConstructorOptions<T>
|
||||||
|
) {
|
||||||
|
this.smartsocketRef = smartsocketRefArg;
|
||||||
|
this.side = optionsArg.side;
|
||||||
|
this.shortid = optionsArg.shortId;
|
||||||
|
this.funcCallData = optionsArg.funcCallData;
|
||||||
|
this.originSocketConnection = optionsArg.originSocketConnection;
|
||||||
|
this.smartsocketRef.socketRequests.add(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
// requesting --------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* dispatches a socketrequest from the requesting to the receiving side
|
||||||
|
*/
|
||||||
|
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
|
const requestData: ISocketRequestDataObject<T> = {
|
||||||
|
funcCallData: this.funcCallData,
|
||||||
|
shortId: this.shortid,
|
||||||
|
};
|
||||||
|
this.originSocketConnection.socket.emit('function', requestData);
|
||||||
|
return this.done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* handles the response that is received by the requesting side
|
||||||
|
*/
|
||||||
|
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
||||||
|
// logger.log('info', 'handling response!');
|
||||||
|
this.done.resolve(responseDataArg.funcCallData);
|
||||||
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
// responding --------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* creates the response on the responding side
|
||||||
|
*/
|
||||||
|
public async createResponse(): Promise<void> {
|
||||||
|
const targetSocketFunction: SocketFunction<T> = SocketFunction.getSocketFunctionByName(
|
||||||
|
this.smartsocketRef,
|
||||||
|
this.funcCallData.funcName
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!targetSocketFunction) {
|
||||||
|
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// logger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||||
|
targetSocketFunction
|
||||||
|
.invoke(this.funcCallData, this.originSocketConnection)
|
||||||
|
.then((resultData) => {
|
||||||
|
// logger.log('info', 'got resultData. Sending it to requesting party.');
|
||||||
|
const responseData: ISocketRequestDataObject<T> = {
|
||||||
|
funcCallData: resultData,
|
||||||
|
shortId: this.shortid,
|
||||||
|
};
|
||||||
|
this.originSocketConnection.socket.emit('functionResponse', responseData);
|
||||||
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
@ -1,25 +0,0 @@
|
|||||||
import * as plugins from "./smartsocket.plugins";
|
|
||||||
|
|
||||||
// import classes
|
|
||||||
import { Stringmap } from "lik";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* interface for class SocketRole
|
|
||||||
*/
|
|
||||||
export interface SocketRoleOptions {
|
|
||||||
name:string;
|
|
||||||
passwordHash:string;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A socketrole defines access to certain routines.
|
|
||||||
*/
|
|
||||||
export class SocketRole {
|
|
||||||
name:string;
|
|
||||||
passwordHash:string;
|
|
||||||
constructor(optionsArg:SocketRoleOptions){
|
|
||||||
this.name = optionsArg.name;
|
|
||||||
this.passwordHash = optionsArg.passwordHash;
|
|
||||||
}
|
|
||||||
}
|
|
94
ts/smartsocket.classes.socketserver.ts
Normal file
94
ts/smartsocket.classes.socketserver.ts
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
||||||
|
|
||||||
|
// used in case no other server is supplied
|
||||||
|
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
||||||
|
import { logger } from './smartsocket.logging.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* class socketServer
|
||||||
|
* handles the attachment of socketIo to whatever server is in play
|
||||||
|
*/
|
||||||
|
export class SocketServer {
|
||||||
|
private smartsocket: Smartsocket;
|
||||||
|
private httpServerDeferred: plugins.smartpromise.Deferred<any>;
|
||||||
|
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* wether httpServer is standalone
|
||||||
|
*/
|
||||||
|
private standaloneServer = false;
|
||||||
|
|
||||||
|
constructor(smartSocketInstance: Smartsocket) {
|
||||||
|
this.smartsocket = smartSocketInstance;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* starts the server with another server
|
||||||
|
* also works with an express style server
|
||||||
|
*/
|
||||||
|
public async setExternalServer(
|
||||||
|
serverType: 'smartexpress',
|
||||||
|
serverArg: pluginsTyped.typedserver.servertools.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() {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
|
||||||
|
// handle http servers
|
||||||
|
// in case an external server has been set "this.standaloneServer" should be false
|
||||||
|
if (this.httpServer && this.standaloneServer) {
|
||||||
|
if (!this.smartsocket.options.port) {
|
||||||
|
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
|
||||||
|
await done.promise;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* closes the server
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
if (this.httpServer) {
|
||||||
|
this.httpServer.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -1,31 +0,0 @@
|
|||||||
import * as plugins from "./smartsocket.plugins";
|
|
||||||
|
|
||||||
// interfaces
|
|
||||||
import {ISocketObject} from "./smartsocket.classes.smartsocket";
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* authenticate a socket
|
|
||||||
*/
|
|
||||||
export let authenticateSocket = (socketObjectArg: ISocketObject) => {
|
|
||||||
let done = plugins.q.defer();
|
|
||||||
socketObjectArg.socket.on("dataAuth", dataArg => {
|
|
||||||
plugins.beautylog.log("received authentication data. now hashing and comparing...");
|
|
||||||
socketObjectArg.socket.removeListener("dataAuth", () => { });
|
|
||||||
if((true)){ // TODO: authenticate password
|
|
||||||
socketObjectArg.alias = dataArg.alias
|
|
||||||
socketObjectArg.authenticated = true;
|
|
||||||
socketObjectArg.role = dataArg.role;
|
|
||||||
socketObjectArg.socket.emit("authenticated");
|
|
||||||
plugins.beautylog.ok(`socket with >>alias ${socketObjectArg.alias} >>role ${socketObjectArg.role} is authenticated!`)
|
|
||||||
done.resolve(socketObjectArg);
|
|
||||||
} else {
|
|
||||||
socketObjectArg.socket.disconnect();
|
|
||||||
done.reject("not authenticated");
|
|
||||||
};
|
|
||||||
});
|
|
||||||
socketObjectArg.socket.emit("requestAuth");
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
3
ts/smartsocket.logging.ts
Normal file
3
ts/smartsocket.logging.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins.js';
|
||||||
|
|
||||||
|
export const logger = new plugins.smartlog.ConsoleLog();
|
@ -1,7 +1,29 @@
|
|||||||
import "typings-global";
|
// apiglobal scope
|
||||||
export import beautylog = require("beautylog");
|
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
||||||
export import lik = require("lik");
|
|
||||||
export import q = require("q");
|
export { typedrequestInterfaces };
|
||||||
export import socketIo = require("socket.io");
|
|
||||||
export import socketIoClient = require("socket.io-client");
|
// pushrocks scope
|
||||||
export import taskbuffer = require("taskbuffer");
|
import * as isohash from '@push.rocks/isohash';
|
||||||
|
import * as isounique from '@push.rocks/isounique';
|
||||||
|
import * as lik from '@push.rocks/lik';
|
||||||
|
import * as smartenv from '@push.rocks/smartenv';
|
||||||
|
import * as smartjson from '@push.rocks/smartjson';
|
||||||
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
|
|
||||||
|
export {
|
||||||
|
isohash,
|
||||||
|
isounique,
|
||||||
|
lik,
|
||||||
|
smartenv,
|
||||||
|
smartjson,
|
||||||
|
smartlog,
|
||||||
|
smartdelay,
|
||||||
|
smartpromise,
|
||||||
|
smarttime,
|
||||||
|
smartrx,
|
||||||
|
};
|
||||||
|
23
ts/smartsocket.pluginstyped.ts
Normal file
23
ts/smartsocket.pluginstyped.ts
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
// node native
|
||||||
|
import type * as http from 'http';
|
||||||
|
import type * as https from 'https';
|
||||||
|
|
||||||
|
export type { http, https };
|
||||||
|
|
||||||
|
// pushrocks scope
|
||||||
|
import type * as typedserver from '@api.global/typedserver';
|
||||||
|
|
||||||
|
export type { typedserver };
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import type { Socket as ServerSocket, Server as ServerServer } from 'socket.io';
|
||||||
|
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;
|
||||||
|
export type connect = typeof ClientIo;
|
||||||
|
}
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user