Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
b9a6f1d5b0 | |||
489ad9284b | |||
6fdf0d9955 | |||
499a1893f9 | |||
2754447aae | |||
544277cb8a | |||
9a23960d21 | |||
23cca6cce3 |
@ -12,6 +12,9 @@ stages:
|
|||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
# ====================
|
# ====================
|
||||||
@ -36,6 +39,7 @@ auditProductionDependencies:
|
|||||||
- npmci command npm audit --audit-level=high --only=prod --production
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
auditDevDependencies:
|
auditDevDependencies:
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
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",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
"name": "current file",
|
"command": "npm test",
|
||||||
"type": "node",
|
"name": "Run npm test",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"args": [
|
"type": "node-terminal"
|
||||||
"${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"
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartsocket",
|
"gitrepo": "smartsocket",
|
||||||
"shortDescription": "easy and secure websocket communication",
|
"description": "easy and secure websocket communication",
|
||||||
"npmPackagename": "@pushrocks/smartsocket",
|
"npmPackagename": "@pushrocks/smartsocket",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks"
|
"projectDomain": "push.rocks"
|
||||||
|
22405
package-lock.json
generated
22405
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
28
package.json
28
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartsocket",
|
"name": "@pushrocks/smartsocket",
|
||||||
"version": "1.2.7",
|
"version": "1.2.11",
|
||||||
"description": "easy and secure websocket communication",
|
"description": "easy and secure websocket communication",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
@ -22,26 +22,26 @@
|
|||||||
"@apiglobal/typedrequest-interfaces": "^1.0.15",
|
"@apiglobal/typedrequest-interfaces": "^1.0.15",
|
||||||
"@pushrocks/isohash": "^1.0.2",
|
"@pushrocks/isohash": "^1.0.2",
|
||||||
"@pushrocks/isounique": "^1.0.4",
|
"@pushrocks/isounique": "^1.0.4",
|
||||||
"@pushrocks/lik": "^4.0.20",
|
"@pushrocks/lik": "^5.0.0",
|
||||||
"@pushrocks/smartdelay": "^2.0.10",
|
"@pushrocks/smartdelay": "^2.0.13",
|
||||||
"@pushrocks/smartenv": "^4.0.16",
|
"@pushrocks/smartenv": "^4.0.16",
|
||||||
"@pushrocks/smartexpress": "^3.0.100",
|
"@pushrocks/smartexpress": "^3.0.108",
|
||||||
"@pushrocks/smartjson": "^4.0.6",
|
"@pushrocks/smartjson": "^4.0.6",
|
||||||
"@pushrocks/smartlog": "^2.0.39",
|
"@pushrocks/smartlog": "^2.0.44",
|
||||||
"@pushrocks/smartpromise": "^3.1.3",
|
"@pushrocks/smartpromise": "^3.1.6",
|
||||||
"@pushrocks/smartrx": "^2.0.19",
|
"@pushrocks/smartrx": "^2.0.19",
|
||||||
"@pushrocks/smarttime": "^3.0.38",
|
"@pushrocks/smarttime": "^3.0.43",
|
||||||
"@types/socket.io": "^2.1.13",
|
"@types/socket.io": "^3.0.2",
|
||||||
"@types/socket.io-client": "^1.4.35",
|
"@types/socket.io-client": "^3.0.0",
|
||||||
"socket.io": "^3.1.0",
|
"socket.io": "^3.1.0",
|
||||||
"socket.io-client": "^3.1.0"
|
"socket.io-client": "^3.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.25",
|
"@gitzone/tsbuild": "^2.1.28",
|
||||||
"@gitzone/tsrun": "^1.2.12",
|
"@gitzone/tsrun": "^1.2.18",
|
||||||
"@gitzone/tstest": "^1.0.52",
|
"@gitzone/tstest": "^1.0.60",
|
||||||
"@pushrocks/tapbundle": "^3.2.10",
|
"@pushrocks/tapbundle": "^3.2.15",
|
||||||
"@types/node": "^14.14.22",
|
"@types/node": "^17.0.9",
|
||||||
"tslint": "^6.1.3",
|
"tslint": "^6.1.3",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"tslint-config-prettier": "^1.18.0"
|
||||||
},
|
},
|
||||||
|
28
test/test.ts
28
test/test.ts
@ -96,7 +96,7 @@ tap.test('should be able to tag a connection from client', async (tools) => {
|
|||||||
payload: 'yes',
|
payload: 'yes',
|
||||||
});
|
});
|
||||||
const tagOnServerSide = await testSmartsocket.socketConnections
|
const tagOnServerSide = await testSmartsocket.socketConnections
|
||||||
.find((socketConnection) => {
|
.findSync((socketConnection) => {
|
||||||
return true;
|
return true;
|
||||||
})
|
})
|
||||||
.getTagById('awesome');
|
.getTagById('awesome');
|
||||||
@ -105,12 +105,13 @@ tap.test('should be able to tag a connection from client', async (tools) => {
|
|||||||
|
|
||||||
tap.test('should be able to tag a connection from server', async (tools) => {
|
tap.test('should be able to tag a connection from server', async (tools) => {
|
||||||
await testSmartsocket.socketConnections
|
await testSmartsocket.socketConnections
|
||||||
.find((socketConnection) => {
|
.findSync((socketConnection) => {
|
||||||
return true;
|
return true;
|
||||||
}).addTag({
|
})
|
||||||
id: 'awesome2',
|
.addTag({
|
||||||
payload: 'absolutely',
|
id: 'awesome2',
|
||||||
});
|
payload: 'absolutely',
|
||||||
|
});
|
||||||
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
const tagOnClientSide = await testSmartsocketClient.socketConnection.getTagById('awesome2');
|
||||||
expect(tagOnClientSide.payload).to.equal('absolutely');
|
expect(tagOnClientSide.payload).to.equal('absolutely');
|
||||||
});
|
});
|
||||||
@ -133,7 +134,7 @@ tap.test('should be able to make a functionCall from server to client', async ()
|
|||||||
{
|
{
|
||||||
hi: 'hi there from server',
|
hi: 'hi there from server',
|
||||||
},
|
},
|
||||||
testSmartsocket.socketConnections.find((socketConnection) => {
|
testSmartsocket.socketConnections.findSync((socketConnection) => {
|
||||||
return true;
|
return true;
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@ -143,10 +144,19 @@ tap.test('should be able to make a functionCall from server to client', async ()
|
|||||||
|
|
||||||
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 testSmartsocketClient.connect();
|
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
|
// terminate
|
||||||
tap.test('should close the server', async () => {
|
tap.test('should close the server', async () => {
|
||||||
await testSmartsocket.stop();
|
await testSmartsocket.stop();
|
||||||
|
@ -61,8 +61,8 @@ export class Smartsocket {
|
|||||||
await plugins.smartdelay.delayFor(1000);
|
await plugins.smartdelay.delayFor(1000);
|
||||||
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
this.socketConnections.forEach((socketObjectArg: SocketConnection) => {
|
||||||
if (socketObjectArg) {
|
if (socketObjectArg) {
|
||||||
logger.log('info', `disconnect socket with >>alias ${socketObjectArg.alias}`);
|
logger.log('info', `disconnecting socket with >>alias ${socketObjectArg.alias} due to server stop...`);
|
||||||
socketObjectArg.socket.disconnect();
|
socketObjectArg.disconnect();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
this.socketConnections.wipe();
|
this.socketConnections.wipe();
|
||||||
@ -113,7 +113,7 @@ export class Smartsocket {
|
|||||||
/**
|
/**
|
||||||
* the standard handler for new socket connections
|
* 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({
|
const socketConnection: SocketConnection = new SocketConnection({
|
||||||
alias: undefined,
|
alias: undefined,
|
||||||
authenticated: false,
|
authenticated: false,
|
||||||
@ -124,7 +124,14 @@ export class Smartsocket {
|
|||||||
});
|
});
|
||||||
logger.log('info', 'Socket connected. Trying to authenticate...');
|
logger.log('info', 'Socket connected. Trying to authenticate...');
|
||||||
this.socketConnections.add(socketConnection);
|
this.socketConnections.add(socketConnection);
|
||||||
|
const disconnectSubscription = socketConnection.eventSubject.subscribe((eventArg) => {
|
||||||
|
if (eventArg === 'disconnected') {
|
||||||
|
this.socketConnections.remove(socketConnection);
|
||||||
|
disconnectSubscription.unsubscribe();
|
||||||
|
}
|
||||||
|
});
|
||||||
await socketConnection.authenticate();
|
await socketConnection.authenticate();
|
||||||
await socketConnection.listenToFunctionRequests();
|
await socketConnection.listenToFunctionRequests();
|
||||||
|
await socketConnection.socket.emit('serverFullyReactive');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -138,11 +138,29 @@ export class SmartsocketClient {
|
|||||||
logger.log('info', 'server requested authentication');
|
logger.log('info', 'server requested authentication');
|
||||||
|
|
||||||
// lets register the authenticated event
|
// lets register the authenticated event
|
||||||
this.socketConnection.socket.on('authenticated', () => {
|
this.socketConnection.socket.on('authenticated', async () => {
|
||||||
this.remoteShortId = requestAuthPayload.serverShortId;
|
this.remoteShortId = requestAuthPayload.serverShortId;
|
||||||
logger.log('info', 'client is authenticated');
|
logger.log('info', 'client is authenticated');
|
||||||
this.socketConnection.authenticated = true;
|
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();
|
done.resolve();
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -163,16 +181,6 @@ export class SmartsocketClient {
|
|||||||
|
|
||||||
// handle connection
|
// handle connection
|
||||||
this.socketConnection.socket.on('connect', async () => {
|
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');
|
this.updateStatus('connected');
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -194,6 +202,7 @@ export class SmartsocketClient {
|
|||||||
* disconnect from the server
|
* disconnect from the server
|
||||||
*/
|
*/
|
||||||
public async disconnect() {
|
public async disconnect() {
|
||||||
|
this.tagStoreSubscription?.unsubscribe();
|
||||||
if (this.socketConnection) {
|
if (this.socketConnection) {
|
||||||
await this.socketConnection.disconnect();
|
await this.socketConnection.disconnect();
|
||||||
this.socketConnection = undefined;
|
this.socketConnection = undefined;
|
||||||
|
@ -8,7 +8,7 @@ import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.s
|
|||||||
import { SocketRole } from './smartsocket.classes.socketrole';
|
import { SocketRole } from './smartsocket.classes.socketrole';
|
||||||
|
|
||||||
// socket.io
|
// socket.io
|
||||||
import * as SocketIO from 'socket.io';
|
import * as pluginsTyped from './smartsocket.pluginstyped';
|
||||||
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
|
||||||
import { logger } from './smartsocket.logging';
|
import { logger } from './smartsocket.logging';
|
||||||
|
|
||||||
@ -83,6 +83,7 @@ export class SocketConnection {
|
|||||||
);
|
);
|
||||||
await this.disconnect();
|
await this.disconnect();
|
||||||
allSocketConnections.remove(this);
|
allSocketConnections.remove(this);
|
||||||
|
this.eventSubject.next('disconnected');
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -94,6 +95,9 @@ export class SocketConnection {
|
|||||||
this.tagStore[tagArg.id] = tagArg;
|
this.tagStore[tagArg.id] = tagArg;
|
||||||
this.tagStoreObservable.next(this.tagStore);
|
this.tagStoreObservable.next(this.tagStore);
|
||||||
const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
|
const remoteSubscription = this.remoteTagStoreObservable.subscribe((remoteTagStore) => {
|
||||||
|
if (!remoteTagStore[tagArg.id]) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
const localTagString = plugins.smartjson.stringify(tagArg);
|
const localTagString = plugins.smartjson.stringify(tagArg);
|
||||||
const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
|
const remoteTagString = plugins.smartjson.stringify(remoteTagStore[tagArg.id]);
|
||||||
if (localTagString === remoteTagString) {
|
if (localTagString === remoteTagString) {
|
||||||
@ -164,7 +168,7 @@ export class SocketConnection {
|
|||||||
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
|
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
|
||||||
// logger.log('info', 'function request received');
|
// logger.log('info', 'function request received');
|
||||||
const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.find(
|
const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.findSync(
|
||||||
(socketFunctionArg) => {
|
(socketFunctionArg) => {
|
||||||
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
return socketFunctionArg.name === dataArg.funcCallData.funcName;
|
||||||
}
|
}
|
||||||
|
@ -58,7 +58,7 @@ export class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedReque
|
|||||||
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
smartsocketRefArg: Smartsocket | SmartsocketClient,
|
||||||
functionNameArg: string
|
functionNameArg: string
|
||||||
): SocketFunction<Q> {
|
): SocketFunction<Q> {
|
||||||
return smartsocketRefArg.socketFunctions.find((socketFunctionArg) => {
|
return smartsocketRefArg.socketFunctions.findSync((socketFunctionArg) => {
|
||||||
return socketFunctionArg.name === functionNameArg;
|
return socketFunctionArg.name === functionNameArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -45,7 +45,7 @@ export class SocketRequest<T extends plugins.typedrequestInterfaces.ITypedReques
|
|||||||
smartsocketRef: Smartsocket | SmartsocketClient,
|
smartsocketRef: Smartsocket | SmartsocketClient,
|
||||||
shortIdArg: string
|
shortIdArg: string
|
||||||
): SocketRequest<any> {
|
): SocketRequest<any> {
|
||||||
return smartsocketRef.socketRequests.find((socketRequestArg) => {
|
return smartsocketRef.socketRequests.findSync((socketRequestArg) => {
|
||||||
return socketRequestArg.shortid === shortIdArg;
|
return socketRequestArg.shortid === shortIdArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -23,7 +23,7 @@ export class SocketRole {
|
|||||||
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
referenceSmartsocket: Smartsocket | SmartsocketClient,
|
||||||
socketRoleNameArg: string
|
socketRoleNameArg: string
|
||||||
): SocketRole {
|
): SocketRole {
|
||||||
return referenceSmartsocket.socketRoles.find((socketRoleArg) => {
|
return referenceSmartsocket.socketRoles.findSync((socketRoleArg) => {
|
||||||
return socketRoleArg.name === socketRoleNameArg;
|
return socketRoleArg.name === socketRoleNameArg;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -32,8 +32,10 @@ export class SocketRole {
|
|||||||
dataArg: ISocketConnectionAuthenticationObject,
|
dataArg: ISocketConnectionAuthenticationObject,
|
||||||
referenceSmartsocket: Smartsocket | SmartsocketClient
|
referenceSmartsocket: Smartsocket | SmartsocketClient
|
||||||
): Promise<boolean> {
|
): Promise<boolean> {
|
||||||
const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role)
|
const targetPasswordHash = SocketRole.getSocketRoleByName(
|
||||||
.passwordHash;
|
referenceSmartsocket,
|
||||||
|
dataArg.role
|
||||||
|
).passwordHash;
|
||||||
const computedCompareHash = await plugins.isohash.sha256FromString(dataArg.password);
|
const computedCompareHash = await plugins.isohash.sha256FromString(dataArg.password);
|
||||||
return targetPasswordHash === computedCompareHash;
|
return targetPasswordHash === computedCompareHash;
|
||||||
}
|
}
|
||||||
|
@ -77,5 +77,9 @@ export class SocketServer {
|
|||||||
/**
|
/**
|
||||||
* closes the server
|
* closes the server
|
||||||
*/
|
*/
|
||||||
public async stop() {}
|
public async stop() {
|
||||||
|
if (this.httpServer) {
|
||||||
|
this.httpServer.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -13,4 +13,4 @@ export { smartexpress };
|
|||||||
import type socketIo from 'socket.io';
|
import type socketIo from 'socket.io';
|
||||||
import type socketIoClient from 'socket.io-client';
|
import type socketIoClient from 'socket.io-client';
|
||||||
|
|
||||||
export { socketIo, socketIoClient };
|
export { socketIoClient, socketIo };
|
||||||
|
Reference in New Issue
Block a user