Repository navigation
[SCAL-353250] Revert host events v2 default to v1 - #755
Merged
Merged
Conversation
Reverts #740 (SCAL-337616). With useHostEventsV2 defaulting to true, the pre-render show cycle breaks on every released cluster. The SDK sends HostEvent.UpdateEmbedParams as 'updateEmbedParams', but blink lists the event as root-level under 'UpdateEmbedParams'. Under v2 a non-root event only reaches handlers whose stored page context matches the incoming one, and the UpdateEmbedParams handler keeps the context from when the embed container mounted. On a Liveboard the update is dropped (noMatchingHandler), so hiddenActions, flags and runtime filters sent at show time never apply. v1 calls every handler, so it is unaffected. - getHostEventsConfig no longer defaults useHostEventsV2 to true - drop the v1 deprecation warning and HOST_EVENTS_V1_DEPRECATED - useHostEventsV2 doc back to @default false - tests restored to the pre-#740 expectations
Contributor
There was a problem hiding this comment.
Code Review
This pull request removes the deprecation warning and default fallback behavior for Host Events V1, changing the default value of useHostEventsV2 from true to undefined (which resolves to false / V1). Corresponding tests and the deprecated error message have been removed or updated. Note that the JSDoc tag order for useHostEventsV2 in src/types.ts violates the repository style guide by placing @default before @version. Feedback on the changes suggests adding a test to verify that the Error event is skipped when useHostEventsV2 is not set to prevent future regressions.
commit: |
sandeep-kr-yadav
approved these changes
Nov 17, 2026
sandeep-kr-yadav
deleted the
fix/SCAL-353250-revert-host-events-v2-default
branch
November 17, 2026 16:11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reverts #740 (SCAL-337616):
useHostEventsV2defaults tofalseagain, so embeds that don't set it use host events v1, as they did before #740.Why
With v2 on by default, the pre-render show cycle breaks on every released cluster:
HostEvent.UpdateEmbedParamsas'updateEmbedParams'. Blink lists the event as root-level underIncomingEventType.UpdateEmbedParams = 'UpdateEmbedParams'(capital U), so it is not treated as root-level.UpdateEmbedParamshandler keeps the page context from when the embed container mounted, so on a Liveboard the event is dropped (noMatchingHandler).hiddenActions, flags such asisContinuousLiveboardPDFEnabled, runtime filters) never applies. Under v1 every handler is called, so the update lands.This surfaced as pre-render Liveboard e2e failures once the v2-default build was published as
@latest, for example "hides the DownloadLiveboard action with hiddenActions config" and "shows the continuous PDF download option with isContinuousLiveboardPDFEnabled config".Changes
getHostEventsConfigno longer falls back totrueforuseHostEventsV2.ERROR_MESSAGE.HOST_EVENTS_V1_DEPRECATED.useHostEventsV2doc comment back to@default false.conversation.tsused the old<TBD>version placeholder. SCAL-349735: Ability to load a specific conversation #739 merged after [SCAL-338917] chore: rename @version placeholder <TBD> to %NEXT_SDK_VERSION% #751 renamed it to%NEXT_SDK_VERSION%, somaincurrently failslint-versions. This PR switches it to the new placeholder.Behavior change
Embeds that don't set
useHostEventsV2go back to v1. SettinguseHostEventsV2: trueexplicitly is unchanged, and still hits the issue above on clusters without a blink fix.Testing
Follow-up
Blink fix: make the SDK's
'updateEmbedParams'root-level, either by addingEventType.UpdateEmbedParamstorootLevelEventsor by fixing theIncomingEventType.UpdateEmbedParamscasing. Re-enable the v2 default once that ships on the supported clusters.