smartsocket/ts/smartsocket.classes.socketconnection.ts

168 lines
5.5 KiB
TypeScript
Raw Normal View History

2018-03-15 01:29:40 +00:00
import * as plugins from './smartsocket.plugins';
2016-08-08 16:20:00 +00:00
import { Objectmap } from '@pushrocks/lik';
2016-08-08 16:20:00 +00:00
// import classes
2018-03-15 01:29:40 +00:00
import { Smartsocket } from './smartsocket.classes.smartsocket';
import { SocketFunction } from './smartsocket.classes.socketfunction';
2019-08-12 20:46:57 +00:00
import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.socketrequest';
2018-03-15 01:29:40 +00:00
import { SocketRole } from './smartsocket.classes.socketrole';
// socket.io
import * as SocketIO from 'socket.io';
2019-08-12 20:31:40 +00:00
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
2016-08-08 16:20:00 +00:00
2016-08-09 09:42:21 +00:00
// export interfaces
/**
* defines is a SocketConnection is server or client side. Important for mesh setups.
*/
2018-03-15 01:29:40 +00:00
export type TSocketConnectionSide = 'server' | 'client';
2016-08-09 09:42:21 +00:00
/**
* interface for constructor of class SocketConnection
*/
2016-08-11 23:32:57 +00:00
export interface ISocketConnectionConstructorOptions {
2018-03-15 01:29:40 +00:00
alias: string;
authenticated: boolean;
role: SocketRole;
side: TSocketConnectionSide;
2019-08-12 20:31:40 +00:00
smartsocketHost: Smartsocket | SmartsocketClient;
2018-03-15 01:29:40 +00:00
socket: SocketIO.Socket | SocketIOClient.Socket;
2017-07-07 20:02:19 +00:00
}
2016-08-08 16:20:00 +00:00
2016-08-09 09:42:21 +00:00
/**
* interface for authentication data
*/
export interface ISocketConnectionAuthenticationObject {
2018-03-15 01:29:40 +00:00
role: 'coreflowContainer';
password: 'somePassword';
alias: 'coreflow1';
2017-07-07 20:02:19 +00:00
}
2016-08-09 09:42:21 +00:00
// export classes
2018-03-15 01:29:40 +00:00
export let allSocketConnections = new Objectmap<SocketConnection>();
2016-08-09 09:42:21 +00:00
/**
* class SocketConnection represents a websocket connection
*/
2016-08-08 16:20:00 +00:00
export class SocketConnection {
2019-06-07 06:40:24 +00:00
public alias: string;
public side: TSocketConnectionSide;
public authenticated: boolean = false;
public role: SocketRole;
2019-08-12 20:31:40 +00:00
public smartsocketRef: Smartsocket | SmartsocketClient;
2019-06-07 06:40:24 +00:00
public socket: SocketIO.Socket | SocketIOClient.Socket;
2018-03-15 01:29:40 +00:00
constructor(optionsArg: ISocketConnectionConstructorOptions) {
this.alias = optionsArg.alias;
this.authenticated = optionsArg.authenticated;
this.role = optionsArg.role;
this.side = optionsArg.side;
2019-08-12 20:31:40 +00:00
this.smartsocketRef = optionsArg.smartsocketHost;
2018-03-15 01:29:40 +00:00
this.socket = optionsArg.socket;
2016-08-12 01:22:36 +00:00
2017-07-07 20:02:19 +00:00
// standard behaviour that is always true
2018-03-15 01:29:40 +00:00
allSocketConnections.add(this);
2017-07-07 20:02:19 +00:00
this.socket.on('disconnect', () => {
plugins.smartlog.defaultLogger.log(
'info',
2018-03-15 01:29:40 +00:00
`SocketConnection with >alias ${this.alias} on >side ${this.side} disconnected`
);
this.socket.disconnect();
allSocketConnections.remove(this);
});
2017-07-07 20:02:19 +00:00
}
2016-08-12 01:22:36 +00:00
2017-07-07 20:02:19 +00:00
// authenticating --------------------------
2016-08-08 16:20:00 +00:00
2017-07-07 20:02:19 +00:00
/**
* authenticate the socket
*/
2019-08-12 20:31:40 +00:00
public authenticate() {
const done = plugins.smartpromise.defer();
2017-07-07 20:02:19 +00:00
this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
plugins.smartlog.defaultLogger.log(
'info',
'received authentication data. now hashing and comparing...'
);
2018-03-15 01:29:40 +00:00
this.socket.removeListener('dataAuth', () => {});
2019-08-12 20:31:40 +00:00
if (SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
2018-03-15 01:29:40 +00:00
// TODO: authenticate password
this.alias = dataArg.alias;
this.authenticated = true;
2019-08-12 20:31:40 +00:00
this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
2018-03-15 01:29:40 +00:00
this.socket.emit('authenticated');
plugins.smartlog.defaultLogger.log(
'ok',
2018-03-15 01:29:40 +00:00
`socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`
);
done.resolve(this);
2017-07-07 20:02:19 +00:00
} else {
2018-03-15 01:29:40 +00:00
this.authenticated = false;
this.socket.disconnect();
done.reject('not authenticated');
2017-07-07 20:02:19 +00:00
}
2018-03-15 01:29:40 +00:00
});
this.socket.emit('requestAuth');
return done.promise;
2017-07-07 20:02:19 +00:00
}
2016-08-12 01:22:36 +00:00
2017-07-07 20:02:19 +00:00
// listening -------------------------------
/**
* listen to function requests
*/
2019-08-12 20:31:40 +00:00
public listenToFunctionRequests() {
const done = plugins.smartpromise.defer();
2017-07-07 20:02:19 +00:00
if (this.authenticated) {
2019-09-09 21:58:32 +00:00
this.socket.on('function', (dataArg: ISocketRequestDataObject<any>) => {
2017-07-07 20:02:19 +00:00
// check if requested function is available to the socket's scope
plugins.smartlog.defaultLogger.log('info', 'function request received');
2019-09-09 21:58:32 +00:00
const referencedFunction: SocketFunction<any> = this.role.allowedFunctions.find(
2018-03-15 01:29:40 +00:00
socketFunctionArg => {
return socketFunctionArg.name === dataArg.funcCallData.funcName;
}
);
2019-08-13 09:36:31 +00:00
if (referencedFunction) {
plugins.smartlog.defaultLogger.log('ok', 'function in access scope');
2019-08-12 20:31:40 +00:00
const localSocketRequest = new SocketRequest(this.smartsocketRef, {
2017-07-07 20:02:19 +00:00
side: 'responding',
originSocketConnection: this,
shortId: dataArg.shortId,
funcCallData: dataArg.funcCallData
2018-03-15 01:29:40 +00:00
});
localSocketRequest.createResponse(); // takes care of creating response and sending it back
2016-08-08 16:20:00 +00:00
} else {
plugins.smartlog.defaultLogger.log(
'warn',
'function not existent or out of access scope'
);
2017-07-07 20:02:19 +00:00
}
2018-03-15 01:29:40 +00:00
});
2019-09-09 21:58:32 +00:00
this.socket.on('functionResponse', (dataArg: ISocketRequestDataObject<any>) => {
plugins.smartlog.defaultLogger.log(
'info',
`received response for request with id ${dataArg.shortId}`
);
2019-08-12 20:46:57 +00:00
const targetSocketRequest = SocketRequest.getSocketRequestById(
this.smartsocketRef,
dataArg.shortId
);
2018-03-15 01:29:40 +00:00
targetSocketRequest.handleResponse(dataArg);
});
plugins.smartlog.defaultLogger.log(
'info',
`now listening to function requests for ${this.alias}`
);
2018-03-15 01:29:40 +00:00
done.resolve(this);
2017-07-07 20:02:19 +00:00
} else {
2019-08-12 20:31:40 +00:00
const errMessage = 'socket needs to be authenticated first';
plugins.smartlog.defaultLogger.log('error', errMessage);
2018-03-15 01:29:40 +00:00
done.reject(errMessage);
2017-07-07 20:02:19 +00:00
}
2018-03-15 01:29:40 +00:00
return done.promise;
2017-07-07 20:02:19 +00:00
}
// sending ----------------------
}