fix(editor): safeguard event unregistrations against undefined values#1125
Open
mrueg wants to merge 1 commit into
Open
fix(editor): safeguard event unregistrations against undefined values#1125mrueg wants to merge 1 commit into
mrueg wants to merge 1 commit into
Conversation
… and remove unused field
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
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.
Description
This PR safeguards the event handler unregistrations in the editor features (
SignsFeatureandLineAuthoringFeature) againstundefinedvalues during feature deactivation / plugin unloading, and removes a dead field.The Issue
When features are deactivated (or when the plugin is unloaded),
EditorIntegrationcallsdeactivateFeature()on each feature. If a feature was never activated (for example, if the feature is disabled in settings), its event variables (e.g.workspaceLeafChangeEvent,fileRenameEvent,fileOpenEvent, etc.) remainundefined.Calling
this.plg.app.workspace.offref(this.workspaceLeafChangeEvent!)directly withundefinedon deactivation is unsafe.Additionally:
SignsFeaturedeclared and unregisteredgutterContextMenuEvent, but it was never registered or used.The Fix
destroyEventHandlers()in both features to verify that event references exist before callingoffref()on them:gutterContextMenuEventdeclaration and unregistration fromSignsFeature.Verification
npm run tsc) pass cleanly.npm run lint) pass with no warnings.