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.

Sign up for GitHub

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

Jump to bottom

eslint: Enable @wordpress/no-global-active-element and @wordpress/no-global-get-selection #39364

Merged
merged 1 commit into from
Sep 16, 2024
Merged

eslint: Enable @wordpress/no-global-active-element and @wordpress/no-global-get-selection #39364

merged 1 commit into from
Sep 16, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Sep 11, 2024

Proposed changes:

These warn about using document.activeElement or window.getSelection(), which can do the wrong thing if iframes are involved (e.g. in the block editor). The correct thing to do is to access .ownerDocument on some target element.

Note that window.getSelection() is equivalent to window.document.getSelection(), so I didn't bother doing .ownerDocument.defaultView.getSelection().

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

Followup to #38436

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

No

Testing instructions:

  • CI happy?
  • Stuff changed here still work as it did before?

@anomiex
eslint: Enable @wordpress/no-global-active-element and `@wordpress/…
90084c6 
…no-global-get-selection`

These warn about using `document.activeElement` or
`window.getSelection()`, which can do the wrong thing if iframes are
involved (e.g. in the block editor). The correct thing to do is to
access `.ownerDocument` on some target element.

Note that `window.getSelection()` is equivalent to
`window.document.getSelection()`, so I didn't bother doing
`.ownerDocument.defaultView.getSelection()`.
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Sep 11, 2024
@anomiex anomiex requested a review from a team September 11, 2024 20:48
@anomiex anomiex self-assigned this Sep 11, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 11, 2024 •
edited
Loading

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/more-eslint-cleanup branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

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

    bin/jetpack-downloader test jetpack update/more-eslint-cleanup

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/more-eslint-cleanup

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] AI Assistant [Block] Contact Form Form block (also see Contact Form label) [Block] Map [Block] Tiled Gallery [Feature] Contact Form [Feature] SSO [JS Package] AI Client [Package] Connection [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Admin Page React-powered dashboard under the Jetpack menu RNA labels Sep 11, 2024
@github-actions GitHub Actions
Copy link
Contributor

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.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

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

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for October 1, 2024 (scheduled code freeze on September 30, 2024).

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

@anomiex anomiex merged commit 737dcd9 into trunk Sep 16, 2024
75 checks passed
@anomiex anomiex deleted the update/more-eslint-cleanup branch September 16, 2024 14:40
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 16, 2024
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 16, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
@anomiex @gogdzl
eslint: Enable @wordpress/no-global-active-element and `@wordpress/…
7e94e16 
…no-global-get-selection` (#39364)

These warn about using `document.activeElement` or
`window.getSelection()`, which can do the wrong thing if iframes are
involved (e.g. in the block editor). The correct thing to do is to
access `.ownerDocument` on some target element.

Note that `window.getSelection()` is equivalent to
`window.document.getSelection()`, so I didn't bother doing
`.ownerDocument.defaultView.getSelection()`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zinigor zinigor zinigor approved these changes

Assignees

@anomiex anomiex

Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] AI Assistant [Block] Contact Form Form block (also see Contact Form label) [Block] Map [Block] Tiled Gallery [Feature] Contact Form [Feature] SSO [JS Package] AI Client [Package] Connection [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal RNA [Type] Janitorial
Projects
None yet
Milestone
jetpack/13.9
Development

Successfully merging this pull request may close these issues.
2 participants
@anomiex @zinigor