Compare commits
No commits in common. "master" and "v1.1.37" have entirely different histories.
@ -1,66 +0,0 @@
|
|||||||
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
|
|
||||||
@ -1,124 +0,0 @@
|
|||||||
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
|
|
||||||
18
.gitignore
vendored
18
.gitignore
vendored
@ -1,20 +1,4 @@
|
|||||||
.nogit/
|
node_modules/
|
||||||
|
|
||||||
# artifacts
|
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
|
||||||
pages/
|
pages/
|
||||||
|
|
||||||
# installs
|
|
||||||
node_modules/
|
|
||||||
|
|
||||||
# caches
|
|
||||||
.yarn/
|
|
||||||
.cache/
|
|
||||||
.rpt2_cache
|
|
||||||
|
|
||||||
# builds
|
|
||||||
dist/
|
|
||||||
dist_*/
|
|
||||||
|
|
||||||
# custom
|
|
||||||
125
.gitlab-ci.yml
Normal file
125
.gitlab-ci.yml
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
# gitzone standard
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: "$CI_BUILD_STAGE"
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
snyk:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install -g snyk
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command snyk test
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testLTS:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
testSTABLE:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
image: docker:stable
|
||||||
|
allow_failure: true
|
||||||
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
|
script:
|
||||||
|
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||||
|
- docker run
|
||||||
|
--env SOURCE_CODE="$PWD"
|
||||||
|
--volume "$PWD":/code
|
||||||
|
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||||
|
artifacts:
|
||||||
|
paths: [codeclimate.json]
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g typedoc typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
13
.snyk
Normal file
13
.snyk
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||||
|
version: v1.13.5
|
||||||
|
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
|
||||||
|
ignore:
|
||||||
|
SNYK-JS-JSYAML-173999:
|
||||||
|
- '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
|
||||||
|
reason: None given
|
||||||
|
expires: '2019-05-24T15:16:11.291Z'
|
||||||
|
SNYK-JS-JSYAML-174129:
|
||||||
|
- '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
|
||||||
|
reason: None given
|
||||||
|
expires: '2019-05-24T15:16:11.291Z'
|
||||||
|
patch: {}
|
||||||
11
.vscode/launch.json
vendored
11
.vscode/launch.json
vendored
@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"command": "npm test",
|
|
||||||
"name": "Run npm test",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"json.schemas": [
|
|
||||||
{
|
|
||||||
"fileMatch": ["/npmextra.json"],
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"npmci": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for npmci"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for gitzone",
|
|
||||||
"properties": {
|
|
||||||
"projectType": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
111
README.md
Normal file
111
README.md
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
# @pushrocks/smartsocket
|
||||||
|
easy and secure websocket communication
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsocket)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsocket)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartsocket)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
||||||
|
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
||||||
|
[](https://www.npmjs.com/package/@pushrocks/smartsocket)
|
||||||
|
[](https://snyk.io/test/npm/@pushrocks/smartsocket)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://prettier.io/)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
Under the hood we use socket.io and shortid for managed data exchange.
|
||||||
|
|
||||||
|
### Serverside
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as smartsocket from 'smartsocket';
|
||||||
|
import * as q from q; // q is a promise library
|
||||||
|
|
||||||
|
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
|
||||||
|
let mySmartsocket = new smartsocket.Smartsocket({
|
||||||
|
port: 3000 // the port smartsocket will listen on
|
||||||
|
});
|
||||||
|
|
||||||
|
// optional:
|
||||||
|
// run this with anothoer existing server like express
|
||||||
|
declare var someExpressServer; // read the express docs about how express actually works
|
||||||
|
mySmartsocket.setServer(someExpressServer);
|
||||||
|
|
||||||
|
// A "SocketRole" can be referenced by "SocketFunction"s.
|
||||||
|
// All "SocketRequest"s carry authentication data for a specific "SocketRole".
|
||||||
|
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
|
||||||
|
let mySocketRole = new smartsocket.SocketRole({
|
||||||
|
name: 'someRoleName',
|
||||||
|
passwordHash: 'someHashedString'
|
||||||
|
});
|
||||||
|
|
||||||
|
// A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
|
||||||
|
// The referenced function must return a promise and resolve with data of type any.
|
||||||
|
// Any "SocketRequest" carries a unique identifier. If the referenced function's promise resolved any passed on argument will be returned to the requesting party
|
||||||
|
let testSocketFunction1 = new smartsocket.SocketFunction({
|
||||||
|
funcName: 'testSocketFunction1',
|
||||||
|
funcDef: data => {
|
||||||
|
console.log('testSocketFunction1 executed successfully!');
|
||||||
|
},
|
||||||
|
allowedRoles: [mySocketRole] // all roles that have access to a specific function
|
||||||
|
});
|
||||||
|
|
||||||
|
// A "Smartsocket" exposes a .clientCall() that gets
|
||||||
|
// 1. the name of the "SocketFunction" on the client side
|
||||||
|
// 2. the data to pass in
|
||||||
|
// 3. And a target "SocketConnection" (there can be multiple connections at once)
|
||||||
|
// any unique id association is done internally
|
||||||
|
mySmartsocket.clientCall('restart', data, someTargetConnection).then(responseData => {});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Client side
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as smartsocket from 'smartsocket';
|
||||||
|
|
||||||
|
// A "SmartsocketClient" is different from a "Smartsocket" in that it doesn't expose any public address.
|
||||||
|
// Thus any new "SocketConnection"s must be innitiated from a "SmartsocketClient".
|
||||||
|
let testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
password: 'testPassword',
|
||||||
|
alias: 'testClient1',
|
||||||
|
role: 'testRole1'
|
||||||
|
});
|
||||||
|
|
||||||
|
// You can .connect() and .disconnect() from a "Smartsocket"
|
||||||
|
testSmartsocketClient.connect().then(() => {
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
|
||||||
|
// The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once
|
||||||
|
let testSocketFunction2 = new smartsocket.SocketFunction({
|
||||||
|
funcName: 'testSocketFunction2',
|
||||||
|
funcDef: data => {}, // the function to execute, has to return promise
|
||||||
|
allowedRoles: []
|
||||||
|
});
|
||||||
|
|
||||||
|
// A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
|
||||||
|
mySmartsocketClient.serverCall('function', functionCallData).then(functionResponseData => {
|
||||||
|
// the functionResponseData comes from the server... awesome, right?
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
> **NOTE:**
|
||||||
|
> you can easily chain dependent requests on either the server or client side with promises.
|
||||||
|
> `data` is always a js object that you can design for your specific needs.
|
||||||
|
> It supports buffers for large binary data network exchange.
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
||||||
103
changelog.md
103
changelog.md
@ -1,103 +0,0 @@
|
|||||||
# 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
|
|
||||||
@ -1,33 +1,17 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartsocket",
|
"gitrepo": "smartsocket",
|
||||||
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
"shortDescription": "easy and secure websocket communication",
|
||||||
"npmPackagename": "@push.rocks/smartsocket",
|
"npmPackagename": "@pushrocks/smartsocket",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks",
|
"projectDomain": "push.rocks"
|
||||||
"keywords": [
|
|
||||||
"websocket",
|
|
||||||
"communication",
|
|
||||||
"server",
|
|
||||||
"client",
|
|
||||||
"socket.io",
|
|
||||||
"authentication",
|
|
||||||
"reconnection",
|
|
||||||
"tagging",
|
|
||||||
"function routing",
|
|
||||||
"secure"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
|
||||||
"tsdoc": {
|
|
||||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
3249
package-lock.json
generated
Normal file
3249
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
89
package.json
89
package.json
@ -1,76 +1,45 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartsocket",
|
"name": "@pushrocks/smartsocket",
|
||||||
"version": "2.1.0",
|
"version": "1.1.37",
|
||||||
"description": "Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.",
|
"description": "easy and secure websocket communication",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"type": "module",
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "tstest test/",
|
||||||
"build": "(tsbuild --web --allowimplicitany && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)",
|
"build": "tsbuild"
|
||||||
"buildDocs": "tsdoc"
|
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://code.foss.global/push.rocks/smartsocket.git"
|
"url": "git+ssh://git@gitlab.com/pushrocks/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://code.foss.global/push.rocks/smartsocket",
|
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@api.global/typedrequest-interfaces": "^3.0.18",
|
"@pushrocks/lik": "^3.0.5",
|
||||||
"@api.global/typedserver": "^3.0.27",
|
"@pushrocks/smartdelay": "^2.0.3",
|
||||||
"@push.rocks/isohash": "^2.0.0",
|
"@pushrocks/smartexpress": "^3.0.21",
|
||||||
"@push.rocks/isounique": "^1.0.5",
|
"@pushrocks/smarthash": "^2.0.4",
|
||||||
"@push.rocks/lik": "^6.0.14",
|
"@pushrocks/smartlog": "^2.0.19",
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
"@pushrocks/smartpromise": "^3.0.2",
|
||||||
"@push.rocks/smartenv": "^5.0.12",
|
"@types/shortid": "0.0.29",
|
||||||
"@push.rocks/smartjson": "^5.0.19",
|
"@types/socket.io": "^2.1.2",
|
||||||
"@push.rocks/smartlog": "^3.0.3",
|
"@types/socket.io-client": "^1.4.32",
|
||||||
"@push.rocks/smartpromise": "^4.0.3",
|
"shortid": "^2.2.14",
|
||||||
"@push.rocks/smartrx": "^3.0.7",
|
"socket.io": "^2.2.0",
|
||||||
"@push.rocks/smarttime": "^4.0.6",
|
"socket.io-client": "^2.2.0"
|
||||||
"engine.io": "6.6.4",
|
|
||||||
"socket.io": "4.8.1",
|
|
||||||
"socket.io-client": "4.8.1"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.66",
|
"@gitzone/tsbuild": "^2.1.11",
|
||||||
"@git.zone/tsbundle": "^2.0.8",
|
"@gitzone/tsrun": "^1.2.6",
|
||||||
"@git.zone/tsrun": "^1.2.44",
|
"@gitzone/tstest": "^1.0.24",
|
||||||
"@git.zone/tstest": "^1.0.77",
|
"@pushrocks/tapbundle": "^3.0.9",
|
||||||
"@push.rocks/tapbundle": "^5.0.23",
|
"@types/node": "^12.0.6",
|
||||||
"@types/node": "^22.13.10"
|
"tslint": "^5.17.0",
|
||||||
|
"tslint-config-prettier": "^1.18.0"
|
||||||
},
|
},
|
||||||
"private": false,
|
"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
10031
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
|||||||
|
|
||||||
149
readme.md
149
readme.md
@ -1,149 +0,0 @@
|
|||||||
# @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.
|
|
||||||
@ -1,31 +1,34 @@
|
|||||||
// tslint:disable-next-line:no-implicit-dependencies
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
import * as isohash from '@push.rocks/isohash';
|
import * as smarthash from '@pushrocks/smarthash';
|
||||||
import * as smartexpress from '@api.global/typedserver';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
import * as smartexpress from '@pushrocks/smartexpress';
|
||||||
|
|
||||||
import * as smartsocket from '../ts/index.js';
|
import socketIoClient = require('socket.io-client');
|
||||||
|
import smartsocket = require('../ts/index');
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
let testSocketFunction1: smartsocket.SocketFunction<any>;
|
let testSocketRole1: smartsocket.SocketRole;
|
||||||
let myseServer: smartexpress.servertools.Server;
|
let testSocketFunction1: smartsocket.SocketFunction;
|
||||||
|
let myseServer: smartexpress.Server;
|
||||||
|
|
||||||
const testConfig = {
|
const testConfig = {
|
||||||
port: 3000,
|
port: 3000
|
||||||
};
|
};
|
||||||
|
|
||||||
// class smartsocket
|
// class smartsocket
|
||||||
tap.test('should create a new smartsocket', async () => {
|
tap.test('should create a new smartsocket', async () => {
|
||||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver', port: testConfig.port });
|
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
||||||
expect(testSmartsocket).toBeInstanceOf(smartsocket.Smartsocket);
|
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('Should accept an smartExpressServer as server', async () => {
|
tap.test('Should accept an smartExpressServer as server', async () => {
|
||||||
myseServer = new smartexpress.servertools.Server({
|
myseServer = new smartexpress.Server({
|
||||||
cors: true,
|
cors: true,
|
||||||
forceSsl: false,
|
forceSsl: false,
|
||||||
port: testConfig.port,
|
port: testConfig.port
|
||||||
});
|
});
|
||||||
|
|
||||||
testSmartsocket.setExternalServer('smartexpress', myseServer);
|
testSmartsocket.setExternalServer('smartexpress', myseServer);
|
||||||
@ -33,37 +36,60 @@ tap.test('Should accept an smartExpressServer as server', async () => {
|
|||||||
await myseServer.start();
|
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 () => {
|
tap.test('should start listening when .started is called', async () => {
|
||||||
await testSmartsocket.start();
|
await testSmartsocket.start();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// class socketrole
|
||||||
|
tap.test('should add a socketrole', async () => {
|
||||||
|
testSocketRole1 = new smartsocket.SocketRole({
|
||||||
|
name: 'testRole1',
|
||||||
|
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunction1 = new smartsocket.SocketFunction({
|
||||||
|
allowedRoles: [testSocketRole1],
|
||||||
|
funcDef: async dataArg => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
// class SmartsocketClient
|
// class SmartsocketClient
|
||||||
tap.test('should react to a new websocket connection from client', async () => {
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
const done = smartpromise.defer();
|
||||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
port: testConfig.port,
|
port: testConfig.port,
|
||||||
url: 'http://localhost',
|
url: 'http://localhost',
|
||||||
|
password: 'testPassword',
|
||||||
alias: 'testClient1',
|
alias: 'testClient1',
|
||||||
|
role: 'testRole1'
|
||||||
});
|
});
|
||||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
testSmartsocketClient.connect().then(() => {
|
||||||
await testSmartsocketClient.connect();
|
done.resolve();
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
});
|
});
|
||||||
|
tap.test('client should disconnect and reconnect', async () => {
|
||||||
tap.test('client should disconnect and reconnect', async (tools) => {
|
let done = smartpromise.defer();
|
||||||
await testSmartsocketClient.disconnect();
|
testSmartsocketClient
|
||||||
await tools.delayFor(100);
|
.disconnect()
|
||||||
await testSmartsocketClient.connect();
|
.then(() => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
setTimeout(() => {
|
||||||
|
testSmartsocketClient.connect().then(done.resolve);
|
||||||
|
}, 0);
|
||||||
|
return done.promise;
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('2 clients should connect in parallel', async () => {
|
tap.test('2 clients should connect in parallel', async () => {
|
||||||
@ -71,28 +97,38 @@ tap.test('2 clients should connect in parallel', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||||
const totalCycles = 20000;
|
let done = smartpromise.defer();
|
||||||
let counter = 0;
|
testSmartsocketClient
|
||||||
let startTime = Date.now();
|
.serverCall('testFunction1', {
|
||||||
while (counter < totalCycles) {
|
value1: 'hello'
|
||||||
const randomString = `hello ${Math.random()}`;
|
})
|
||||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
.then(dataArg => {
|
||||||
value1: randomString,
|
console.log(dataArg);
|
||||||
|
done.resolve();
|
||||||
});
|
});
|
||||||
expect(response.value1).toEqual(randomString);
|
await done.promise;
|
||||||
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 () => {});
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
let targetSocket = (() => {
|
||||||
|
return smartsocket.allSocketConnections.find(socketConnectionArg => {
|
||||||
|
return socketConnectionArg.alias === 'testClient1';
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
testSmartsocket
|
||||||
|
.clientCall(
|
||||||
|
'testFunction1',
|
||||||
|
{
|
||||||
|
value1: 'helloFromServer'
|
||||||
|
},
|
||||||
|
targetSocket
|
||||||
|
)
|
||||||
|
.then(dataArg => {
|
||||||
|
console.log(dataArg);
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
// terminate
|
// terminate
|
||||||
tap.test('should close the server', async () => {
|
tap.test('should close the server', async () => {
|
||||||
|
|||||||
@ -1,152 +0,0 @@
|
|||||||
// 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();
|
|
||||||
@ -1,147 +0,0 @@
|
|||||||
// 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();
|
|
||||||
124
test/test.ts
Normal file
124
test/test.ts
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
|
import * as smarthash from '@pushrocks/smarthash';
|
||||||
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
|
import socketIoClient = require('socket.io-client');
|
||||||
|
import smartsocket = require('../ts/index');
|
||||||
|
|
||||||
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketRole1: smartsocket.SocketRole;
|
||||||
|
let testSocketFunction1: smartsocket.SocketFunction;
|
||||||
|
|
||||||
|
const testConfig = {
|
||||||
|
port: 3000
|
||||||
|
};
|
||||||
|
|
||||||
|
// class smartsocket
|
||||||
|
tap.test('should create a new smartsocket', async () => {
|
||||||
|
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
||||||
|
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should start listening when .started is called', async () => {
|
||||||
|
await testSmartsocket.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
// class socketrole
|
||||||
|
tap.test('should add a socketrole', async () => {
|
||||||
|
testSocketRole1 = new smartsocket.SocketRole({
|
||||||
|
name: 'testRole1',
|
||||||
|
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SocketFunction
|
||||||
|
tap.test('should register a new Function', async () => {
|
||||||
|
testSocketFunction1 = new smartsocket.SocketFunction({
|
||||||
|
allowedRoles: [testSocketRole1],
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction1'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// class SmartsocketClient
|
||||||
|
tap.test('should react to a new websocket connection from client', async () => {
|
||||||
|
const done = smartpromise.defer();
|
||||||
|
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||||
|
port: testConfig.port,
|
||||||
|
url: 'http://localhost',
|
||||||
|
password: 'testPassword',
|
||||||
|
alias: 'testClient1',
|
||||||
|
role: 'testRole1'
|
||||||
|
});
|
||||||
|
testSmartsocketClient.connect().then(() => {
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
tap.test('client should disconnect and reconnect', async () => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
testSmartsocketClient
|
||||||
|
.disconnect()
|
||||||
|
.then(() => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
setTimeout(() => {
|
||||||
|
testSmartsocketClient.connect().then(done.resolve);
|
||||||
|
}, 0);
|
||||||
|
return done.promise;
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
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 () => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
testSmartsocketClient
|
||||||
|
.serverCall('testFunction1', {
|
||||||
|
value1: 'hello'
|
||||||
|
})
|
||||||
|
.then(dataArg => {
|
||||||
|
console.log(dataArg);
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to make a functionCall from server to client', async () => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
let targetSocket = (() => {
|
||||||
|
return smartsocket.allSocketConnections.find(socketConnectionArg => {
|
||||||
|
return socketConnectionArg.alias === 'testClient1';
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
testSmartsocket
|
||||||
|
.clientCall(
|
||||||
|
'testFunction1',
|
||||||
|
{
|
||||||
|
value1: 'helloFromServer'
|
||||||
|
},
|
||||||
|
targetSocket
|
||||||
|
)
|
||||||
|
.then(dataArg => {
|
||||||
|
console.log(dataArg);
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// terminate
|
||||||
|
tap.test('should close the server', async () => {
|
||||||
|
await testSmartsocket.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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.'
|
|
||||||
}
|
|
||||||
14
ts/index.ts
14
ts/index.ts
@ -1,10 +1,10 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
// export main classes
|
// export main classes
|
||||||
export * from './smartsocket.classes.smartsocket.js';
|
export * from './smartsocket.classes.smartsocket';
|
||||||
export * from './smartsocket.classes.smartsocketclient.js';
|
export * from './smartsocket.classes.smartsocketclient';
|
||||||
|
|
||||||
// export further classes and objects
|
// export further classes and objects
|
||||||
export * from './smartsocket.classes.socketfunction.js';
|
export * from './smartsocket.classes.socketfunction';
|
||||||
export * from './smartsocket.classes.socketconnection.js';
|
export * from './smartsocket.classes.socketrole';
|
||||||
|
export * from './smartsocket.classes.socketconnection';
|
||||||
// export types so they can be referred to
|
|
||||||
export * from './interfaces/index.js';
|
|
||||||
|
|||||||
@ -1,11 +0,0 @@
|
|||||||
export interface IRequestAuthPayload {
|
|
||||||
serverAlias: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type TConnectionStatus =
|
|
||||||
| 'new'
|
|
||||||
| 'connecting'
|
|
||||||
| 'connected'
|
|
||||||
| 'disconnecting'
|
|
||||||
| 'disconnected'
|
|
||||||
| 'timedOut';
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
export * from './connection.js';
|
|
||||||
export * from './tag.js';
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
export interface ITag<T = any> {
|
|
||||||
id: string;
|
|
||||||
payload: T;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type TTagStore = { [key: string]: ITag };
|
|
||||||
@ -1,45 +1,34 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
import * as helpers from './smartsocket.helpers';
|
||||||
import * as interfaces from './interfaces/index.js';
|
|
||||||
|
|
||||||
// classes
|
// classes
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
import {
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
type ISocketFunctionCallDataRequest,
|
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
SocketFunction,
|
import { SocketRequest } from './smartsocket.classes.socketrequest';
|
||||||
type ISocketFunctionCallDataResponse,
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
} from './smartsocket.classes.socketfunction.js';
|
import { SocketServer } from './smartsocket.classes.socketserver';
|
||||||
import { SocketRequest } from './smartsocket.classes.socketrequest.js';
|
|
||||||
import { SocketServer } from './smartsocket.classes.socketserver.js';
|
|
||||||
|
|
||||||
import { logger } from './smartsocket.logging.js';
|
// socket.io
|
||||||
|
import * as SocketIO from 'socket.io';
|
||||||
|
|
||||||
export interface ISmartsocketConstructorOptions {
|
export interface ISmartsocketConstructorOptions {
|
||||||
alias: string;
|
|
||||||
port?: number;
|
port?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Smartsocket {
|
export class Smartsocket {
|
||||||
/**
|
|
||||||
* a unique id to detect server restarts
|
|
||||||
*/
|
|
||||||
public alias: string;
|
|
||||||
public smartenv = new plugins.smartenv.Smartenv();
|
|
||||||
public options: ISmartsocketConstructorOptions;
|
public options: ISmartsocketConstructorOptions;
|
||||||
public io: pluginsTyped.socketIo.Server;
|
public io: SocketIO.Server;
|
||||||
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
public openSockets = new Objectmap<SocketConnection>();
|
||||||
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
public socketRoles = new Objectmap<SocketRole>();
|
||||||
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
|
||||||
|
|
||||||
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
|
||||||
|
|
||||||
private socketServer = new SocketServer(this);
|
private socketServer = new SocketServer(this);
|
||||||
|
|
||||||
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
||||||
this.options = optionsArg;
|
this.options = optionsArg;
|
||||||
this.alias = plugins.isounique.uni(this.options.alias);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// tslint:disable-next-line:member-ordering
|
||||||
public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
|
public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
|
||||||
await this.socketServer.setExternalServer(serverType, serverArg);
|
await this.socketServer.setExternalServer(serverType, serverArg);
|
||||||
}
|
}
|
||||||
@ -48,16 +37,9 @@ export class Smartsocket {
|
|||||||
* starts smartsocket
|
* starts smartsocket
|
||||||
*/
|
*/
|
||||||
public async start() {
|
public async start() {
|
||||||
const socketIoModule = await this.smartenv.getSafeNodeModule('socket.io');
|
this.io = plugins.socketIo(this.socketServer.getServerForSocketIo());
|
||||||
this.io = new socketIoModule.Server(await this.socketServer.getServerForSocketIo(), {
|
|
||||||
cors: {
|
|
||||||
allowedHeaders: '*',
|
|
||||||
methods: '*',
|
|
||||||
origin: '*',
|
|
||||||
},
|
|
||||||
});
|
|
||||||
await this.socketServer.start();
|
await this.socketServer.start();
|
||||||
this.io.on('connection', (socketArg) => {
|
this.io.on('connection', socketArg => {
|
||||||
this._handleSocketConnection(socketArg);
|
this._handleSocketConnection(socketArg);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -67,16 +49,14 @@ export class Smartsocket {
|
|||||||
*/
|
*/
|
||||||
public async stop() {
|
public async stop() {
|
||||||
await plugins.smartdelay.delayFor(1000);
|
await plugins.smartdelay.delayFor(1000);
|
||||||
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
this.openSockets.forEach((socketObjectArg: SocketConnection) => {
|
||||||
if (socketObjectArg) {
|
plugins.smartlog.defaultLogger.log(
|
||||||
logger.log(
|
|
||||||
'info',
|
'info',
|
||||||
`disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`
|
`disconnect socket with >>alias ${socketObjectArg.alias}`
|
||||||
);
|
);
|
||||||
socketObjectArg.disconnect();
|
socketObjectArg.socket.disconnect();
|
||||||
}
|
|
||||||
});
|
});
|
||||||
this.socketConnections.wipe();
|
this.openSockets.wipe();
|
||||||
this.io.close();
|
this.io.close();
|
||||||
|
|
||||||
// stop the corresponging server
|
// stop the corresponging server
|
||||||
@ -88,50 +68,59 @@ export class Smartsocket {
|
|||||||
/**
|
/**
|
||||||
* allows call to specific client.
|
* allows call to specific client.
|
||||||
*/
|
*/
|
||||||
public async clientCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
public async clientCall(
|
||||||
functionNameArg: T['method'],
|
functionNameArg: string,
|
||||||
dataArg: T['request'],
|
dataArg: any,
|
||||||
targetSocketConnectionArg: SocketConnection
|
targetSocketConnectionArg: SocketConnection
|
||||||
): Promise<T['response']> {
|
) {
|
||||||
const socketRequest = new SocketRequest<T>(this, {
|
const done = plugins.smartpromise.defer();
|
||||||
|
const socketRequest = new SocketRequest({
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcDataArg: dataArg,
|
funcDataArg: dataArg,
|
||||||
funcName: functionNameArg,
|
funcName: functionNameArg
|
||||||
},
|
},
|
||||||
originSocketConnection: targetSocketConnectionArg,
|
originSocketConnection: targetSocketConnectionArg,
|
||||||
shortId: plugins.isounique.uni(),
|
shortId: plugins.shortid.generate(),
|
||||||
side: 'requesting',
|
side: 'requesting'
|
||||||
});
|
});
|
||||||
const response: ISocketFunctionCallDataResponse<T> = await socketRequest.dispatch();
|
socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
|
||||||
const result = response.funcDataArg;
|
done.resolve(dataArg2.funcDataArg);
|
||||||
|
});
|
||||||
|
const result = await done.promise;
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
/**
|
||||||
this.socketFunctions.add(socketFunction);
|
* adds socketRoles
|
||||||
|
*/
|
||||||
|
public addSocketRoles(socketRolesArray: SocketRole[]): void {
|
||||||
|
for (const socketRole of socketRolesArray) {
|
||||||
|
this.socketRoles.add(socketRole);
|
||||||
|
}
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the standard handler for new socket connections
|
* the standard handler for new socket connections
|
||||||
*/
|
*/
|
||||||
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
|
private _handleSocketConnection(socketArg) {
|
||||||
const socketConnection: SocketConnection = new SocketConnection({
|
const socketConnection: SocketConnection = new SocketConnection({
|
||||||
alias: undefined,
|
alias: undefined,
|
||||||
authenticated: false,
|
authenticated: false,
|
||||||
|
role: undefined,
|
||||||
side: 'server',
|
side: 'server',
|
||||||
smartsocketHost: this,
|
smartsocketHost: this,
|
||||||
socket: socketArg,
|
socket: socketArg
|
||||||
});
|
});
|
||||||
logger.log('info', 'Socket connected. Trying to authenticate...');
|
plugins.smartlog.defaultLogger.log('info', 'Socket connected. Trying to authenticate...');
|
||||||
this.socketConnections.add(socketConnection);
|
this.openSockets.add(socketConnection);
|
||||||
const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
|
socketConnection
|
||||||
if (eventArg === 'disconnected') {
|
.authenticate()
|
||||||
this.socketConnections.remove(socketConnection);
|
.then(() => {
|
||||||
disconnectSubscription.unsubscribe();
|
return socketConnection.listenToFunctionRequests();
|
||||||
}
|
})
|
||||||
|
.catch(err => {
|
||||||
|
console.log(err);
|
||||||
});
|
});
|
||||||
await socketConnection.authenticate();
|
|
||||||
await socketConnection.listenToFunctionRequests();
|
|
||||||
await socketConnection.socket.emit('serverFullyReactive');
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,14 +1,8 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
|
||||||
import * as interfaces from './interfaces/index.js';
|
|
||||||
|
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import {
|
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
type ISocketFunctionCallDataRequest,
|
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
|
||||||
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
|
||||||
@ -17,301 +11,80 @@ export interface ISmartsocketClientOptions {
|
|||||||
port: number;
|
port: number;
|
||||||
url: string;
|
url: string;
|
||||||
alias: string; // an alias makes it easier to identify this client in a multo client environment
|
alias: string; // an alias makes it easier to identify this client in a multo client environment
|
||||||
autoReconnect?: boolean;
|
role: string;
|
||||||
maxRetries?: number; // maximum number of reconnection attempts
|
password: string; // by setting a password access to functions can be limited
|
||||||
initialBackoffDelay?: number; // initial backoff delay in ms
|
|
||||||
maxBackoffDelay?: number; // maximum backoff delay in ms
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export class SmartsocketClient {
|
export class SmartsocketClient {
|
||||||
// a unique id
|
alias: string;
|
||||||
public shortId = plugins.isounique.uni();
|
role: string;
|
||||||
|
socketConnection: SocketConnection;
|
||||||
// the shortId of the remote we connect to
|
serverUrl: string;
|
||||||
public remoteShortId: string = null;
|
serverPort: number;
|
||||||
|
serverPassword: string;
|
||||||
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) {
|
constructor(optionsArg: ISmartsocketClientOptions) {
|
||||||
this.alias = optionsArg.alias;
|
this.alias = optionsArg.alias;
|
||||||
|
this.role = optionsArg.role;
|
||||||
this.serverUrl = optionsArg.url;
|
this.serverUrl = optionsArg.url;
|
||||||
this.serverPort = optionsArg.port;
|
this.serverPort = optionsArg.port;
|
||||||
this.autoReconnect = optionsArg.autoReconnect;
|
this.serverPassword = optionsArg.password;
|
||||||
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
|
* connect the client to the server
|
||||||
*/
|
*/
|
||||||
public async connect() {
|
connect() {
|
||||||
// Reset retry counters on new connection attempt
|
let done = plugins.smartpromise.defer();
|
||||||
this.currentRetryCount = 0;
|
plugins.smartlog.defaultLogger.log('info', 'trying to connect...');
|
||||||
this.currentBackoffDelay = this.initialBackoffDelay;
|
let socketUrl = `${this.serverUrl}:${this.serverPort}`;
|
||||||
|
|
||||||
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({
|
this.socketConnection = new SocketConnection({
|
||||||
alias: this.alias,
|
alias: this.alias,
|
||||||
authenticated: false,
|
authenticated: false,
|
||||||
|
role: undefined,
|
||||||
side: 'client',
|
side: 'client',
|
||||||
smartsocketHost: this,
|
smartsocketHost: null,
|
||||||
socket: await socketIoClient
|
socket: plugins.socketIoClient(socketUrl, { multiplex: false })
|
||||||
.connect(socketUrl, {
|
|
||||||
multiplex: true,
|
|
||||||
rememberUpgrade: true,
|
|
||||||
autoConnect: false,
|
|
||||||
reconnectionAttempts: 0,
|
|
||||||
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
|
|
||||||
})
|
|
||||||
.open(),
|
|
||||||
});
|
});
|
||||||
|
this.socketConnection.socket.on('requestAuth', () => {
|
||||||
const timer = new plugins.smarttime.Timer(5000);
|
console.log('server requested authentication');
|
||||||
timer.start();
|
this.socketConnection.socket.emit('dataAuth', {
|
||||||
timer.completed.then(() => {
|
role: this.role,
|
||||||
this.updateStatus('timedOut');
|
password: this.serverPassword,
|
||||||
logger.log('warn', 'connection to server timed out.');
|
alias: this.alias
|
||||||
this.disconnect(true);
|
|
||||||
});
|
});
|
||||||
|
this.socketConnection.socket.on('authenticated', () => {
|
||||||
// authentication flow
|
console.log('client is authenticated');
|
||||||
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;
|
this.socketConnection.authenticated = true;
|
||||||
await this.socketConnection.listenToFunctionRequests();
|
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();
|
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;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
private disconnectRunning = false;
|
disconnect() {
|
||||||
|
let done = plugins.smartpromise.defer();
|
||||||
/**
|
this.socketConnection.socket.disconnect();
|
||||||
* 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;
|
this.socketConnection = undefined;
|
||||||
logger.log('ok', 'disconnected socket!');
|
plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
|
||||||
} else {
|
done.resolve();
|
||||||
this.disconnectRunning = false;
|
return done.promise;
|
||||||
logger.log('warn', 'tried to disconnect, without a SocketConnection');
|
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.log('warn', `disconnected from server ${this.remoteShortId}`);
|
serverCall(functionNameArg: string, dataArg: any) {
|
||||||
this.remoteShortId = null;
|
let done = plugins.smartpromise.defer();
|
||||||
|
let socketRequest = new SocketRequest({
|
||||||
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',
|
side: 'requesting',
|
||||||
originSocketConnection: this.socketConnection,
|
originSocketConnection: this.socketConnection,
|
||||||
shortId: plugins.isounique.uni(),
|
shortId: plugins.shortid.generate(),
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcName: functionNameArg,
|
funcName: functionNameArg,
|
||||||
funcDataArg: dataArg,
|
funcDataArg: dataArg
|
||||||
},
|
}
|
||||||
});
|
});
|
||||||
const response = await socketRequest.dispatch();
|
socketRequest.dispatch().then((dataArg: ISocketFunctionCall) => {
|
||||||
const result = response.funcDataArg;
|
done.resolve(dataArg.funcDataArg);
|
||||||
return result;
|
});
|
||||||
}
|
return done.promise;
|
||||||
|
|
||||||
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;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,15 +1,20 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
import * as helpers from './smartsocket.helpers';
|
||||||
import * as interfaces from './interfaces/index.js';
|
|
||||||
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
import { SocketFunction } from './smartsocket.classes.socketfunction.js';
|
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
import { SocketRequest, type ISocketRequestDataObject } from './smartsocket.classes.socketrequest.js';
|
import {
|
||||||
|
SocketRequest,
|
||||||
|
ISocketRequestDataObject,
|
||||||
|
allSocketRequests
|
||||||
|
} from './smartsocket.classes.socketrequest';
|
||||||
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
|
|
||||||
// socket.io
|
// socket.io
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
import * as SocketIO from 'socket.io';
|
||||||
import { logger } from './smartsocket.logging.js';
|
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
|
|
||||||
@ -24,129 +29,85 @@ export type TSocketConnectionSide = 'server' | 'client';
|
|||||||
export interface ISocketConnectionConstructorOptions {
|
export interface ISocketConnectionConstructorOptions {
|
||||||
alias: string;
|
alias: string;
|
||||||
authenticated: boolean;
|
authenticated: boolean;
|
||||||
|
role: SocketRole;
|
||||||
side: TSocketConnectionSide;
|
side: TSocketConnectionSide;
|
||||||
smartsocketHost: Smartsocket | SmartsocketClient;
|
smartsocketHost: Smartsocket;
|
||||||
socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
socket: SocketIO.Socket | SocketIOClient.Socket;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for authentication data
|
* interface for authentication data
|
||||||
*/
|
*/
|
||||||
export interface ISocketConnectionAuthenticationObject {
|
export interface ISocketConnectionAuthenticationObject {
|
||||||
alias: string;
|
role: 'coreflowContainer';
|
||||||
|
password: 'somePassword';
|
||||||
|
alias: 'coreflow1';
|
||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
export let allSocketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
export let allSocketConnections = new Objectmap<SocketConnection>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class SocketConnection represents a websocket connection
|
* class SocketConnection represents a websocket connection
|
||||||
*/
|
*/
|
||||||
export class SocketConnection {
|
export class SocketConnection {
|
||||||
public alias: string;
|
alias: string;
|
||||||
public side: TSocketConnectionSide;
|
side: TSocketConnectionSide;
|
||||||
public authenticated: boolean = false;
|
authenticated: boolean = false;
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
role: SocketRole;
|
||||||
public socket: pluginsTyped.socketIo.Socket | pluginsTyped.socketIoClient.Socket;
|
smartsocketHost: Smartsocket;
|
||||||
|
socket: any; // SocketIO.Socket | 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) {
|
constructor(optionsArg: ISocketConnectionConstructorOptions) {
|
||||||
this.alias = optionsArg.alias;
|
this.alias = optionsArg.alias;
|
||||||
this.authenticated = optionsArg.authenticated;
|
this.authenticated = optionsArg.authenticated;
|
||||||
|
this.role = optionsArg.role;
|
||||||
this.side = optionsArg.side;
|
this.side = optionsArg.side;
|
||||||
this.smartsocketRef = optionsArg.smartsocketHost;
|
this.smartsocketHost = optionsArg.smartsocketHost;
|
||||||
this.socket = optionsArg.socket;
|
this.socket = optionsArg.socket;
|
||||||
|
|
||||||
// standard behaviour that is always true
|
// standard behaviour that is always true
|
||||||
allSocketConnections.add(this);
|
allSocketConnections.add(this);
|
||||||
|
this.socket.on('disconnect', () => {
|
||||||
// handle connection
|
plugins.smartlog.defaultLogger.log(
|
||||||
this.socket.on('connect', async () => {
|
|
||||||
this.updateStatus('connected');
|
|
||||||
});
|
|
||||||
this.socket.on('disconnect', async () => {
|
|
||||||
logger.log(
|
|
||||||
'info',
|
'info',
|
||||||
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
|
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
|
||||||
);
|
);
|
||||||
await this.disconnect();
|
this.socket.disconnect();
|
||||||
allSocketConnections.remove(this);
|
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 --------------------------
|
// authenticating --------------------------
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* authenticate the socket
|
* authenticate the socket
|
||||||
*/
|
*/
|
||||||
public authenticate() {
|
authenticate() {
|
||||||
const done = plugins.smartpromise.defer();
|
let done = plugins.smartpromise.defer();
|
||||||
this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
|
this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
|
||||||
logger.log('info', 'received authentication data...');
|
plugins.smartlog.defaultLogger.log(
|
||||||
this.socket.removeAllListeners('dataAuth');
|
'info',
|
||||||
if (dataArg.alias) {
|
'received authentication data. now hashing and comparing...'
|
||||||
|
);
|
||||||
|
this.socket.removeListener('dataAuth', () => {});
|
||||||
|
if (helpers.checkPasswordForRole(dataArg, this.smartsocketHost)) {
|
||||||
// TODO: authenticate password
|
// TODO: authenticate password
|
||||||
this.alias = dataArg.alias;
|
this.alias = dataArg.alias;
|
||||||
this.authenticated = true;
|
this.authenticated = true;
|
||||||
|
this.role = helpers.getSocketRoleByName(dataArg.role, this.smartsocketHost);
|
||||||
this.socket.emit('authenticated');
|
this.socket.emit('authenticated');
|
||||||
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
|
plugins.smartlog.defaultLogger.log(
|
||||||
|
'ok',
|
||||||
|
`socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`
|
||||||
|
);
|
||||||
done.resolve(this);
|
done.resolve(this);
|
||||||
} else {
|
} else {
|
||||||
this.authenticated = false;
|
this.authenticated = false;
|
||||||
await this.disconnect();
|
this.socket.disconnect();
|
||||||
done.reject('a socket tried to connect, but could not authenticated.');
|
done.reject('not authenticated');
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
const requestAuthPayload: interfaces.IRequestAuthPayload = {
|
this.socket.emit('requestAuth');
|
||||||
serverAlias: this.smartsocketRef.alias,
|
|
||||||
};
|
|
||||||
this.socket.emit('requestAuth', requestAuthPayload);
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -155,70 +116,53 @@ export class SocketConnection {
|
|||||||
/**
|
/**
|
||||||
* listen to function requests
|
* listen to function requests
|
||||||
*/
|
*/
|
||||||
public listenToFunctionRequests() {
|
listenToFunctionRequests() {
|
||||||
const done = plugins.smartpromise.defer();
|
let done = plugins.smartpromise.defer();
|
||||||
if (this.authenticated) {
|
if (this.authenticated) {
|
||||||
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
this.socket.on('function', (dataArg: ISocketRequestDataObject) => {
|
||||||
// check if requested function is available to the socket's scope
|
// check if requested function is available to the socket's scope
|
||||||
// logger.log('info', 'function request received');
|
plugins.smartlog.defaultLogger.log('info', 'function request received');
|
||||||
const referencedFunction: SocketFunction<any> =
|
let referencedFunction: SocketFunction = this.role.allowedFunctions.find(
|
||||||
this.smartsocketRef.socketFunctions.findSync((socketFunctionArg) => {
|
socketFunctionArg => {
|
||||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||||
});
|
}
|
||||||
if (referencedFunction) {
|
);
|
||||||
// logger.log('ok', 'function in access scope');
|
if (referencedFunction !== undefined) {
|
||||||
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
plugins.smartlog.defaultLogger.log('ok', 'function in access scope');
|
||||||
|
let localSocketRequest = new SocketRequest({
|
||||||
side: 'responding',
|
side: 'responding',
|
||||||
originSocketConnection: this,
|
originSocketConnection: this,
|
||||||
shortId: dataArg.shortId,
|
shortId: dataArg.shortId,
|
||||||
funcCallData: dataArg.funcCallData,
|
funcCallData: dataArg.funcCallData
|
||||||
});
|
});
|
||||||
localSocketRequest.createResponse(); // takes care of creating response and sending it back
|
localSocketRequest.createResponse(); // takes care of creating response and sending it back
|
||||||
} else {
|
} else {
|
||||||
logger.log('warn', 'function not existent or out of access scope');
|
plugins.smartlog.defaultLogger.log(
|
||||||
|
'warn',
|
||||||
|
'function not existent or out of access scope'
|
||||||
|
);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
|
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject) => {
|
||||||
// logger.log('info', `received response for request with id ${dataArg.shortId}`);
|
plugins.smartlog.defaultLogger.log(
|
||||||
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
'info',
|
||||||
this.smartsocketRef,
|
`received response for request with id ${dataArg.shortId}`
|
||||||
dataArg.shortId
|
|
||||||
);
|
);
|
||||||
|
let targetSocketRequest = helpers.getSocketRequestById(dataArg.shortId);
|
||||||
targetSocketRequest.handleResponse(dataArg);
|
targetSocketRequest.handleResponse(dataArg);
|
||||||
});
|
});
|
||||||
|
plugins.smartlog.defaultLogger.log(
|
||||||
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',
|
'info',
|
||||||
`now listening to function requests for ${this.alias} on side ${this.side}`
|
`now listening to function requests for ${this.alias}`
|
||||||
);
|
);
|
||||||
done.resolve(this);
|
done.resolve(this);
|
||||||
} else {
|
} else {
|
||||||
const errMessage = 'socket needs to be authenticated first';
|
let errMessage: 'socket needs to be authenticated first';
|
||||||
logger.log('error', errMessage);
|
plugins.smartlog.defaultLogger.log('error', errMessage);
|
||||||
done.reject(errMessage);
|
done.reject(errMessage);
|
||||||
}
|
}
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
// disconnecting ----------------------
|
// sending ----------------------
|
||||||
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,93 +1,83 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface of the contructor options of class SocketFunction
|
* interface of the contructor options of class SocketFunction
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionConstructorOptions<
|
export interface ISocketFunctionConstructorOptions {
|
||||||
T extends plugins.typedrequestInterfaces.ITypedRequest
|
funcName: string;
|
||||||
> {
|
funcDef: TFuncDef;
|
||||||
funcName: T['method'];
|
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
||||||
funcDef: TFuncDef<T>;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface of the Socket Function call, in other words the object that routes a call to a function
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionCallDataRequest<
|
export interface ISocketFunctionCall {
|
||||||
T extends plugins.typedrequestInterfaces.ITypedRequest
|
funcName: string;
|
||||||
> {
|
funcDataArg: any;
|
||||||
funcName: T['method'];
|
|
||||||
funcDataArg: T['request'];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* interface of the Socket Function call, in other words the object that routes a call to a function
|
|
||||||
*/
|
|
||||||
export interface ISocketFunctionCallDataResponse<
|
|
||||||
T extends plugins.typedrequestInterfaces.ITypedRequest
|
|
||||||
> {
|
|
||||||
funcName: T['method'];
|
|
||||||
funcDataArg: T['response'];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for function definition of SocketFunction
|
* interface for function definition of SocketFunction
|
||||||
*/
|
*/
|
||||||
export type TFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
|
export type TFuncDef = (dataArg: any, connectionArg: SocketConnection) => PromiseLike<any>;
|
||||||
dataArg: T['request'],
|
|
||||||
connectionArg: SocketConnection
|
// export objects
|
||||||
) => PromiseLike<T['response']>;
|
export let allSocketFunctions = new Objectmap<SocketFunction>();
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class that respresents a function that can be transparently called using a SocketConnection
|
* class that respresents a function that can be transparently called using a SocketConnection
|
||||||
*/
|
*/
|
||||||
export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
export class SocketFunction {
|
||||||
// STATIC
|
name: string;
|
||||||
public static getSocketFunctionByName<Q extends plugins.typedrequestInterfaces.ITypedRequest>(
|
funcDef: TFuncDef;
|
||||||
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
roles: SocketRole[];
|
||||||
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
|
* the constructor for SocketFunction
|
||||||
*/
|
*/
|
||||||
constructor(optionsArg: ISocketFunctionConstructorOptions<T>) {
|
constructor(optionsArg: ISocketFunctionConstructorOptions) {
|
||||||
this.name = optionsArg.funcName;
|
this.name = optionsArg.funcName;
|
||||||
this.funcDef = optionsArg.funcDef;
|
this.funcDef = optionsArg.funcDef;
|
||||||
|
this.roles = optionsArg.allowedRoles;
|
||||||
|
for (let socketRoleArg of this.roles) {
|
||||||
|
this._notifyRole(socketRoleArg);
|
||||||
|
}
|
||||||
|
allSocketFunctions.add(this); // map instance with Objectmap
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* invokes the function of this SocketFunction
|
* invokes the function of this SocketFunction
|
||||||
*/
|
*/
|
||||||
public async invoke(
|
invoke(dataArg: ISocketFunctionCall, socketConnectionArg: SocketConnection): Promise<any> {
|
||||||
dataArg: ISocketFunctionCallDataRequest<T>,
|
let done = plugins.smartpromise.defer();
|
||||||
socketConnectionArg: SocketConnection
|
|
||||||
): Promise<ISocketFunctionCallDataResponse<T>> {
|
|
||||||
if (dataArg.funcName === this.name) {
|
if (dataArg.funcName === this.name) {
|
||||||
const funcResponseData: ISocketFunctionCallDataResponse<T> = {
|
this.funcDef(dataArg.funcDataArg, socketConnectionArg).then((resultData: any) => {
|
||||||
|
let funcResponseData: ISocketFunctionCall = {
|
||||||
funcName: this.name,
|
funcName: this.name,
|
||||||
funcDataArg: await this.funcDef(dataArg.funcDataArg, socketConnectionArg),
|
funcDataArg: resultData
|
||||||
};
|
};
|
||||||
return funcResponseData;
|
done.resolve(funcResponseData);
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
||||||
}
|
}
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* notifies a role about access to this SocketFunction
|
||||||
|
*/
|
||||||
|
private _notifyRole(socketRoleArg: SocketRole) {
|
||||||
|
socketRoleArg.addSocketFunction(this);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,17 +1,14 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
import * as helpers from './smartsocket.helpers';
|
||||||
|
|
||||||
// import interfaces
|
// import interfaces
|
||||||
import {
|
import { ISocketFunctionCall } from './smartsocket.classes.socketfunction';
|
||||||
SocketFunction,
|
|
||||||
type ISocketFunctionCallDataRequest,
|
|
||||||
type ISocketFunctionCallDataResponse,
|
|
||||||
} from './smartsocket.classes.socketfunction.js';
|
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
import { logger } from './smartsocket.logging.js';
|
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
|
import { defaultLogger } from '@pushrocks/smartlog';
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
|
export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
|
||||||
@ -20,56 +17,39 @@ export type TSocketRequestSide = 'requesting' | 'responding';
|
|||||||
/**
|
/**
|
||||||
* interface of constructor of class SocketRequest
|
* interface of constructor of class SocketRequest
|
||||||
*/
|
*/
|
||||||
export interface ISocketRequestConstructorOptions<
|
export interface SocketRequestConstructorOptions {
|
||||||
T extends plugins.typedrequestInterfaces.ITypedRequest
|
|
||||||
> {
|
|
||||||
side: TSocketRequestSide;
|
side: TSocketRequestSide;
|
||||||
originSocketConnection: SocketConnection;
|
originSocketConnection: SocketConnection;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
funcCallData?: ISocketFunctionCallDataRequest<T>;
|
funcCallData?: ISocketFunctionCall;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* request object that is sent initially and may or may not receive a response
|
* request object that is sent initially and may or may not receive a response
|
||||||
*/
|
*/
|
||||||
export interface ISocketRequestDataObject<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
export interface ISocketRequestDataObject {
|
||||||
funcCallData: ISocketFunctionCallDataRequest<T> | ISocketFunctionCallDataResponse<T>;
|
funcCallData: ISocketFunctionCall;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
responseTimeout?: number;
|
responseTimeout?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export objects
|
||||||
export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
export let allSocketRequests = new Objectmap<SocketRequest>();
|
||||||
// STATIC
|
|
||||||
public static getSocketRequestById(
|
|
||||||
smartsocketRef: Smartsocket | SmartsocketClient,
|
|
||||||
shortIdArg: string
|
|
||||||
): SocketRequest<any> {
|
|
||||||
return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
|
|
||||||
return socketRequestArg.shortid === shortIdArg;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// INSTANCE
|
// export classes
|
||||||
|
export class SocketRequest {
|
||||||
public status: TSocketRequestStatus = 'new';
|
public status: TSocketRequestStatus = 'new';
|
||||||
public side: TSocketRequestSide;
|
public side: TSocketRequestSide;
|
||||||
public shortid: string;
|
public shortid: string;
|
||||||
public originSocketConnection: SocketConnection;
|
public originSocketConnection: SocketConnection;
|
||||||
public funcCallData: ISocketFunctionCallDataRequest<T>;
|
public funcCallData: ISocketFunctionCall;
|
||||||
public done = plugins.smartpromise.defer<ISocketFunctionCallDataResponse<T>>();
|
public done = plugins.smartpromise.defer();
|
||||||
|
constructor(optionsArg: SocketRequestConstructorOptions) {
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
|
||||||
optionsArg: ISocketRequestConstructorOptions<T>
|
|
||||||
) {
|
|
||||||
this.smartsocketRef = smartsocketRefArg;
|
|
||||||
this.side = optionsArg.side;
|
this.side = optionsArg.side;
|
||||||
this.shortid = optionsArg.shortId;
|
this.shortid = optionsArg.shortId;
|
||||||
this.funcCallData = optionsArg.funcCallData;
|
this.funcCallData = optionsArg.funcCallData;
|
||||||
this.originSocketConnection = optionsArg.originSocketConnection;
|
this.originSocketConnection = optionsArg.originSocketConnection;
|
||||||
this.smartsocketRef.socketRequests.add(this);
|
allSocketRequests.add(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
// requesting --------------------------
|
// requesting --------------------------
|
||||||
@ -77,10 +57,10 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
|||||||
/**
|
/**
|
||||||
* dispatches a socketrequest from the requesting to the receiving side
|
* dispatches a socketrequest from the requesting to the receiving side
|
||||||
*/
|
*/
|
||||||
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
|
public dispatch() {
|
||||||
const requestData: ISocketRequestDataObject<T> = {
|
let requestData: ISocketRequestDataObject = {
|
||||||
funcCallData: this.funcCallData,
|
funcCallData: this.funcCallData,
|
||||||
shortId: this.shortid,
|
shortId: this.shortid
|
||||||
};
|
};
|
||||||
this.originSocketConnection.socket.emit('function', requestData);
|
this.originSocketConnection.socket.emit('function', requestData);
|
||||||
return this.done.promise;
|
return this.done.promise;
|
||||||
@ -89,10 +69,10 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
|||||||
/**
|
/**
|
||||||
* handles the response that is received by the requesting side
|
* handles the response that is received by the requesting side
|
||||||
*/
|
*/
|
||||||
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
public handleResponse(responseDataArg: ISocketRequestDataObject) {
|
||||||
// logger.log('info', 'handling response!');
|
plugins.smartlog.defaultLogger.log('info', 'handling response!');
|
||||||
this.done.resolve(responseDataArg.funcCallData);
|
this.done.resolve(responseDataArg.funcCallData);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
allSocketRequests.remove(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
// responding --------------------------
|
// responding --------------------------
|
||||||
@ -101,26 +81,26 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
|||||||
* creates the response on the responding side
|
* creates the response on the responding side
|
||||||
*/
|
*/
|
||||||
public async createResponse(): Promise<void> {
|
public async createResponse(): Promise<void> {
|
||||||
const targetSocketFunction: SocketFunction<T> = SocketFunction.getSocketFunctionByName(
|
const targetSocketFunction: SocketFunction = helpers.getSocketFunctionByName(
|
||||||
this.smartsocketRef,
|
|
||||||
this.funcCallData.funcName
|
this.funcCallData.funcName
|
||||||
);
|
);
|
||||||
|
|
||||||
if (!targetSocketFunction) {
|
if (!targetSocketFunction) {
|
||||||
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
defaultLogger.log(
|
||||||
|
'warn',
|
||||||
|
`There is no SocketFunction defined for ${this.funcCallData.funcName}`
|
||||||
|
);
|
||||||
|
defaultLogger.log('warn', `So now response is being sent.`);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// logger.log('info', `invoking ${targetSocketFunction.name}`);
|
plugins.smartlog.defaultLogger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||||
targetSocketFunction
|
targetSocketFunction.invoke(this.funcCallData, this.originSocketConnection).then(resultData => {
|
||||||
.invoke(this.funcCallData, this.originSocketConnection)
|
plugins.smartlog.defaultLogger.log('info', 'got resultData. Sending it to requesting party.');
|
||||||
.then((resultData) => {
|
let requestData: ISocketRequestDataObject = {
|
||||||
// logger.log('info', 'got resultData. Sending it to requesting party.');
|
|
||||||
const responseData: ISocketRequestDataObject<T> = {
|
|
||||||
funcCallData: resultData,
|
funcCallData: resultData,
|
||||||
shortId: this.shortid,
|
shortId: this.shortid
|
||||||
};
|
};
|
||||||
this.originSocketConnection.socket.emit('functionResponse', responseData);
|
this.originSocketConnection.socket.emit('functionResponse', requestData);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
allSocketRequests.remove(this);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
29
ts/smartsocket.classes.socketrole.ts
Normal file
29
ts/smartsocket.classes.socketrole.ts
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
|
// import classes
|
||||||
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
|
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
allowedFunctions = new Objectmap<SocketFunction>();
|
||||||
|
constructor(optionsArg: SocketRoleOptions) {
|
||||||
|
this.name = optionsArg.name;
|
||||||
|
this.passwordHash = optionsArg.passwordHash;
|
||||||
|
}
|
||||||
|
addSocketFunction(socketFunctionArg: SocketFunction) {
|
||||||
|
this.allowedFunctions.add(socketFunctionArg);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,9 +1,8 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
import * as plugins from './smartsocket.plugins';
|
||||||
import * as pluginsTyped from './smartsocket.pluginstyped.js';
|
|
||||||
|
|
||||||
// used in case no other server is supplied
|
// used in case no other server is supplied
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
|
import * as http from 'http';
|
||||||
import { logger } from './smartsocket.logging.js';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class socketServer
|
* class socketServer
|
||||||
@ -11,13 +10,10 @@ import { logger } from './smartsocket.logging.js';
|
|||||||
*/
|
*/
|
||||||
export class SocketServer {
|
export class SocketServer {
|
||||||
private smartsocket: Smartsocket;
|
private smartsocket: Smartsocket;
|
||||||
private httpServerDeferred: plugins.smartpromise.Deferred<any>;
|
private httpServer: http.Server;
|
||||||
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
// wether httpServer is standalone
|
||||||
|
|
||||||
/**
|
|
||||||
* wether httpServer is standalone
|
|
||||||
*/
|
|
||||||
private standaloneServer = false;
|
private standaloneServer = false;
|
||||||
|
private expressServer: any;
|
||||||
|
|
||||||
constructor(smartSocketInstance: Smartsocket) {
|
constructor(smartSocketInstance: Smartsocket) {
|
||||||
this.smartsocket = smartSocketInstance;
|
this.smartsocket = smartSocketInstance;
|
||||||
@ -29,26 +25,20 @@ export class SocketServer {
|
|||||||
*/
|
*/
|
||||||
public async setExternalServer(
|
public async setExternalServer(
|
||||||
serverType: 'smartexpress',
|
serverType: 'smartexpress',
|
||||||
serverArg: pluginsTyped.typedserver.servertools.Server
|
serverArg: plugins.smartexpress.Server
|
||||||
) {
|
) {
|
||||||
this.httpServerDeferred = plugins.smartpromise.defer();
|
|
||||||
await serverArg.startedPromise;
|
await serverArg.startedPromise;
|
||||||
this.httpServer = serverArg.httpServer;
|
this.httpServer = serverArg.httpServer;
|
||||||
this.httpServerDeferred.resolve();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gets the server for socket.io
|
* gets the server for socket.io
|
||||||
*/
|
*/
|
||||||
public async getServerForSocketIo() {
|
public getServerForSocketIo() {
|
||||||
if (this.httpServerDeferred) {
|
|
||||||
await this.httpServerDeferred.promise;
|
|
||||||
}
|
|
||||||
if (this.httpServer) {
|
if (this.httpServer) {
|
||||||
return this.httpServer;
|
return this.httpServer;
|
||||||
} else {
|
} else {
|
||||||
const httpModule = await this.smartsocket.smartenv.getSafeNodeModule('http');
|
this.httpServer = new http.Server();
|
||||||
this.httpServer = new httpModule.Server();
|
|
||||||
this.standaloneServer = true;
|
this.standaloneServer = true;
|
||||||
return this.httpServer;
|
return this.httpServer;
|
||||||
}
|
}
|
||||||
@ -64,14 +54,11 @@ export class SocketServer {
|
|||||||
// in case an external server has been set "this.standaloneServer" should be false
|
// in case an external server has been set "this.standaloneServer" should be false
|
||||||
if (this.httpServer && this.standaloneServer) {
|
if (this.httpServer && this.standaloneServer) {
|
||||||
if (!this.smartsocket.options.port) {
|
if (!this.smartsocket.options.port) {
|
||||||
logger.log('error', 'there should be a port specifed for smartsocket!');
|
console.log('there should be a port specifed for smartsocket!');
|
||||||
throw new Error('there should be a port specified for smartsocket');
|
throw new Error('there should be a port specified for smartsocket');
|
||||||
}
|
}
|
||||||
this.httpServer.listen(this.smartsocket.options.port, () => {
|
this.httpServer.listen(this.smartsocket.options.port, () => {
|
||||||
logger.log(
|
console.log(`Server started in standalone mode on ${this.smartsocket.options.port}`);
|
||||||
'success',
|
|
||||||
`Server started in standalone mode on ${this.smartsocket.options.port}`
|
|
||||||
);
|
|
||||||
done.resolve();
|
done.resolve();
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
@ -86,9 +73,5 @@ export class SocketServer {
|
|||||||
/**
|
/**
|
||||||
* closes the server
|
* closes the server
|
||||||
*/
|
*/
|
||||||
public async stop() {
|
public async stop() {}
|
||||||
if (this.httpServer) {
|
|
||||||
this.httpServer.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
60
ts/smartsocket.helpers.ts
Normal file
60
ts/smartsocket.helpers.ts
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
|
// classes
|
||||||
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
|
import { SocketFunction, allSocketFunctions } from './smartsocket.classes.socketfunction';
|
||||||
|
import {
|
||||||
|
SocketConnection,
|
||||||
|
ISocketConnectionAuthenticationObject
|
||||||
|
} from './smartsocket.classes.socketconnection';
|
||||||
|
import {
|
||||||
|
SocketRequest,
|
||||||
|
allSocketRequests,
|
||||||
|
TSocketRequestSide
|
||||||
|
} from './smartsocket.classes.socketrequest';
|
||||||
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
|
|
||||||
|
// SocketConnection helpers
|
||||||
|
export let checkPasswordForRole = (
|
||||||
|
dataArg: ISocketConnectionAuthenticationObject,
|
||||||
|
referenceSmartsocket: Smartsocket
|
||||||
|
): boolean => {
|
||||||
|
let targetPasswordHash = getSocketRoleByName(dataArg.role, referenceSmartsocket).passwordHash;
|
||||||
|
let computedCompareHash = plugins.smarthash.sha256FromStringSync(dataArg.password);
|
||||||
|
return targetPasswordHash === computedCompareHash;
|
||||||
|
};
|
||||||
|
|
||||||
|
// SocketFunction helpers
|
||||||
|
export let getSocketFunctionByName = (functionNameArg: string): SocketFunction => {
|
||||||
|
return allSocketFunctions.find(socketFunctionArg => {
|
||||||
|
return socketFunctionArg.name === functionNameArg;
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// SocketRequest helpers
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get corresponding Socketrequest instance by shortId
|
||||||
|
*/
|
||||||
|
export let getSocketRequestById = (
|
||||||
|
shortIdArg: string,
|
||||||
|
requestSide?: TSocketRequestSide
|
||||||
|
): SocketRequest => {
|
||||||
|
return allSocketRequests.find(socketRequestArg => {
|
||||||
|
return socketRequestArg.shortid === shortIdArg;
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// SocketRole helpers
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get corresponding SocketRole instance by name
|
||||||
|
*/
|
||||||
|
export let getSocketRoleByName = (
|
||||||
|
socketRoleNameArg: string,
|
||||||
|
referenceSmartsocket: Smartsocket
|
||||||
|
): SocketRole => {
|
||||||
|
return referenceSmartsocket.socketRoles.find(socketRoleArg => {
|
||||||
|
return socketRoleArg.name === socketRoleNameArg;
|
||||||
|
});
|
||||||
|
};
|
||||||
@ -1,3 +0,0 @@
|
|||||||
import * as plugins from './smartsocket.plugins.js';
|
|
||||||
|
|
||||||
export const logger = new plugins.smartlog.ConsoleLog();
|
|
||||||
@ -1,29 +1,21 @@
|
|||||||
// apiglobal scope
|
import * as lik from '@pushrocks/lik';
|
||||||
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
import * as smartlog from '@pushrocks/smartlog';
|
||||||
|
import * as smarthash from '@pushrocks/smarthash';
|
||||||
export { typedrequestInterfaces };
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
|
import * as smartexpress from '@pushrocks/smartexpress';
|
||||||
// pushrocks scope
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as isohash from '@push.rocks/isohash';
|
import * as shortid from 'shortid';
|
||||||
import * as isounique from '@push.rocks/isounique';
|
import socketIo from 'socket.io';
|
||||||
import * as lik from '@push.rocks/lik';
|
import socketIoClient from 'socket.io-client';
|
||||||
import * as smartenv from '@push.rocks/smartenv';
|
|
||||||
import * as smartjson from '@push.rocks/smartjson';
|
|
||||||
import * as smartlog from '@push.rocks/smartlog';
|
|
||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
|
||||||
import * as smarttime from '@push.rocks/smarttime';
|
|
||||||
import * as smartrx from '@push.rocks/smartrx';
|
|
||||||
|
|
||||||
export {
|
export {
|
||||||
isohash,
|
|
||||||
isounique,
|
|
||||||
lik,
|
lik,
|
||||||
smartenv,
|
|
||||||
smartjson,
|
|
||||||
smartlog,
|
smartlog,
|
||||||
|
smarthash,
|
||||||
smartdelay,
|
smartdelay,
|
||||||
|
smartexpress,
|
||||||
smartpromise,
|
smartpromise,
|
||||||
smarttime,
|
shortid,
|
||||||
smartrx,
|
socketIo,
|
||||||
|
socketIoClient
|
||||||
};
|
};
|
||||||
|
|||||||
@ -1,23 +0,0 @@
|
|||||||
// 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;
|
|
||||||
}
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "NodeNext",
|
|
||||||
"moduleResolution": "NodeNext",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"verbatimModuleSyntax": true
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user