Repository navigation
JS/TS server: Fix JSDoc return type on generated factories - #871
Merged
Merged
Conversation
The factory functions' JSDoc hardcoded `@returns {EventsServerEventLogger}`
regardless of ping. For any ping other than `events` (e.g.
`server-deletion-request`), the factory actually returns a different class,
such as `ServerDeletionRequestServerEvent`, so the JSDoc misled editors and
API navigation.
Use the same `event_class_name` filter as the `return new ...` line so the
documented type always matches the returned class.
Reported by Copilot review on mozilla/fxa#21475.
akkomar
force-pushed
the
js-server-jsdoc-return-type
branch
from
October 19, 2026 11:28
56001f1 to
f5c2263
Compare
akkomar
marked this pull request as ready for review
October 19, 2026 11:33
3 of 5 tasks
travis79
approved these changes
Oct 20, 2026
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
2 participants
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 factory functions' JSDoc hardcoded
@returns {EventsServerEventLogger}regardless of ping. For any ping other thanevents(e.g.server-deletion-request), the factory actually returns a different class, such asServerDeletionRequestServerEvent, so the JSDoc misled editors and API navigation.To fix this we'll use the same
event_class_namefilter as thereturn new ...line so the documented type always matches the returned class.Reported by Copilot review on mozilla/fxa#21475.
Pull Request checklist
make testruns without emitting any warningsmake lintruns without emitting any errorsCHANGELOG.mdor an explanation of why it does not need one