refactor: rename 'blacklist' to 'exclude'

[harisha-swaminathan]

No description provided.

[codecov]

Codecov Report

Merging #1274 (3c688bc) into next (43fce26) will decrease coverage by 0.01%.
The diff coverage is 97.05%.

@@            Coverage Diff             @@
##             next    #1274      +/-   ##
==========================================
- Coverage   86.24%   86.22%   -0.02%     
==========================================
  Files          39       39              
  Lines        9769     9757      -12     
  Branches     2281     2276       -5     
==========================================
- Hits         8425     8413      -12     
  Misses       1344     1344              

Impacted Files	Coverage Δ
src/dash-playlist-loader.js	90.05% <ø> (ø)
src/media-segment-request.js	95.40% <ø> (ø)
src/playback-watcher.js	98.33% <ø> (-0.45%)	⬇️
src/playlist-selectors.js	87.05% <ø> (ø)
src/segment-loader.js	96.36% <ø> (ø)
src/master-playlist-controller.js	94.95% <96.42%> (-0.02%)	⬇️
src/media-groups.js	98.66% <100.00%> (ø)
src/playlist.js	94.56% <100.00%> (ø)
src/videojs-http-streaming.js	90.41% <100.00%> (+0.17%)	⬆️
... and 3 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 43fce26...3c688bc. Read the comment docs.

[gesinger]

While we're modifying the public pieces, it may be worth renaming all instance of blacklist throughout the repo as well as the properties (e.g., ABORT_EARLY_BLACKLIST_SECONDS and blacklistReasons in MasterPlaylistController, various comments talking about blacklisting, and test messages).

We also should start a migration guide for updating to the next major version.

[gesinger]

I think there are only a few more references.

http-streaming/docs/a-walk-through-vhs.md

Line 250 in 8ca62cc

There are other modules, and other functions of the code (e.g., blacklisting logic, ABR, etc.), but this is the most critical path of VHS, the one that allows video to play in the browser.

http-streaming/src/media-segment-request.js

Line 428 in 8ca62cc

// because we can only blacklist a playlist and abort requests

and then we trigger blacklistplaylist in src/master-playlist-controller.js:

http-streaming/src/master-playlist-controller.js

Line 1233 in 8ca62cc

this.tech_.trigger('blacklistplaylist');

(and test for it in test/videojs-http-streaming.text.js):

http-streaming/test/videojs-http-streaming.test.js

Line 2056 in 8ca62cc

this.player.tech_.on('blacklistplaylist', () => excludedplaylist++);

[gesinger]

This is great! Thank you for doing the extra rename!

[gesinger]

It may be a bit more work, but it might be worth us having to functions: excludeCurrentPlaylist and excludePlaylist

excludeCurrentPlaylist can call excludePlaylist with an explicit playlist (this.masterPlaylistLoader_.media()), and excludePlaylist accepts a playlistToExclude param.

This would let the code read clearer for callers of the function.