Skip to content

fix(webhooks): log the event representation the hook subscribed to - #77

Merged
prlanzarin merged 1 commit into
bigbluebutton:developfrom
Arthurk12:get-raw-log-enhancement
Sep 14, 2026
Merged

prlanzarin merged 1 commit into
bigbluebutton:developfrom
Arthurk12:get-raw-log-enhancement

Conversation

@Arthurk12

Copy link
Copy Markdown
Member

What does this PR do?

The callback emitter receives either a mapped event or a raw one, depending on the hook's getRaw setting, but it has no way of telling them apart. It runs every event through simplifiedEvent(), which reads data.id and data.event.ts -- paths that do not exist in a raw BBB message. Callbacks for getRaw hooks therefore log
"event: { name: undefined, timestamp: undefined }", hiding which event was actually delivered.

Forward the hook's getRaw flag to the emitter and pick the logged payload accordingly: raw hooks log the untouched message under rawEvent and an empty event, mapped hooks keep the simplified string under event and an empty rawEvent. Both keys are always present so the log shape stays stable for parsers. The failure log gets the same treatment, since it suffers from the same undefined fields.

Detecting the event format inside the emitter by probing for envelope or data keys was considered and discarded: the hook already carries the answer, and guessing would silently misclassify future event shapes.

The callback emitter receives either a mapped event or a raw one,
depending on the hook's getRaw setting, but it has no way of telling
them apart. It runs every event through simplifiedEvent(), which reads
data.id and data.event.ts -- paths that do not exist in a raw BBB
message. Callbacks for getRaw hooks therefore log
"event: { name: undefined, timestamp: undefined }", hiding which event
was actually delivered.

Forward the hook's getRaw flag to the emitter and pick the logged
payload accordingly: raw hooks log the untouched message under rawEvent
and an empty event, mapped hooks keep the simplified string under event
and an empty rawEvent. Both keys are always present so the log shape
stays stable for parsers. The failure log gets the same treatment, since
it suffers from the same undefined fields.

Detecting the event format inside the emitter by probing for envelope or
data keys was considered and discarded: the hook already carries the
answer, and guessing would silently misclassify future event shapes.
@prlanzarin
prlanzarin self-requested a review September 14, 2026 17:23
@prlanzarin
prlanzarin merged commit 6c26bd6 into bigbluebutton:develop Sep 14, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants