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

React compatibility: Removing javascript: url usage #38783

Merged
merged 6 commits into from
Aug 12, 2024

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Aug 8, 2024

Fixes #38780

Proposed changes:

  • In React 19, there will be better error reporting for javascript: URLs. Though occurrences of these will continue to work if preventDefault is used, we do have existing console errors and it is worth cleaning these up in our codebase anyway.
  • We only have three JS files that use javascript URLs, all in the Jetpack plugin:
    • modules/shortcodes/js/recipes-printthis.js - code specific to IE browser which I believe is no longer supported, plus it's a regular JS file (not using React), so I believe we can leave that (not touched in this PR)
    • The second is related to the cookie consent block atextensions/blocks/cookie-consent/view.js. This is also only JS, not React, but given it's a reasonably quick fix I have changed this one.
    • The third is a React file - _inc/client/searchable-modules/index.jsx, related to the SearchableModules component.
  • For the last two, this PR changes the Javascript URLs to be #, then preventing the default behaviour so that the # is also not added to the URL.
  • Better solutions would have included changing the components that the URLs are added to, to be buttons instead of anchor elements with the role of button. However that would in both cases have involved a greater component re-write, so I've opted for this option instead.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

#38780

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

Cookie Consent Block

  • With this PR applied for self-hosted or Atomic (or this patch using the generated comment on a Simple site), activate a theme that supports the site editor (for example Twenty Twenty Four)
  • Using the site editor - Appearance -> Site Editor - add the Cookie Consent block somewhere on the site
  • Add unset( $_COOKIE['eucookielaw'] ); to a functions.php file or code snippets plugin to delete the cookie after it is added (after removing the notice), so that you can test this more than once.
  • On the front-end of the site, click on the Cookie Consent banner's 'Accept' button - the banner should be removed. If you click on other buttons on the page, they should work as they did before applying the patch.

SearchableModule component

  • To confirm the default behaviour, on a self-hosted or Atomic site activate a classic theme such as Twenty Fifteen.
  • Go to Jetpack > Settings and enter 'Contact Form' in the search field, after having deactivated 'Contact Form' from the modules page at /wp-admin/admin.php?page=jetpack_modules.
  • You will see the React warning in your console (you may need to make sure you have script debug enabled - define( 'SCRIPT_DEBUG', true ); in wp-config.php).
  • Click on the 'Activate' button - you should stay on the same page, and see a notice saying the settings are being updated.
  • Apply the PR, and follow the same testing instructions. The behaviour should be the same.

Copy link
Contributor

github-actions bot commented Aug 8, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/react-compat-javascript-url branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/react-compat-javascript-url
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Block] Cookie Consent [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Admin Page React-powered dashboard under the Jetpack menu labels Aug 8, 2024
Copy link
Contributor

github-actions bot commented Aug 8, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 3, 2024 (scheduled code freeze on September 2, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@coder-karen coder-karen marked this pull request as ready for review August 8, 2024 13:10
@coder-karen coder-karen requested a review from a team August 8, 2024 13:21
@coder-karen coder-karen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Aug 8, 2024
Copy link
Contributor

@darssen darssen 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 in Self Hosted and Atomic

@coder-karen coder-karen merged commit e29cee2 into trunk Aug 12, 2024
57 checks passed
@coder-karen coder-karen deleted the update/react-compat-javascript-url branch August 12, 2024 10:33
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Aug 12, 2024
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] Cookie Consent [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

React compatibility: Clean up javascript: url usage
2 participants