fix(dashboard): in-app editor preview only call when tab is opened #7186
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
LetItRock
requested review from
SokratisVidros,
BiswaViraj,
ChmaraX and
desiprisg
LetItRock
commented
Dec 2, 2024
| }, [editorValue]); | ||
|
|
||
| const previewResult = previewData?.result; | ||
| const preview = previewResult?.preview as InAppRenderOutput | undefined; |
There was a problem hiding this comment.
I don't like this, but unfortunately, with the current implementation, we can't show the skeleton loader optimistically.
To have the types automatically picked we need to do check for the type:
if (previewData?.result?.type !== IN_APP) {
// RENDER SKELETON
}
// RENDER IN_APP PREVIEW
This requires a lot of refactoring in this file.
Comment on lines
+50
to
+63
| const dataRef = useDataRef({ | ||
| workflowSlug, | ||
| stepSlug, | ||
| controlValues, | ||
| editorValue, | ||
| }); | ||
|
|
||
| useEffect(() => { | ||
| previewStep({ | ||
| workflowSlug: dataRef.current.workflowSlug, | ||
| stepSlug: dataRef.current.stepSlug, | ||
| data: { controlValues: dataRef.current.controlValues, previewPayload: JSON.parse(dataRef.current.editorValue) }, | ||
| }); | ||
| }, [dataRef, previewStep]); |
There was a problem hiding this comment.
on mount call the preview endpoint
Comment on lines
+65
to
+71
| const previewStepCallback = useCallback(() => { | ||
| return previewStep({ | ||
| workflowSlug, | ||
| stepSlug, | ||
| data: { controlValues, previewPayload: JSON.parse(editorValue) }, | ||
| }); | ||
| }, [workflowSlug, stepSlug, controlValues, editorValue, previewStep]); |
There was a problem hiding this comment.
used for the apply button click
✅ Deploy Preview for dev-web-novu ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for novu-stg-vite-dashboard-poc ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for dashboard-v2-novu-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
scopsy
approved these changes
Dec 2, 2024
SokratisVidros
approved these changes
Dec 2, 2024
apps/dashboard/src/components/workflow-editor/steps/use-editor-preview.tsx
Outdated
Show resolved
Hide resolved
LetItRock
commented
Dec 2, 2024
| <div className="to-background absolute -bottom-3 h-16 w-full bg-gradient-to-b from-transparent to-80%" /> | ||
| </div> | ||
|
|
||
| <InboxPreview isPreviewPending={isPreviewPending} previewData={previewData} /> | ||
| <Accordion type="single" collapsible value={accordionValue} onValueChange={setAccordionValue}> |
There was a problem hiding this comment.
I didn't decide on removing the accordion here in case of API "graceful error" as it provides a weird user experience when the components is shown during the loading state and then disappears.
LetItRock
commented
Dec 2, 2024
| if (!isPreviewPending && !data?.result) { | ||
| return null; | ||
| const previewResult = previewData?.result; | ||
| if (isPreviewPending || previewData === undefined) { |
There was a problem hiding this comment.
the preview endpoint should never respond with an error
SokratisVidros
approved these changes
Dec 3, 2024
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 changed? Why was the change needed?
In-App Editor Preview - the api request for the preview should only be called when the tab is opened or when the
applybutton is pressed.In the attached video, there are 2x calls to the API because the React
effectis called twice on the mount.Screenshots
Screen.Recording.2024-12-02.at.23.42.05.mov
Screen.Recording.2024-12-02.at.23.34.56.mov
Screen.Recording.2024-12-02.at.23.02.44.mov
Screen.Recording.2024-12-02.at.23.00.38.mov