-
Notifications
You must be signed in to change notification settings - Fork 375
Fix URL change detection broken by database search and replace #13135
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
Open
shervElmi
wants to merge
8
commits into
develop
Choose a base branch
from
bug/12962-encode-connected-proxy-url
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3b6235f
Encode the connected proxy URL setting.
shervElmi 2e8c6be
Add the connected proxy URL migration.
shervElmi 984a68f
Register the connected proxy URL migration.
shervElmi d57a71a
Update comments for clarity in Connected_Proxy_URL and migrations.
shervElmi 7e1de03
Encode the connected proxy URL without a read filter.
shervElmi 67a2678
Address CR feedback.
shervElmi d184b3b
Merge remote-tracking branch 'origin/develop' into bug/12962-encode-c…
shervElmi e35bb46
Fix PHP lint full-stop errors.
shervElmi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| <?php | ||
| /** | ||
| * Migration for the connected proxy URL setting. | ||
| * | ||
| * @package Google\Site_Kit\Core\Util | ||
| * @copyright 2026 Google LLC | ||
| * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0 | ||
| * @link https://sitekit.withgoogle.com | ||
| */ | ||
|
|
||
| namespace Google\Site_Kit\Core\Util; | ||
|
|
||
| use Google\Site_Kit\Context; | ||
| use Google\Site_Kit\Core\Authentication\Connected_Proxy_URL; | ||
| use Google\Site_Kit\Core\Storage\Options; | ||
|
|
||
| /** | ||
| * Class Migration_N_E_X_T. | ||
| * | ||
| * @since n.e.x.t | ||
| * @access private | ||
| * @ignore | ||
| */ | ||
| class Migration_N_E_X_T { | ||
| /** | ||
| * Target DB version. | ||
| */ | ||
| const DB_VERSION = 'n.e.x.t'; | ||
|
|
||
| /** | ||
| * DB version option name. | ||
| */ | ||
| const DB_VERSION_OPTION = 'googlesitekit_db_version'; | ||
|
|
||
| /** | ||
| * Options instance. | ||
| * | ||
| * @since n.e.x.t | ||
| * @var Options | ||
| */ | ||
| protected Options $options; | ||
|
|
||
| /** | ||
| * Connected_Proxy_URL instance. | ||
| * | ||
| * @since n.e.x.t | ||
| * @var Connected_Proxy_URL | ||
| */ | ||
| protected Connected_Proxy_URL $connected_proxy_url; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @since n.e.x.t | ||
| * | ||
| * @param Context $context Plugin context instance. | ||
| * @param Options $options Optional. Options instance. | ||
| */ | ||
| public function __construct( | ||
| Context $context, | ||
| ?Options $options = null | ||
| ) { | ||
| $this->options = $options ?: new Options( $context ); | ||
| $this->connected_proxy_url = new Connected_Proxy_URL( $this->options ); | ||
| } | ||
|
|
||
| /** | ||
| * Registers hooks. | ||
| * | ||
| * @since n.e.x.t | ||
| */ | ||
| public function register() { | ||
| add_action( 'admin_init', array( $this, 'migrate' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Migrates the DB. | ||
| * | ||
| * @since n.e.x.t | ||
| */ | ||
| public function migrate() { | ||
| $db_version = $this->options->get( self::DB_VERSION_OPTION ); | ||
|
|
||
| if ( ! $db_version || version_compare( $db_version, self::DB_VERSION, '<' ) ) { | ||
| $this->migrate_connected_proxy_url(); | ||
|
|
||
| $this->options->set( self::DB_VERSION_OPTION, self::DB_VERSION ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Migrates a plain text connected proxy URL to the encoded format. | ||
| * | ||
| * Earlier plugin versions stored the URL in plain text. A stored value that | ||
| * still starts with its scheme goes back through Connected_Proxy_URL::set(), | ||
| * which stores it encoded. | ||
| * | ||
| * @since n.e.x.t | ||
| */ | ||
| protected function migrate_connected_proxy_url() { | ||
| $stored_url = $this->options->get( Connected_Proxy_URL::OPTION ); | ||
|
|
||
| if ( ! is_string( $stored_url ) || 0 !== strpos( $stored_url, 'http' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $this->connected_proxy_url->set( $stored_url ); | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we already have this migration, why do we need to account for both encoded and unencoded values in the
Connected_Proxy_URLfile? 🤔Seems we can assume they're always encoded, no?