Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reader: fix broken back navigation when mounting reader onboarding #99123

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

holdercp
Copy link
Contributor

@holdercp holdercp commented Jan 30, 2025

When working on reproducing #98359, I discovered a similar but unrelated bug that was introduced in #98679 where the browser's history state gets reset when the <ReaderOnboarding/> component mounts. This component mounts whenever the "stream" view of the Reader Recent feed is loaded, whether it's rendered or not. This causes the browser's back navigation to break whenever a user visited the recent stream view at /read.

Screen.Recording.2025-01-30.at.11.47.02.AM.mov

Proposed Changes

  • Rework the useEffect callback logic to only update the router state when the related query param is present
  • Use page.redirect instead of history.replaceState so this navigation is using the router library directly. This should have the same effect as replaceState but we don't have to worry about manually copying over state. Docs for that method here: https://visionmedia.github.io/page.js/#pageredirectpath
Screen.Recording.2025-01-30.at.12.11.26.PM.mov

Why are these changes being made?

  • To fix back navigation when using the Reader

Testing Instructions

  • Navigate to /read with a new user so onboarding is shown. Make sure you are viewing the "stream" view.
  • Ensure there's no regression in functionality added in Reader onboarding - expose to unverified users and prompt verification at the appropriate point. #98679.
  • Use the Reader normally and ensure the back button in the browser chrome and the Reader UI works as expected.
    • Specifically navigate to /read with the stream view active.
    • Click on a post, site feed link, or user icon to navigate away from the recent feed
    • Click the browser back button or Reader "back" UI button

Pre-merge Checklist

  • Has the general commit checklist been followed? (PCYsg-hS-p2)
  • Have you written new tests for your changes?
  • Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
  • Have you checked for TypeScript, React or other console errors?
  • Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
  • Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
    • For UI changes, have we tested the change in various languages (for example, ES, PT, FR, or DE)? The length of text and words vary significantly between languages.
  • For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

@holdercp holdercp requested a review from a team as a code owner January 30, 2025 18:44
@matticbot matticbot added [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. labels Jan 30, 2025
@holdercp holdercp self-assigned this Jan 30, 2025
@matticbot
Copy link
Contributor

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

Sections (~13 bytes removed 📉 [gzipped])

name    parsed_size           gzip_size
reader        -19 B  (-0.0%)      -13 B  (-0.0%)

Sections contain code specific for a given set of routes. Is downloaded and parsed only when a particular route is navigated to.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

@holdercp
Copy link
Contributor Author

@Addison-Stavlo added you as a reviewer because I want to make sure I'm not breaking anything from #98679

@matticbot
Copy link
Contributor

This PR modifies the release build for the following Calypso Apps:

For info about this notification, see here: PCYsg-OT6-p2

  • notifications
  • wpcom-block-editor

To test WordPress.com changes, run install-plugin.sh $pluginSlug fix/reader-back-nav-broken on your sandbox.

@holdercp holdercp changed the title Reader: fix history state issue when mounting reader onboarding Reader: fix broken back navigation when mounting reader onboarding Jan 30, 2025
Copy link
Contributor

@eoigal eoigal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@Addison-Stavlo Addison-Stavlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great, thank you!

@Addison-Stavlo Addison-Stavlo merged commit 84af3eb into trunk Feb 3, 2025
19 checks passed
@Addison-Stavlo Addison-Stavlo deleted the fix/reader-back-nav-broken branch February 3, 2025 10:36
@github-actions github-actions bot removed the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants