Refactor draftail ModalWorkflowSource for extensibility #6651
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
gasman
force-pushed
the
cleanup/modalworkflowsource-subclass
branch
from
4b0ce3d
to
1cddb9c
Compare
…WorkflowSource This means we're not artificially forcing four different entity types into the same code path, and makes it possible to define new entity types outside of this module. Also relax the eslint no-unused-vars to allow unused function parameters - having multiple classes following the same interface is a legitimate use of this.
gasman
force-pushed
the
cleanup/modalworkflowsource-subclass
branch
from
1cddb9c
to
71912ea
Compare
Manage this branch in SquashTest this branch here: https://gasmancleanupmodalworkflowsour-pvtxo.squash.io |
jacobtoppm
approved these changes
Jun 28, 2021
| @@ -161,10 +29,20 @@ class ModalWorkflowSource extends Component { | |||
| this.onClose = this.onClose.bind(this); | |||
| } | |||
|
|
|||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | |||
| getChooserConfig(entity, selectedText) { | |||
There was a problem hiding this comment.
Is it worth using Typescript abstract class for this, and making this an abstract method for instance? See https://www.typescriptlang.org/docs/handbook/2/classes.html#abstract-classes-and-members
There was a problem hiding this comment.
Sounds good - will give that a go!
There was a problem hiding this comment.
Gave it a try, but npm run test says it isn't valid outside of a Typescript file, and if I rename the file to ModalWorkflowSource.ts I get failures elsewhere (Property 'jQuery' does not exist on type 'Global & typeof globalThis'). I'll leave that improvement for someone who knows Typescript :-)
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.
Currently, the important work in draftail's ModalWorkflowSource.js is handled by two functions
getChooserConfigandfilterEntityDatawhich consist of a switch/case over the four built-in entity types: images, embeds, links and documents. This makes it impossible to extend draftail with new modal-powered entity types without editing (or duplicating) this file. To address this, I've refactored ModalWorkflowSource into an abstract class which is subclassed for each entity type.Along the way I've relaxed the no-unused-vars eslint rule so that it doesn't complain about unused function parameters - I think this is needlessly restrictive, since a case like this (where multiple classes are implementing the same interface) is a valid place where unused parameters can arise.Now rebased to use"args": "after-used"and eslint-ignore as per Slack discussion...