RFC: use React Context to pass server side tests #7126
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| import { ArticleDesign, ArticleDisplay, ArticlePillar } from '@guardian/libs'; | ||
| import { ArticleContainer } from './ArticleContainer'; | ||
| import { ArticleHeadline } from './ArticleHeadline'; | ||
| import { Flex } from './Flex'; | ||
| import { LeftColumn } from './LeftColumn'; | ||
| import { Section } from './Section'; | ||
| import { | ||
| mockServerSideTestsProviderFactory, | ||
| useServerSideTests, | ||
| } from './ServerSideTestProvider'; | ||
|
|
||
| export default { | ||
| component: ArticleHeadline, | ||
| title: 'Components/ArticleHeadlineServerTestDemo', | ||
| }; | ||
|
|
||
| const format = { | ||
| display: ArticleDisplay.Standard, | ||
| design: ArticleDesign.Standard, | ||
| theme: ArticlePillar.News, | ||
| }; | ||
|
|
||
| const ArticleHeadlineWithTest = () => { | ||
| const { activeServerSideTests } = useServerSideTests(); | ||
| return ( | ||
| <> | ||
| <ArticleHeadline | ||
| headlineString="This is how the default headline looks" | ||
| format={format} | ||
| tags={[]} | ||
| webPublicationDateDeprecated="" | ||
| /> | ||
| {activeServerSideTests.myTest == 'variant' | ||
| ? '~*^_ the variant version _^*~' | ||
| : ''} | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export const VariantStory = () => { | ||
| return ( | ||
| <Section fullWidth={true}> | ||
| <Flex> | ||
| <LeftColumn borderType="full"> | ||
| <></> | ||
| </LeftColumn> | ||
| <ArticleContainer format={format}> | ||
| <ArticleHeadlineWithTest /> | ||
| </ArticleContainer> | ||
| </Flex> | ||
| </Section> | ||
| ); | ||
| }; | ||
| VariantStory.story = { | ||
| name: 'Variant Demo', | ||
| decorators: [mockServerSideTestsProviderFactory({ myTest: 'variant' })], | ||
| }; | ||
|
|
||
| export const ControlStory = () => { | ||
| return ( | ||
| <Section fullWidth={true}> | ||
| <Flex> | ||
| <LeftColumn borderType="full"> | ||
| <></> | ||
| </LeftColumn> | ||
| <ArticleContainer format={format}> | ||
| <ArticleHeadlineWithTest /> | ||
| </ArticleContainer> | ||
| </Flex> | ||
| </Section> | ||
| ); | ||
| }; | ||
| ControlStory.story = { | ||
| name: 'Control Demo', | ||
| decorators: [mockServerSideTestsProviderFactory({ myTest: 'control' })], | ||
| }; | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| import type { PartialStoryFn } from '@storybook/addons/dist/ts3.9/types'; | ||
| import type { ComponentProps, JSXElementConstructor } from 'react'; | ||
| import React from 'react'; | ||
| import type { ServerSideTests } from '../../types/config'; | ||
|
|
||
| const ServerSideTestContext = React.createContext< | ||
| { activeServerSideTests: ServerSideTests } | undefined | ||
| >(undefined); | ||
|
|
||
| export const ServerSideTestProvider = ({ | ||
| tests, | ||
| children, | ||
| }: { | ||
| tests: ServerSideTests; | ||
| children: React.ReactNode; | ||
| }) => ( | ||
| <ServerSideTestContext.Provider value={{ activeServerSideTests: tests }}> | ||
| {children} | ||
| </ServerSideTestContext.Provider> | ||
| ); | ||
|
|
||
| /** | ||
| * Get current server side tests | ||
| * | ||
| * @example | ||
| * const { activeServerSideTests } = useServerSideTests(); | ||
| * | ||
| * if (activeServerSideTests.myTestName == "variant") { | ||
| * //... | ||
| * } else { | ||
| * //... | ||
| * } | ||
| * | ||
| */ | ||
| export const useServerSideTests = () => { | ||
| const context = React.useContext(ServerSideTestContext); | ||
|
|
||
| if (context === undefined) { | ||
| throw Error( | ||
| 'useServerSideTests must be used within the ContentABTestProvider', | ||
| ); | ||
| } | ||
|
|
||
| return context; | ||
| }; | ||
|
|
||
| /** | ||
|
There was a problem hiding this comment. I've adapted the wrapper component and the hook code above from The Storybook decorator is something new that I've come up with today (which probably shows when you read the code!) It feels like Storybook/Chromatic might be one of the main pain points for using Context in this way, so I thought it would be worth trying to create a user-friendly way to mock the Using a factory here doesn't feel ideal tbh. I ended up doing it to make the type declarations easier (for me, at least!) but I'm sure that it could be rewritten in a more user-friendly way if the pattern is adopted. |
||
| * | ||
| * @param tests | ||
| * @returns A Storybook decorator function which will wrap a story in a <ServerSideTestProvider> | ||
| * containing the data passed to the factory in the `tests` parameter. | ||
| * This decorator should receive a type parameter corresponding to the top-level | ||
| * component in the story. | ||
| * | ||
| * @example | ||
| export default { | ||
| component: MyComponent, | ||
| title: 'Components/MyComponent', | ||
| decorators: [ | ||
| mockServerSideTestsProviderFactory({myTest: "control"})<typeof MyComponent>, | ||
| ], | ||
| }; | ||
| */ | ||
| export function mockServerSideTestsProviderFactory(tests: ServerSideTests) { | ||
| return function < | ||
| /* eslint-disable @typescript-eslint/no-explicit-any -- Can we narrow this? */ | ||
| C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>, | ||
| /* eslint-enable @typescript-eslint/no-explicit-any */ | ||
| >(Story: PartialStoryFn<ComponentProps<C>>) { | ||
| return ( | ||
| <ServerSideTestProvider tests={tests}> | ||
| <Story /> | ||
| </ServerSideTestProvider> | ||
| ); | ||
| }; | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm creating this component in the story file just to demonstrate what a component with a test would look like. We can imagine that this is a regular component in the
components/directory which has had test code added to it.