checkSupport made static and protected
#5336
Open
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
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-5336
📋 StatsFile sizes
Modules
View stats and visualisations on the review app Action run for 290af25 |
patrickpatrickpatrick
force-pushed
the
revised-check-support
branch
from
6c3228e
to
fd1179a
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-5336
`checkSupport` of `GOVUKFrontend` can be overloaded by classes that extend it. Added tests for `createAll` when `checkSupport` has been overloaded.
patrickpatrickpatrick
force-pushed
the
revised-check-support
branch
from
fd1179a
to
290af25
Compare
Comment on lines
+52
to
56
| * @protected | ||
| * @static | ||
| * @throws {SupportError} when the components are not supported | ||
| */ | ||
| checkSupport() { |
There was a problem hiding this comment.
issue This only documents the method as static, but the method itself is not static from a JavaScript point of view (it's interesting that TypeScript does not pick up on that, actually, that'll be something to remember).
Suggested change
| * @protected | |
| * @static | |
| * @throws {SupportError} when the components are not supported | |
| */ | |
| checkSupport() { | |
| * @protected | |
| * @throws {SupportError} when the components are not supported | |
| */ | |
| static checkSupport() { |
Having the method static will help avoid overloading the console with errors when a component is repeated multiple times on the page (like the Copy button on the Design System page), letting createAll do a single initial check before looping.
| const result = createAll(MockComponentWithCheckSupport) | ||
| expect(checkSupportMock).toHaveBeenCalled() | ||
| expect(result).toStrictEqual([]) | ||
| expect(global.console.log).toHaveBeenCalledWith(expect.any(Error)) |
There was a problem hiding this comment.
suggestion Is there a way we can check this is the error thrown by the support mock (for example, comparing the text of the error)?
Comment on lines
+230
to
234
| class MockComponent extends GOVUKFrontendComponent { | ||
| constructor(...args) { | ||
| super(...args) | ||
| this.args = args | ||
| } |
There was a problem hiding this comment.
Good spot to update this here 🙌🏻
Comment on lines
+304
to
+308
| class MockComponentWithCheckSupport extends MockComponent { | ||
| checkSupport() { | ||
| checkSupportMock() | ||
| } | ||
| } |
There was a problem hiding this comment.
suggestion Possibly a long shot, but does jest.spyOn let us avoid creating one class per test with the method being static?
const checkSupportMock = jest.spyOn(MockComponent, 'checkSupport')
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.
What
Specify that
checkSupportofGOVUKFrontendComponentisstaticandprotectedinstead ofprivate.Why
Change in approach to how we allow people to run their own function to check if a component is supported. This change means now components that extend
GOVUKFrontendComponentcan overloadcheckSupport(as can be seen in the tests).Fixes #5225 (comment)