Skip to content

fix: migrations not using custom DB connection of migration runner #8221

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

Merged
merged 4 commits into from
Dec 13, 2023
Merged

fix: migrations not using custom DB connection of migration runner #8221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd6e076
Add failing test
paulbalandan Nov 15, 2023
1879418
Add fix
paulbalandan Nov 15, 2023
dd920cc
Fix setting of group
paulbalandan Nov 19, 2023
42fe160
Change priority order of migration's db group
paulbalandan Dec 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions phpstan-baseline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,11 +1146,6 @@
'count' => 1,
'path' => __DIR__ . '/system/Database/Migration.php',
];
$ignoreErrors[] = [
'message' => '#^Property CodeIgniter\\\\Database\\\\Migration\\:\\:\\$DBGroup \\(string\\) on left side of \\?\\? is not nullable\\.$#',
'count' => 1,
'path' => __DIR__ . '/system/Database/Migration.php',
];
$ignoreErrors[] = [
'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
'count' => 8,
Expand Down
13 changes: 8 additions & 5 deletions system/Database/Migration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ abstract class Migration
/**
* The name of the database group to use.
*
* @var string
* @var string|null
*/
protected $DBGroup;

Expand All @@ -39,12 +39,15 @@ abstract class Migration
*/
protected $forge;

/**
* Constructor.
*/
public function __construct(?Forge $forge = null)
{
$this->forge = $forge ?? Database::forge($this->DBGroup ?? config(Database::class)->defaultGroup);
if (isset($this->DBGroup)) {
$this->forge = Database::forge($this->DBGroup);
} elseif ($forge !== null) {
$this->forge = $forge;
} else {
$this->forge = Database::forge(config(Database::class)->defaultGroup);
}

$this->db = $this->forge->getConnection();
}
Expand Down
17 changes: 6 additions & 11 deletions system/Database/MigrationRunner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,16 +135,12 @@ public function __construct(MigrationsConfig $config, $db = null)
$this->enabled = $config->enabled ?? false;
$this->table = $config->table ?? 'migrations';

// Default name space is the app namespace
$this->namespace = APP_NAMESPACE;

// get default database group
$config = config(Database::class);
$this->group = $config->defaultGroup;
unset($config);
// Even if a DB connection is passed, since it is a test,
// it is assumed to use the default group name
$this->group = is_string($db) ? $db : config(Database::class)->defaultGroup;

// If no db connection passed in, use
// default database group.
$this->db = db_connect($db);
}

Expand Down Expand Up @@ -836,8 +832,9 @@ protected function migrate($direction, $migration): bool
throw new RuntimeException($message);
}

$instance = new $class();
$group = $instance->getDBGroup() ?? config(Database::class)->defaultGroup;
/** @var Migration $instance */
$instance = new $class(Database::forge($this->db));
$group = $instance->getDBGroup() ?? $this->group;

if (ENVIRONMENT !== 'testing' && $group === 'tests' && $this->groupFilter !== 'tests') {
// @codeCoverageIgnoreStart
Expand All @@ -853,8 +850,6 @@ protected function migrate($direction, $migration): bool
return true;
}

$this->setGroup($group);

if (! is_callable([$instance, $direction])) {
$message = sprintf(lang('Migrations.missingMethod'), $direction);

Expand Down
30 changes: 26 additions & 4 deletions tests/system/Database/Migrations/MigrationRunnerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
namespace CodeIgniter\Database\Migrations;

use CodeIgniter\Database\BaseConnection;
use CodeIgniter\Database\Config;
use CodeIgniter\Database\MigrationRunner;
use CodeIgniter\Events\Events;
use CodeIgniter\Exceptions\ConfigException;
Expand Down Expand Up @@ -454,11 +453,34 @@ public function testGetBatchVersions(): void
$this->assertSame('2018-01-24-102302', $runner->getBatchEnd(1));
}

protected function resetTables(): void
public function testMigrationUsesSameConnectionAsMigrationRunner(): void
{
$forge = Config::forge();
$config = ['database' => WRITEPATH . 'runner.sqlite', 'DBDriver' => 'SQLite3', 'DBDebug' => true];

foreach (db_connect()->listTables() as $table) {
$database = Database::connect($config, false);
$this->resetTables($database);

$runner = new MigrationRunner(config(Migrations::class), $database);
$runner->clearCliMessages();
$runner->clearHistory();
$runner->setNamespace('Tests\Support\MigrationTestMigrations');
$runner->latest();

$tables = $database->listTables();
$this->assertCount(2, $tables);
$this->assertSame('migrations', $tables[0]);
$this->assertSame('foo', $tables[1]);
}

protected function resetTables($db = null): void
{
$forge = Database::forge($db);

/** @var BaseConnection $conn */
$conn = $forge->getConnection();
$conn->resetDataCache();

foreach (db_connect($db)->listTables() as $table) {
$table = str_replace('db_', '', $table);
$forge->dropTable($table, true);
}
Expand Down