-import type { IncomingMessage } from 'http';
-import type { Duplex } from 'stream';
+import type { IncomingMessage } from 'node:http';
+import type { Duplex } from 'node:stream';
import { StatusCodes } from 'http-status-codes';
-import WebSocket, { type RawData, WebSocketServer } from 'ws';
+import { type RawData, WebSocket, WebSocketServer } from 'ws';
+import { AbstractUIServer } from './AbstractUIServer';
+import { UIServerUtils } from './UIServerUtils';
import {
type ProtocolRequest,
type ProtocolResponse,
type UIServerConfiguration,
WebSocketCloseEventStatusCode,
} from '../../types';
-import { Utils, logger } from '../../utils';
-import { AbstractUIServer, UIServerUtils } from '../internal';
+import {
+ Constants,
+ getWebSocketCloseEventStatusString,
+ isNotEmptyString,
+ isNullOrUndefined,
+ logPrefix,
+ logger,
+ validateUUID,
+} from '../../utils';
const moduleName = 'UIWebSocketServer';
logger.error(
`${this.logPrefix(
moduleName,
- 'start.server.onconnection'
- )} Unsupported UI protocol version: '${ws.protocol}'`
+ 'start.server.onconnection',
+ )} Unsupported UI protocol version: '${ws.protocol}'`,
);
ws.close(WebSocketCloseEventStatusCode.CLOSE_PROTOCOL_ERROR);
}
this.uiServices
.get(version)
?.requestHandler(request)
- .catch(() => {
- /* Error caught by AbstractUIService */
- });
+ .then((protocolResponse?: ProtocolResponse) => {
+ if (!isNullOrUndefined(protocolResponse)) {
+ this.sendResponse(protocolResponse!);
+ }
+ })
+ .catch(Constants.EMPTY_FUNCTION);
});
ws.on('error', (error) => {
logger.error(`${this.logPrefix(moduleName, 'start.ws.onerror')} WebSocket error:`, error);
logger.debug(
`${this.logPrefix(
moduleName,
- 'start.ws.onclose'
- )} WebSocket closed: '${Utils.getWebSocketCloseEventStatusString(
- code
- )}' - '${reason.toString()}'`
+ 'start.ws.onclose',
+ )} WebSocket closed: '${getWebSocketCloseEventStatusString(
+ code,
+ )}' - '${reason.toString()}'`,
);
});
});
logger.error(
`${this.logPrefix(
moduleName,
- 'start.httpServer.on.upgrade'
+ 'start.httpServer.on.upgrade',
)} Error at handling connection upgrade:`,
- error
+ error,
);
}
});
}
public sendResponse(response: ProtocolResponse): void {
- const responseId = response[0];
+ const responseId = response?.[0];
try {
- if (this.responseHandlers.has(responseId)) {
+ if (this.hasResponseHandler(responseId)) {
const ws = this.responseHandlers.get(responseId) as WebSocket;
if (ws?.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(response));
logger.error(
`${this.logPrefix(
moduleName,
- 'sendResponse'
- )} Error at sending response id '${responseId}', WebSocket is not open: ${
- ws?.readyState
- }`
+ 'sendResponse',
+ )} Error at sending response id '${responseId}', WebSocket is not open: ${ws?.readyState}`,
);
}
} else {
logger.error(
`${this.logPrefix(
moduleName,
- 'sendResponse'
- )} Response for unknown request id: ${responseId}`
+ 'sendResponse',
+ )} Response for unknown request id: ${responseId}`,
);
}
} catch (error) {
logger.error(
`${this.logPrefix(
moduleName,
- 'sendResponse'
+ 'sendResponse',
)} Error at sending response id '${responseId}':`,
- error
+ error,
);
} finally {
this.responseHandlers.delete(responseId);
? `UI WebSocket Server ${prefixSuffix}`
: 'UI WebSocket Server';
const logMsg =
- Utils.isNotEmptyString(modName) && Utils.isNotEmptyString(methodName)
+ isNotEmptyString(modName) && isNotEmptyString(methodName)
? ` ${logMsgPrefix} | ${modName}.${methodName}:`
: ` ${logMsgPrefix} |`;
- return Utils.logPrefix(logMsg);
+ return logPrefix(logMsg);
};
private broadcastToClients(message: string): void {
// logger.debug(
// `${this.logPrefix(
// moduleName,
- // 'validateRawDataRequest'
- // )} Raw data received in string format: ${rawData.toString()}`
+ // 'validateRawDataRequest',
+ // // eslint-disable-next-line @typescript-eslint/no-base-to-string
+ // )} Raw data received in string format: ${rawData.toString()}`,
// );
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
const request = JSON.parse(rawData.toString()) as ProtocolRequest;
if (Array.isArray(request) === false) {
logger.error(
`${this.logPrefix(
moduleName,
- 'validateRawDataRequest'
+ 'validateRawDataRequest',
)} UI protocol request is not an array:`,
- request
+ request,
);
return false;
}
if (request.length !== 3) {
logger.error(
`${this.logPrefix(moduleName, 'validateRawDataRequest')} UI protocol request is malformed:`,
- request
+ request,
);
return false;
}
- if (Utils.validateUUID(request[0]) === false) {
+ if (validateUUID(request?.[0]) === false) {
logger.error(
`${this.logPrefix(
moduleName,
- 'validateRawDataRequest'
+ 'validateRawDataRequest',
)} UI protocol request UUID field is invalid:`,
- request
+ request,
);
return false;
}