Compare commits
46 Commits
Author | SHA1 | Date | |
---|---|---|---|
278b35c9c5 | |||
da78da27e5 | |||
a8aeeaaa6c | |||
f9f6975b87 | |||
b9a6f1d5b0 | |||
489ad9284b | |||
6fdf0d9955 | |||
499a1893f9 | |||
2754447aae | |||
544277cb8a | |||
9a23960d21 | |||
23cca6cce3 | |||
2a9e58cc35 | |||
7d6a9921b5 | |||
3ee46a31f7 | |||
d72310ce10 | |||
1e14166ddb | |||
be38e91548 | |||
6c2057b119 | |||
08d7224016 | |||
bfa3330eb6 | |||
644fa2a49d | |||
c0dad3a977 | |||
a921033cc4 | |||
21e4712b04 | |||
df43bc2974 | |||
564988185d | |||
8442f3570f | |||
196357c878 | |||
bc187b7e41 | |||
0e54bf889f | |||
4c211bc82e | |||
a1be281670 | |||
1a44d2027c | |||
4bf5456a1d | |||
57c748657a | |||
15df24bf68 | |||
ca7470eedf | |||
38f017934c | |||
1980824540 | |||
09dec2071e | |||
a1443deafe | |||
9eac5ad336 | |||
cf607a79d5 | |||
8426c976bf | |||
1086065000 |
@ -12,6 +12,9 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
@ -36,6 +39,7 @@ auditProductionDependencies:
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -5,7 +5,7 @@
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "smartsocket",
|
||||
"shortDescription": "easy and secure websocket communication",
|
||||
"description": "easy and secure websocket communication",
|
||||
"npmPackagename": "@pushrocks/smartsocket",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
|
23493
package-lock.json
generated
23493
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
35
package.json
35
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@pushrocks/smartsocket",
|
||||
"version": "1.1.62",
|
||||
"version": "1.2.13",
|
||||
"description": "easy and secure websocket communication",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
@ -22,25 +22,26 @@
|
||||
"@apiglobal/typedrequest-interfaces": "^1.0.15",
|
||||
"@pushrocks/isohash": "^1.0.2",
|
||||
"@pushrocks/isounique": "^1.0.4",
|
||||
"@pushrocks/lik": "^4.0.17",
|
||||
"@pushrocks/smartdelay": "^2.0.10",
|
||||
"@pushrocks/smartenv": "^4.0.11",
|
||||
"@pushrocks/smartexpress": "^3.0.76",
|
||||
"@pushrocks/smartlog": "^2.0.39",
|
||||
"@pushrocks/smartpromise": "^3.0.6",
|
||||
"@pushrocks/lik": "^5.0.0",
|
||||
"@pushrocks/smartdelay": "^2.0.13",
|
||||
"@pushrocks/smartenv": "^4.0.16",
|
||||
"@pushrocks/smartexpress": "^3.0.108",
|
||||
"@pushrocks/smartjson": "^4.0.6",
|
||||
"@pushrocks/smartlog": "^2.0.44",
|
||||
"@pushrocks/smartpromise": "^3.1.6",
|
||||
"@pushrocks/smartrx": "^2.0.19",
|
||||
"@pushrocks/smarttime": "^3.0.35",
|
||||
"@types/socket.io": "^2.1.11",
|
||||
"@types/socket.io-client": "^1.4.33",
|
||||
"socket.io": "^2.3.0",
|
||||
"socket.io-client": "^2.3.0"
|
||||
"@pushrocks/smarttime": "^3.0.43",
|
||||
"@types/socket.io": "^3.0.2",
|
||||
"@types/socket.io-client": "^3.0.0",
|
||||
"socket.io": "^3.1.0",
|
||||
"socket.io-client": "^3.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsrun": "^1.2.12",
|
||||
"@gitzone/tstest": "^1.0.48",
|
||||
"@pushrocks/tapbundle": "^3.2.9",
|
||||
"@types/node": "^14.11.2",
|
||||
"@gitzone/tsbuild": "^2.1.28",
|
||||
"@gitzone/tsrun": "^1.2.18",
|
||||
"@gitzone/tstest": "^1.0.60",
|
||||
"@pushrocks/tapbundle": "^3.2.15",
|
||||
"@types/node": "^17.0.9",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
|
@ -8,13 +8,20 @@ easy and secure websocket communication
|
||||
* [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/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
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
|
||||
|
||||
@ -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.
|
||||
let mySmartsocket = new smartsocket.Smartsocket({
|
||||
port: 3000 // the port smartsocket will listen on
|
||||
port: 3000, // the port smartsocket will listen on
|
||||
});
|
||||
|
||||
// optional:
|
||||
@ -43,7 +50,7 @@ mySmartsocket.setServer(someExpressServer);
|
||||
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
|
||||
let mySocketRole = new smartsocket.SocketRole({
|
||||
name: 'someRoleName',
|
||||
passwordHash: 'someHashedString'
|
||||
passwordHash: 'someHashedString',
|
||||
});
|
||||
|
||||
// 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
|
||||
let testSocketFunction1 = new smartsocket.SocketFunction({
|
||||
funcName: 'testSocketFunction1',
|
||||
funcDef: data => {
|
||||
funcDef: (data) => {
|
||||
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
|
||||
@ -62,7 +69,7 @@ let testSocketFunction1 = new smartsocket.SocketFunction({
|
||||
// 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 => {});
|
||||
mySmartsocket.clientCall('restart', data, someTargetConnection).then((responseData) => {});
|
||||
```
|
||||
|
||||
#### Client side
|
||||
@ -77,7 +84,7 @@ let testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||
url: 'http://localhost',
|
||||
password: 'testPassword',
|
||||
alias: 'testClient1',
|
||||
role: 'testRole1'
|
||||
role: 'testRole1',
|
||||
});
|
||||
|
||||
// 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
|
||||
let testSocketFunction2 = new smartsocket.SocketFunction({
|
||||
funcName: 'testSocketFunction2',
|
||||
funcDef: data => {}, // the function to execute, has to return promise
|
||||
allowedRoles: []
|
||||
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 => {
|
||||
mySmartsocketClient.serverCall('function', functionCallData).then((functionResponseData) => {
|
||||
// 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.
|
||||
> 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.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
@ -1 +0,0 @@
|
||||
console.log('TODO');
|
@ -1,16 +1,13 @@
|
||||
// tslint:disable-next-line:no-implicit-dependencies
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
import * as smarthash from '@pushrocks/smarthash';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as isohash from '@pushrocks/isohash';
|
||||
import * as smartexpress from '@pushrocks/smartexpress';
|
||||
|
||||
import socketIoClient = require('socket.io-client');
|
||||
import smartsocket = require('../ts/index');
|
||||
|
||||
let testSmartsocket: smartsocket.Smartsocket;
|
||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||
let testSocketRole1: smartsocket.SocketRole;
|
||||
let testSocketFunction1: smartsocket.SocketFunction<any>;
|
||||
let myseServer: smartexpress.Server;
|
||||
|
||||
@ -20,7 +17,7 @@ const testConfig = {
|
||||
|
||||
// class smartsocket
|
||||
tap.test('should create a new smartsocket', async () => {
|
||||
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver', port: testConfig.port });
|
||||
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
||||
});
|
||||
|
||||
@ -36,19 +33,10 @@ tap.test('Should accept an smartExpressServer as server', async () => {
|
||||
await myseServer.start();
|
||||
});
|
||||
|
||||
// class socketrole
|
||||
tap.test('should add a socketrole', async () => {
|
||||
testSocketRole1 = new smartsocket.SocketRole({
|
||||
name: 'testRole1',
|
||||
passwordHash: smarthash.sha256FromStringSync('testPassword'),
|
||||
});
|
||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||
});
|
||||
|
||||
// class SocketFunction
|
||||
tap.test('should register a new Function', async () => {
|
||||
testSocketFunction1 = new smartsocket.SocketFunction({
|
||||
allowedRoles: [testSocketRole1],
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
return dataArg;
|
||||
},
|
||||
@ -67,12 +55,9 @@ tap.test('should react to a new websocket connection from client', async () => {
|
||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||
port: testConfig.port,
|
||||
url: 'http://localhost',
|
||||
password: 'testPassword',
|
||||
alias: 'testClient1',
|
||||
role: 'testRole1',
|
||||
});
|
||||
testSmartsocketClient.addSocketFunction(testSocketFunction1);
|
||||
console.log(testSmartsocketClient.socketFunctions);
|
||||
await testSmartsocketClient.connect();
|
||||
});
|
||||
|
||||
@ -87,10 +72,25 @@ tap.test('2 clients should connect in parallel', async () => {
|
||||
});
|
||||
|
||||
tap.test('should be able to make a functionCall from client to server', async () => {
|
||||
const response = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: 'hello',
|
||||
});
|
||||
console.log(response);
|
||||
const totalCycles = 20000;
|
||||
let counter = 0;
|
||||
let startTime = Date.now();
|
||||
while (counter < totalCycles) {
|
||||
const randomString = `hello ${Math.random()}`;
|
||||
const response: any = await testSmartsocketClient.serverCall('testFunction1', {
|
||||
value1: randomString,
|
||||
});
|
||||
expect(response.value1).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 () => {});
|
||||
|
5
test/test.reconnect.ts
Normal file
5
test/test.reconnect.ts
Normal file
@ -0,0 +1,5 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
|
||||
tap.test('should run a test', async () => {});
|
||||
|
||||
tap.start();
|
@ -1,16 +1,12 @@
|
||||
// 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');
|
||||
import * as isohash from '@pushrocks/isohash';
|
||||
|
||||
let testSmartsocket: smartsocket.Smartsocket;
|
||||
let testSmartsocketClient: smartsocket.SmartsocketClient;
|
||||
let testSocketConnection: smartsocket.SocketConnection;
|
||||
let testSocketRole1: smartsocket.SocketRole;
|
||||
let testSocketFunctionForServer: smartsocket.SocketFunction<any>;
|
||||
let testSocketFunctionClient: smartsocket.SocketFunction<any>;
|
||||
|
||||
@ -40,23 +36,13 @@ const testConfig = {
|
||||
|
||||
// class smartsocket
|
||||
tap.test('should create a new smartsocket', async () => {
|
||||
testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
|
||||
testSmartsocket = new smartsocket.Smartsocket({ alias: 'testserver2', port: testConfig.port });
|
||||
expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
|
||||
});
|
||||
|
||||
// class socketrole
|
||||
tap.test('should add a socketrole', async () => {
|
||||
testSocketRole1 = new smartsocket.SocketRole({
|
||||
name: 'testRole1',
|
||||
passwordHash: smarthash.sha256FromStringSync('testPassword'),
|
||||
});
|
||||
testSmartsocket.addSocketRoles([testSocketRole1]);
|
||||
});
|
||||
|
||||
// class SocketFunction
|
||||
tap.test('should register a new Function', async () => {
|
||||
testSocketFunctionForServer = new smartsocket.SocketFunction({
|
||||
allowedRoles: [testSocketRole1],
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
return dataArg;
|
||||
},
|
||||
@ -65,7 +51,6 @@ tap.test('should register a new Function', async () => {
|
||||
testSmartsocket.addSocketFunction(testSocketFunctionForServer);
|
||||
|
||||
testSocketFunctionClient = new smartsocket.SocketFunction({
|
||||
allowedRoles: [],
|
||||
funcDef: async (dataArg, socketConnectionArg) => {
|
||||
return dataArg;
|
||||
},
|
||||
@ -84,15 +69,39 @@ tap.test('should react to a new websocket connection from client', async () => {
|
||||
testSmartsocketClient = new smartsocket.SmartsocketClient({
|
||||
port: testConfig.port,
|
||||
url: 'http://localhost',
|
||||
password: 'testPassword',
|
||||
alias: 'testClient1',
|
||||
role: 'testRole1',
|
||||
});
|
||||
testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
|
||||
console.log(testSmartsocketClient.socketFunctions);
|
||||
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).to.equal('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).to.equal('absolutely');
|
||||
});
|
||||
|
||||
tap.test('2 clients should connect in parallel', async () => {
|
||||
// TODO: implement parallel test
|
||||
});
|
||||
@ -111,7 +120,7 @@ tap.test('should be able to make a functionCall from server to client', async ()
|
||||
{
|
||||
hi: 'hi there from server',
|
||||
},
|
||||
testSmartsocket.socketConnections.find((socketConnection) => {
|
||||
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||
return true;
|
||||
})
|
||||
);
|
||||
@ -121,10 +130,19 @@ tap.test('should be able to make a functionCall from server to client', async ()
|
||||
|
||||
tap.test('client should disconnect and reconnect', async (tools) => {
|
||||
await testSmartsocketClient.disconnect();
|
||||
await tools.delayFor(100);
|
||||
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).to.equal('yes');
|
||||
});
|
||||
|
||||
// terminate
|
||||
tap.test('should close the server', async () => {
|
||||
await testSmartsocket.stop();
|
@ -4,5 +4,4 @@ export * from './smartsocket.classes.smartsocketclient';
|
||||
|
||||
// export further classes and objects
|
||||
export * from './smartsocket.classes.socketfunction';
|
||||
export * from './smartsocket.classes.socketrole';
|
||||
export * from './smartsocket.classes.socketconnection';
|
||||
|
@ -1,5 +1,5 @@
|
||||
export interface IRequestAuthPayload {
|
||||
serverShortId: string;
|
||||
serverAlias: string;
|
||||
}
|
||||
|
||||
export type TConnectionStatus =
|
||||
|
@ -1 +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 };
|
@ -9,12 +9,12 @@ import {
|
||||
ISocketFunctionCallDataResponse,
|
||||
} from './smartsocket.classes.socketfunction';
|
||||
import { SocketRequest } from './smartsocket.classes.socketrequest';
|
||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||
import { SocketServer } from './smartsocket.classes.socketserver';
|
||||
|
||||
import { logger } from './smartsocket.logging';
|
||||
|
||||
export interface ISmartsocketConstructorOptions {
|
||||
alias: string;
|
||||
port?: number;
|
||||
}
|
||||
|
||||
@ -22,12 +22,11 @@ export class Smartsocket {
|
||||
/**
|
||||
* a unique id to detect server restarts
|
||||
*/
|
||||
public shortId = plugins.isounique.uni();
|
||||
public alias: string;
|
||||
public smartenv = new plugins.smartenv.Smartenv();
|
||||
public options: ISmartsocketConstructorOptions;
|
||||
public io: pluginsTyped.socketIo.Server;
|
||||
public socketConnections = new plugins.lik.ObjectMap<SocketConnection>();
|
||||
public socketRoles = new plugins.lik.ObjectMap<SocketRole>();
|
||||
public socketFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||
public socketRequests = new plugins.lik.ObjectMap<SocketRequest<any>>();
|
||||
|
||||
@ -35,6 +34,7 @@ export class Smartsocket {
|
||||
|
||||
constructor(optionsArg: ISmartsocketConstructorOptions) {
|
||||
this.options = optionsArg;
|
||||
this.alias = plugins.isounique.uni(this.options.alias);
|
||||
}
|
||||
|
||||
// tslint:disable-next-line:member-ordering
|
||||
@ -60,8 +60,10 @@ export class Smartsocket {
|
||||
public async stop() {
|
||||
await plugins.smartdelay.delayFor(1000);
|
||||
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
||||
logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
|
||||
socketObjectArg.socket.disconnect();
|
||||
if (socketObjectArg) {
|
||||
logger.log('info', `disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`);
|
||||
socketObjectArg.disconnect();
|
||||
}
|
||||
});
|
||||
this.socketConnections.wipe();
|
||||
this.io.close();
|
||||
@ -94,16 +96,6 @@ export class Smartsocket {
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* adds socketRoles
|
||||
*/
|
||||
public addSocketRoles(socketRolesArray: SocketRole[]): void {
|
||||
for (const socketRole of socketRolesArray) {
|
||||
this.socketRoles.add(socketRole);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||
this.socketFunctions.add(socketFunction);
|
||||
}
|
||||
@ -111,18 +103,24 @@ export class Smartsocket {
|
||||
/**
|
||||
* the standard handler for new socket connections
|
||||
*/
|
||||
private async _handleSocketConnection(socketArg: pluginsTyped.socketIo.Socket) {
|
||||
private async _handleSocketConnection(socketArg: SocketIO.Socket) {
|
||||
const socketConnection: SocketConnection = new SocketConnection({
|
||||
alias: undefined,
|
||||
authenticated: false,
|
||||
role: undefined,
|
||||
side: 'server',
|
||||
smartsocketHost: this,
|
||||
socket: socketArg,
|
||||
});
|
||||
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||
this.socketConnections.add(socketConnection);
|
||||
const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
|
||||
if (eventArg === 'disconnected') {
|
||||
this.socketConnections.remove(socketConnection);
|
||||
disconnectSubscription.unsubscribe();
|
||||
}
|
||||
});
|
||||
await socketConnection.authenticate();
|
||||
await socketConnection.listenToFunctionRequests();
|
||||
await socketConnection.socket.emit('serverFullyReactive');
|
||||
}
|
||||
}
|
||||
|
@ -8,7 +8,6 @@ import {
|
||||
SocketFunction,
|
||||
} from './smartsocket.classes.socketfunction';
|
||||
import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
|
||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||
import { logger } from './smartsocket.logging';
|
||||
|
||||
/**
|
||||
@ -18,8 +17,6 @@ export interface ISmartsocketClientOptions {
|
||||
port: number;
|
||||
url: string;
|
||||
alias: string; // an alias makes it easier to identify this client in a multo client environment
|
||||
role: string;
|
||||
password: string; // by setting a password access to functions can be limited
|
||||
autoReconnect?: boolean;
|
||||
}
|
||||
|
||||
@ -31,7 +28,6 @@ export class SmartsocketClient {
|
||||
public remoteShortId: string = null;
|
||||
|
||||
public alias: string;
|
||||
public socketRole: SocketRole;
|
||||
public socketConnection: SocketConnection;
|
||||
public serverUrl: string;
|
||||
public serverPort: number;
|
||||
@ -43,40 +39,76 @@ export class SmartsocketClient {
|
||||
|
||||
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) {
|
||||
this.alias = optionsArg.alias;
|
||||
this.serverUrl = optionsArg.url;
|
||||
this.serverPort = optionsArg.port;
|
||||
this.socketRole = new SocketRole({
|
||||
name: optionsArg.role,
|
||||
passwordHash: optionsArg.password,
|
||||
});
|
||||
this.autoReconnect = optionsArg.autoReconnect;
|
||||
}
|
||||
|
||||
public addSocketFunction(socketFunction: SocketFunction<any>) {
|
||||
this.socketFunctions.add(socketFunction);
|
||||
this.socketRole.allowedFunctions.add(socketFunction);
|
||||
}
|
||||
|
||||
/**
|
||||
* connect the client to the server
|
||||
*/
|
||||
public connect() {
|
||||
public async connect() {
|
||||
const done = plugins.smartpromise.defer();
|
||||
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}`;
|
||||
this.socketConnection = new SocketConnection({
|
||||
alias: this.alias,
|
||||
authenticated: false,
|
||||
role: this.socketRole,
|
||||
side: 'client',
|
||||
smartsocketHost: this,
|
||||
socket: plugins.socketIoClient(socketUrl, {
|
||||
socket: await socketIoClient.connect(socketUrl, {
|
||||
multiplex: false,
|
||||
reconnectionAttempts: 5,
|
||||
rejectUnauthorized: socketUrl.startsWith('https://localhost') ? false : true,
|
||||
}),
|
||||
});
|
||||
|
||||
@ -95,11 +127,29 @@ export class SmartsocketClient {
|
||||
logger.log('info', 'server requested authentication');
|
||||
|
||||
// lets register the authenticated event
|
||||
this.socketConnection.socket.on('authenticated', () => {
|
||||
this.remoteShortId = requestAuthPayload.serverShortId;
|
||||
this.socketConnection.socket.on('authenticated', async () => {
|
||||
this.remoteShortId = requestAuthPayload.serverAlias;
|
||||
logger.log('info', 'client is authenticated');
|
||||
this.socketConnection.authenticated = true;
|
||||
this.socketConnection.listenToFunctionRequests();
|
||||
await this.socketConnection.listenToFunctionRequests();
|
||||
});
|
||||
|
||||
this.socketConnection.socket.on('serverFullyReactive', async () => {
|
||||
// lets take care of retagging
|
||||
const oldTagStore = this.tagStore;
|
||||
this.tagStoreSubscription?.unsubscribe();
|
||||
for (const keyArg of Object.keys(this.tagStore)) {
|
||||
this.socketConnection.addTag(this.tagStore[keyArg]);
|
||||
}
|
||||
this.tagStoreSubscription = this.socketConnection.tagStoreObservable.subscribe(
|
||||
(tagStoreArg) => {
|
||||
this.tagStore = tagStoreArg;
|
||||
}
|
||||
);
|
||||
|
||||
for (const tag of Object.keys(oldTagStore)) {
|
||||
await this.addTag(oldTagStore[tag]);
|
||||
}
|
||||
done.resolve();
|
||||
});
|
||||
|
||||
@ -111,8 +161,6 @@ export class SmartsocketClient {
|
||||
|
||||
// lets provide the actual auth data
|
||||
this.socketConnection.socket.emit('dataAuth', {
|
||||
role: this.socketRole.name,
|
||||
password: this.socketRole.passwordHash,
|
||||
alias: this.alias,
|
||||
});
|
||||
}
|
||||
@ -141,6 +189,7 @@ export class SmartsocketClient {
|
||||
* disconnect from the server
|
||||
*/
|
||||
public async disconnect() {
|
||||
this.tagStoreSubscription?.unsubscribe();
|
||||
if (this.socketConnection) {
|
||||
await this.socketConnection.disconnect();
|
||||
this.socketConnection = undefined;
|
||||
@ -155,11 +204,19 @@ export class SmartsocketClient {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 plugins.smartdelay.delayForRandom(10000, 50000);
|
||||
await this.connect();
|
||||
}
|
||||
|
||||
|
@ -5,10 +5,9 @@ import * as interfaces from './interfaces';
|
||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||
import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.socketrequest';
|
||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||
|
||||
// socket.io
|
||||
import * as SocketIO from 'socket.io';
|
||||
import * as pluginsTyped from './smartsocket.pluginstyped';
|
||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||
import { logger } from './smartsocket.logging';
|
||||
|
||||
@ -25,7 +24,6 @@ export type TSocketConnectionSide = 'server' | 'client';
|
||||
export interface ISocketConnectionConstructorOptions {
|
||||
alias: string;
|
||||
authenticated: boolean;
|
||||
role: SocketRole;
|
||||
side: TSocketConnectionSide;
|
||||
smartsocketHost: Smartsocket | SmartsocketClient;
|
||||
socket: SocketIO.Socket | SocketIOClient.Socket;
|
||||
@ -35,9 +33,7 @@ export interface ISocketConnectionConstructorOptions {
|
||||
* interface for authentication data
|
||||
*/
|
||||
export interface ISocketConnectionAuthenticationObject {
|
||||
role: 'coreflowContainer';
|
||||
password: 'somePassword';
|
||||
alias: 'coreflow1';
|
||||
alias: string;
|
||||
}
|
||||
|
||||
// export classes
|
||||
@ -50,17 +46,19 @@ export class SocketConnection {
|
||||
public alias: string;
|
||||
public side: TSocketConnectionSide;
|
||||
public authenticated: boolean = false;
|
||||
public role: SocketRole;
|
||||
public smartsocketRef: Smartsocket | SmartsocketClient;
|
||||
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) {
|
||||
this.alias = optionsArg.alias;
|
||||
this.authenticated = optionsArg.authenticated;
|
||||
this.role = optionsArg.role;
|
||||
this.side = optionsArg.side;
|
||||
this.smartsocketRef = optionsArg.smartsocketHost;
|
||||
this.socket = optionsArg.socket;
|
||||
@ -79,9 +77,49 @@ export class SocketConnection {
|
||||
);
|
||||
await this.disconnect();
|
||||
allSocketConnections.remove(this);
|
||||
this.eventSubject.next('disconnected');
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* adds a tag to a connection
|
||||
*/
|
||||
public async addTag(tagArg: interfaces.ITag) {
|
||||
const done = plugins.smartpromise.defer();
|
||||
this.tagStore[tagArg.id] = tagArg;
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
|
||||
if (!remoteTagStore[tagArg.id]) {
|
||||
return;
|
||||
}
|
||||
const localTagString = plugins.smartjson.stringify(tagArg);
|
||||
const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
|
||||
if (localTagString === remoteTagString) {
|
||||
remoteSubscription.unsubscribe();
|
||||
done.resolve();
|
||||
}
|
||||
});
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
await done.promise;
|
||||
}
|
||||
|
||||
/**
|
||||
* gets a tag by id
|
||||
* @param tagIdArg
|
||||
*/
|
||||
public async getTagById(tagIdArg: interfaces.ITag['id']) {
|
||||
return this.tagStore[tagIdArg];
|
||||
}
|
||||
|
||||
/**
|
||||
* removes a tag from a connection
|
||||
*/
|
||||
public async removeTagById(tagIdArg: interfaces.ITag['id']) {
|
||||
delete this.tagStore[tagIdArg];
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
}
|
||||
|
||||
// authenticating --------------------------
|
||||
|
||||
/**
|
||||
@ -90,24 +128,23 @@ export class SocketConnection {
|
||||
public authenticate() {
|
||||
const done = plugins.smartpromise.defer();
|
||||
this.socket.on('dataAuth', async (dataArg: ISocketConnectionAuthenticationObject) => {
|
||||
logger.log('info', 'received authentication data. now hashing and comparing...');
|
||||
this.socket.removeListener('dataAuth', () => {});
|
||||
if (await SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
|
||||
logger.log('info', 'received authentication data...');
|
||||
this.socket.removeAllListeners('dataAuth');
|
||||
if (dataArg.alias) {
|
||||
// TODO: authenticate password
|
||||
this.alias = dataArg.alias;
|
||||
this.authenticated = true;
|
||||
this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
|
||||
this.socket.emit('authenticated');
|
||||
logger.log('ok', `socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`);
|
||||
logger.log('ok', `socket with >>alias ${this.alias} is authenticated!`);
|
||||
done.resolve(this);
|
||||
} else {
|
||||
this.authenticated = false;
|
||||
await this.disconnect();
|
||||
done.reject('not authenticated');
|
||||
done.reject('a socket tried to connect, but could not authenticated.');
|
||||
}
|
||||
});
|
||||
const requestAuthPayload: interfaces.IRequestAuthPayload = {
|
||||
serverShortId: this.smartsocketRef.shortId,
|
||||
serverAlias: this.smartsocketRef.alias,
|
||||
};
|
||||
this.socket.emit('requestAuth', requestAuthPayload);
|
||||
return done.promise;
|
||||
@ -124,7 +161,7 @@ export class SocketConnection {
|
||||
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
||||
// check if requested function is available to the socket's scope
|
||||
// logger.log('info', 'function request received');
|
||||
const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.find(
|
||||
const referencedFunction: SocketFunction<any> = this.smartsocketRef.socketFunctions.findSync(
|
||||
(socketFunctionArg) => {
|
||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||
}
|
||||
@ -143,13 +180,23 @@ export class SocketConnection {
|
||||
}
|
||||
});
|
||||
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
|
||||
logger.log('info', `received response for request with id ${dataArg.shortId}`);
|
||||
// logger.log('info', `received response for request with id ${dataArg.shortId}`);
|
||||
const targetSocketRequest = SocketRequest.getSocketRequestById(
|
||||
this.smartsocketRef,
|
||||
dataArg.shortId
|
||||
);
|
||||
targetSocketRequest.handleResponse(dataArg);
|
||||
});
|
||||
|
||||
this.socket.on('updateTagStore', async (tagStoreArg: interfaces.TTagStore) => {
|
||||
if (!plugins.smartjson.deepEqualObjects(this.tagStore, tagStoreArg)) {
|
||||
this.tagStore = tagStoreArg;
|
||||
this.socket.emit('updateTagStore', this.tagStore);
|
||||
this.tagStoreObservable.next(this.tagStore);
|
||||
}
|
||||
this.remoteTagStoreObservable.next(tagStoreArg);
|
||||
});
|
||||
|
||||
logger.log('info', `now listening to function requests for ${this.alias}`);
|
||||
done.resolve(this);
|
||||
} else {
|
||||
|
@ -1,7 +1,6 @@
|
||||
import * as plugins from './smartsocket.plugins';
|
||||
|
||||
// import classes
|
||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||
import { SocketConnection } from './smartsocket.classes.socketconnection';
|
||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||
@ -16,7 +15,6 @@ export interface ISocketFunctionConstructorOptions<
|
||||
> {
|
||||
funcName: T['method'];
|
||||
funcDef: TFuncDef<T>;
|
||||
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
|
||||
}
|
||||
|
||||
/**
|
||||
@ -58,7 +56,7 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
|
||||
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||
functionNameArg: string
|
||||
): SocketFunction<Q> {
|
||||
return smartsocketRefArg.socketFunctions.find((socketFunctionArg) => {
|
||||
return smartsocketRefArg.socketFunctions.findSync((socketFunctionArg) => {
|
||||
return socketFunctionArg.name === functionNameArg;
|
||||
});
|
||||
}
|
||||
@ -66,7 +64,6 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
|
||||
// INSTANCE
|
||||
public name: string;
|
||||
public funcDef: TFuncDef<T>;
|
||||
public roles: SocketRole[];
|
||||
|
||||
/**
|
||||
* the constructor for SocketFunction
|
||||
@ -74,10 +71,6 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
|
||||
constructor(optionsArg: ISocketFunctionConstructorOptions<T>) {
|
||||
this.name = optionsArg.funcName;
|
||||
this.funcDef = optionsArg.funcDef;
|
||||
this.roles = optionsArg.allowedRoles;
|
||||
for (const socketRoleArg of this.roles) {
|
||||
this._notifyRole(socketRoleArg);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@ -97,11 +90,4 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
|
||||
throw new Error("SocketFunction.name does not match the data argument's .name!");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* notifies a role about access to this SocketFunction
|
||||
*/
|
||||
private _notifyRole(socketRoleArg: SocketRole) {
|
||||
socketRoleArg.addSocketFunction(this);
|
||||
}
|
||||
}
|
||||
|
@ -45,7 +45,7 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
smartsocketRef: Smartsocket | SmartsocketClient,
|
||||
shortIdArg: string
|
||||
): SocketRequest<any> {
|
||||
return smartsocketRef.socketRequests.find((socketRequestArg) => {
|
||||
return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
|
||||
return socketRequestArg.shortid === shortIdArg;
|
||||
});
|
||||
}
|
||||
@ -90,7 +90,7 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
* handles the response that is received by the requesting side
|
||||
*/
|
||||
public async handleResponse(responseDataArg: ISocketRequestDataObject<T>) {
|
||||
logger.log('info', 'handling response!');
|
||||
// logger.log('info', 'handling response!');
|
||||
this.done.resolve(responseDataArg.funcCallData);
|
||||
this.smartsocketRef.socketRequests.remove(this);
|
||||
}
|
||||
@ -110,11 +110,11 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
||||
logger.log('error', `There is no SocketFunction defined for ${this.funcCallData.funcName}`);
|
||||
return;
|
||||
}
|
||||
logger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||
// logger.log('info', `invoking ${targetSocketFunction.name}`);
|
||||
targetSocketFunction
|
||||
.invoke(this.funcCallData, this.originSocketConnection)
|
||||
.then((resultData) => {
|
||||
logger.log('info', 'got resultData. Sending it to requesting party.');
|
||||
// logger.log('info', 'got resultData. Sending it to requesting party.');
|
||||
const responseData: ISocketRequestDataObject<T> = {
|
||||
funcCallData: resultData,
|
||||
shortId: this.shortid,
|
||||
|
@ -1,57 +0,0 @@
|
||||
import * as plugins from './smartsocket.plugins';
|
||||
|
||||
// import classes
|
||||
import { SocketFunction } from './smartsocket.classes.socketfunction';
|
||||
import { Smartsocket } from './smartsocket.classes.smartsocket';
|
||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||
import { ISocketConnectionAuthenticationObject } from './smartsocket.classes.socketconnection';
|
||||
|
||||
/**
|
||||
* interface for class SocketRole
|
||||
*/
|
||||
export interface ISocketRoleOptions {
|
||||
name: string;
|
||||
passwordHash: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* A socketrole defines access to certain routines.
|
||||
*/
|
||||
export class SocketRole {
|
||||
// STATIC
|
||||
public static getSocketRoleByName(
|
||||
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
||||
socketRoleNameArg: string
|
||||
): SocketRole {
|
||||
return referenceSmartsocket.socketRoles.find((socketRoleArg) => {
|
||||
return socketRoleArg.name === socketRoleNameArg;
|
||||
});
|
||||
}
|
||||
|
||||
public static async checkPasswordForRole(
|
||||
dataArg: ISocketConnectionAuthenticationObject,
|
||||
referenceSmartsocket: Smartsocket | SmartsocketClient
|
||||
): Promise<boolean> {
|
||||
const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role)
|
||||
.passwordHash;
|
||||
const computedCompareHash = await plugins.isohash.sha256FromString(dataArg.password);
|
||||
return targetPasswordHash === computedCompareHash;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
public name: string;
|
||||
public passwordHash: string;
|
||||
public allowedFunctions = new plugins.lik.ObjectMap<SocketFunction<any>>();
|
||||
constructor(optionsArg: ISocketRoleOptions) {
|
||||
this.name = optionsArg.name;
|
||||
this.passwordHash = optionsArg.passwordHash;
|
||||
}
|
||||
|
||||
/**
|
||||
* adds the socketfunction to the socketrole
|
||||
* @param socketFunctionArg
|
||||
*/
|
||||
public addSocketFunction(socketFunctionArg: SocketFunction<any>) {
|
||||
this.allowedFunctions.add(socketFunctionArg);
|
||||
}
|
||||
}
|
@ -12,9 +12,11 @@ import { logger } from './smartsocket.logging';
|
||||
export class SocketServer {
|
||||
private smartsocket: Smartsocket;
|
||||
private httpServer: pluginsTyped.http.Server | pluginsTyped.https.Server;
|
||||
// wether httpServer is standalone
|
||||
|
||||
/**
|
||||
* wether httpServer is standalone
|
||||
*/
|
||||
private standaloneServer = false;
|
||||
private expressServer: any;
|
||||
|
||||
constructor(smartSocketInstance: Smartsocket) {
|
||||
this.smartsocket = smartSocketInstance;
|
||||
@ -78,5 +80,9 @@ export class SocketServer {
|
||||
/**
|
||||
* closes the server
|
||||
*/
|
||||
public async stop() {}
|
||||
public async stop() {
|
||||
if (this.httpServer) {
|
||||
this.httpServer.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,3 +0,0 @@
|
||||
import * as plugins from './smartsocket.plugins';
|
||||
|
||||
export class SocketStats {}
|
@ -8,6 +8,7 @@ import * as isohash from '@pushrocks/isohash';
|
||||
import * as isounique from '@pushrocks/isounique';
|
||||
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 smartdelay from '@pushrocks/smartdelay';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
@ -19,16 +20,10 @@ export {
|
||||
isounique,
|
||||
lik,
|
||||
smartenv,
|
||||
smartjson,
|
||||
smartlog,
|
||||
smartdelay,
|
||||
smartpromise,
|
||||
smarttime,
|
||||
smartrx,
|
||||
};
|
||||
|
||||
// third party
|
||||
import socketIoClient from 'socket.io-client';
|
||||
|
||||
export {
|
||||
socketIoClient
|
||||
};
|
||||
|
@ -2,19 +2,15 @@
|
||||
import type http from 'http';
|
||||
import type https from 'https';
|
||||
|
||||
export {
|
||||
http,
|
||||
https
|
||||
};
|
||||
export { http, https };
|
||||
|
||||
// pushrocks scope
|
||||
import type * as smartexpress from '@pushrocks/smartexpress';
|
||||
|
||||
export {
|
||||
smartexpress
|
||||
};
|
||||
export { smartexpress };
|
||||
|
||||
// third party scope
|
||||
import type socketIo from 'socket.io';
|
||||
import type socketIoClient from 'socket.io-client';
|
||||
|
||||
export { socketIo };
|
||||
export { socketIoClient, socketIo };
|
||||
|
Reference in New Issue
Block a user