1 import type { IncomingMessage
, RequestListener
, ServerResponse
} from
'http';
3 import { StatusCodes
} from
'http-status-codes';
5 import { BaseError
} from
'../../exception';
10 type ProtocolResponse
,
14 type UIServerConfiguration
,
16 import { Utils
, logger
} from
'../../utils';
17 import { AbstractUIServer
, UIServerUtils
} from
'../internal';
19 const moduleName
= 'UIHttpServer';
21 export class UIHttpServer
extends AbstractUIServer
{
22 public constructor(protected readonly uiServerConfiguration
: UIServerConfiguration
) {
23 super(uiServerConfiguration
);
26 public start(): void {
27 this.httpServer
.on('request', this.requestListener
.bind(this) as RequestListener
);
28 this.startHttpServer();
31 // eslint-disable-next-line @typescript-eslint/no-unused-vars
32 public sendRequest(request
: ProtocolRequest
): void {
33 // This is intentionally left blank
36 public sendResponse(response
: ProtocolResponse
): void {
37 const [uuid
, payload
] = response
;
39 if (this.responseHandlers
.has(uuid
) === true) {
40 const res
= this.responseHandlers
.get(uuid
) as ServerResponse
;
42 .writeHead(this.responseStatusToStatusCode(payload
.status), {
43 'Content-Type': 'application/json',
45 .end(JSON
.stringify(payload
));
48 `${this.logPrefix(moduleName, 'sendResponse')} Response for unknown request id: ${uuid}`
53 `${this.logPrefix(moduleName, 'sendResponse')} Error at sending response id '${uuid}':`,
57 this.responseHandlers
.delete(uuid
);
61 public logPrefix
= (modName
?: string, methodName
?: string, prefixSuffix
?: string): string => {
62 const logMsgPrefix
= prefixSuffix
? `UI HTTP Server ${prefixSuffix}` : 'UI HTTP Server';
64 Utils
.isNotEmptyString(modName
) && Utils
.isNotEmptyString(methodName
)
65 ? ` ${logMsgPrefix} | ${modName}.${methodName}:`
66 : ` ${logMsgPrefix} |`;
67 return Utils
.logPrefix(logMsg
);
70 private requestListener(req
: IncomingMessage
, res
: ServerResponse
): void {
71 this.authenticate(req
, (err
) => {
74 .writeHead(StatusCodes
.UNAUTHORIZED
, {
75 'Content-Type': 'text/plain',
76 'WWW-Authenticate': 'Basic realm=users',
78 .end(`${StatusCodes.UNAUTHORIZED} Unauthorized`)
83 // Expected request URL pathname: /ui/:version/:procedureName
84 const [protocol
, version
, procedureName
] = req
.url
?.split('/').slice(1) as [
89 const uuid
= Utils
.generateUUID();
90 this.responseHandlers
.set(uuid
, res
);
92 const fullProtocol
= `${protocol}${version}`;
93 if (UIServerUtils
.isProtocolAndVersionSupported(fullProtocol
) === false) {
94 throw new BaseError(`Unsupported UI protocol version: '${fullProtocol}'`);
96 this.registerProtocolVersionUIService(version
);
97 req
.on('error', (error
) => {
99 `${this.logPrefix(moduleName, 'requestListener.req.onerror')} Error on HTTP request:`,
103 if (req
.method
=== 'POST') {
104 const bodyBuffer
= [];
106 .on('data', (chunk
) => {
107 bodyBuffer
.push(chunk
);
110 const body
= JSON
.parse(Buffer
.concat(bodyBuffer
).toString()) as RequestPayload
;
113 ?.requestHandler(this.buildProtocolRequest(uuid
, procedureName
, body
?? {}))
115 /* Error caught by AbstractUIService */
119 throw new BaseError(`Unsupported HTTP method: '${req.method}'`);
123 `${this.logPrefix(moduleName, 'requestListener')} Handle HTTP request error:`,
126 this.sendResponse(this.buildProtocolResponse(uuid
, { status: ResponseStatus
.FAILURE
}));
130 private responseStatusToStatusCode(status: ResponseStatus
): StatusCodes
{
132 case ResponseStatus
.SUCCESS
:
133 return StatusCodes
.OK
;
134 case ResponseStatus
.FAILURE
:
135 return StatusCodes
.BAD_REQUEST
;
137 return StatusCodes
.INTERNAL_SERVER_ERROR
;