Skip to content

fix: [SQLite3] Forge::modifyColumn() messes up table #8457

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

Merged
merged 7 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 20 additions & 1 deletion system/Database/SQLite3/Forge.php
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,28 @@ protected function _alterTable(string $alterType, string $table, $processedField
return ''; // Why empty string?

case 'CHANGE':
$fieldsToModify = [];

foreach ($processedFields as $processedField) {
$name = $processedField['name'];
$newName = $processedField['new_name'];

$field = $this->fields[$name];
$field['name'] = $name;
$field['new_name'] = $newName;

// Unlike when creating a table, if `null` is not specified,
// the column will be `NULL`, not `NOT NULL`.
if ($processedField['null'] === '') {
$field['null'] = true;
}

$fieldsToModify[] = $field;
}

(new Table($this->db, $this))
->fromTable($table)
->modifyColumn($processedFields) // @TODO Bug: should be NOT processed fields
->modifyColumn($fieldsToModify)
->run();

return null; // Why null?
Expand Down
42 changes: 42 additions & 0 deletions system/Database/SQLite3/Table.php
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,24 @@ protected function formatFields($fields)
'null' => $field->nullable,
];

if ($field->default === null) {
// `null` means that the default value is not defined.
unset($return[$field->name]['default']);
} elseif ($field->default === 'NULL') {
// 'NULL' means that the default value is NULL.
$return[$field->name]['default'] = null;
} else {
$default = trim($field->default, "'");

if ($this->isIntegerType($field->type)) {
$default = (int) $default;
} elseif ($this->isNumericType($field->type)) {
$default = (float) $default;
}

$return[$field->name]['default'] = $default;
}

if ($field->primary_key) {
$this->keys['primary'] = [
'fields' => [$field->name],
Expand All @@ -403,6 +421,30 @@ protected function formatFields($fields)
return $return;
}

/**
* Is INTEGER type?
*
* @param string $type SQLite data type (case-insensitive)
*
* @see https://www.sqlite.org/datatype3.html
*/
private function isIntegerType(string $type): bool
{
return strpos(strtoupper($type), 'INT') !== false;
}

/**
* Is NUMERIC type?
*
* @param string $type SQLite data type (case-insensitive)
*
* @see https://www.sqlite.org/datatype3.html
*/
private function isNumericType(string $type): bool
{
return in_array(strtoupper($type), ['NUMERIC', 'DECIMAL'], true);
}

/**
* Converts keys retrieved from the database to
* the format needed to create later.
Expand Down
28 changes: 26 additions & 2 deletions tests/system/Database/Live/ForgeTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1289,8 +1289,18 @@ public function testModifyColumnRename(): void
'unsigned' => false,
'auto_increment' => true,
],
'int' => [
'type' => 'INT',
'constraint' => 10,
'null' => false,
],
'varchar' => [
'type' => 'VARCHAR',
'constraint' => 7,
'null' => false,
],
'name' => [
'type' => 'varchar',
'type' => 'VARCHAR',
'constraint' => 255,
'null' => true,
],
Expand All @@ -1304,17 +1314,31 @@ public function testModifyColumnRename(): void
$this->forge->modifyColumn('forge_test_three', [
'name' => [
'name' => 'altered',
'type' => 'varchar',
'type' => 'VARCHAR',
'constraint' => 255,
'null' => true,
],
]);

$this->db->resetDataCache();

$fieldData = $this->db->getFieldData('forge_test_three');
$fields = [];

foreach ($fieldData as $obj) {
$fields[$obj->name] = $obj;
}

$this->assertFalse($this->db->fieldExists('name', 'forge_test_three'));
$this->assertTrue($this->db->fieldExists('altered', 'forge_test_three'));

$this->assertTrue($fields['altered']->nullable);
$this->assertFalse($fields['int']->nullable);
$this->assertFalse($fields['varchar']->nullable);
$this->assertNull($fields['altered']->default);
$this->assertNull($fields['int']->default);
$this->assertNull($fields['varchar']->default);

$this->forge->dropTable('forge_test_three', true);
}

Expand Down
6 changes: 3 additions & 3 deletions tests/system/Database/Live/SQLite3/AlterTableTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,17 @@ public function testFromTableFillsDetails(): void

$this->assertCount(5, $fields);
$this->assertArrayHasKey('id', $fields);
$this->assertNull($fields['id']['default']);
$this->assertArrayNotHasKey('default', $fields['id']);
$this->assertTrue($fields['id']['null']);
$this->assertSame('integer', strtolower($fields['id']['type']));

$this->assertArrayHasKey('name', $fields);
$this->assertNull($fields['name']['default']);
$this->assertArrayNotHasKey('default', $fields['name']);
$this->assertFalse($fields['name']['null']);
$this->assertSame('varchar', strtolower($fields['name']['type']));

$this->assertArrayHasKey('email', $fields);
$this->assertNull($fields['email']['default']);
$this->assertArrayNotHasKey('default', $fields['email']);
$this->assertTrue($fields['email']['null']);
$this->assertSame('varchar', strtolower($fields['email']['type']));

Expand Down
115 changes: 115 additions & 0 deletions tests/system/Database/Live/SQLite3/ForgeModifyColumnTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Database\Live\SQLite3;

use CodeIgniter\Database\Forge;
use CodeIgniter\Test\CIUnitTestCase;
use Config\Database;

/**
* @group DatabaseLive
*
* @internal
*/
final class ForgeModifyColumnTest extends CIUnitTestCase
{
private Forge $forge;

protected function setUp(): void
{
parent::setUp();

$this->db = Database::connect($this->DBGroup);

if ($this->db->DBDriver !== 'SQLite3') {
$this->markTestSkipped('This test is only for SQLite3.');
}

$this->forge = Database::forge($this->DBGroup);
}

public function testModifyColumnRename(): void
{
$table = 'forge_test_three';

$this->forge->dropTable($table, true);

$this->forge->addField([
'id' => [
'type' => 'INTEGER',
'constraint' => 11,
'auto_increment' => true,
],
'int' => [
'type' => 'INT',
'constraint' => 10,
'null' => false,
'default' => 0,
],
'varchar' => [
'type' => 'VARCHAR',
'constraint' => 7,
'null' => false,
],
'decimal' => [
'type' => 'DECIMAL',
'constraint' => '10,5',
'default' => 0.1,
],
'name' => [
'type' => 'VARCHAR',
'constraint' => 255,
'null' => true,
],
]);

$this->forge->addKey('id', true);
$this->forge->createTable($table);

$this->assertTrue($this->db->fieldExists('name', $table));

$this->forge->modifyColumn($table, [
'name' => [
'name' => 'altered',
'type' => 'VARCHAR',
'constraint' => 255,
'null' => true,
],
]);

$this->db->resetDataCache();

$fieldData = $this->db->getFieldData($table);
$fields = [];

foreach ($fieldData as $obj) {
$fields[$obj->name] = $obj;
}

$this->assertFalse($this->db->fieldExists('name', $table));
$this->assertTrue($this->db->fieldExists('altered', $table));

$this->assertFalse($fields['int']->nullable);
$this->assertSame('0', $fields['int']->default);

$this->assertFalse($fields['varchar']->nullable);
$this->assertNull($fields['varchar']->default);

$this->assertFalse($fields['decimal']->nullable);
$this->assertSame('0.1', $fields['decimal']->default);

$this->assertTrue($fields['altered']->nullable);
$this->assertNull($fields['altered']->default);

$this->forge->dropTable($table, true);
}
}