Fire STEERING_MANIFEST_LOADED event when loading a Content Steering Manifest #5417
Conversation
This file contains 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
robwalch
requested changes
Apr 24, 2023
src/types/events.ts
Outdated
| @@ -366,3 +367,8 @@ export interface BackBufferData { | |||
| * @deprecated Use BackBufferData | |||
| */ | |||
| export interface LiveBackBufferData extends BackBufferData {} | |||
|
|
|||
| export interface SteeringManifestLoadedData { | |||
| response: SteeringManifest; | |||
There was a problem hiding this comment.
response is used in error events and has a broader scope than it does here (type LoaderResponse). Maybe a more fitting property name here would be one of these?
data("data" is used for string | ArrayBuffer | Object responses. The responseText "data" has been parsed so maybe not perfect.)steeringManifest(call it what it is)response(appreciate that this matches the XHR property, so I could be convinced it is fine as-is if other options do not align better with current API conventions)
There was a problem hiding this comment.
used steeringManifest, as it clearly defines the content of that field.
robwalch
requested changes
Apr 25, 2023
robwalch
approved these changes
May 26, 2023
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.
This PR will...
Fire a new event (
STEERING_MANIFEST_LOADED) when the Steering Manifest is loaded and expose on it the content of the received steering manifest.Why is this Pull Request needed?
We may need the application loading the player to react when receiving Content Steering Manifests. In our case and for now, we are using the steering params for debugging purposes, so it was handy to expose them.
Are there any points in the code the reviewer needs to double check?
Please check the unit tests are enough. As I was using already existing interfaces, I didn't extend much the checks over the event contents. I can do it if I needed.
Checklist