Skip to content
This repository was archived by the owner on Feb 5, 2024. It is now read-only.

Add method bulkGet #91

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add method bulkGet #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8ce1f13
add method bulkGet references _bulk_get
Jan 27, 2020
d7d8c6d
Description bulkGet method
Jan 27, 2020
e4918e8
Code formatting suggestion accepted
sidneycorreia Jan 28, 2020
41957d6
Mudando nome do projeto
Jan 28, 2020
4e5a854
Mudando nome do projeto
Jan 28, 2020
1e9e97c
Add testBulkGet and fix testFindDocuments
Jan 28, 2020
79233f4
Apply suggestions from code review
sidneycorreia Jan 28, 2020
295ca0a
Update tests/Doctrine/Tests/CouchDB/Functional/CouchDBClientTest.php
sidneycorreia Jan 28, 2020
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
27 changes: 27 additions & 0 deletions lib/Doctrine/CouchDB/CouchDBClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,33 @@ public function ensureFullCommit()
throw HTTPException::fromResponse($path, $response);
}

return $response->body;
}

/**
* Bulk get.
*
* @param array<int, array<string, string>> $docs
*
* @throws HTTPException
*
* @return array
Copy link
Member

@greg0ire greg0ire Jan 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

The body of the response is an array? What type are the elements in the array exactly?

Copy link
Author

Choose a reason for hiding this comment

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

As described on www.com.behttps://docs.couchdb.org/en/stable/api/database/bulk-api.html#db-bulk-get

Copy link
Member

Choose a reason for hiding this comment

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

Your link is broken

Copy link
Author

Choose a reason for hiding this comment

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

https://docs.couchdb.org/en/stable/api/database/bulk-api.html#db-bulk-get

Copy link
Member

Choose a reason for hiding this comment

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

Ok so it should also be

Suggested change
* @return array
* @return array<int, array<string, string>>

correct?

*/
public function bulkGet(array $docs = [])
Copy link
Member

@greg0ire greg0ire Jan 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Can we add a return type declaration here?

Copy link
Author

@sidneycorreia sidneycorreia Jan 29, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I think this return type is too complex for method documentation. We can add a link to method's official documentation http://docs.couchdb.org/en/2.2.0/api/database/bulk-api.html#db-bulk-get

Copy link
Member

Choose a reason for hiding this comment

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

Does it return other PHP types than array like the previous return annotation suggests?

Copy link
Member

Choose a reason for hiding this comment

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

I was suggesting this

Suggested change
public function bulkGet(array $docs = [])
public function bulkGet(array $docs = []): array

{
$path = '/'.$this->databaseName.'/_bulk_get';

$response = $this->httpClient->request(
'POST',
'/'.$this->databaseName.'/_bulk_get',
json_encode(['docs' => $docs])
);

if ($response->status != 200) {
throw HTTPException::fromResponse($path, $response);
}


return $response->body;
}
}
62 changes: 56 additions & 6 deletions tests/Doctrine/Tests/CouchDB/Functional/CouchDBClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,20 +393,21 @@ public function testFindDocuments()
}

$response = $client->findDocuments($ids);

$this->assertEquals(['total_rows' => 3, 'rows' => $expectedRows], $response->body);
// print_r(['total_rows' => 3, 'offset' => null, 'rows' => $expectedRows]);
// print_r($response->body);
$this->assertEquals(['total_rows' => 3, 'offset' => null, 'rows' => $expectedRows], $response->body);

$response = $client->findDocuments($ids, 0);
$this->assertEquals(['total_rows' => 3, 'rows' => $expectedRows], $response->body);
$this->assertEquals(['total_rows' => 3, 'offset' => null, 'rows' => $expectedRows], $response->body);

$response = $client->findDocuments($ids, 1);
$this->assertEquals(['total_rows' => 3, 'rows' => [$expectedRows[0]]], $response->body);
$this->assertEquals(['total_rows' => 3, 'offset' => null, 'rows' => [$expectedRows[0]]], $response->body);

$response = $client->findDocuments($ids, 0, 2);
$this->assertEquals(['total_rows' => 3, 'rows' => [$expectedRows[2]]], $response->body);
$this->assertEquals(['total_rows' => 3, 'offset' => null, 'rows' => [$expectedRows[2]]], $response->body);

$response = $client->findDocuments($ids, 1, 1);
$this->assertEquals(['total_rows' => 3, 'rows' => [$expectedRows[1]]], $response->body);
$this->assertEquals(['total_rows' => 3, 'offset' => null, 'rows' => [$expectedRows[1]]], $response->body);
}

public function testAllDocs()
Expand Down Expand Up @@ -683,4 +684,53 @@ public function testEncodeQueryParamsCorrectly()

$this->assertEquals(0, $result->getTotalRows());
}


public function testBulkGet(): void
{
$client = $this->couchClient;


$docs = [];
$expectedRows = [];
foreach (range(1, 3) as $i) {
list($id, $rev) = $client->postDocument(['foo' => 'bar'.$i]);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
list($id, $rev) = $client->postDocument(['foo' => 'bar'.$i]);
[$id, $rev] = $client->postDocument(['foo' => 'bar'.$i]);

Copy link
Member

Choose a reason for hiding this comment

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

The composer constraint is currently "php": ">=5.4", but I assume we are going to have at least 7.2 soon.

$docs[] = [
'id' => $id,
'rev' => $rev
];

$ids[] = $id;

$expectedRows[] = [
'id' => $id,
'docs' => [
['ok' => [
'_id' => $id,
'_rev' => $rev,
'foo' => 'bar'.$i,
]]
]
];
}


$bulkGet = $client->bulkGet($docs);
$this->assertEquals(['results' => $expectedRows], $bulkGet);

$bulkGetNonexistent = $client->bulkGet([['id' => 'nonexistent-id']]);
$expectedRowsWhenNonexistent[] = [
'id' => 'nonexistent-id',
'docs' => [
['error' => [
'id' => 'nonexistent-id',
'rev' => 'undefined',
'error' => 'not_found',
'reason' => 'missing',
]]
]
];

$this->assertEquals(['results' => $expectedRowsWhenNonexistent], $bulkGetNonexistent);
}
}