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

Stats: Store date range shortcut and chart period by site #98303

Merged
merged 2 commits into from
Jan 14, 2025

Conversation

dognose24
Copy link
Contributor

@dognose24 dognose24 commented Jan 14, 2025

Related to p1736489258690049-slack-C82FZ5T4G

Proposed Changes

  • Store the applied date range shortcut ID to LocalStorage by site
  • Store the applied chart period to LocalStorage by site

Why are these changes being made?

  • The current stored date range shortcut and chart period are shared between all sites, which might not be adaptable to users having many sites.

Testing Instructions

  • Spin this change up with the Calypso Live branch.
  • Navigate to Stats > Traffic page.
  • Ensure the previous stored date range shortcut is still applied.
  • Choose and apply another date range shortcut.
  • Ensure the shortcut works well after refreshing the Traffic page.
  • Go to the Traffic page of another site on Calypso.
  • Choose and apply another date range shortcut.
  • Ensure the applied shortcut does not change the stored date range shortcut of the last step.
  • Test for stored chart period as well by the steps above.

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)?

@dognose24 dognose24 requested a review from a team January 14, 2025 02:59
@matticbot matticbot added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Jan 14, 2025
@dognose24 dognose24 self-assigned this Jan 14, 2025
@dognose24 dognose24 added [Feature] Stats Everything related to our analytics product at /stats/ and removed [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. labels Jan 14, 2025
@matticbot matticbot added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Jan 14, 2025
@matticbot
Copy link
Contributor

matticbot commented Jan 14, 2025

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

Sections (~115 bytes added 📈 [gzipped])

name   parsed_size           gzip_size
stats       +447 B  (+0.0%)     +115 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.

Async-loaded Components (~42 bytes added 📈 [gzipped])

name                                       parsed_size           gzip_size
async-load-store-app-store-stats-listview       +174 B  (+0.1%)      +42 B  (+0.1%)
async-load-store-app-store-stats                +174 B  (+0.1%)      +42 B  (+0.1%)

React components that are loaded lazily, when a certain part of UI is displayed for the first time.

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.

@dognose24 dognose24 changed the title Stats: Store date range shortcut by site Stats: Store date range shortcut and chart period by site Jan 14, 2025
@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
  • odyssey-stats

To test WordPress.com changes, run install-plugin.sh $pluginSlug update/stats_store_date_range_shortcut_by_site on your sandbox.

Copy link
Contributor

@a8ck3n a8ck3n left a comment

Choose a reason for hiding this comment

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

Tests well for me! 👍

I think personally, I'd prefer to use the slug over the site ID as it makes it easier to manage if someone wants to manually remove the key from local storage. Seeing multiple of the same key with different IDs doesn't help in that scenario. It's not really a common use-case though.

@dognose24
Copy link
Contributor Author

dognose24 commented Jan 14, 2025

if someone wants to manually remove the key from local storage

As you said, that might be a rare path, especially for users rather than developers. On the other hand, considering the site slug complexity, using site ID would keep the key length limited and easy to identify. What do you think? cc @kangzj

@dognose24 dognose24 requested review from kangzj and a team January 14, 2025 08:48
@kangzj kangzj merged commit edd22c8 into trunk Jan 14, 2025
15 of 16 checks passed
@kangzj kangzj deleted the update/stats_store_date_range_shortcut_by_site branch January 14, 2025 22:51
@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 Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Stats Everything related to our analytics product at /stats/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants