1 import type { IncomingMessage
, RequestListener
, ServerResponse
} from
'http';
3 import { StatusCodes
} from
'http-status-codes';
5 import { AbstractUIServer
} from
'./AbstractUIServer';
6 import { UIServerUtils
} from
'./UIServerUtils';
7 import BaseError from
'../../exception/BaseError';
8 import type { UIServerConfiguration
} from
'../../types/ConfigurationData';
13 type ProtocolResponse
,
17 } from
'../../types/UIProtocol';
18 import logger from
'../../utils/Logger';
19 import Utils from
'../../utils/Utils';
21 const moduleName
= 'UIHttpServer';
23 export default class UIHttpServer
extends AbstractUIServer
{
24 public constructor(protected readonly uiServerConfiguration
: UIServerConfiguration
) {
25 super(uiServerConfiguration
);
28 public start(): void {
29 this.httpServer
.on('request', this.requestListener
.bind(this) as RequestListener
);
30 this.startHttpServer();
33 // eslint-disable-next-line @typescript-eslint/no-unused-vars
34 public sendRequest(request
: ProtocolRequest
): void {
35 // This is intentionally left blank
38 public sendResponse(response
: ProtocolResponse
): void {
39 const [uuid
, payload
] = response
;
41 if (this.responseHandlers
.has(uuid
) === true) {
42 const res
= this.responseHandlers
.get(uuid
) as ServerResponse
;
44 .writeHead(this.responseStatusToStatusCode(payload
.status), {
45 'Content-Type': 'application/json',
47 .end(JSON
.stringify(payload
));
50 `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}`
55 `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`,
59 this.responseHandlers
.delete(uuid
);
63 public logPrefix
= (modName
?: string, methodName
?: string, prefixSuffix
?: string): string => {
64 const logMsgPrefix
= prefixSuffix
? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server';
66 !Utils
.isEmptyString(modName
) && !Utils
.isEmptyString(methodName
)
67 ? ` ${logMsgPrefix} | ${modName}.${methodName}:`
68 : ` ${logMsgPrefix} |`;
69 return Utils
.logPrefix(logMsg
);
72 private requestListener(req
: IncomingMessage
, res
: ServerResponse
): void {
73 this.authenticate(req
, (err
) => {
76 .writeHead(StatusCodes
.UNAUTHORIZED
, {
77 'Content-Type': 'text/plain',
78 'WWW-Authenticate': 'Basic realm=users',
80 .end(`${StatusCodes.UNAUTHORIZED} Unauthorized`)
85 // Expected request URL pathname: /ui/:version/:procedureName
86 const [protocol
, version
, procedureName
] = req
.url
?.split('/').slice(1) as [
91 const uuid
= Utils
.generateUUID();
92 this.responseHandlers
.set(uuid
, res
);
94 const fullProtocol
= `${protocol}${version}`;
95 if (UIServerUtils
.isProtocolAndVersionSupported(fullProtocol
) === false) {
96 throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`);
98 this.registerProtocolVersionUIService(version
);
99 req
.on('error', (error
) => {
101 `${this.logPrefix(moduleName, 'requestListener.req.onerror')} Error on HTTP request:`,
105 if (req
.method
=== 'POST') {
106 const bodyBuffer
= [];
108 .on('data', (chunk
) => {
109 bodyBuffer
.push(chunk
);
112 const body
= JSON
.parse(Buffer
.concat(bodyBuffer
).toString()) as RequestPayload
;
115 ?.requestHandler(this.buildProtocolRequest(uuid
, procedureName
, body
?? {}))
117 /* Error caught by AbstractUIService */
121 throw new BaseError(`Unsupported HTTP method: '${req.method}'`);
125 `${this.logPrefix(moduleName, 'requestListener')} Handle HTTP request error:`,
128 this.sendResponse(this.buildProtocolResponse(uuid
, { status: ResponseStatus
.FAILURE
}));
132 private responseStatusToStatusCode(status: ResponseStatus
): StatusCodes
{
134 case ResponseStatus
.SUCCESS
:
135 return StatusCodes
.OK
;
136 case ResponseStatus
.FAILURE
:
137 return StatusCodes
.BAD_REQUEST
;
139 return StatusCodes
.INTERNAL_SERVER_ERROR
;