Rename redirect_url to store_url in the state parameter
#2396
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
changelog: tweak
puntope
reviewed
May 10, 2024
src/API/WP/OAuthService.php
Outdated
| * | ||
| * where its URL decoded version is: | ||
| * nonce=nonce-123&redirect_url=https://merchant-site.example.com/wp-admin/admin.php?page=wc-admin&path=/google/setup-mc | ||
| * nonce=nonce-123&store_url=https://merchant-site.example.com/wp-admin/admin.php?page=wc-admin&path=/google/setup-mc | ||
| * | ||
| * @param string $path An URL parameter for the path within GL&A page, which will be added in the merchant redirect URL. |
There was a problem hiding this comment.
Not introduced in this PR but in line 66 "An URL" seems not correct and it should be "A URL".
puntope
approved these changes
May 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this Pull Request:
Part of #2146, this PR renames
redirect_urltostore_url, so it will not be confused withredirect_uri.The
store_urlis merchant's store URL, which Google will help redirect to after the OAuth2 flow is completed.Note that after the PR is merged we also need to update the internal document about the new parameter name.
Internal doc link: PCYsg-Ypu-p2
Screenshots:
Detailed test instructions:
Prerequisite
add_filter( 'woocommerce_gla_notifications_enabled', '__return_true' ).gla_wpcom_rest_api_statusis not in the DB.Test steps
Enablenew product sync from the top-left banner.stateparameter, which is base64 encoded.store_urlparamAdditional details:
Changelog entry