feat(csms): 增强 OCPP 操作的日志记录,添加请求和响应的详细信息

This commit is contained in:
2026-04-20 14:28:27 +08:00
parent d688a8497d
commit 073bae726a
9 changed files with 207 additions and 18 deletions

View File

@@ -101,6 +101,59 @@ const actionHandlers: ActionHandlerMap = {
StopTransaction: handleStopTransaction,
}
function shortId(value: string): string {
return value.length <= 12 ? value : `${value.slice(0, 8)}...${value.slice(-4)}`
}
function summarizeCallPayload(action: string, payload: unknown): Record<string, unknown> {
const p = payload as Record<string, unknown>
switch (action) {
case 'BootNotification':
return {
chargePointVendor: p.chargePointVendor,
chargePointModel: p.chargePointModel,
firmwareVersion: p.firmwareVersion ?? null,
}
case 'Authorize':
return {
idTag: typeof p.idTag === 'string' ? shortId(p.idTag) : undefined,
}
case 'Heartbeat':
return {}
case 'StatusNotification':
return {
connectorId: p.connectorId,
status: p.status,
errorCode: p.errorCode,
timestamp: p.timestamp ?? null,
}
case 'StartTransaction':
return {
connectorId: p.connectorId,
idTag: typeof p.idTag === 'string' ? shortId(p.idTag) : undefined,
meterStart: p.meterStart,
timestamp: p.timestamp,
}
case 'StopTransaction':
return {
transactionId: p.transactionId,
meterStop: p.meterStop,
reason: p.reason ?? null,
timestamp: p.timestamp,
}
case 'MeterValues':
return {
connectorId: p.connectorId,
transactionId: p.transactionId ?? null,
meterValueCount: Array.isArray(p.meterValue) ? p.meterValue.length : 0,
}
default:
return {
keys: p && typeof p === 'object' ? Object.keys(p).slice(0, 20) : [],
}
}
}
function sendCallResult(ws: WSContext, uniqueId: string, payload: unknown): void {
ws.send(JSON.stringify([OCPP_MESSAGE_TYPE.CALLRESULT, uniqueId, payload]))
}
@@ -162,9 +215,17 @@ export async function sendOcppCall<TPayload extends Record<string, unknown>, TRe
const uniqueId =
typeof timeoutOrOptions === 'number' ? crypto.randomUUID() : (timeoutOrOptions.uniqueId ?? crypto.randomUUID())
console.info(
`[OCPP][TX][CALL] cp=${chargePointIdentifier} action=${action} uniqueId=${uniqueId} timeoutMs=${timeoutMs}`,
summarizeCallPayload(action, payload),
)
const resultPromise = new Promise<TResult>((resolve, reject) => {
const timeout = setTimeout(async () => {
pendingCalls.delete(uniqueId)
console.warn(
`[OCPP][TX][TIMEOUT] cp=${chargePointIdentifier} action=${action} uniqueId=${uniqueId} timeoutMs=${timeoutMs}`,
)
await updateTransportState(chargePointIdentifier, {
transportStatus: getCommandChannelStatus(chargePointIdentifier),
lastCommandStatus: 'Timeout',
@@ -176,7 +237,12 @@ export async function sendOcppCall<TPayload extends Record<string, unknown>, TRe
pendingCalls.set(uniqueId, {
chargePointIdentifier,
action,
resolve: (response) => resolve(response as TResult),
resolve: (response) => {
console.info(
`[OCPP][TX][CALLRESULT] cp=${chargePointIdentifier} action=${action} uniqueId=${uniqueId}`,
)
resolve(response as TResult)
},
reject,
timeout,
})
@@ -195,6 +261,10 @@ export async function sendOcppCall<TPayload extends Record<string, unknown>, TRe
lastCommandStatus: 'Error',
lastCommandAt: dayjs().toDate(),
})
console.error(
`[OCPP][TX][SEND_ERROR] cp=${chargePointIdentifier} action=${action} uniqueId=${uniqueId}`,
error,
)
throw error instanceof Error ? error : new Error('CommandSendFailed')
}
@@ -219,6 +289,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
async onOpen(_evt: Event, ws: WSContext) {
const subProtocol = ws.protocol ?? 'unknown'
if (!isSupportedOCPP(subProtocol)) {
console.warn(
`[OCPP][WS][OPEN_REJECT] cp=${chargePointIdentifier} session=${sessionId} subProtocol=${subProtocol} reason=unsupported_subprotocol`,
)
ws.close(1002, 'Unsupported subprotocol')
return
}
@@ -246,12 +319,14 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
connectionSessionId: sessionId,
lastWsConnectedAt: dayjs().toDate(),
})
console.log(
`[OCPP] ${chargePointIdentifier} connected` +
(remoteAddr ? ` from ${remoteAddr}` : ''),
console.info(
`[OCPP][WS][OPEN] cp=${chargePointIdentifier} session=${sessionId} subProtocol=${subProtocol} registered=${ctx.isRegistered}` +
(remoteAddr ? ` remote=${remoteAddr}` : ''),
)
if (previous && previous.sessionId !== sessionId) {
console.log(`[OCPP] ${chargePointIdentifier} replaced previous connection`)
console.info(
`[OCPP][WS][REPLACE] cp=${chargePointIdentifier} oldSession=${previous.sessionId} newSession=${sessionId}`,
)
}
},
@@ -260,6 +335,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
try {
const current = ocppConnections.get(chargePointIdentifier)
if (!current || current.sessionId !== sessionId) {
console.warn(
`[OCPP][WS][STALE] cp=${chargePointIdentifier} session=${sessionId} activeSession=${current?.sessionId ?? 'none'}`,
)
try {
ws.close(1008, 'Stale connection')
} catch {
@@ -288,6 +366,23 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
const [messageType, msgUniqueId] = message
uniqueId = String(msgUniqueId)
if (messageType === OCPP_MESSAGE_TYPE.CALL) {
const [, , action, payload] = message as OcppCall
console.info(
`[OCPP][RX][CALL] cp=${chargePointIdentifier} session=${sessionId} action=${action} uniqueId=${uniqueId}`,
summarizeCallPayload(action, payload),
)
} else if (messageType === OCPP_MESSAGE_TYPE.CALLRESULT) {
console.info(
`[OCPP][RX][CALLRESULT] cp=${chargePointIdentifier} session=${sessionId} uniqueId=${uniqueId}`,
)
} else if (messageType === OCPP_MESSAGE_TYPE.CALLERROR) {
const [, , errorCode, errorDescription] = message as OcppCallErrorMessage
console.warn(
`[OCPP][RX][CALLERROR] cp=${chargePointIdentifier} session=${sessionId} uniqueId=${uniqueId} code=${errorCode} desc=${errorDescription}`,
)
}
if (messageType === OCPP_MESSAGE_TYPE.CALLRESULT) {
const [, responseUniqueId, payload] = message as OcppCallResultMessage
const pending = pendingCalls.get(responseUniqueId)
@@ -314,6 +409,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
lastCommandStatus: errorCode === 'InternalError' ? 'Error' : 'Rejected',
lastCommandAt: dayjs().toDate(),
})
console.warn(
`[OCPP][TX][REJECTED] cp=${pending.chargePointIdentifier} action=${pending.action} uniqueId=${responseUniqueId} code=${errorCode} desc=${errorDescription}`,
)
pending.reject(new Error(`${errorCode}:${errorDescription}`))
return
}
@@ -324,6 +422,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
// Enforce BootNotification before any other action
if (!ctx.isRegistered && action !== 'BootNotification') {
console.warn(
`[OCPP][RX][REJECT] cp=${chargePointIdentifier} session=${sessionId} action=${action} uniqueId=${uniqueId} reason=boot_notification_required`,
)
sendCallError(
ws,
uniqueId,
@@ -335,6 +436,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
const handler = actionHandlers[action as keyof ActionHandlerMap]
if (!handler) {
console.warn(
`[OCPP][RX][NOT_IMPLEMENTED] cp=${chargePointIdentifier} session=${sessionId} action=${action} uniqueId=${uniqueId}`,
)
sendCallError(ws, uniqueId, 'NotImplemented', `Action '${action}' is not implemented`)
return
}
@@ -343,9 +447,15 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
handler as (payload: unknown, ctx: OcppConnectionContext) => Promise<unknown>
)(payload, ctx)
console.info(
`[OCPP][TX][CALLRESULT] cp=${chargePointIdentifier} session=${sessionId} action=${action} uniqueId=${uniqueId}`,
)
sendCallResult(ws, uniqueId, response)
} catch (err) {
console.error(`[OCPP] Error handling message from ${chargePointIdentifier} (uniqueId=${uniqueId}):`, err)
console.error(
`[OCPP][RX][ERROR] cp=${chargePointIdentifier} session=${sessionId} uniqueId=${uniqueId}`,
err,
)
sendCallError(ws, uniqueId, 'InternalError', 'Internal server error')
}
},
@@ -359,7 +469,9 @@ export function createOcppHandler(chargePointIdentifier: string, remoteAddr?: st
lastWsDisconnectedAt: dayjs().toDate(),
})
}
console.log(`[OCPP] ${chargePointIdentifier} disconnected (code=${evt.code})`)
console.info(
`[OCPP][WS][CLOSE] cp=${chargePointIdentifier} session=${sessionId} code=${evt.code} activeSession=${current?.sessionId ?? 'none'}`,
)
},
}
}