fix(core): Respect event.event_id in scope.captureEvent return value

[limbonaut]

I found a bug while working on the JavaScript SDK integration in Sentry for Godot (it's a game engine SDK).

When you call Sentry.captureEvent({ event_id: "<custom-event-id>" }), the event_id you provide IS actually used when the event is processed and sent to Sentry (because prepareEvent.ts correctly checks event.event_id first). However, the return value from captureEvent() is wrong because:

In sentry-javascript/packages/core/src/scope.ts:

sentry-javascript/packages/core/src/scope.ts

Line 758 in 170b6f8

const eventId = hint?.event_id || uuid4();

This only checks hint?.event_id, not event.event_id. So while your supplied event_id gets sent to Sentry correctly, the function returns a newly generated UUID.

Closes #issue_link_here

[andreiborza]

For prosperity: I was initially thinking we should prioritize hint over event but it seems like we aren't doing that in other places as you brought up:

sentry-javascript/packages/core/src/client.ts

Line 1200 in 090d08c

isolationScope.setLastEventId(event.event_id || hint.event_id);

sentry-javascript/packages/core/src/utils/prepareEvent.ts

Line 51 in 090d08c

event_id: event.event_id || hint.event_id || uuid4(),

Let's stick with event over hint over uuid for now!

[andreiborza]

Thanks for taking care of this!