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

537 refactor microcaching the api endpoints into using cache decorators #21879

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Nov 29, 2024

Context

  • We want to abstract the caching part away from getting the actual data.

Summary

This PR can be summarized in the following changelog entry:

  • Refactors microcaching to use the decorator pattern.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

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.

QA can test this PR by following these steps:

  • For QA just testing the entire feature will also make sure this PR did not do anything strange.

Impact check

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

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 #

@thijsoo thijsoo added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Nov 29, 2024
@thijsoo thijsoo added this to the feature/dash-phase-1 milestone Nov 29, 2024
@thijsoo thijsoo changed the base branch from trunk to feature/dash-phase-1 November 29, 2024 13:19
@coveralls
Copy link

coveralls commented Nov 29, 2024

Pull Request Test Coverage Report for Build 9c7ab956e19bbe25f9d4a0b686fe9c3e9e761ad9

Details

  • 0 of 36 (0.0%) changed or added relevant lines in 4 files are covered.
  • 521 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.01%) to 54.386%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/dashboard/infrastructure/score-results/readability-score-results/readability-score-results-collector.php 0 1 0.0%
src/dashboard/infrastructure/score-results/seo-score-results/seo-score-results-collector.php 0 1 0.0%
src/dashboard/infrastructure/score-results/readability-score-results/cached-readability-score-results-collector.php 0 17 0.0%
src/dashboard/infrastructure/score-results/seo-score-results/cached-seo-score-results-collector.php 0 17 0.0%
Files with Coverage Reduction New Missed Lines %
src/generated/container.php 521 0.39%
Totals Coverage Status
Change from base Build 3bd4db682fc5a2609c8f2c0ec4672eedbe69005c: -0.01%
Covered Lines: 29938
Relevant Lines: 55464

💛 - Coveralls

@igorschoester igorschoester removed this from the feature/dash-phase-1 milestone Dec 3, 2024
Base automatically changed from feature/dash-phase-1 to trunk December 3, 2024 10:40
…tor-microcaching-the-api-endpoints-into-using-cache-decorators

# Conflicts:
#	src/dashboard/infrastructure/score-results/readability-score-results/readability-score-results-collector.php
#	src/dashboard/infrastructure/score-results/seo-score-results/seo-score-results-collector.php
Copy link
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR: 🏗️

Some remarks, mostly about making the decorated classes cache-agnostic


return $results;
}
$results = $this->readability_score_results_collector->get_score_results( $score_groups, $content_type, $term_id, $is_troubleshooting );
Copy link
Contributor

Choose a reason for hiding this comment

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

I would like an empty line above, but that's maybe just me?

Copy link
Contributor

Choose a reason for hiding this comment

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

Same for the other cached collector

if ( $is_troubleshooting !== true ) {
\set_transient( $transient_name, WPSEO_Utils::format_json_encode( $current_scores ), \MINUTE_IN_SECONDS );
}

$results['scores'] = $current_scores;
$results['cache_used'] = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that the collector should be agnostic of anything cache related, so I think it's the cached collectors' responsibility to set $results['cache_used'] = false;

?bool $is_troubleshooting
) {
$content_type_name = $content_type->get_name();
$transient_name = Readability_Score_Results_Collector::READABILITY_SCORES_TRANSIENT . '_' . $content_type_name . ( ( $term_id === null ) ? '' : '_' . $term_id );
Copy link
Contributor

Choose a reason for hiding this comment

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

The READABILITY_SCORES_TRANSIENT constant should be set in this class, instead of the cache-agnostic collector, I think.

Copy link
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR + Acceptance is ✅

@leonidasmi leonidasmi added this to the 24.2 milestone Dec 11, 2024
@leonidasmi leonidasmi merged commit b602854 into trunk Dec 11, 2024
23 checks passed
@leonidasmi leonidasmi deleted the 537-refactor-microcaching-the-api-endpoints-into-using-cache-decorators branch December 11, 2024 09:53
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.

4 participants