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

ScanReport: Disable hiding relevant fields #40602

Open
wants to merge 2 commits into
base: add/protect/core
Choose a base branch
from

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Dec 12, 2024

Fixes #
Currently you can manually hide many relevant ScanReport fields using the DataViews settings, enough so that what can remain is unclear what it refers to. Additionally, in list view the Files entry does not have title.

Proposed changes:

  • Add enableHiding: false to all relevant fields.
  • Add a title to the Files entry when in list view.

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

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

  • No

Testing instructions:

  • Review ScanReport storybooks and ensure
    • You cannot hide fields
    • In list view the Files entry has a title

@dkmyta dkmyta self-assigned this Dec 12, 2024
@dkmyta dkmyta marked this pull request as ready for review December 12, 2024 22:13
@dkmyta dkmyta changed the base branch from trunk to add/protect/core December 12, 2024 22:14
Copy link
Contributor

github-actions bot commented Dec 12, 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/components/scan-report-field-enable-hiding 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/components/scan-report-field-enable-hiding
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/components/scan-report-field-enable-hiding
    

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

Copy link
Contributor

github-actions bot commented Dec 12, 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 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/js-packages/components

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!

@nateweller nateweller force-pushed the update/components/scan-report-field-enable-hiding branch from ff2d2c2 to 5cf0fbf Compare December 15, 2024 03:43
@nateweller nateweller added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] In Progress labels Dec 15, 2024
@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Dec 15, 2024
Comment on lines +164 to +167
if ( view.type === 'list' && item.type === 'files' ) {
return 'Files';
}

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if ( view.type === 'list' && item.type === 'files' ) {
return 'Files';
}

Ideally, we shouldn't be worrying about something like this at the component level - we should expect that the necessary data is provided.

Luckily, since we control the files item, can we avoid needing this side effect in the first place by adding name: __( 'Files', 'jetpack-components' ) when providing the data to the component on the implementation side in Protect. 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

I've included adding the name property in this PR: #40616

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Components RNA [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants