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

Before entering Main, check for showPolicy query param to show policy #4609

Merged
merged 6 commits into from
Aug 20, 2024

Conversation

nucleogenesis
Copy link
Member

Summary

Description of the change(s) you made

In beforeRouteEnter in Main.vue we check the to.query.showPolicy - if it's a valid policy it'll be shown to the user. Includes a check to help be sure this is the first page load.

The URLs would be:

https://studio.learningequality.org/en/accounts?showPolicy=privacy_policy
https://studio.learningequality.org/ar/accounts?showPolicy=privacy_policy
https://studio.learningequality.org/es-es/accounts?showPolicy=privacy_policy
https://studio.learningequality.org/fr-fr/accounts?showPolicy=privacy_policy
https://studio.learningequality.org/pt-br/accounts?showPolicy=privacy_policy

https://studio.learningequality.org/en/accounts?showPolicy=terms_of_service
https://studio.learningequality.org/ar/accounts?showPolicy=terms_of_service
https://studio.learningequality.org/es-es/accounts?showPolicy=terms_of_service
https://studio.learningequality.org/fr-fr/accounts?showPolicy=terms_of_service
https://studio.learningequality.org/pt-br/accounts?showPolicy=terms_of_service

https://studio.learningequality.org/en/accounts?showPolicy=community_standards
https://studio.learningequality.org/ar/accounts?showPolicy=community_standards
https://studio.learningequality.org/es-es/accounts?showPolicy=community_standards
https://studio.learningequality.org/fr-fr/accounts?showPolicy=community_standards
https://studio.learningequality.org/pt-br/accounts?showPolicy=community_standards

Reviewer guidance

How can a reviewer test these changes?

Run the changes, then replace studio.learningequality.org in the URLs listed above with the one you use to access your testing instance and see that they work.

Are there any risky areas that deserve extra testing?

Go back & forth. Sign in, out, etc. It should only show the policy if it is the initial load of the page.

References

Closes #4133

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

this should allow us to send links to people directly to any of our policies
Comment on lines 191 to 193
to.query?.showPolicy &&
Object.values(policies).includes(to.query.showPolicy) &&
!from.name // Prevents the modal from showing when navigating back
Copy link
Member Author

Choose a reason for hiding this comment

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

Any simpler/better conditions here?

The issue suggests this is particularly to accommodate users who have not signed up yet. I considered maybe using a route name (ie, is this only on the account sign in page?)

Copy link
Member

Choose a reason for hiding this comment

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

The simpler solution would probably involve a bit more of a rewrite of the state - and just have the policy query parameter be the thing that determines whether the modal is shown or not.

Then closing the policy modal would just mean removing the query parameter, so you shouldn't get into this situation where you need to check the from route etc.

@rtibbles rtibbles added this to the Studio: Q2-24 Release milestone Jul 22, 2024
@rtibbles rtibbles self-assigned this Jul 25, 2024
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

Code makes sense, manual testing of new functionality checks out, and original functionality has no apparent regressions.

@rtibbles rtibbles merged commit 3ebe652 into learningequality:unstable Aug 20, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 24, 2024
@radinamatic
Copy link
Member

Manual QA on the unstable branch confirms the fix.

@akolson akolson mentioned this pull request Oct 1, 2024
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.

Terms of Service and Community Standards aren't publicly accessible
3 participants