Skip to content

Improve migration flow to new OAuth authentication for a better user experience. #67

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.

Sign up for GitHub

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

Jump to bottom
Merged
dkotter merged 5 commits into from
Oct 10, 2024
Merged

Improve migration flow to new OAuth authentication for a better user experience. #67

dkotter merged 5 commits into from
Oct 10, 2024

Conversation

@iamdharmesh
Copy link
Collaborator

@iamdharmesh iamdharmesh commented Oct 4, 2024 •
edited by jeffpaul
Loading

Description of the Change

This PR improves the user experience for migrating from API key authentication to the new OAuth authentication. The existing flow requires a two-step process (logout and login with OAuth authentication). This new flow introduces a "Migrate to OAuth authentication" button in the notice on the settings page, making the process a single-step, easier, and confusion-free.

Oct-04-2024 16-23-01

How to test the Change

  1. Install the old version of the plugin 1.5.8.
  2. Configure the plugin by adding the API key and saving the settings.
  3. Checkout this PR.
  4. Verify that an admin notice to migrate to OAuth authentication is displayed in the dashboard.
  5. Verify that an admin notice with the "Migrate to OAuth authentication" button is displayed on the plugin settings page.
  6. Click the "Migrate to OAuth authentication" button and verify that it triggers the Mailchimp OAuth login flow.
  7. Follow the steps in the opened modal and complete the process. You should be redirected to the plugin settings page, with the authentication successfully migrated to OAuth.
  8. Verify that the settings remain unchanged.

Changelog Entry

Changed - Improved migration flow from API Key to OAuth authentication for a better user experience.

Credits

Props @iamdharmesh @jeffpaul

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@iamdharmesh iamdharmesh self-assigned this Oct 4, 2024
@iamdharmesh iamdharmesh changed the base branch from fix/persist-list to develop October 4, 2024 11:12
@github-actions github-actions bot added this to the 1.7.0 milestone Oct 4, 2024
@github-actions github-actions bot added the needs:code-review This requires code review. label Oct 4, 2024
@iamdharmesh iamdharmesh changed the base branch from develop to fix/persist-list October 4, 2024 11:17
@iamdharmesh iamdharmesh requested a review from dkotter October 4, 2024 11:17
@qasumitbagthariya
Copy link
Collaborator

qasumitbagthariya commented Oct 8, 2024

QA Update ✅

I have verified this PR in the enhancement/migrate-to-oauth branch which has been fixed and is functioning as intended.

The migration to OAuth authentication works as expected, with no changes to existing settings.

I tested the following on this branch:

  • Checked the PR and verified that an admin notice to migrate to OAuth authentication is displayed in the dashboard.
  • Confirmed that an admin notice with the "Migrate to OAuth authentication" button is present on the plugin settings page.
  • Clicked the "Migrate to OAuth authentication" button, which successfully triggered the Mailchimp OAuth login flow.
  • Followed the steps in the opened modal and completed the process.
  • Verified that I was redirected to the plugin settings page with the authentication successfully migrated to OAuth.
  • Confirmed that all settings remained unchanged after the migration.
Screen.Recording.2024-10-08.at.5.47.12.PM.mov
Screen.Recording.2024-10-08.at.5.15.50.PM.mov

Testing Environment

  • WordPress: 6.6.2
  • Theme: Storefront 4.6.0
  • Theme: Twenty Twenty-Four 1.2
  • PHP: 8.0.30
  • Web Server: Nginx 1.20.2
  • Browser: Chrome
  • OS: macOS Ventura 13.3
  • Branch: enhancement/migrate-to-oauth

Steps to Test- As mentioned in the PR description.
Test Results - It is working as expected.
Functional Demo / Screencast -
Special Notes - Ready for code review (Woo)
Testing Document status:
Cases related to this Issue/PR are added to the Critical Flow Wiki pages:

  • Yes
  • Not Required/Applicable for this PR

@jeffpaul jeffpaul self-requested a review October 8, 2024 21:50
jeffpaul
jeffpaul approved these changes Oct 8, 2024
View reviewed changes
Copy link
Collaborator

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

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

Looks good to me in testing, ok to move to Regression Testing if you're 👍🏼 @dkotter

@qasumitbagthariya
Copy link
Collaborator

qasumitbagthariya commented Oct 10, 2024

Regression / Smoke Test Report ✅

I have verified this PR in the smoke-test branch and it is working as expected.

Testing Environment

  • WordPress: 6.6.2
  • Theme: Twenty Twenty-Four 1.2
  • WooCommerce - 9.3.3
  • PHP: 8.0.30
  • Web Server: Nginx 1.20.2
  • Browser: Chrome
  • OS: macOS Ventura 13.3
  • Branch: smoke-testing

Next Step- Ready to Merge 🚀

@vikrampm1 vikrampm1 modified the milestones: 1.7.0, 1.6.1 Oct 10, 2024
@vikrampm1
Copy link
Collaborator

vikrampm1 commented Oct 10, 2024

@dkotter this PR commits into fix/persist-list branch as opposed to develop so I would let you review and merge accordingly.

@vikrampm1 vikrampm1 mentioned this pull request Oct 10, 2024
Closed
22 tasks
@dkotter dkotter changed the base branch from fix/persist-list to develop October 10, 2024 21:06
@dkotter dkotter merged commit 44d673f into develop Oct 10, 2024
@dkotter dkotter deleted the enhancement/migrate-to-oauth branch October 10, 2024 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dkotter dkotter dkotter approved these changes

@jeffpaul jeffpaul jeffpaul approved these changes

@qasumitbagthariya qasumitbagthariya qasumitbagthariya approved these changes

Assignees

@iamdharmesh iamdharmesh

Labels

needs:code-review This requires code review.

Projects

None yet

Milestone

1.6.1

Development

Successfully merging this pull request may close these issues.

6 participants

@iamdharmesh @qasumitbagthariya @vikrampm1 @dkotter @jeffpaul