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

21908 double request to semrush api #21913

Merged
merged 10 commits into from
Dec 23, 2024

Conversation

vraja-pro
Copy link
Contributor

@vraja-pro vraja-pro commented Dec 11, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where the request for semrush would execute twice when opening the modal for related keyphrases.

Relevant technical choices:

  • I moved the API request to a control function in the redux store so I would have access from the country selector and use it on clicking the "Get related keyphrases" button outside the modal.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Edit a post with focus keyphrase.
  • Log in to your semrush account.
  • Open the dev tool console on the network tab, and click on "Get related keyphrases"
  • Check you see only one request by the name "related_keyphrases".
  • Check you see the loading table and then the results in the table.
  • Change the focus keyphrase to something random that would not have results and check you get the error for not match was found.
  • Mock the failing on the request and check you are getting the message for failing.
  • Reach the limit of the requests and check you are getting the limit request notice.

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:

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 Double request to semrush api

@vraja-pro vraja-pro added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Dec 11, 2024
@coveralls
Copy link

coveralls commented Dec 11, 2024

Pull Request Test Coverage Report for Build 86c2787f13b812cb4f9bdfebb4b08399e94b352e

Details

  • 14 of 28 (50.0%) changed or added relevant lines in 6 files are covered.
  • 5 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.02%) to 54.626%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/containers/SEMrushRelatedKeyphrasesModal.js 0 1 0.0%
packages/js/src/components/SEMrushRelatedKeyphrasesModalContent.js 4 6 66.67%
packages/js/src/redux/controls/SEMrushRequest.js 0 3 0.0%
packages/js/src/redux/actions/SEMrushRequest.js 4 12 33.33%
Files with Coverage Reduction New Missed Lines %
packages/js/src/redux/reducers/SEMrushRequest.js 1 71.43%
packages/js/src/containers/SEMrushRelatedKeyphrases.js 2 0.0%
packages/js/src/containers/SEMrushRelatedKeyphrasesModal.js 2 0.0%
Totals Coverage Status
Change from base Build 3e0db5e9443cbdf8e70b7c4db78d9563aa155b65: -0.02%
Covered Lines: 30105
Relevant Lines: 55467

💛 - 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 🏗️

As a quick AT: I blocked the request via the network tab and got the no data available info alert instead of error?
Might have something to do with my last succesful one yielding no results?

packages/js/src/redux/controls/SEMrushRequest.js Outdated Show resolved Hide resolved
packages/js/src/redux/controls/SEMrushRequest.js Outdated Show resolved Hide resolved
packages/js/src/redux/controls/SEMrushRequest.js Outdated Show resolved Hide resolved
packages/js/src/redux/controls/SEMrushRequest.js Outdated Show resolved Hide resolved
packages/js/src/redux/controls/SEMrushRequest.js Outdated Show resolved Hide resolved
@vraja-pro vraja-pro force-pushed the 21908-double-request-to-semrush-api branch from 949f269 to 4a44b14 Compare December 16, 2024 13:01
@vraja-pro
Copy link
Contributor Author

Added exception for "fetch_error" code, you should get an error notice now when offline.

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 && AT ✅

@igorschoester igorschoester added this to the 24.3 milestone Dec 23, 2024
@igorschoester igorschoester merged commit a4a6bf5 into trunk Dec 23, 2024
15 checks passed
@igorschoester igorschoester deleted the 21908-double-request-to-semrush-api branch December 23, 2024 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Double request to semrush api
3 participants