Skip to content

Commit

Permalink
[6.x] Port whereKey fix and bugfix for null type (#34031)
Browse files Browse the repository at this point in the history 
* [7.x] Cast primary key to string when $keyType is string (#33930)

* Cast primary key to string when $keyType is string

* fix test

* fix remaining tests

* Fix bug with whereKey null

Co-authored-by: Steve Thomas <steve@codinglabs.io>
  • Loading branch information
@driesvints @stevethomas
driesvints and stevethomas committed Aug 27, 2020
1 parent 0eb542d commit f4f9ac1
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 2 deletions.
8 changes: 8 additions & 0 deletions src/Illuminate/Database/Eloquent/Builder.php
View file
Expand Up @@ -193,6 +193,10 @@ public function whereKey($id)
return $this;
}

if ($id !== null && $this->model->getKeyType() === 'string') {
$id = (string) $id;
}

return $this->where($this->model->getQualifiedKeyName(), '=', $id);
}

Expand All @@ -210,6 +214,10 @@ public function whereKeyNot($id)
return $this;
}

if ($id !== null && $this->model->getKeyType() === 'string') {
$id = (string) $id;
}

return $this->where($this->model->getQualifiedKeyName(), '!=', $id);
}

Expand Down
75 changes: 73 additions & 2 deletions tests/Database/DatabaseEloquentBuilderTest.php
View file
Expand Up @@ -31,7 +31,9 @@ protected function tearDown(): void
public function testFindMethod()
{
$builder = m::mock(Builder::class.'[first]', [$this->getMockQueryBuilder()]);
$builder->setModel($this->getMockModel());
$model = $this->getMockModel();
$builder->setModel($model);
$model->shouldReceive('getKeyType')->once()->andReturn('int');
$builder->getQuery()->shouldReceive('where')->once()->with('foo_table.foo', '=', 'bar');
$builder->shouldReceive('first')->with(['column'])->andReturn('baz');

Expand Down Expand Up @@ -76,6 +78,7 @@ public function testFindManyMethod()
public function testFindOrNewMethodModelFound()
{
$model = $this->getMockModel();
$model->shouldReceive('getKeyType')->once()->andReturn('int');
$model->shouldReceive('findOrNew')->once()->andReturn('baz');

$builder = m::mock(Builder::class.'[first]', [$this->getMockQueryBuilder()]);
Expand All @@ -91,6 +94,7 @@ public function testFindOrNewMethodModelFound()
public function testFindOrNewMethodModelNotFound()
{
$model = $this->getMockModel();
$model->shouldReceive('getKeyType')->once()->andReturn('int');
$model->shouldReceive('findOrNew')->once()->andReturn(m::mock(Model::class));

$builder = m::mock(Builder::class.'[first]', [$this->getMockQueryBuilder()]);
Expand All @@ -109,7 +113,9 @@ public function testFindOrFailMethodThrowsModelNotFoundException()
$this->expectException(ModelNotFoundException::class);

$builder = m::mock(Builder::class.'[first]', [$this->getMockQueryBuilder()]);
$builder->setModel($this->getMockModel());
$model = $this->getMockModel();
$model->shouldReceive('getKeyType')->once()->andReturn('int');
$builder->setModel($model);
$builder->getQuery()->shouldReceive('where')->once()->with('foo_table.foo', '=', 'bar');
$builder->shouldReceive('first')->with(['column'])->andReturn(null);
$builder->findOrFail('bar', ['column']);
Expand Down Expand Up @@ -1017,11 +1023,39 @@ public function testWhereKeyMethodWithInt()

$int = 1;

$model->shouldReceive('getKeyType')->once()->andReturn('int');
$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '=', $int);

$builder->whereKey($int);
}

public function testWhereKeyMethodWithStringZero()
{
$model = new EloquentBuilderTestStubStringPrimaryKey();
$builder = $this->getBuilder()->setModel($model);
$keyName = $model->getQualifiedKeyName();

$int = 0;

$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '=', (string) $int);

$builder->whereKey($int);
}

/** @group Foo */
public function testWhereKeyMethodWithStringNull()
{
$model = new EloquentBuilderTestStubStringPrimaryKey();
$builder = $this->getBuilder()->setModel($model);
$keyName = $model->getQualifiedKeyName();

$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '=', m::on(function ($argument) {
return $argument === null;
}));

$builder->whereKey(null);
}

public function testWhereKeyMethodWithArray()
{
$model = $this->getMockModel();
Expand All @@ -1048,6 +1082,33 @@ public function testWhereKeyMethodWithCollection()
$builder->whereKey($collection);
}

public function testWhereKeyNotMethodWithStringZero()
{
$model = new EloquentBuilderTestStubStringPrimaryKey();
$builder = $this->getBuilder()->setModel($model);
$keyName = $model->getQualifiedKeyName();

$int = 0;

$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '!=', (string) $int);

$builder->whereKeyNot($int);
}

/** @group Foo */
public function testWhereKeyNotMethodWithStringNull()
{
$model = new EloquentBuilderTestStubStringPrimaryKey();
$builder = $this->getBuilder()->setModel($model);
$keyName = $model->getQualifiedKeyName();

$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '!=', m::on(function ($argument) {
return $argument === null;
}));

$builder->whereKeyNot(null);
}

public function testWhereKeyNotMethodWithInt()
{
$model = $this->getMockModel();
Expand All @@ -1056,6 +1117,7 @@ public function testWhereKeyNotMethodWithInt()

$int = 1;

$model->shouldReceive('getKeyType')->once()->andReturn('int');
$builder->getQuery()->shouldReceive('where')->once()->with($keyName, '!=', $int);

$builder->whereKeyNot($int);
Expand Down Expand Up @@ -1414,3 +1476,12 @@ class EloquentBuilderTestStubWithoutTimestamp extends Model

protected $table = 'table';
}

class EloquentBuilderTestStubStringPrimaryKey extends Model
{
public $incrementing = false;

protected $table = 'foo_table';

protected $keyType = 'string';
}

0 comments on commit f4f9ac1

Please sign in to comment.