Error migration m201207_124200_add_product_types_to_sitemap::dropCheck()

[gmonseur]

Hi everyone,

Description

I get this error when upgrading from craft 3 to 4 with seo 4.0 plugin.
Can you help me please ?

applying m201207_124200_add_product_types_to_sitemap
PHP Compile Error 'yii\base\ErrorException' with message 'Access level to ether\seo\migrations\m201207_124200_add_product_types_to_sitemap::dropCheck() must be public (as in class yii\db\Migration)'

in /media/DATA/www/.../vendor/ether/seo/src/migrations/m201207_124200_add_product_types_to_sitemap.php:39

Steps to reproduce

1. requires
   craftcms/cms ^4.0 (4.12.5)
   ether/seo 4.0.0 (4.0.0)

2. composer install (Composer version 2.5.2 2023-02-04 14:33:22)

Additional info

• Craft version: 4.12.5
• SEO version: 4.0.0
• PHP version: 8.2
• Database driver & version: 10.6.18-MariaDB-0ubuntu0.22.04.1 - Ubuntu 22.04
• Other Plugins:
  "clubstudioltd/craft-asset-rev": "^7.0",
  "craftcms/cms": "^4.0",
  "craftcms/contact-form": "^3.1.0",
  "craftcms/contact-form-honeypot": "^2.1.0",
  "craftcms/redactor": "^3.0",
  "ether/seo": "4.0.0",
  "la-haute-societe/craft-google-tag-manager": "^2.0",
  "nystudio107/craft-imageoptimize": "^4.0",
  "nystudio107/craft-minify": "^4.0",
  "nystudio107/craft-templatecomments": "^4.0",
  "topshelfcraft/environment-label": "^4.0",
  "verbb/navigation": "^2.0",
  "verbb/super-table": "^3.0",
  "vlucas/phpdotenv": "5.4.0",
  "wbrowar/craft-admin-bar": "^3.0.3",
  "wrav/oembed": "^3.1.1"

[timstrawbridge]

I wouldn't absolutely rely on this but what if you change the access modifier on the method "dropCheck" to public instead of it being protected?

[gmonseur]

Hi @timstrawbridge

Thanks for your help :)

Yes, if I pass the method in public, I get this error :

*** applying m201207_124200_add_product_types_to_sitemap
PHP Compile Error 'yii\base\ErrorException' with message 'Declaration of ether\seo\migrations\m201207_124200_add_product_types_to_sitemap::dropCheck() must be compatible with yii\db\Migration::dropCheck($name, $table)'

in /media/DATA/www/.../vendor/ether/seo/src/migrations/m201207_124200_add_product_types_to_sitemap.php:39

Stack trace:
#0 [internal function]: yii\base\ErrorHandler->handleFatalError()
#1 {main}
Script @php craft migrate/all handling the post-install-cmd event returned with error code 1

This method exists in the parent class with the required parameters. I don't understand.
vendor/yiisoft/yii2/db/Migration.php (line 544)

    /**
     * Creates a SQL command for dropping a check constraint.
     * @param string $name the name of the check constraint to be dropped.
     * The name will be properly quoted by the method.
     * @param string $table the table whose check constraint is to be dropped.
     * The name will be properly quoted by the method.
     */
    public function dropCheck($name, $table)
    {
        $time = $this->beginCommand("drop check $name in table $table");
        $this->db->createCommand()->dropCheck($name, $table)->execute();
        $this->endCommand($time);
    }

[gmonseur]

Does anyone have any ideas on how I can continue upgrading? :)

[sydneyhaggard]

@gmonseur My team ended up running into this same issue. We had to get into the m201207_124200_add_product_types_to_sitemap.php file and made it compatible with the Yii dropCheck function by adding the needed parameters and adjusting the function calls to use those parameters.

So our m201207_124200_add_product_types_to_sitemap.php file ended up looking like:

<?php

namespace ether\seo\migrations;

use Craft;
use craft\db\Migration;
use ether\seo\records\SitemapRecord;

/**
 * m201207_124200_add_product_types_to_sitemap migration.
 */
class m201207_124200_add_product_types_to_sitemap extends Migration
{
	/**
	 * @inheritdoc
	 */
	public function safeUp()
	{
		$this->dropCheck('seo_sitemap_group_check', SitemapRecord::$tableName);
		$this->alterColumn(SitemapRecord::$tableName, 'group', $this->enum('group', [
			'sections', 'categories', 'productTypes', 'customUrls',
		])->notNull());
	}

	/**
	 * @inheritdoc
	 */
	public function safeDown()
	{
		$this->dropCheck('seo_sitemap_group_check', SitemapRecord::$tableName);
		$this->alterColumn(SitemapRecord::$tableName, $this->enum('group', [
			'sections', 'categories', 'customUrls',
		])->notNull());
	}

	/**
	 * Drop group check.
	 */
	protected function dropCheck($name, $table)
	{
		if ($this->db->getIsMysql())
			return;

		$this->db->createCommand($name, $table)->dropCheck()->execute();
	}
}

Running the updated migration with a fresh database fixed the issue.