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

Account Protection: Add Settings Class #41829

Merged
merged 3 commits into from
Feb 16, 2025
Merged

Account Protection: Add Settings Class #41829

merged 3 commits into from
Feb 16, 2025

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Feb 15, 2025 •
edited
Loading

Added in support of https://github.com/Automattic/jetpack-scan-team/issues/1678 and https://github.com/Automattic/jetpack-scan-team/issues/1677.

Proposed changes:

  • Adds a new Automattic\Jetpack\Account_Protection\Settings class, responsible for managing settings related to the package.
  • Updates the Protect plugin to use the new Settings class and the full settings object.

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

peb6dq-3o9-p2

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

No

Testing instructions:

  • On a new JN site, validate activating Protect and viewing/toggling the account protection setting.
  • Validate the settings object provided by the server via window.jetpackProtectInitialState or Tanstack Query dev tools.

@nateweller nateweller added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Feb 15, 2025
@nateweller nateweller requested review from dkmyta and a team February 15, 2025 20:21
@nateweller nateweller self-assigned this Feb 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 15, 2025 •
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 add/account-protection-settings branch.

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

    bin/jetpack-downloader test jetpack add/account-protection-settings

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 [Package] Account Protection [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Status] In Progress labels Feb 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 15, 2025 •
edited
Loading

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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.

🔴 Action required: Please add missing changelog entries for the following projects: projects/packages/account-protection, projects/plugins/protect

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md

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!

Protect plugin:

  • Next scheduled release: none scheduled.

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

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Feb 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 15, 2025 •
edited
Loading

Code Coverage Summary

No summary data is avilable for parent commit 547328a, cannot calculate coverage changes. 😴

If that commit is a feature branch rather than a trunk commit, this is expected. Otherwise, this should be updated once coverage for 547328a is available.

Full summary · PHP report · JS report

@nateweller nateweller marked this pull request as ready for review February 15, 2025 21:27
@nateweller nateweller added [Status] Needs Team Review Obsolete. Use Needs Review instead. and removed [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 15, 2025
This was referenced Feb 15, 2025
Merged
Merged
@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Feb 15, 2025
@nateweller nateweller removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Feb 15, 2025
@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Feb 15, 2025
dkmyta
dkmyta approved these changes Feb 16, 2025
View reviewed changes
Copy link
Contributor

@dkmyta dkmyta left a comment

Choose a reason for hiding this comment

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

Works as described and tests all pass.

Side note: On a fresh install, the initial state of the toggle is off again (same issue as before). Unclear if its related, or if the original fix never addressed it.

@dkmyta dkmyta merged commit 6478ee4 into add/account-protection Feb 16, 2025
58 of 60 checks passed
@dkmyta dkmyta deleted the add/account-protection-settings branch February 16, 2025 17:50
@github-actions github-actions bot removed [Status] Needs Team Review Obsolete. Use Needs Review instead. [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 16, 2025
@dkmyta dkmyta mentioned this pull request Feb 16, 2025
Open
3 tasks
nateweller added a commit that referenced this pull request Feb 20, 2025
@nateweller
Account Protection: Add Settings Class (#41829)
03ad3eb 
* Protect: use object for account protection settings, add isEnabled and isSupported

* Add test for Settings class

* Minor clean up
nateweller added a commit that referenced this pull request Feb 28, 2025
@nateweller
Account Protection: Add Settings Class (#41829)
aa077ba 
* Protect: use object for account protection settings, add isEnabled and isSupported

* Add test for Settings class

* Minor clean up
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dkmyta dkmyta dkmyta approved these changes

Assignees

@nateweller nateweller

Labels
[Package] Account Protection [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Tests] Includes Tests [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nateweller @dkmyta