Compare commits
74 Commits
Author | SHA1 | Date | |
---|---|---|---|
3ee46a31f7 | |||
d72310ce10 | |||
1e14166ddb | |||
be38e91548 | |||
6c2057b119 | |||
08d7224016 | |||
bfa3330eb6 | |||
644fa2a49d | |||
c0dad3a977 | |||
a921033cc4 | |||
21e4712b04 | |||
df43bc2974 | |||
564988185d | |||
8442f3570f | |||
196357c878 | |||
bc187b7e41 | |||
0e54bf889f | |||
4c211bc82e | |||
a1be281670 | |||
1a44d2027c | |||
4bf5456a1d | |||
57c748657a | |||
15df24bf68 | |||
ca7470eedf | |||
38f017934c | |||
1980824540 | |||
09dec2071e | |||
a1443deafe | |||
9eac5ad336 | |||
cf607a79d5 | |||
8426c976bf | |||
1086065000 | |||
72196ec383 | |||
c6ad490a6f | |||
a40a83f0bf | |||
82fa029d05 | |||
0d76e7f577 | |||
57e6f058be | |||
b0bf9d7c95 | |||
1fbc76ef30 | |||
424d9cca91 | |||
d712270946 | |||
f98c797ad8 | |||
a23e7349be | |||
c390881a4e | |||
5e64f4ca25 | |||
765bc73197 | |||
105acaf97b | |||
5139136af4 | |||
bcc4ce9a87 | |||
20e7584eb9 | |||
59cbc343cc | |||
75aa1f6f0d | |||
3f073ab9b3 | |||
08c1618ea8 | |||
eb181fa2f6 | |||
c901ab75d3 | |||
075c59ed2c | |||
8d358dd93d | |||
e576d6058a | |||
6546da2394 | |||
29597daba1 | |||
c8b647d2fd | |||
1fa4aca049 | |||
2d4695de22 | |||
a3f4dcbc2a | |||
d6e81288b4 | |||
c441d89596 | |||
85b69e487a | |||
0d94ed9345 | |||
e188b18016 | |||
33c0fa3746 | |||
52be1415ee | |||
e75d5eabdb |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
@ -19,57 +19,71 @@ mirror:
|
|||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install --production --ignore-scripts
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command snyk test
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command npm run build
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -79,11 +93,15 @@ release:
|
|||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g tslint typescript
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- priv
|
- priv
|
||||||
|
|
||||||
@ -94,20 +112,20 @@ trigger:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-dbase:npmci
|
|
||||||
services:
|
|
||||||
- docker:18-dind
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
|
- npmci node install lts
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
|
10500
package-lock.json
generated
10500
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
66
package.json
66
package.json
@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartsocket",
|
"name": "@pushrocks/smartsocket",
|
||||||
"version": "1.1.41",
|
"version": "1.2.6",
|
||||||
"description": "easy and secure websocket communication",
|
"description": "easy and secure websocket communication",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "tstest test/",
|
"test": "(tstest test/)",
|
||||||
"build": "tsbuild"
|
"build": "(tsbuild --web && tsbundle --from ./ts/index.ts --to dist_bundle/bundle.js)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -19,38 +19,46 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
"homepage": "https://gitlab.com/pushrocks/smartsocket#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.10",
|
"@apiglobal/typedrequest-interfaces": "^1.0.15",
|
||||||
"@pushrocks/smartdelay": "^2.0.3",
|
"@pushrocks/isohash": "^1.0.2",
|
||||||
"@pushrocks/smartexpress": "^3.0.38",
|
"@pushrocks/isounique": "^1.0.4",
|
||||||
"@pushrocks/smarthash": "^2.0.6",
|
"@pushrocks/lik": "^4.0.20",
|
||||||
"@pushrocks/smartlog": "^2.0.19",
|
"@pushrocks/smartdelay": "^2.0.10",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartenv": "^4.0.16",
|
||||||
"@types/shortid": "0.0.29",
|
"@pushrocks/smartexpress": "^3.0.100",
|
||||||
"@types/socket.io": "^2.1.2",
|
"@pushrocks/smartjson": "^4.0.5",
|
||||||
"@types/socket.io-client": "^1.4.32",
|
"@pushrocks/smartlog": "^2.0.39",
|
||||||
"shortid": "^2.2.14",
|
"@pushrocks/smartpromise": "^3.1.3",
|
||||||
"socket.io": "^2.2.0",
|
"@pushrocks/smartrx": "^2.0.19",
|
||||||
"socket.io-client": "^2.2.0"
|
"@pushrocks/smarttime": "^3.0.38",
|
||||||
|
"@types/socket.io": "^2.1.13",
|
||||||
|
"@types/socket.io-client": "^1.4.35",
|
||||||
|
"socket.io": "^3.1.0",
|
||||||
|
"socket.io-client": "^3.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.11",
|
"@gitzone/tsbuild": "^2.1.25",
|
||||||
"@gitzone/tsrun": "^1.2.8",
|
"@gitzone/tsrun": "^1.2.12",
|
||||||
"@gitzone/tstest": "^1.0.24",
|
"@gitzone/tstest": "^1.0.52",
|
||||||
"@pushrocks/tapbundle": "^3.0.11",
|
"@pushrocks/tapbundle": "^3.2.10",
|
||||||
"@types/node": "^12.7.1",
|
"@types/node": "^14.14.22",
|
||||||
"tslint": "^5.18.0",
|
"tslint": "^6.1.3",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"tslint-config-prettier": "^1.18.0"
|
||||||
},
|
},
|
||||||
"private": false,
|
"private": false,
|
||||||
"files": [
|
"files": [
|
||||||
"ts/*",
|
"ts/**/*",
|
||||||
"ts_web/*",
|
"ts_web/**/*",
|
||||||
"dist/*",
|
"dist/**/*",
|
||||||
"dist_web/*",
|
"dist_*/**/*",
|
||||||
"dist_ts_web/*",
|
"dist_ts/**/*",
|
||||||
"assets/*",
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -8,13 +8,20 @@ easy and secure websocket communication
|
|||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/)
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartsocket/commits/master)
|
Status Category | Status Badge
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartsocket)
|
-- | --
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartsocket)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
npm | [](https://lossless.cloud)
|
||||||
[](https://prettier.io/)
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -30,7 +37,7 @@ import * as q from q; // q is a promise library
|
|||||||
|
|
||||||
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
|
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
|
||||||
let mySmartsocket = new smartsocket.Smartsocket({
|
let mySmartsocket = new smartsocket.Smartsocket({
|
||||||
port: 3000 // the port smartsocket will listen on
|
port: 3000, // the port smartsocket will listen on
|
||||||
});
|
});
|
||||||
|
|
||||||
// optional:
|
// optional:
|
||||||
@ -43,7 +50,7 @@ mySmartsocket.setServer(someExpressServer);
|
|||||||
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
|
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
|
||||||
let mySocketRole = new smartsocket.SocketRole({
|
let mySocketRole = new smartsocket.SocketRole({
|
||||||
name: 'someRoleName',
|
name: 'someRoleName',
|
||||||
passwordHash: 'someHashedString'
|
passwordHash: 'someHashedString',
|
||||||
});
|
});
|
||||||
|
|
||||||
// A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
|
// A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
|
||||||
@ -51,10 +58,10 @@ let mySocketRole = new smartsocket.SocketRole({
|
|||||||
// Any "SocketRequest" carries a unique identifier. If the referenced function's promise resolved any passed on argument will be returned to the requesting party
|
// 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({
|
let testSocketFunction1 = new smartsocket.SocketFunction({
|
||||||
funcName: 'testSocketFunction1',
|
funcName: 'testSocketFunction1',
|
||||||
funcDef: data => {
|
funcDef: (data) => {
|
||||||
console.log('testSocketFunction1 executed successfully!');
|
console.log('testSocketFunction1 executed successfully!');
|
||||||
},
|
},
|
||||||
allowedRoles: [mySocketRole] // all roles that have access to a specific function
|
allowedRoles: [mySocketRole], // all roles that have access to a specific function
|
||||||
});
|
});
|
||||||
|
|
||||||
// A "Smartsocket" exposes a .clientCall() that gets
|
// A "Smartsocket" exposes a .clientCall() that gets
|
||||||
@ -62,7 +69,7 @@ let testSocketFunction1 = new smartsocket.SocketFunction({
|
|||||||
// 2. the data to pass in
|
// 2. the data to pass in
|
||||||
// 3. And a target "SocketConnection" (there can be multiple connections at once)
|
// 3. And a target "SocketConnection" (there can be multiple connections at once)
|
||||||
// any unique id association is done internally
|
// any unique id association is done internally
|
||||||
mySmartsocket.clientCall('restart', data, someTargetConnection).then(responseData => {});
|
mySmartsocket.clientCall('restart', data, someTargetConnection).then((responseData) => {});
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Client side
|
#### Client side
|
||||||
@ -77,7 +84,7 @@ let testSmartsocketClient = new smartsocket.SmartsocketClient({
|
|||||||
url: 'http://localhost',
|
url: 'http://localhost',
|
||||||
password: 'testPassword',
|
password: 'testPassword',
|
||||||
alias: 'testClient1',
|
alias: 'testClient1',
|
||||||
role: 'testRole1'
|
role: 'testRole1',
|
||||||
});
|
});
|
||||||
|
|
||||||
// You can .connect() and .disconnect() from a "Smartsocket"
|
// You can .connect() and .disconnect() from a "Smartsocket"
|
||||||
@ -88,12 +95,12 @@ testSmartsocketClient.connect().then(() => {
|
|||||||
// The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once
|
// 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({
|
let testSocketFunction2 = new smartsocket.SocketFunction({
|
||||||
funcName: 'testSocketFunction2',
|
funcName: 'testSocketFunction2',
|
||||||
funcDef: data => {}, // the function to execute, has to return promise
|
funcDef: (data) => {}, // the function to execute, has to return promise
|
||||||
allowedRoles: []
|
allowedRoles: [],
|
||||||
});
|
});
|
||||||
|
|
||||||
// A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
|
// A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
|
||||||
mySmartsocketClient.serverCall('function', functionCallData).then(functionResponseData => {
|
mySmartsocketClient.serverCall('function', functionCallData).then((functionResponseData) => {
|
||||||
// the functionResponseData comes from the server... awesome, right?
|
// the functionResponseData comes from the server... awesome, right?
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
@ -103,6 +110,10 @@ mySmartsocketClient.serverCall('function', functionCallData).then(functionRespon
|
|||||||
> `data` is always a js object that you can design for your specific needs.
|
> `data` is always a js object that you can design for your specific needs.
|
||||||
> It supports buffers for large binary data network exchange.
|
> It supports buffers for large binary data network exchange.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
@ -1,21 +1,19 @@
|
|||||||
// tslint:disable-next-line:no-implicit-dependencies
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
import * as isohash from '@pushrocks/isohash';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
|
||||||
import * as smartexpress from '@pushrocks/smartexpress';
|
import * as smartexpress from '@pushrocks/smartexpress';
|
||||||
|
|
||||||
import socketIoClient = require('socket.io-client');
|
|
||||||
import smartsocket = require('../ts/index');
|
import smartsocket = require('../ts/index');
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
let testSocketRole1: smartsocket.SocketRole;
|
let testSocketRole1: smartsocket.SocketRole;
|
||||||
let testSocketFunction1: smartsocket.SocketFunction;
|
let testSocketFunction1: smartsocket.SocketFunction<any>;
|
||||||
let myseServer: smartexpress.Server;
|
let myseServer: smartexpress.Server;
|
||||||
|
|
||||||
const testConfig = {
|
const testConfig = {
|
||||||
port: 3000
|
port: 3000,
|
||||||
};
|
};
|
||||||
|
|
||||||
// class smartsocket
|
// class smartsocket
|
||||||
@ -28,7 +26,7 @@ tap.test('Should accept an smartExpressServer as server', async () => {
|
|||||||
myseServer = new smartexpress.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);
|
||||||
@ -40,7 +38,7 @@ tap.test('Should accept an smartExpressServer as server', async () => {
|
|||||||
tap.test('should add a socketrole', async () => {
|
tap.test('should add a socketrole', async () => {
|
||||||
testSocketRole1 = new smartsocket.SocketRole({
|
testSocketRole1 = new smartsocket.SocketRole({
|
||||||
name: 'testRole1',
|
name: 'testRole1',
|
||||||
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
passwordHash: await isohash.sha256FromString('testPassword'),
|
||||||
});
|
});
|
||||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||||
});
|
});
|
||||||
@ -52,7 +50,7 @@ tap.test('should register a new Function', async () => {
|
|||||||
funcDef: async (dataArg, socketConnectionArg) => {
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
return dataArg;
|
return dataArg;
|
||||||
},
|
},
|
||||||
funcName: 'testFunction1'
|
funcName: 'testFunction1',
|
||||||
});
|
});
|
||||||
testSmartsocket.addSocketFunction(testSocketFunction1);
|
testSmartsocket.addSocketFunction(testSocketFunction1);
|
||||||
console.log(testSmartsocket.socketFunctions);
|
console.log(testSmartsocket.socketFunctions);
|
||||||
@ -69,14 +67,14 @@ tap.test('should react to a new websocket connection from client', async () => {
|
|||||||
url: 'http://localhost',
|
url: 'http://localhost',
|
||||||
password: 'testPassword',
|
password: 'testPassword',
|
||||||
alias: 'testClient1',
|
alias: 'testClient1',
|
||||||
role: 'testRole1'
|
role: 'testRole1',
|
||||||
});
|
});
|
||||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
||||||
console.log(testSmartsocketClient.socketFunctions);
|
console.log(testSmartsocketClient.socketFunctions);
|
||||||
await testSmartsocketClient.connect();
|
await testSmartsocketClient.connect();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('client should disconnect and reconnect', async tools => {
|
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||||
await testSmartsocketClient.disconnect();
|
await testSmartsocketClient.disconnect();
|
||||||
await tools.delayFor(100);
|
await tools.delayFor(100);
|
||||||
await testSmartsocketClient.connect();
|
await testSmartsocketClient.connect();
|
||||||
@ -87,15 +85,28 @@ 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 response = await testSmartsocketClient.serverCall('testFunction1', {
|
const totalCycles = 20000;
|
||||||
value1: 'hello'
|
let counter = 0;
|
||||||
|
let startTime = Date.now();
|
||||||
|
while (counter < totalCycles) {
|
||||||
|
const randomString = `hello ${Math.random()}`;
|
||||||
|
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||||
|
value1: randomString,
|
||||||
});
|
});
|
||||||
console.log(response);
|
expect(response.value1).to.equal(randomString);
|
||||||
|
if (counter % 100 === 0) {
|
||||||
|
console.log(
|
||||||
|
`processed 100 more messages in ${Date.now() - startTime}ms. ${
|
||||||
|
totalCycles - counter
|
||||||
|
} messages to go.`
|
||||||
|
);
|
||||||
|
startTime = Date.now();
|
||||||
|
}
|
||||||
|
counter++;
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should be able to make a functionCall from server to client', async () => {
|
tap.test('should be able to make a functionCall from server to client', async () => {});
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
// terminate
|
// terminate
|
||||||
tap.test('should close the server', async () => {
|
tap.test('should close the server', async () => {
|
||||||
|
103
test/test.ts
103
test/test.ts
@ -1,19 +1,38 @@
|
|||||||
// tslint:disable-next-line:no-implicit-dependencies
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
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');
|
import smartsocket = require('../ts/index');
|
||||||
|
import * as isohash from '@pushrocks/isohash';
|
||||||
|
|
||||||
let testSmartsocket: smartsocket.Smartsocket;
|
let testSmartsocket: smartsocket.Smartsocket;
|
||||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||||
|
let testSocketConnection: smartsocket.SocketConnection;
|
||||||
let testSocketRole1: smartsocket.SocketRole;
|
let testSocketRole1: smartsocket.SocketRole;
|
||||||
let testSocketFunction1: smartsocket.SocketFunction;
|
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 = {
|
const testConfig = {
|
||||||
port: 3000
|
port: 3000,
|
||||||
};
|
};
|
||||||
|
|
||||||
// class smartsocket
|
// class smartsocket
|
||||||
@ -26,21 +45,30 @@ tap.test('should create a new smartsocket', async () => {
|
|||||||
tap.test('should add a socketrole', async () => {
|
tap.test('should add a socketrole', async () => {
|
||||||
testSocketRole1 = new smartsocket.SocketRole({
|
testSocketRole1 = new smartsocket.SocketRole({
|
||||||
name: 'testRole1',
|
name: 'testRole1',
|
||||||
passwordHash: smarthash.sha256FromStringSync('testPassword')
|
passwordHash: await isohash.sha256FromString('testPassword'),
|
||||||
});
|
});
|
||||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// class SocketFunction
|
// class SocketFunction
|
||||||
tap.test('should register a new Function', async () => {
|
tap.test('should register a new Function', async () => {
|
||||||
testSocketFunction1 = new smartsocket.SocketFunction({
|
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||||
allowedRoles: [testSocketRole1],
|
allowedRoles: [testSocketRole1],
|
||||||
funcDef: async (dataArg, socketConnectionArg) => {
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
return dataArg;
|
return dataArg;
|
||||||
},
|
},
|
||||||
funcName: 'testFunction1'
|
funcName: 'testFunction1',
|
||||||
});
|
});
|
||||||
testSmartsocket.addSocketFunction(testSocketFunction1);
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
|
|
||||||
|
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||||
|
allowedRoles: [],
|
||||||
|
funcDef: async (dataArg, socketConnectionArg) => {
|
||||||
|
return dataArg;
|
||||||
|
},
|
||||||
|
funcName: 'testFunction2',
|
||||||
|
});
|
||||||
|
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||||
console.log(testSmartsocket.socketFunctions);
|
console.log(testSmartsocket.socketFunctions);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -55,17 +83,36 @@ tap.test('should react to a new websocket connection from client', async () => {
|
|||||||
url: 'http://localhost',
|
url: 'http://localhost',
|
||||||
password: 'testPassword',
|
password: 'testPassword',
|
||||||
alias: 'testClient1',
|
alias: 'testClient1',
|
||||||
role: 'testRole1'
|
role: 'testRole1',
|
||||||
});
|
});
|
||||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||||
console.log(testSmartsocketClient.socketFunctions);
|
console.log(testSmartsocketClient.socketFunctions);
|
||||||
await testSmartsocketClient.connect();
|
await testSmartsocketClient.connect();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('client should disconnect and reconnect', async tools => {
|
tap.test('should be able to tag a connection from client', async (tools) => {
|
||||||
await testSmartsocketClient.disconnect();
|
await testSmartsocketClient.addTag({
|
||||||
await tools.delayFor(100);
|
id: 'awesome',
|
||||||
await testSmartsocketClient.connect();
|
payload: 'yes',
|
||||||
|
});
|
||||||
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
|
.find((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
.getTagById('awesome');
|
||||||
|
expect(tagOnServerSide.payload).to.equal('yes');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
|
await testSmartsocket.socketConnections
|
||||||
|
.find((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
}).addTag({
|
||||||
|
id: 'awesome2',
|
||||||
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
|
expect(tagOnClientSide.payload).to.equal('absolutely');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('2 clients should connect in parallel', async () => {
|
tap.test('2 clients should connect in parallel', async () => {
|
||||||
@ -73,17 +120,31 @@ 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 response = await testSmartsocketClient.serverCall('testFunction1', {
|
const response = await testSmartsocketClient.serverCall<IReqResClient>('testFunction1', {
|
||||||
value1: 'hello'
|
value1: 'hello',
|
||||||
});
|
});
|
||||||
console.log(response);
|
console.log(response);
|
||||||
|
expect(response.value1).to.equal('hello');
|
||||||
});
|
});
|
||||||
|
|
||||||
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 () => {
|
||||||
const response = await testSmartsocketClient.serverCall('testFunction1', {
|
const response = await testSmartsocket.clientCall<IReqResServer>(
|
||||||
hi: 'hi there from client'
|
'testFunction2',
|
||||||
});
|
{
|
||||||
|
hi: 'hi there from server',
|
||||||
|
},
|
||||||
|
testSmartsocket.socketConnections.find((socketConnection) => {
|
||||||
|
return true;
|
||||||
|
})
|
||||||
|
);
|
||||||
console.log(response);
|
console.log(response);
|
||||||
|
expect(response.hi).to.equal('hi there from server');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||||
|
await testSmartsocketClient.disconnect();
|
||||||
|
await tools.delayFor(100);
|
||||||
|
await testSmartsocketClient.connect();
|
||||||
});
|
});
|
||||||
|
|
||||||
// terminate
|
// terminate
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
|
||||||
|
|
||||||
// export main classes
|
// export main classes
|
||||||
export * from './smartsocket.classes.smartsocket';
|
export * from './smartsocket.classes.smartsocket';
|
||||||
export * from './smartsocket.classes.smartsocketclient';
|
export * from './smartsocket.classes.smartsocketclient';
|
||||||
|
10
ts/interfaces/connection.ts
Normal file
10
ts/interfaces/connection.ts
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
export interface IRequestAuthPayload {
|
||||||
|
serverShortId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TConnectionStatus =
|
||||||
|
| 'new'
|
||||||
|
| 'connecting'
|
||||||
|
| 'connected'
|
||||||
|
| 'disconnecting'
|
||||||
|
| 'disconnected';
|
2
ts/interfaces/index.ts
Normal file
2
ts/interfaces/index.ts
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from './connection';
|
||||||
|
export * from './tag';
|
6
ts/interfaces/tag.ts
Normal file
6
ts/interfaces/tag.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
export interface ITag<T = any> {
|
||||||
|
id: string;
|
||||||
|
payload: T;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type TTagStore = { [key: string]: ITag };
|
@ -1,27 +1,35 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped';
|
||||||
|
|
||||||
// classes
|
// classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
import {
|
||||||
|
ISocketFunctionCallDataRequest,
|
||||||
|
SocketFunction,
|
||||||
|
ISocketFunctionCallDataResponse,
|
||||||
|
} from './smartsocket.classes.socketfunction';
|
||||||
import { SocketRequest } from './smartsocket.classes.socketrequest';
|
import { SocketRequest } from './smartsocket.classes.socketrequest';
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
import { SocketServer } from './smartsocket.classes.socketserver';
|
import { SocketServer } from './smartsocket.classes.socketserver';
|
||||||
|
|
||||||
// socket.io
|
import { logger } from './smartsocket.logging';
|
||||||
import * as SocketIO from 'socket.io';
|
|
||||||
|
|
||||||
export interface ISmartsocketConstructorOptions {
|
export interface ISmartsocketConstructorOptions {
|
||||||
port?: number;
|
port?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Smartsocket {
|
export class Smartsocket {
|
||||||
|
/**
|
||||||
|
* a unique id to detect server restarts
|
||||||
|
*/
|
||||||
|
public shortId = plugins.isounique.uni();
|
||||||
|
public smartenv = new plugins.smartenv.Smartenv();
|
||||||
public options: ISmartsocketConstructorOptions;
|
public options: ISmartsocketConstructorOptions;
|
||||||
public io: SocketIO.Server;
|
public io: pluginsTyped.socketIo.Server;
|
||||||
public openSockets = new Objectmap<SocketConnection>();
|
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
public socketRoles = new Objectmap<SocketRole>();
|
public socketRoles = new plugins.lik.ObjectMap<SocketRole>();
|
||||||
public socketFunctions = new Objectmap<SocketFunction>();
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
public socketRequests = new Objectmap<SocketRequest>();
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
|
|
||||||
private socketServer = new SocketServer(this);
|
private socketServer = new SocketServer(this);
|
||||||
|
|
||||||
@ -38,9 +46,10 @@ export class Smartsocket {
|
|||||||
* starts smartsocket
|
* starts smartsocket
|
||||||
*/
|
*/
|
||||||
public async start() {
|
public async start() {
|
||||||
this.io = plugins.socketIo(this.socketServer.getServerForSocketIo());
|
const socketIoModule = this.smartenv.getSafeNodeModule('socket.io');
|
||||||
|
this.io = socketIoModule(this.socketServer.getServerForSocketIo());
|
||||||
await this.socketServer.start();
|
await this.socketServer.start();
|
||||||
this.io.on('connection', socketArg => {
|
this.io.on('connection', (socketArg) => {
|
||||||
this._handleSocketConnection(socketArg);
|
this._handleSocketConnection(socketArg);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -50,14 +59,13 @@ export class Smartsocket {
|
|||||||
*/
|
*/
|
||||||
public async stop() {
|
public async stop() {
|
||||||
await plugins.smartdelay.delayFor(1000);
|
await plugins.smartdelay.delayFor(1000);
|
||||||
this.openSockets.forEach((socketObjectArg: SocketConnection) => {
|
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
||||||
plugins.smartlog.defaultLogger.log(
|
if (socketObjectArg) {
|
||||||
'info',
|
logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
|
||||||
`disconnect socket with >>alias ${socketObjectArg.alias}`
|
|
||||||
);
|
|
||||||
socketObjectArg.socket.disconnect();
|
socketObjectArg.socket.disconnect();
|
||||||
|
}
|
||||||
});
|
});
|
||||||
this.openSockets.wipe();
|
this.socketConnections.wipe();
|
||||||
this.io.close();
|
this.io.close();
|
||||||
|
|
||||||
// stop the corresponging server
|
// stop the corresponging server
|
||||||
@ -69,25 +77,22 @@ export class Smartsocket {
|
|||||||
/**
|
/**
|
||||||
* allows call to specific client.
|
* allows call to specific client.
|
||||||
*/
|
*/
|
||||||
public async clientCall(
|
public async clientCall<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
functionNameArg: string,
|
functionNameArg: T['method'],
|
||||||
dataArg: any,
|
dataArg: T['request'],
|
||||||
targetSocketConnectionArg: SocketConnection
|
targetSocketConnectionArg: SocketConnection
|
||||||
) {
|
): Promise<T['response']> {
|
||||||
const done = plugins.smartpromise.defer();
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
const socketRequest = new SocketRequest(this, {
|
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcDataArg: dataArg,
|
funcDataArg: dataArg,
|
||||||
funcName: functionNameArg
|
funcName: functionNameArg,
|
||||||
},
|
},
|
||||||
originSocketConnection: targetSocketConnectionArg,
|
originSocketConnection: targetSocketConnectionArg,
|
||||||
shortId: plugins.shortid.generate(),
|
shortId: plugins.isounique.uni(),
|
||||||
side: 'requesting'
|
side: 'requesting',
|
||||||
});
|
});
|
||||||
socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
|
const response: ISocketFunctionCallDataResponse<T> = await socketRequest.dispatch();
|
||||||
done.resolve(dataArg2.funcDataArg);
|
const result = response.funcDataArg;
|
||||||
});
|
|
||||||
const result = await done.promise;
|
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -101,31 +106,25 @@ export class Smartsocket {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
public addSocketFunction(socketFunction: SocketFunction) {
|
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||||
this.socketFunctions.add(socketFunction);
|
this.socketFunctions.add(socketFunction);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the standard handler for new socket connections
|
* the standard handler for new socket connections
|
||||||
*/
|
*/
|
||||||
private _handleSocketConnection(socketArg) {
|
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
|
||||||
const socketConnection: SocketConnection = new SocketConnection({
|
const socketConnection: SocketConnection = new SocketConnection({
|
||||||
alias: undefined,
|
alias: undefined,
|
||||||
authenticated: false,
|
authenticated: false,
|
||||||
role: undefined,
|
role: undefined,
|
||||||
side: 'server',
|
side: 'server',
|
||||||
smartsocketHost: this,
|
smartsocketHost: this,
|
||||||
socket: socketArg
|
socket: socketArg,
|
||||||
});
|
|
||||||
plugins.smartlog.defaultLogger.log('info', 'Socket connected. Trying to authenticate...');
|
|
||||||
this.openSockets.add(socketConnection);
|
|
||||||
socketConnection
|
|
||||||
.authenticate()
|
|
||||||
.then(() => {
|
|
||||||
return socketConnection.listenToFunctionRequests();
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
});
|
||||||
|
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||||
|
this.socketConnections.add(socketConnection);
|
||||||
|
await socketConnection.authenticate();
|
||||||
|
await socketConnection.listenToFunctionRequests();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,9 +1,15 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
|
import {
|
||||||
|
ISocketFunctionCallDataRequest,
|
||||||
|
SocketFunction,
|
||||||
|
} from './smartsocket.classes.socketfunction';
|
||||||
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
|
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
|
import { logger } from './smartsocket.logging';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for class SmartsocketClient
|
* interface for class SmartsocketClient
|
||||||
@ -14,87 +20,238 @@ export interface ISmartsocketClientOptions {
|
|||||||
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
|
||||||
role: string;
|
role: string;
|
||||||
password: string; // by setting a password access to functions can be limited
|
password: string; // by setting a password access to functions can be limited
|
||||||
|
autoReconnect?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class SmartsocketClient {
|
export class SmartsocketClient {
|
||||||
|
// a unique id
|
||||||
|
public shortId = plugins.isounique.uni();
|
||||||
|
|
||||||
|
// the shortId of the remote we connect to
|
||||||
|
public remoteShortId: string = null;
|
||||||
|
|
||||||
public alias: string;
|
public alias: string;
|
||||||
public role: string;
|
public socketRole: SocketRole;
|
||||||
public socketConnection: SocketConnection;
|
public socketConnection: SocketConnection;
|
||||||
public serverUrl: string;
|
public serverUrl: string;
|
||||||
public serverPort: number;
|
public serverPort: number;
|
||||||
public serverPassword: string;
|
public autoReconnect: boolean;
|
||||||
|
|
||||||
public socketFunctions = new plugins.lik.Objectmap<SocketFunction>();
|
// status handling
|
||||||
public socketRequests = new plugins.lik.Objectmap<SocketRequest>();
|
public eventSubject = new plugins.smartrx.rxjs.Subject<interfaces.TConnectionStatus>();
|
||||||
public socketRoles = new plugins.lik.Objectmap<SocketRole>();
|
public eventStatus: interfaces.TConnectionStatus = 'new';
|
||||||
|
|
||||||
|
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
|
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||||
|
public socketRoles = new plugins.lik.ObjectMap<SocketRole>();
|
||||||
|
|
||||||
|
// tagStore
|
||||||
|
private tagStore: { [key: string]: interfaces.ITag } = {};
|
||||||
|
private tagStoreSubscription: plugins.smartrx.rxjs.Subscription;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a tag to a connection
|
||||||
|
*/
|
||||||
|
public async addTag(tagArg: interfaces.ITag) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.addTag(tagArg);
|
||||||
|
} else {
|
||||||
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a tag by id
|
||||||
|
* @param tagIdArg
|
||||||
|
*/
|
||||||
|
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
return this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes a tag from a connection
|
||||||
|
*/
|
||||||
|
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
this.socketConnection.removeTagById(tagIdArg);
|
||||||
|
} else {
|
||||||
|
delete this.tagStore[tagIdArg];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
constructor(optionsArg: ISmartsocketClientOptions) {
|
constructor(optionsArg: ISmartsocketClientOptions) {
|
||||||
this.alias = optionsArg.alias;
|
this.alias = optionsArg.alias;
|
||||||
this.role = optionsArg.role;
|
|
||||||
this.serverUrl = optionsArg.url;
|
this.serverUrl = optionsArg.url;
|
||||||
this.serverPort = optionsArg.port;
|
this.serverPort = optionsArg.port;
|
||||||
this.serverPassword = optionsArg.password;
|
this.socketRole = new SocketRole({
|
||||||
|
name: optionsArg.role,
|
||||||
|
passwordHash: optionsArg.password,
|
||||||
|
});
|
||||||
|
this.autoReconnect = optionsArg.autoReconnect;
|
||||||
}
|
}
|
||||||
|
|
||||||
public addSocketFunction(socketFunction: SocketFunction) {
|
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||||
this.socketFunctions.add(socketFunction);
|
this.socketFunctions.add(socketFunction);
|
||||||
|
this.socketRole.allowedFunctions.add(socketFunction);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* connect the client to the server
|
* connect the client to the server
|
||||||
*/
|
*/
|
||||||
public connect() {
|
public async connect() {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
plugins.smartlog.defaultLogger.log('info', 'trying to connect...');
|
const smartenvInstance = new plugins.smartenv.Smartenv();
|
||||||
|
const socketIoClient = await smartenvInstance.getEnvAwareModule({
|
||||||
|
nodeModuleName: 'socket.io-client',
|
||||||
|
webUrlArg: 'https://cdn.jsdelivr.net/npm/socket.io-client@2/dist/socket.io.js',
|
||||||
|
getFunction: () => {
|
||||||
|
return globalThis.io;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
logger.log('info', 'trying to connect...');
|
||||||
const socketUrl = `${this.serverUrl}:${this.serverPort}`;
|
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,
|
role: this.socketRole,
|
||||||
side: 'client',
|
side: 'client',
|
||||||
smartsocketHost: this,
|
smartsocketHost: this,
|
||||||
socket: plugins.socketIoClient(socketUrl, { multiplex: false })
|
socket: await socketIoClient.connect(socketUrl, {
|
||||||
|
multiplex: false,
|
||||||
|
reconnectionAttempts: 5,
|
||||||
|
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
|
||||||
|
}),
|
||||||
});
|
});
|
||||||
this.socketConnection.socket.on('requestAuth', () => {
|
|
||||||
console.log('server requested authentication');
|
const timer = new plugins.smarttime.Timer(5000);
|
||||||
this.socketConnection.socket.emit('dataAuth', {
|
timer.start();
|
||||||
role: this.role,
|
timer.completed.then(() => {
|
||||||
password: this.serverPassword,
|
logger.log('warn', 'connection to server timed out.');
|
||||||
alias: this.alias
|
this.disconnect();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// authentication flow
|
||||||
|
this.socketConnection.socket.on(
|
||||||
|
'requestAuth',
|
||||||
|
(requestAuthPayload: interfaces.IRequestAuthPayload) => {
|
||||||
|
timer.reset();
|
||||||
|
logger.log('info', 'server requested authentication');
|
||||||
|
|
||||||
|
// lets register the authenticated event
|
||||||
this.socketConnection.socket.on('authenticated', () => {
|
this.socketConnection.socket.on('authenticated', () => {
|
||||||
console.log('client is authenticated');
|
this.remoteShortId = requestAuthPayload.serverShortId;
|
||||||
|
logger.log('info', 'client is authenticated');
|
||||||
this.socketConnection.authenticated = true;
|
this.socketConnection.authenticated = true;
|
||||||
this.socketConnection.listenToFunctionRequests();
|
this.socketConnection.listenToFunctionRequests();
|
||||||
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', {
|
||||||
|
role: this.socketRole.name,
|
||||||
|
password: this.socketRole.passwordHash,
|
||||||
|
alias: this.alias,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// handle connection
|
||||||
|
this.socketConnection.socket.on('connect', async () => {
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
this.updateStatus('connected');
|
||||||
|
});
|
||||||
|
|
||||||
|
// handle disconnection and errors
|
||||||
|
this.socketConnection.socket.on('disconnect', async () => {
|
||||||
|
await this.disconnect();
|
||||||
|
});
|
||||||
|
|
||||||
|
this.socketConnection.socket.on('reconnect_failed', async () => {
|
||||||
|
await this.disconnect();
|
||||||
|
});
|
||||||
|
this.socketConnection.socket.on('connect_error', async () => {
|
||||||
|
await this.disconnect();
|
||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
public disconnect() {
|
/**
|
||||||
const done = plugins.smartpromise.defer();
|
* disconnect from the server
|
||||||
this.socketConnection.socket.disconnect();
|
*/
|
||||||
|
public async disconnect() {
|
||||||
|
if (this.socketConnection) {
|
||||||
|
await this.socketConnection.disconnect();
|
||||||
this.socketConnection = undefined;
|
this.socketConnection = undefined;
|
||||||
plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
|
logger.log('ok', 'disconnected!');
|
||||||
done.resolve();
|
}
|
||||||
return done.promise;
|
logger.log('warn', `disconnected from server ${this.remoteShortId}`);
|
||||||
|
this.remoteShortId = null;
|
||||||
|
this.updateStatus('disconnected');
|
||||||
|
|
||||||
|
if (this.autoReconnect) {
|
||||||
|
this.tryDebouncedReconnect();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public serverCall(functionNameArg: string, dataArg: any) {
|
/**
|
||||||
|
* stops the client completely
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
this.autoReconnect = false;
|
||||||
|
await this.disconnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* try a reconnection
|
||||||
|
*/
|
||||||
|
public async tryDebouncedReconnect() {
|
||||||
|
await plugins.smartdelay.delayForRandom(10000, 60000);
|
||||||
|
await this.connect();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 done = plugins.smartpromise.defer();
|
||||||
const socketRequest = new SocketRequest(this, {
|
const socketRequest = new SocketRequest<T>(this, {
|
||||||
side: 'requesting',
|
side: 'requesting',
|
||||||
originSocketConnection: this.socketConnection,
|
originSocketConnection: this.socketConnection,
|
||||||
shortId: plugins.shortid.generate(),
|
shortId: plugins.isounique.uni(),
|
||||||
funcCallData: {
|
funcCallData: {
|
||||||
funcName: functionNameArg,
|
funcName: functionNameArg,
|
||||||
funcDataArg: dataArg
|
funcDataArg: dataArg,
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
|
const response = await socketRequest.dispatch();
|
||||||
done.resolve(dataArg2.funcDataArg);
|
const result = response.funcDataArg;
|
||||||
});
|
return result;
|
||||||
return done.promise;
|
}
|
||||||
|
|
||||||
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
|
if (this.eventStatus !== statusArg) {
|
||||||
|
this.eventSubject.next(statusArg);
|
||||||
|
}
|
||||||
|
this.eventStatus = statusArg;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,19 +1,16 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
import {
|
import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.socketrequest';
|
||||||
SocketRequest,
|
|
||||||
ISocketRequestDataObject,
|
|
||||||
} from './smartsocket.classes.socketrequest';
|
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
|
|
||||||
// socket.io
|
// socket.io
|
||||||
import * as SocketIO from 'socket.io';
|
import * as SocketIO from 'socket.io';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||||
|
import { logger } from './smartsocket.logging';
|
||||||
|
|
||||||
// export interfaces
|
// export interfaces
|
||||||
|
|
||||||
@ -44,7 +41,7 @@ export interface ISocketConnectionAuthenticationObject {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
export let allSocketConnections = new Objectmap<SocketConnection>();
|
export let allSocketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class SocketConnection represents a websocket connection
|
* class SocketConnection represents a websocket connection
|
||||||
@ -56,6 +53,14 @@ export class SocketConnection {
|
|||||||
public role: SocketRole;
|
public role: SocketRole;
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
public socket: SocketIO.Socket | SocketIOClient.Socket;
|
public socket: 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;
|
||||||
@ -66,16 +71,57 @@ export class SocketConnection {
|
|||||||
|
|
||||||
// standard behaviour that is always true
|
// standard behaviour that is always true
|
||||||
allSocketConnections.add(this);
|
allSocketConnections.add(this);
|
||||||
this.socket.on('disconnect', () => {
|
|
||||||
plugins.smartlog.defaultLogger.log(
|
// handle connection
|
||||||
|
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`
|
||||||
);
|
);
|
||||||
this.socket.disconnect();
|
await this.disconnect();
|
||||||
allSocketConnections.remove(this);
|
allSocketConnections.remove(this);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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) => {
|
||||||
|
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 --------------------------
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -83,30 +129,27 @@ export class SocketConnection {
|
|||||||
*/
|
*/
|
||||||
public authenticate() {
|
public authenticate() {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
|
this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
|
||||||
plugins.smartlog.defaultLogger.log(
|
logger.log('info', 'received authentication data. now hashing and comparing...');
|
||||||
'info',
|
this.socket.removeAllListeners('dataAuth');
|
||||||
'received authentication data. now hashing and comparing...'
|
if (await SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
|
||||||
);
|
|
||||||
this.socket.removeListener('dataAuth', () => {});
|
|
||||||
if (SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
|
|
||||||
// TODO: authenticate password
|
// TODO: authenticate password
|
||||||
this.alias = dataArg.alias;
|
this.alias = dataArg.alias;
|
||||||
this.authenticated = true;
|
this.authenticated = true;
|
||||||
this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
|
this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
|
||||||
this.socket.emit('authenticated');
|
this.socket.emit('authenticated');
|
||||||
plugins.smartlog.defaultLogger.log(
|
logger.log('ok', `socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`);
|
||||||
'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;
|
||||||
this.socket.disconnect();
|
await this.disconnect();
|
||||||
done.reject('not authenticated');
|
done.reject('not authenticated');
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
this.socket.emit('requestAuth');
|
const requestAuthPayload: interfaces.IRequestAuthPayload = {
|
||||||
|
serverShortId: this.smartsocketRef.shortId,
|
||||||
|
};
|
||||||
|
this.socket.emit('requestAuth', requestAuthPayload);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -118,50 +161,69 @@ export class SocketConnection {
|
|||||||
public listenToFunctionRequests() {
|
public listenToFunctionRequests() {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
if (this.authenticated) {
|
if (this.authenticated) {
|
||||||
this.socket.on('function', (dataArg: ISocketRequestDataObject) => {
|
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
||||||
// check if requested function is available to the socket's scope
|
// check if requested function is available to the socket's scope
|
||||||
plugins.smartlog.defaultLogger.log('info', 'function request received');
|
// logger.log('info', 'function request received');
|
||||||
const referencedFunction: SocketFunction = this.role.allowedFunctions.find(
|
const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.find(
|
||||||
socketFunctionArg => {
|
(socketFunctionArg) => {
|
||||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
if (referencedFunction !== undefined) {
|
if (referencedFunction) {
|
||||||
plugins.smartlog.defaultLogger.log('ok', 'function in access scope');
|
// logger.log('ok', 'function in access scope');
|
||||||
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
|
||||||
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 {
|
||||||
plugins.smartlog.defaultLogger.log(
|
logger.log('warn', 'function not existent or out of access scope');
|
||||||
'warn',
|
|
||||||
'function not existent or out of access scope'
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject) => {
|
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
|
||||||
plugins.smartlog.defaultLogger.log(
|
// logger.log('info', `received response for request with id ${dataArg.shortId}`);
|
||||||
'info',
|
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
||||||
`received response for request with id ${dataArg.shortId}`
|
this.smartsocketRef,
|
||||||
|
dataArg.shortId
|
||||||
);
|
);
|
||||||
const targetSocketRequest = SocketRequest.getSocketRequestById(this.smartsocketRef, dataArg.shortId);
|
|
||||||
targetSocketRequest.handleResponse(dataArg);
|
targetSocketRequest.handleResponse(dataArg);
|
||||||
});
|
});
|
||||||
plugins.smartlog.defaultLogger.log(
|
|
||||||
'info',
|
this.socket.on('updateTagStore', async (tagStoreArg: interfaces.TTagStore) => {
|
||||||
`now listening to function requests for ${this.alias}`
|
const exitingStoreString = plugins.smartjson.stringify(this.tagStore);
|
||||||
);
|
const newStoreString = plugins.smartjson.stringify(tagStoreArg);
|
||||||
|
console.log(exitingStoreString);
|
||||||
|
console.log(newStoreString);
|
||||||
|
if (exitingStoreString !== newStoreString) {
|
||||||
|
this.tagStore = tagStoreArg;
|
||||||
|
this.socket.emit('updateTagStore', this.tagStore);
|
||||||
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
|
}
|
||||||
|
this.remoteTagStoreObservable.next(tagStoreArg);
|
||||||
|
});
|
||||||
|
|
||||||
|
logger.log('info', `now listening to function requests for ${this.alias}`);
|
||||||
done.resolve(this);
|
done.resolve(this);
|
||||||
} else {
|
} else {
|
||||||
const errMessage = 'socket needs to be authenticated first';
|
const errMessage = 'socket needs to be authenticated first';
|
||||||
plugins.smartlog.defaultLogger.log('error', errMessage);
|
logger.log('error', errMessage);
|
||||||
done.reject(errMessage);
|
done.reject(errMessage);
|
||||||
}
|
}
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
// sending ----------------------
|
// disconnecting ----------------------
|
||||||
|
public async disconnect() {
|
||||||
|
this.socket.disconnect(true);
|
||||||
|
this.updateStatus('disconnected');
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateStatus(statusArg: interfaces.TConnectionStatus) {
|
||||||
|
if (this.eventStatus !== statusArg) {
|
||||||
|
this.eventSubject.next(statusArg);
|
||||||
|
}
|
||||||
|
this.eventStatus = statusArg;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
@ -12,48 +11,67 @@ import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
|||||||
/**
|
/**
|
||||||
* interface of the contructor options of class SocketFunction
|
* interface of the contructor options of class SocketFunction
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionConstructorOptions {
|
export interface ISocketFunctionConstructorOptions<
|
||||||
funcName: string;
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
funcDef: TFuncDef;
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDef: TFuncDef<T>;
|
||||||
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface of the Socket Function call, in other words the object that routes a call to a function
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
*/
|
*/
|
||||||
export interface ISocketFunctionCall {
|
export interface ISocketFunctionCallDataRequest<
|
||||||
funcName: string;
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
funcDataArg: any;
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['request'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* interface of the Socket Function call, in other words the object that routes a call to a function
|
||||||
|
*/
|
||||||
|
export interface ISocketFunctionCallDataResponse<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
|
funcName: T['method'];
|
||||||
|
funcDataArg: T['response'];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* interface for function definition of SocketFunction
|
* interface for function definition of SocketFunction
|
||||||
*/
|
*/
|
||||||
export type TFuncDef = (dataArg: any, connectionArg: SocketConnection) => PromiseLike<any>;
|
export type TFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (
|
||||||
|
dataArg: T['request'],
|
||||||
|
connectionArg: SocketConnection
|
||||||
|
) => PromiseLike<T['response']>;
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class that respresents a function that can be transparently called using a SocketConnection
|
* class that respresents a function that can be transparently called using a SocketConnection
|
||||||
*/
|
*/
|
||||||
export class SocketFunction {
|
export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
// STATIC
|
// STATIC
|
||||||
public static getSocketFunctionByName (smartsocketRefArg: Smartsocket | SmartsocketClient, functionNameArg: string): SocketFunction {
|
public static getSocketFunctionByName<Q extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||||
console.log(smartsocketRefArg.socketFunctions);
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
return smartsocketRefArg.socketFunctions.find(socketFunctionArg => {
|
functionNameArg: string
|
||||||
|
): SocketFunction<Q> {
|
||||||
|
return smartsocketRefArg.socketFunctions.find((socketFunctionArg) => {
|
||||||
return socketFunctionArg.name === functionNameArg;
|
return socketFunctionArg.name === functionNameArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// INSTANCE
|
// INSTANCE
|
||||||
public name: string;
|
public name: string;
|
||||||
public funcDef: TFuncDef;
|
public funcDef: TFuncDef<T>;
|
||||||
public roles: SocketRole[];
|
public roles: SocketRole[];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the constructor for SocketFunction
|
* the constructor for SocketFunction
|
||||||
*/
|
*/
|
||||||
constructor(optionsArg: ISocketFunctionConstructorOptions) {
|
constructor(optionsArg: ISocketFunctionConstructorOptions<T>) {
|
||||||
this.name = optionsArg.funcName;
|
this.name = optionsArg.funcName;
|
||||||
this.funcDef = optionsArg.funcDef;
|
this.funcDef = optionsArg.funcDef;
|
||||||
this.roles = optionsArg.allowedRoles;
|
this.roles = optionsArg.allowedRoles;
|
||||||
@ -65,20 +83,19 @@ export class SocketFunction {
|
|||||||
/**
|
/**
|
||||||
* invokes the function of this SocketFunction
|
* invokes the function of this SocketFunction
|
||||||
*/
|
*/
|
||||||
public invoke(dataArg: ISocketFunctionCall, socketConnectionArg: SocketConnection): Promise<any> {
|
public async invoke(
|
||||||
const done = plugins.smartpromise.defer();
|
dataArg: ISocketFunctionCallDataRequest<T>,
|
||||||
|
socketConnectionArg: SocketConnection
|
||||||
|
): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
if (dataArg.funcName === this.name) {
|
if (dataArg.funcName === this.name) {
|
||||||
this.funcDef(dataArg.funcDataArg, socketConnectionArg).then((resultData: any) => {
|
const funcResponseData: ISocketFunctionCallDataResponse<T> = {
|
||||||
const funcResponseData: ISocketFunctionCall = {
|
|
||||||
funcName: this.name,
|
funcName: this.name,
|
||||||
funcDataArg: resultData
|
funcDataArg: await this.funcDef(dataArg.funcDataArg, socketConnectionArg),
|
||||||
};
|
};
|
||||||
done.resolve(funcResponseData);
|
return funcResponseData;
|
||||||
});
|
|
||||||
} else {
|
} else {
|
||||||
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
||||||
}
|
}
|
||||||
return done.promise;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -1,12 +1,15 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
// import interfaces
|
// import interfaces
|
||||||
import { SocketFunction, ISocketFunctionCall } from './smartsocket.classes.socketfunction';
|
import {
|
||||||
|
SocketFunction,
|
||||||
|
ISocketFunctionCallDataRequest,
|
||||||
|
ISocketFunctionCallDataResponse,
|
||||||
|
} from './smartsocket.classes.socketfunction';
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||||
import { defaultLogger } from '@pushrocks/smartlog';
|
import { logger } from './smartsocket.logging';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||||
|
|
||||||
@ -17,30 +20,32 @@ export type TSocketRequestSide = 'requesting' | 'responding';
|
|||||||
/**
|
/**
|
||||||
* interface of constructor of class SocketRequest
|
* interface of constructor of class SocketRequest
|
||||||
*/
|
*/
|
||||||
export interface SocketRequestConstructorOptions {
|
export interface ISocketRequestConstructorOptions<
|
||||||
|
T extends plugins.typedrequestInterfaces.ITypedRequest
|
||||||
|
> {
|
||||||
side: TSocketRequestSide;
|
side: TSocketRequestSide;
|
||||||
originSocketConnection: SocketConnection;
|
originSocketConnection: SocketConnection;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
funcCallData?: ISocketFunctionCall;
|
funcCallData?: ISocketFunctionCallDataRequest<T>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* request object that is sent initially and may or may not receive a response
|
* request object that is sent initially and may or may not receive a response
|
||||||
*/
|
*/
|
||||||
export interface ISocketRequestDataObject {
|
export interface ISocketRequestDataObject<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
funcCallData: ISocketFunctionCall;
|
funcCallData: ISocketFunctionCallDataRequest<T> | ISocketFunctionCallDataResponse<T>;
|
||||||
shortId: string;
|
shortId: string;
|
||||||
responseTimeout?: number;
|
responseTimeout?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
// export classes
|
// export classes
|
||||||
export class SocketRequest {
|
export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
|
||||||
// STATIC
|
// STATIC
|
||||||
public static getSocketRequestById(
|
public static getSocketRequestById(
|
||||||
smartsocketRef: Smartsocket | SmartsocketClient,
|
smartsocketRef: Smartsocket | SmartsocketClient,
|
||||||
shortIdArg: string
|
shortIdArg: string
|
||||||
): SocketRequest {
|
): SocketRequest<any> {
|
||||||
return smartsocketRef.socketRequests.find(socketRequestArg => {
|
return smartsocketRef.socketRequests.find((socketRequestArg) => {
|
||||||
return socketRequestArg.shortid === shortIdArg;
|
return socketRequestArg.shortid === shortIdArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -50,13 +55,15 @@ export class SocketRequest {
|
|||||||
public side: TSocketRequestSide;
|
public side: TSocketRequestSide;
|
||||||
public shortid: string;
|
public shortid: string;
|
||||||
public originSocketConnection: SocketConnection;
|
public originSocketConnection: SocketConnection;
|
||||||
public funcCallData: ISocketFunctionCall;
|
public funcCallData: ISocketFunctionCallDataRequest<T>;
|
||||||
public done = plugins.smartpromise.defer();
|
public done = plugins.smartpromise.defer<ISocketFunctionCallDataResponse<T>>();
|
||||||
|
|
||||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||||
|
|
||||||
|
constructor(
|
||||||
constructor(smartsocketRefArg: Smartsocket | SmartsocketClient, optionsArg: SocketRequestConstructorOptions) {
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
|
optionsArg: ISocketRequestConstructorOptions<T>
|
||||||
|
) {
|
||||||
this.smartsocketRef = smartsocketRefArg;
|
this.smartsocketRef = smartsocketRefArg;
|
||||||
this.side = optionsArg.side;
|
this.side = optionsArg.side;
|
||||||
this.shortid = optionsArg.shortId;
|
this.shortid = optionsArg.shortId;
|
||||||
@ -70,10 +77,10 @@ export class SocketRequest {
|
|||||||
/**
|
/**
|
||||||
* dispatches a socketrequest from the requesting to the receiving side
|
* dispatches a socketrequest from the requesting to the receiving side
|
||||||
*/
|
*/
|
||||||
public dispatch() {
|
public dispatch(): Promise<ISocketFunctionCallDataResponse<T>> {
|
||||||
const requestData: ISocketRequestDataObject = {
|
const requestData: ISocketRequestDataObject<T> = {
|
||||||
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;
|
||||||
@ -82,8 +89,8 @@ export class SocketRequest {
|
|||||||
/**
|
/**
|
||||||
* handles the response that is received by the requesting side
|
* handles the response that is received by the requesting side
|
||||||
*/
|
*/
|
||||||
public handleResponse(responseDataArg: ISocketRequestDataObject) {
|
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
||||||
plugins.smartlog.defaultLogger.log('info', 'handling response!');
|
// logger.log('info', 'handling response!');
|
||||||
this.done.resolve(responseDataArg.funcCallData);
|
this.done.resolve(responseDataArg.funcCallData);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
}
|
}
|
||||||
@ -94,27 +101,25 @@ export class SocketRequest {
|
|||||||
* creates the response on the responding side
|
* creates the response on the responding side
|
||||||
*/
|
*/
|
||||||
public async createResponse(): Promise<void> {
|
public async createResponse(): Promise<void> {
|
||||||
const targetSocketFunction: SocketFunction = SocketFunction.getSocketFunctionByName(
|
const targetSocketFunction: SocketFunction<T> = SocketFunction.getSocketFunctionByName(
|
||||||
this.smartsocketRef,
|
this.smartsocketRef,
|
||||||
this.funcCallData.funcName
|
this.funcCallData.funcName
|
||||||
);
|
);
|
||||||
|
|
||||||
if (!targetSocketFunction) {
|
if (!targetSocketFunction) {
|
||||||
defaultLogger.log(
|
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
||||||
'warn',
|
|
||||||
`There is no SocketFunction defined for ${this.funcCallData.funcName}`
|
|
||||||
);
|
|
||||||
defaultLogger.log('warn', `So now response is being sent.`);
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
plugins.smartlog.defaultLogger.log('info', `invoking ${targetSocketFunction.name}`);
|
// logger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||||
targetSocketFunction.invoke(this.funcCallData, this.originSocketConnection).then(resultData => {
|
targetSocketFunction
|
||||||
plugins.smartlog.defaultLogger.log('info', 'got resultData. Sending it to requesting party.');
|
.invoke(this.funcCallData, this.originSocketConnection)
|
||||||
const requestData: ISocketRequestDataObject = {
|
.then((resultData) => {
|
||||||
|
// 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', requestData);
|
this.originSocketConnection.socket.emit('functionResponse', responseData);
|
||||||
this.smartsocketRef.socketRequests.remove(this);
|
this.smartsocketRef.socketRequests.remove(this);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -1,8 +1,6 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
|
|
||||||
// import classes
|
// import classes
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
|
||||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||||
@ -11,7 +9,7 @@ import { ISocketConnectionAuthenticationObject } from './smartsocket.classes.soc
|
|||||||
/**
|
/**
|
||||||
* interface for class SocketRole
|
* interface for class SocketRole
|
||||||
*/
|
*/
|
||||||
export interface SocketRoleOptions {
|
export interface ISocketRoleOptions {
|
||||||
name: string;
|
name: string;
|
||||||
passwordHash: string;
|
passwordHash: string;
|
||||||
}
|
}
|
||||||
@ -23,31 +21,37 @@ export class SocketRole {
|
|||||||
// STATIC
|
// STATIC
|
||||||
public static getSocketRoleByName(
|
public static getSocketRoleByName(
|
||||||
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
||||||
socketRoleNameArg: string,
|
socketRoleNameArg: string
|
||||||
): SocketRole {
|
): SocketRole {
|
||||||
return referenceSmartsocket.socketRoles.find(socketRoleArg => {
|
return referenceSmartsocket.socketRoles.find((socketRoleArg) => {
|
||||||
return socketRoleArg.name === socketRoleNameArg;
|
return socketRoleArg.name === socketRoleNameArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
public static checkPasswordForRole (
|
public static async checkPasswordForRole(
|
||||||
dataArg: ISocketConnectionAuthenticationObject,
|
dataArg: ISocketConnectionAuthenticationObject,
|
||||||
referenceSmartsocket: Smartsocket | SmartsocketClient
|
referenceSmartsocket: Smartsocket | SmartsocketClient
|
||||||
): boolean {
|
): Promise<boolean> {
|
||||||
const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role).passwordHash;
|
const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role)
|
||||||
const computedCompareHash = plugins.smarthash.sha256FromStringSync(dataArg.password);
|
.passwordHash;
|
||||||
|
const computedCompareHash = await plugins.isohash.sha256FromString(dataArg.password);
|
||||||
return targetPasswordHash === computedCompareHash;
|
return targetPasswordHash === computedCompareHash;
|
||||||
}
|
}
|
||||||
|
|
||||||
// INSTANCE
|
// INSTANCE
|
||||||
public name: string;
|
public name: string;
|
||||||
public passwordHash: string;
|
public passwordHash: string;
|
||||||
public allowedFunctions = new Objectmap<SocketFunction>();
|
public allowedFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||||
constructor(optionsArg: SocketRoleOptions) {
|
constructor(optionsArg: ISocketRoleOptions) {
|
||||||
this.name = optionsArg.name;
|
this.name = optionsArg.name;
|
||||||
this.passwordHash = optionsArg.passwordHash;
|
this.passwordHash = optionsArg.passwordHash;
|
||||||
}
|
}
|
||||||
public addSocketFunction(socketFunctionArg: SocketFunction) {
|
|
||||||
|
/**
|
||||||
|
* adds the socketfunction to the socketrole
|
||||||
|
* @param socketFunctionArg
|
||||||
|
*/
|
||||||
|
public addSocketFunction(socketFunctionArg: SocketFunction<any>) {
|
||||||
this.allowedFunctions.add(socketFunctionArg);
|
this.allowedFunctions.add(socketFunctionArg);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,8 +1,9 @@
|
|||||||
import * as plugins from './smartsocket.plugins';
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
import * as pluginsTyped from './smartsocket.pluginstyped';
|
||||||
|
|
||||||
// used in case no other server is supplied
|
// used in case no other server is supplied
|
||||||
import * as http from 'http';
|
|
||||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||||
|
import { logger } from './smartsocket.logging';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class socketServer
|
* class socketServer
|
||||||
@ -10,10 +11,9 @@ import { Smartsocket } from './smartsocket.classes.smartsocket';
|
|||||||
*/
|
*/
|
||||||
export class SocketServer {
|
export class SocketServer {
|
||||||
private smartsocket: Smartsocket;
|
private smartsocket: Smartsocket;
|
||||||
private httpServer: http.Server;
|
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
||||||
// wether httpServer is standalone
|
// 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;
|
||||||
@ -25,7 +25,7 @@ export class SocketServer {
|
|||||||
*/
|
*/
|
||||||
public async setExternalServer(
|
public async setExternalServer(
|
||||||
serverType: 'smartexpress',
|
serverType: 'smartexpress',
|
||||||
serverArg: plugins.smartexpress.Server
|
serverArg: pluginsTyped.smartexpress.Server
|
||||||
) {
|
) {
|
||||||
await serverArg.startedPromise;
|
await serverArg.startedPromise;
|
||||||
this.httpServer = serverArg.httpServer;
|
this.httpServer = serverArg.httpServer;
|
||||||
@ -38,7 +38,8 @@ export class SocketServer {
|
|||||||
if (this.httpServer) {
|
if (this.httpServer) {
|
||||||
return this.httpServer;
|
return this.httpServer;
|
||||||
} else {
|
} else {
|
||||||
this.httpServer = new http.Server();
|
const httpModule = this.smartsocket.smartenv.getSafeNodeModule('http');
|
||||||
|
this.httpServer = new httpModule.Server();
|
||||||
this.standaloneServer = true;
|
this.standaloneServer = true;
|
||||||
return this.httpServer;
|
return this.httpServer;
|
||||||
}
|
}
|
||||||
@ -54,11 +55,14 @@ 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) {
|
||||||
console.log('there should be a port specifed for smartsocket!');
|
logger.log('error', '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, () => {
|
||||||
console.log(`Server started in standalone mode on ${this.smartsocket.options.port}`);
|
logger.log(
|
||||||
|
'success',
|
||||||
|
`Server started in standalone mode on ${this.smartsocket.options.port}`
|
||||||
|
);
|
||||||
done.resolve();
|
done.resolve();
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
|
3
ts/smartsocket.classes.socketstats.ts
Normal file
3
ts/smartsocket.classes.socketstats.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
|
export class SocketStats {}
|
3
ts/smartsocket.logging.ts
Normal file
3
ts/smartsocket.logging.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import * as plugins from './smartsocket.plugins';
|
||||||
|
|
||||||
|
export const logger = new plugins.smartlog.ConsoleLog();
|
@ -1,21 +1,29 @@
|
|||||||
|
// apiglobal scope
|
||||||
|
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||||
|
|
||||||
|
export { typedrequestInterfaces };
|
||||||
|
|
||||||
|
// pushrocks scope
|
||||||
|
import * as isohash from '@pushrocks/isohash';
|
||||||
|
import * as isounique from '@pushrocks/isounique';
|
||||||
import * as lik from '@pushrocks/lik';
|
import * as lik from '@pushrocks/lik';
|
||||||
|
import * as smartenv from '@pushrocks/smartenv';
|
||||||
|
import * as smartjson from '@pushrocks/smartjson';
|
||||||
import * as smartlog from '@pushrocks/smartlog';
|
import * as smartlog from '@pushrocks/smartlog';
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
import * as smartexpress from '@pushrocks/smartexpress';
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as shortid from 'shortid';
|
import * as smarttime from '@pushrocks/smarttime';
|
||||||
import socketIo from 'socket.io';
|
import * as smartrx from '@pushrocks/smartrx';
|
||||||
import socketIoClient from 'socket.io-client';
|
|
||||||
|
|
||||||
export {
|
export {
|
||||||
|
isohash,
|
||||||
|
isounique,
|
||||||
lik,
|
lik,
|
||||||
|
smartenv,
|
||||||
|
smartjson,
|
||||||
smartlog,
|
smartlog,
|
||||||
smarthash,
|
|
||||||
smartdelay,
|
smartdelay,
|
||||||
smartexpress,
|
|
||||||
smartpromise,
|
smartpromise,
|
||||||
shortid,
|
smarttime,
|
||||||
socketIo,
|
smartrx,
|
||||||
socketIoClient
|
|
||||||
};
|
};
|
||||||
|
16
ts/smartsocket.pluginstyped.ts
Normal file
16
ts/smartsocket.pluginstyped.ts
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
// node native
|
||||||
|
import type http from 'http';
|
||||||
|
import type https from 'https';
|
||||||
|
|
||||||
|
export { http, https };
|
||||||
|
|
||||||
|
// pushrocks scope
|
||||||
|
import type * as smartexpress from '@pushrocks/smartexpress';
|
||||||
|
|
||||||
|
export { smartexpress };
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import type socketIo from 'socket.io';
|
||||||
|
import type socketIoClient from 'socket.io-client';
|
||||||
|
|
||||||
|
export { socketIo, socketIoClient };
|
Reference in New Issue
Block a user