Skip to content

Add tests for the addition of cached data in the dashboard frontend package #22216

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

Merged
merged 10 commits into from
May 12, 2025

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented Apr 24, 2025

Context

  • Brings the test coverage of the dashboard-frontend package back to 95% lines.

Summary

This PR can be summarized in the following changelog entry:

  • Follows up the addition of cached data in the dashboard package, by adding tests.

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:

  • N/A

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:

  • No impact

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/reserved-tasks/issues/515

@leonidasmi leonidasmi changed the base branch from trunk to poc/add-browser-cache-sk April 24, 2025 10:08
Base automatically changed from poc/add-browser-cache-sk to trunk April 25, 2025 12:11
@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Apr 30, 2025
@coveralls
Copy link

coveralls commented Apr 30, 2025

Pull Request Test Coverage Report for Build 91b9a4994deeba5f197c52928f328466f14ced00

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.1%) to 52.898%

Totals Coverage Status
Change from base Build c122b65f10dc870041aa32063f370fb2a203577e: 0.1%
Covered Lines: 29606
Relevant Lines: 57106

💛 - Coveralls

Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

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

CR 🏗️

P.S. your PR is still in draft.

Copy link
Member

Choose a reason for hiding this comment

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

Some branches are not covered.
I can recommend running coverage and checking out the report for details.

File % Stmts % Branch % Funcs % Lines Uncovered Line #s
cache.js 90 66.67 100 90 59,69,200-208

Code coverage report for src_services_cache.js (5_6_2025 11:07:40 AM).html.zip

Copy link
Contributor Author

@leonidasmi leonidasmi May 8, 2025

Choose a reason for hiding this comment

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

Brought branch coverage to 80% with this commit. I've tried to mock the storage API functions, to increase it even more to no avail.

Copy link
Member

Choose a reason for hiding this comment

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

Here is an example of getting to test the exception for an error when the storage is exceeded:

	it( "should return the storage also when quota exceeded", () => {
		global.FakeStorage = {
			setItem: jest.fn().mockImplementation( () => {
				throw new DOMException( "code 22", "QuotaExceededError" );
			} ),
			removeItem: jest.fn(),
			length: 1,
		};
		setStorageOrder( [ "FakeStorage" ] );

		try {
			expect( getStorage() ).toEqual( global.FakeStorage );
			expect( global.FakeStorage.setItem ).toHaveBeenCalled();
		} finally {
			// Clean up the fake storage.
			delete global.FakeStorage;
		}
	} );

Not sure how far you actually want/need to go. But if it is because you didn't know how, this should help.

@leonidasmi leonidasmi force-pushed the 515-add-tests-for-cached-remoted-data branch from 5bc6e36 to e4447a3 Compare May 8, 2025 06:15
@leonidasmi leonidasmi force-pushed the 515-add-tests-for-cached-remoted-data branch from 18a4890 to 0ae3d8c Compare May 8, 2025 06:52
@leonidasmi leonidasmi force-pushed the 515-add-tests-for-cached-remoted-data branch from 79277b0 to f79718c Compare May 8, 2025 08:21
@leonidasmi leonidasmi marked this pull request as ready for review May 8, 2025 08:32
@igorschoester igorschoester added this to the 25.2 milestone May 12, 2025
@igorschoester igorschoester merged commit c1c7a76 into trunk May 12, 2025
19 checks passed
@igorschoester igorschoester deleted the 515-add-tests-for-cached-remoted-data branch May 12, 2025 07:33
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