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

Exclude post types that have false show_ui from the dashboard feature #21902

Merged

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented Dec 6, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes an unreleased bug where we would show post types with false show_ui in the dashboard feature, which would result into linking to non existing admin pages.

Relevant technical choices:

  • Instead of deciding whether we should fix the source of truth (aka, whether post types with false show_ui should be indexable-d), we do the quick fix here and an investigation task was created for taking care of this properly in the future.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Create a post type with false show_ui but true public:
function register_blog_post_type() {
    $args = [
		'label'              => \__( 'Blog posts', 'yoast-test-helper' ),
		'labels'             => [
			'name'          => \__( 'Blog posts', 'yoast-test-helper' ),
			'singular_name' => \__( 'Blog post', 'yoast-test-helper' ),
		],
        'public'             => true,
        'show_ui'            => false,
    ];

    register_post_type('blog-post', $args);
}
add_action('init', 'register_blog_post_type');
  • Confirm that you dont get a dropdown in the content type filter of both scores in the dashboard:
    image
  • You can check the same if you activate BuddyPress in your site
    • Without this PR BuddyPress Directories is being shown in the dropdown, but if you clicked on the View links you used to get an error page.
    • With this PR, BuddyPress Directories is not being shown in the dropdown

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Smoke test that you still get scores for all content types that you would expect

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/plugins-automated-testing/issues/2020

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Dec 6, 2024
@leonidasmi leonidasmi added this to the 24.1 milestone Dec 6, 2024
@leonidasmi leonidasmi marked this pull request as ready for review December 6, 2024 12:27
@coveralls
Copy link

Pull Request Test Coverage Report for Build 7c74a1057df29f5b4707e477075145f9083e92b8

Details

  • 0 of 2 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+1.8%) to 54.092%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/dashboard/infrastructure/content-types/content-types-collector.php 0 2 0.0%
Totals Coverage Status
Change from base Build 67038981d34819ce29a1957c3f22c19a49494082: 1.8%
Covered Lines: 29774
Relevant Lines: 55402

💛 - Coveralls

@vraja-pro
Copy link
Contributor

CR & AC ✅

@vraja-pro vraja-pro merged commit b6c4d91 into release/24.1 Dec 6, 2024
23 checks passed
@vraja-pro vraja-pro deleted the 2020-241---dashboard-hide-cpt-with-show_ui--false branch December 6, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants