Add ugly skipLog parameter to the synchronizeInventory method
#1341
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
peaBerberian
force-pushed
the
misc/segment-inventory-skipLog
branch
from
a1ffaea
to
b072a38
Compare
The `synchronizeInventory` method is an internal method of the RxPlayer allowing to synchronize our internal representation of media buffers (representing which segments are buffered where) with the anounced buffered TimeRanges of the media buffer as indicated by the web browser, which should be more up-to-date (e.g. take into consideration garbage collection). As this internal representation of the buffer is very valuable when debugging, the `synchronizeInventory` produce logs each time it is called. Yet that method is very often called when the debug element (under the `DEBUG_ELEMENT` feature) to be sure it is mostly up-to-date with the browser's buffer as it is an element only shown in debugging contexts. Calling that method in this context of visual debugging here has consequently the side-effect of producing a large ammount of debug logs, which isn't necessary. Due to this, I decided to add an optional `skipLog` boolean parameter to the `synchronizeInventory` method. It is ugly, as it leaks debugging-related implementation details into the method signature, but it appears to me to be useful in that specific situation.
peaBerberian
force-pushed
the
misc/segment-inventory-skipLog
branch
from
b072a38
to
1acbb35
Compare
Florent-Bouisset
approved these changes
Dec 27, 2023
Merged
This pull request was closed.
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.
The
synchronizeInventorymethod is an internal method of the RxPlayer allowing to synchronize our internal representation of media buffers (representing which segments are buffered where) with the anounced buffered TimeRanges of the media buffer as indicated by the web browser, which should be more up-to-date (e.g. take into consideration garbage collection).As this internal representation of the buffer is very valuable when debugging, the
synchronizeInventoryproduce logs each time it is called.Yet that method is very often called when the debug element (under the
DEBUG_ELEMENTfeature) to be sure it is mostly up-to-date with the browser's buffer as the debug element is only shown in debugging contexts.Calling that method in this context of visual debugging here has consequently the side-effect of producing a large ammount of debug logs, which isn't necessary.
Due to this, I decided to add an optional
skipLogboolean parameter to thesynchronizeInventorymethod. It is ugly, as it leaks debugging-related implementation details into the method signature, but it appears to me to be useful in that specific situation.