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

Add Wincher upgrade callouts #20239

Conversation

KaisZaoualiWincher
Copy link
Contributor

Context

Add the Wincher account upgrade callouts in both edit-post and dashboard pages.

Summary

This PR can be summarized in the following changelog entry:

  • Add the Wincher upgrade callout to the Wincher performance report on the dashboard.
  • Add the Wincher upgrade callout to the Wincher SEO performance on the edit post page.

Test instructions

  • Have Wincher integration enabled.
  • Go to the edit post page.
  • Add 4 keywords to Wincher i.e. add a keyphrase in "Focus keyphrase" and then enable tracking it in the "Track SEO performance" box.
  • Check an upgrade callout is displayed above the keyphrases table.
  • Go to the dashboard page.
  • Check an upgrade callout is displayed above the keyphrases table, with a shortened title this time.

Test instructions for the acceptance test before the PR gets merged

  • An upgrade callout is displayed in edit-post and dashboard pages when the user has already used at least 80% of the account keyword limit (e.g. 4 keywords for the Yoast free account including 5 keywords)
  • Upgrade title in the dashboard is shortened.
  • If it's not a free account, we don't show "free" in the title on the edit-post page
  • We display the discount percentage and the number of months in the description if the Wincher campaign API returns a campaign with a "rate" type and months > 0.
  • If no campaign is returned by the Wincher API, we don't display any discount information but we still display an upgrade callout with a link to the Wincher upgrade page.

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 (Block/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:

  • The Wincher performance report on the dashboard page.
  • The Wincher SEO performance box on the edit-post page.

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.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins 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.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Evidence

  • Months type campaign returned by the API, upgrade callout on the edit-post page:

image

  • No campaign returned by the API: can't be tested without controlling the API

image

  • Amount type campaign: can't be tested without controlling the API

image

  • Upgrade callout on the dashboard page:

image

@manuelaugustin
Copy link
Contributor

@KaisZaoualiWincher Hi, the screenshot of the Dashboard page still shows the combined widget. In Add dashboard wincher connect you split out the keyphrase overview into a separate widget. Has this also been changed in this PR? If so, could you provide an updated screenshot? Thanks! 🙂

@KaisZaoualiWincher
Copy link
Contributor Author

Hi @manuelaugustin! No, this is not changed in this PR since we didn't base this branch on #20107 (comment). Both branches should not be conflicting since we don't add changes to the widget files in this PR.

@vraja-pro vraja-pro self-requested a review June 7, 2023 11:20
@vraja-pro vraja-pro self-assigned this Jun 7, 2023
@vraja-pro
Copy link
Contributor

vraja-pro commented Jun 7, 2023

On post edit, when opening the toggle for Tracking SEO performance:
Screenshot 2023-06-07 at 14 31 21

Integration and unit tests are passing locally.

@KaisZaoualiWincher
Copy link
Contributor Author

Hello @vraja-pro! I've pushed a fix for the last issue. It's not related to the current PR, but still, we need to fix it. Thank you for the catch.

@vraja-pro vraja-pro mentioned this pull request Jun 9, 2023
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants