Skip to content

fix: [Postgres] reset binds when replace() method is called multiple times in the context #6728

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 2 commits into from
Oct 22, 2022
Merged

fix: [Postgres] reset binds when replace() method is called multiple times in the context #6728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e558e8
fix: reset binds when replace() method is called multiple times in th…
michalsn Oct 20, 2022
9f0fd7e
add a reference to the issue in the test [ci skip]
michalsn Oct 21, 2022
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
1 change: 1 addition & 0 deletions system/Database/Postgre/Builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ public function replace(?array $set = null)

unset($builder);
$this->resetWrite();
$this->binds = [];

return $result;
}
Expand Down
32 changes: 32 additions & 0 deletions tests/system/Database/Live/InsertTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,38 @@ public function testReplaceWithMatchingData()
$this->assertSame('Cab Driver', $row->name);
}

/**
* @see https://github.com/codeigniter4/CodeIgniter4/issues/6726
*/
public function testReplaceTwice()
{
Copy link
Member

@sclubricants sclubricants Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we consolidate this test with testReplaceWithNoMatchingData() and testReplaceWithMatchingData()?

It seems all three tests could be accomplished in a single test.

Copy link
Member

@kenjis kenjis Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree. It is bad practice.

testReplaceWithNoMatchingData() is test for replace with no matching data.
testReplaceWithMatchingData() is test for replace with matching data.
testReplaceTwice() is test for replace twice.
They all differ in the intent of the test.

Copy link
Member

@sclubricants sclubricants Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If replace works twice then it also works once.

testReplaceWithMatchingData() is test for replace with matching data.

Not sure what this is testing. It really doesn't matter if there is matching data or not. Whatever data is there is deleted and whatever is defined is replaced. Its not like it senses no changes and leaves it alone. If it works with mismatched data then is works without it.

I think we need to keep tests minimized where possible so that we don't have an hour of tests to run everytime. Yes they should be thorough though.

Copy link
Member Author

@michalsn michalsn Oct 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You both have a good point.

I think we are used to making tests based on the behavior of the methods. In addition, if there is a bug, we always make a separate test for it (it's some sort of a rule).

Even if merging everything into one test would save us 1 sec, I am not sure if it would be worth it in the long run. Readability of tests is important - we should not test 3 different things in one test.

I added a reference to the issue above the test and I'm gonna leave it as it is.

Copy link
Member

@kenjis kenjis Oct 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, slow tests are surely another issue.

Not sure what this is testing. It really doesn't matter if there is matching data or not.

From a testing perspective, it really matters.
If you don't have the test, a needed test case is missing.

Whatever data is there is deleted and whatever is defined is replaced.

We test to see if these data can really be replaced.
All those cases (with matching data or without matching data) should be tested.

If replace works twice then it also works once.

It probably does, but not for sure. It depends on the production code.
But in this case, I also believe it does.

$builder = $this->db->table('job');

$data = [
'id' => 1,
'name' => 'John Smith',
'description' => 'American',
];
$builder->replace($data);

$row = $this->db->table('job')
->getwhere(['id' => 1])
->getRow();
$this->assertSame('John Smith', $row->name);

$data = [
'id' => 2,
'name' => 'Hans Schmidt',
'description' => 'German',
];
$builder->replace($data);

$row = $this->db->table('job')
->getwhere(['id' => 2])
->getRow();
$this->assertSame('Hans Schmidt', $row->name);
}

public function testBug302()
{
$code = "my code \\'CodeIgniter\\Autoloader\\'";
Expand Down
1 change: 1 addition & 0 deletions user_guide_src/source/changelogs/v4.2.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ Bugs Fixed
**********

- Fixed a bug when the ``CodeIgniter\HTTP\IncomingRequest::getPostGet()`` and ``CodeIgniter\HTTP\IncomingRequest::getGetPost()`` methods didn't return values from the other stream when ``index`` was set to ``null``.
- Fixed a bug when ``binds`` weren't cleaned properly when calling ``CodeIgniter\Database\Postgre::replace()`` multiple times in the context.

See the repo's `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_ for a complete list of bugs fixed.