Discussion as an island
#3839
Merged
Discussion as an island
#3839
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
This change will get overwritten once I merge in main
|
Size Change: -127 kB (-5%) ✅ Total Size: 2.59 MB
ℹ️ View Unchanged
|
OllysCoding
reviewed
Jan 18, 2022
Comment on lines
-29
to
-40
| // ************************************************************************** | ||
| // beingHydrated? | ||
| // We use this prop to solve a problem we have with Storybook. If you remove | ||
| // it then the page will render fine on production but our layout stories | ||
| // will render two copies of Discussion, side by side. The reason for this | ||
| // is because we technically server side render these layout stories on the | ||
| // client, inside the story file itself. | ||
| // | ||
| // Yes, it's true, having props purely to solve test implementation problems | ||
| // is not great. If you feel strongly about this and want to remove this | ||
| // prop I'm okay with that. If you were able to solve this another way | ||
| // then thank you! |
OllysCoding
reviewed
Jan 18, 2022
Comment on lines
65
to
71
| const { data: user } = useApi<{ userProfile: UserProfile }>( | ||
| isSignedIn | ||
| ? joinUrl( | ||
| discussionApiUrl, | ||
| 'profile/me?strict_sanctions_check=false', | ||
| ) | ||
| : '', |
There was a problem hiding this comment.
How does useApi behave when passed an empty string? Does it throw an error?
There was a problem hiding this comment.
I've removed that pattern now and replaced it with composition. I was hoping to avoid using that approach because it's a lot of file renaming but it seems to be the only way. If you pass fetch '' then it makes a call to the domain the page is on, which isn't what we want.
oliverlloyd
requested review from
DavidLawes,
jlieb10 and
lucymonie
as code owners
oliverlloyd
commented
Jan 18, 2022
| )} | ||
|
|
||
| {beingHydrated && !isExpanded && ( | ||
| <Lazy margin={300} disableFlexStyles={true}> |
There was a problem hiding this comment.
We no longer need this Lazy component because Island provides this deferred loading built in
oliverlloyd
commented
Jan 18, 2022
| // prop I'm okay with that. If you were able to solve this another way | ||
| // then thank you! | ||
| beingHydrated?: boolean; | ||
| // ************************************************************************** |
There was a problem hiding this comment.
This prop was needed to fix an issue with hydration in Storybook. This problem was solved by the islands pattern so this prop could be removed.
oliverlloyd
commented
Jan 18, 2022
| @@ -108,7 +106,6 @@ let renderCount = 0; | |||
| export const App = ({ CAPI, ophanRecord }: Props) => { | |||
| log('dotcom', `App.tsx render #${(renderCount += 1)}`); | |||
| const isSignedIn = !!getCookie({ name: 'GU_U', shouldMemoize: true }); | |||
| const [user, setUser] = useState<UserProfile | null>(); | |||
There was a problem hiding this comment.
This PR removes the global state of user from App.tsx
oliverlloyd
commented
Jan 18, 2022
| CAPI.config.discussionApiClientHeader | ||
| } | ||
| enableDiscussionSwitch={ | ||
| CAPI.config.switches.enableDiscussionSwitch |
There was a problem hiding this comment.
We now set this property correctly using the actual switch value from CAPI
|
part of #3629 |
OllysCoding
reviewed
Jan 20, 2022
| @@ -180,62 +164,29 @@ export const Discussion = ({ | |||
| /> | |||
| </div> | |||
| </Hide> | |||
|
|
|||
| {beingHydrated && isExpanded && ( | |||
There was a problem hiding this comment.
Should we test what happens with expanded behaviour
OllysCoding
approved these changes
Jan 20, 2022
ioannakok
approved these changes
Jan 20, 2022
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 does this change?
This moves
Discussionover to the island patternAlong the way
To make this transition work the following refactors and changes were needed
Discussion v9.1.1
It turns out
Discussionwasn't being included in our automated accessibility checks but that when we loaded it onto the page via an island this issue was fixed. However, this meant we started to see new problems in the report failing the build. To get past this I fixed those issues indiscussion-renderingand brought that new release in hereNo
userin App.tsxThis PR removes the global state of
userfrom App.tsxNo more
beingHydratedThis prop was needed to fix an issue with hydration in Storybook. This problem was solved by the islands pattern so this prop could be removed.
DiscussionContainerThis is a wrapper component that is being used to compose the decision about if the user is signed in or not. If they are, we render another wrapper component
DiscussionWhenSignedwhich is where we fetch the user profile, and if they are not, we directly renderDiscussionitself.This level of composition is needed because you cannot conditionally call a react hook.
Why?
🏖️ Islands are where we want to be 🏝️