Remove Ads Conversion ID from Analytics and migrate setting. #12394
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| <?php | ||
| /** | ||
| * Migration for Analytics Ads Conversion ID. | ||
| * | ||
| * @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\Storage\Options; | ||
| use Google\Site_Kit\Modules\Analytics_4\Settings as Analytics_Settings; | ||
|
|
||
| /** | ||
| * 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'; | ||
|
|
||
| /** | ||
| * Context instance. | ||
| * | ||
| * @since n.e.x.t | ||
| * @var Context | ||
| */ | ||
| protected $context; | ||
|
|
||
| /** | ||
| * Options instance. | ||
| * | ||
| * @since n.e.x.t | ||
| * @var Options | ||
| */ | ||
| protected $options; | ||
|
|
||
| /** | ||
| * Analytics_Settings instance. | ||
| * | ||
| * @since n.e.x.t | ||
| * @var Analytics_Settings | ||
| */ | ||
| protected $analytics_settings; | ||
|
|
||
| /** | ||
| * 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->context = $context; | ||
| $this->options = $options ?: new Options( $context ); | ||
| $this->analytics_settings = new Analytics_Settings( $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_remove_analytics_conversion_id_setting(); | ||
|
|
||
| $this->options->set( self::DB_VERSION_OPTION, self::DB_VERSION ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Removes the `adsConversionIDMigratedAtMs` setting that is no longer used, | ||
| * if present. | ||
| * | ||
| * @since n.e.x.t | ||
| */ | ||
zutigrm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| protected function migrate_remove_analytics_conversion_id_setting() { | ||
| if ( ! $this->analytics_settings->has() ) { | ||
| return; | ||
| } | ||
|
|
||
| $analytics_settings = $this->analytics_settings->get(); | ||
|
|
||
| if ( ! is_array( $analytics_settings ) || empty( $analytics_settings ) ) { | ||
| return; | ||
| } | ||
|
|
||
| // If the `adsConversionIDMigratedAtMs` setting does not exist, | ||
| // there is nothing to remove and we can return early. | ||
| if ( | ||
| ! array_key_exists( | ||
| 'adsConversionIDMigratedAtMs', | ||
| $analytics_settings | ||
| ) | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| unset( $analytics_settings['adsConversionIDMigratedAtMs'] ); | ||
|
|
||
| // Save the updated settings. | ||
| $this->analytics_settings->set( $analytics_settings ); | ||
| } | ||
| } | ||
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
|
Collaborator
There was a problem hiding this comment. Same here, not needed. |
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,117 @@ | ||
| <?php | ||
| /** | ||
| * \Google\Site_Kit\Tests\Core\Util\Migration_n_e_x_tTest | ||
| * | ||
| * @package Google\Site_Kit\Tests\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\Tests\Core\Util; | ||
|
|
||
| use Google\Site_Kit\Context; | ||
| use Google\Site_Kit\Core\Storage\Options; | ||
| use Google\Site_Kit\Core\Util\Migration_N_E_X_T; | ||
| use Google\Site_Kit\Modules\Analytics_4\Settings as Analytics_Settings; | ||
| use Google\Site_Kit\Tests\TestCase; | ||
|
|
||
| class Migration_N_E_X_TTest extends TestCase { | ||
|
|
||
| /** | ||
| * @var Context | ||
| */ | ||
| protected $context; | ||
|
|
||
| /** | ||
| * @var Options | ||
| */ | ||
| protected $options; | ||
|
|
||
| /** | ||
| * @var Analytics_Settings | ||
| */ | ||
| protected $analytics_settings; | ||
|
|
||
| public function set_up() { | ||
| parent::set_up(); | ||
|
|
||
| $this->context = new Context( GOOGLESITEKIT_PLUGIN_MAIN_FILE ); | ||
| $this->options = new Options( $this->context ); | ||
| $this->analytics_settings = new Analytics_Settings( $this->options ); | ||
|
|
||
| $this->analytics_settings->register(); | ||
| $this->delete_db_version(); | ||
| } | ||
|
|
||
| public function get_new_migration_instance() { | ||
| return new Migration_n_e_x_t( | ||
| $this->context, | ||
| $this->options | ||
| ); | ||
| } | ||
|
|
||
| public function test_register() { | ||
| $migration = $this->get_new_migration_instance(); | ||
| remove_all_actions( 'admin_init' ); | ||
|
|
||
| $migration->register(); | ||
|
|
||
| $this->assertTrue( has_action( 'admin_init' ), 'Migration should register admin_init action.' ); | ||
| } | ||
|
|
||
| public function test_migrate_when_setting_present() { | ||
| $migration = $this->get_new_migration_instance(); | ||
|
|
||
| $analytics_data = array( | ||
| 'availableAudiences' => array( 'audience1', 'audience2' ), | ||
| 'availableAudiencesLastSyncedAt' => 1678886400, | ||
| 'audienceSegmentationSetupCompletedBy' => 123, | ||
| 'adsConversionIDMigratedAtMs' => 1678886400, | ||
| 'other_analytics_setting' => 'value', | ||
| ); | ||
|
|
||
| $this->analytics_settings->set( $analytics_data ); | ||
|
|
||
| $pre_migration_settings = $this->analytics_settings->get(); | ||
|
|
||
| $this->assertArrayHasKey( 'adsConversionIDMigratedAtMs', $pre_migration_settings, 'adsConversionIDMigratedAtMs setting should exist in Analytics settings before migration.' ); | ||
|
|
||
| $migration->migrate(); | ||
|
|
||
| $post_migration_settings = $this->analytics_settings->get(); | ||
|
|
||
| $this->assertArrayNotHasKey( 'adsConversionIDMigratedAtMs', $post_migration_settings, 'adsConversionIDMigratedAtMs setting should be removed from Analytics settings.' ); | ||
| } | ||
|
|
||
| public function test_migrate_when_setting_not_present() { | ||
| $migration = $this->get_new_migration_instance(); | ||
|
|
||
| $analytics_data = array( | ||
| 'availableAudiences' => array( 'audience1', 'audience2' ), | ||
| 'availableAudiencesLastSyncedAt' => 1678886400, | ||
| 'audienceSegmentationSetupCompletedBy' => 123, | ||
| 'other_analytics_setting' => 'value', | ||
| ); | ||
|
|
||
| $this->analytics_settings->set( $analytics_data ); | ||
|
|
||
| $pre_migration_settings = $this->analytics_settings->get(); | ||
|
|
||
| $this->assertArrayNotHasKey( 'adsConversionIDMigratedAtMs', $pre_migration_settings, 'adsConversionIDMigratedAtMs setting should not exist in Analytics settings before migration.' ); | ||
|
|
||
| $migration->migrate(); | ||
|
|
||
| $post_migration_settings = $this->analytics_settings->get(); | ||
|
|
||
| $this->assertArrayNotHasKey( 'adsConversionIDMigratedAtMs', $post_migration_settings, 'adsConversionIDMigratedAtMs setting should not be present in Analytics settings after migration.' ); | ||
| } | ||
|
|
||
| protected function get_db_version() { | ||
| return $this->options->get( Migration_n_e_x_t::DB_VERSION_OPTION ); | ||
| } | ||
|
|
||
| protected function delete_db_version() { | ||
| $this->options->delete( Migration_n_e_x_t::DB_VERSION_OPTION ); | ||
| } | ||
| } |
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.
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.
I know this has been added to IB, but we don't need this migration. There is nothing to migrate here. Let's remove this class.
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.
We've previously removed unneeded/unused keys from settings with other migrations; wouldn't it make sense to remove it now that it's no longer in use? It's not strictly needed but seems like good housekeeping 🤔