Skip to content

refactor: fix upcoming Closure Compiler type errors on Symbol.iterator #8851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion build/generateExterns.js
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,15 @@ function createExternMethod(node) {
if (node.static) {
methodString += 'static ';
}
methodString += id + '(' + params.join(', ') + ') {}';
if (node.key.type === 'Identifier') {
methodString += id;
} else {
assert.equal(
node.key.type, 'MemberExpression',
'Unexpected exported member name in exported class!');
methodString += `[${id}]`;
}
methodString += '(' + params.join(', ') + ') {}';
return methodString;
}

Expand Down Expand Up @@ -566,6 +574,11 @@ function createExternAssignment(name, node, alwaysIncludeConstructor) {
// constructor in some situations.
if (member.key.name == 'constructor' && alwaysIncludeConstructor) {
// Fall through and generate externs.
} else if (member.key.type === 'MemberExpression' &&
getIdentifierString(member.key) === 'Symbol.iterator') {
// Symbol.iterator is needed to implement the Iterable interface for
// Closure Compiler, so always assume it is exported.
// Closure Compiler does not allow putting an explicit @export.
} else {
// Skip extern generation.
continue;
Expand Down
6 changes: 6 additions & 0 deletions externs/domstringlist.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,9 @@
* @suppress {duplicate}
*/
var DOMStringList = function() {};

/**
* @override
* @return {!Iterator<string>}
*/
DOMStringList.prototype[Symbol.iterator] = function() {};
3 changes: 3 additions & 0 deletions externs/texttrackcuelist.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@
* @suppress {duplicate}
*/
var TextTrackCueList = function() {};

/** @override */
TextTrackCueList.prototype[Symbol.iterator] = function() {};
2 changes: 1 addition & 1 deletion lib/dash/segment_template.js
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ shaka.dash.SegmentTemplate = class {
*
* @extends shaka.media.SegmentIndex
* @implements {shaka.util.IReleasable}
* @implements {Iterable<!shaka.media.SegmentReference>}
* @implements {Iterable<?shaka.media.SegmentReference>}
*
* @private
*
Expand Down
18 changes: 11 additions & 7 deletions lib/media/segment_index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ goog.require('shaka.util.Timer');
*
* @implements {shaka.extern.SegmentIndex}
* @implements {shaka.util.IReleasable}
* @implements {Iterable<!shaka.media.SegmentReference>}
* @implements {Iterable<?shaka.media.SegmentReference>}
* @export
*/
shaka.media.SegmentIndex = class {
Expand Down Expand Up @@ -414,7 +414,10 @@ shaka.media.SegmentIndex = class {
}


/** @return {!shaka.media.SegmentIterator} */
/**
* @return {!shaka.media.SegmentIterator}
* @override
*/
[Symbol.iterator]() {
const iter = this.getIteratorForTime(0);
goog.asserts.assert(iter != null, 'Iterator for 0 should never be null!');
Expand Down Expand Up @@ -564,18 +567,18 @@ if (goog.DEBUG) {
/**
* An iterator over a SegmentIndex's references.
*
* @implements {Iterator<shaka.media.SegmentReference>}
* @implements {Iterator<?shaka.media.SegmentReference>}
* @export
*/
shaka.media.SegmentIterator = class {
/**
* @param {shaka.media.SegmentIndex} segmentIndex
* @param {!shaka.media.SegmentIndex} segmentIndex
* @param {number} index
* @param {number} partialSegmentIndex
* @param {boolean} reverse
*/
constructor(segmentIndex, index, partialSegmentIndex, reverse) {
/** @private {shaka.media.SegmentIndex} */
/** @private {!shaka.media.SegmentIndex} */
this.segmentIndex_ = segmentIndex;

/** @private {number} */
Expand Down Expand Up @@ -605,7 +608,7 @@ shaka.media.SegmentIterator = class {
}

/**
* @return {shaka.media.SegmentReference}
* @return {?shaka.media.SegmentReference}
* @export
*/
current() {
Expand Down Expand Up @@ -634,6 +637,7 @@ shaka.media.SegmentIterator = class {
/**
* @override
* @export
* @return {!IIterableResult<?shaka.media.SegmentReference>}
*/
next() {
const ref = this.segmentIndex_.get(this.currentPosition_);
Expand Down Expand Up @@ -717,7 +721,7 @@ shaka.media.SegmentIterator = class {
*
* @extends shaka.media.SegmentIndex
* @implements {shaka.util.IReleasable}
* @implements {Iterable<!shaka.media.SegmentReference>}
* @implements {Iterable<?shaka.media.SegmentReference>}
* @export
*/
shaka.media.MetaSegmentIndex = class extends shaka.media.SegmentIndex {
Expand Down
Loading