Skip to content

[OP#41127] filter work packages by storage and sort by status #88

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
individual-it merged 4 commits into from
Mar 31, 2022
Merged

[OP#41127] filter work packages by storage and sort by status #88

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
b0835da
[OP#41127] filter work packages by status and storage
individual-it Mar 22, 2022
3627f36
urlencode storage url
individual-it Mar 28, 2022
b25477b
don't filter by status, but sort by status
individual-it Mar 29, 2022
536fe82
fix codestyle
individual-it Mar 30, 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
3 changes: 2 additions & 1 deletion lib/Controller/OpenProjectAPIController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ public function getSearchedWorkPackages(?string $searchQuery = null, ?int $fileI
$result = $this->openprojectAPIService->searchWorkPackage(
$this->userId,
$searchQuery,
$fileId
$fileId,
$this->urlGenerator->getBaseUrl()
);

if (!isset($result['error'])) {
Expand Down
25 changes: 20 additions & 5 deletions lib/Service/OpenProjectAPIService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,26 @@ public function getNotifications(
* @param string $userId
* @param string|null $query
* @param int|null $fileId
* @param string|null $storageUrl
* @param int $offset
* @param int $limit
* @return array<mixed>
* @throws \OCP\PreConditionNotMetException
* @throws \Safe\Exceptions\JsonException
*/
public function searchWorkPackage(
string $userId, string $query = null, int $fileId = null, int $offset = 0, int $limit = 5
string $userId,
string $query = null,
int $fileId = null,
string $storageUrl = null,
int $offset = 0,
int $limit = 5
): array {
$linkableStorageFilter = [
'linkable_to_storage_url' =>
['operator' => '=', 'values' => [urlencode($storageUrl)]]
];
$sortBy = [['status', 'asc'],['updatedAt', 'desc']];
$resultsById = [];
$filters = [];

Expand All @@ -254,11 +265,13 @@ public function searchWorkPackage(
}
if ($query !== null) {
$filters[] = ['description' => ['operator' => '~', 'values' => [$query]]];
$filters[] = ['status' => ['operator' => '!', 'values' => ['14']]];
if ($storageUrl !== null) {
$filters[] = $linkableStorageFilter;
}
}
$params = [
'filters' => \Safe\json_encode($filters),
'sortBy' => '[["updatedAt", "desc"]]',
'sortBy' => \Safe\json_encode($sortBy),
// 'limit' => $limit,
];
$searchDescResult = $this->request($userId, 'work_packages', $params);
Expand All @@ -276,11 +289,13 @@ public function searchWorkPackage(
if ($query !== null) {
$filters = [
['subject' => ['operator' => '~', 'values' => [$query]]],
['status' => ['operator' => '!', 'values' => ['14']]]
];
if ($storageUrl !== null) {
$filters[] = $linkableStorageFilter;
}
$params = [
'filters' => \Safe\json_encode($filters),
'sortBy' => '[["updatedAt", "desc"]]',
'sortBy' => \Safe\json_encode($sortBy),
// 'limit' => $limit,
];
$searchSubjectResult = $this->request($userId, 'work_packages', $params);
Expand Down
67 changes: 58 additions & 9 deletions tests/lib/Service/OpenProjectAPIServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,15 +333,15 @@ public function testSearchWorkPackageOnlyQueryDescAndSubjectResponse(
[
'user', 'work_packages',
[
'filters' => '[{"description":{"operator":"~","values":["search query"]}},{"status":{"operator":"!","values":["14"]}}]',
'sortBy' => '[["updatedAt", "desc"]]',
'filters' => '[{"description":{"operator":"~","values":["search query"]}}]',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
],
[
'user', 'work_packages',
[
'filters' => '[{"subject":{"operator":"~","values":["search query"]}},{"status":{"operator":"!","values":["14"]}}]',
'sortBy' => '[["updatedAt", "desc"]]',
'filters' => '[{"subject":{"operator":"~","values":["search query"]}}]',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
]
)
Expand All @@ -353,6 +353,55 @@ public function testSearchWorkPackageOnlyQueryDescAndSubjectResponse(
$this->assertSame($expectedResult, $result);
}

/**
* @param array<mixed> $descriptionResponse
* @param array<mixed> $subjectResponse
* @param array<mixed> $expectedResult
* @return void
* @dataProvider searchWorkPackageDataProvider
*/
public function testSearchWorkPackageQueryAndStorage(
array $descriptionResponse, array $subjectResponse, array $expectedResult
) {
$service = $this->getServiceMock();
$service->method('request')
->withConsecutive(
[
'user', 'work_packages',
[
'filters' => '[' .
'{"description":' .
'{"operator":"~","values":["search query"]}'.
'},'.
'{"linkable_to_storage_url":'.
'{"operator":"=","values":["https%3A%2F%2Fnc.my-server.org"]}}'.
']',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
],
[
'user', 'work_packages',
[
'filters' => '[' .
'{"subject":' .
'{"operator":"~","values":["search query"]}'.
'},'.
'{"linkable_to_storage_url":'.
'{"operator":"=","values":["https%3A%2F%2Fnc.my-server.org"]}}'.
']',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
]
)
->willReturnOnConsecutiveCalls(
$descriptionResponse,
$subjectResponse
);
$result = $service->searchWorkPackage(
'user', 'search query', null, 'https://nc.my-server.org'
);
$this->assertSame($expectedResult, $result);
}
/**
* @return void
*/
Expand All @@ -364,7 +413,7 @@ public function testSearchWorkPackageByFileIdOnlyFileId() {
'user', 'work_packages',
[
'filters' => '[{"file_link_origin_id":{"operator":"=","values":["123"]}}]',
'sortBy' => '[["updatedAt", "desc"]]',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
],
)
Expand All @@ -385,15 +434,15 @@ public function testSearchWorkPackageByFileIdQueryAndFileId() {
[
'user', 'work_packages',
[
'filters' => '[{"file_link_origin_id":{"operator":"=","values":["123"]}},{"description":{"operator":"~","values":["search query"]}},{"status":{"operator":"!","values":["14"]}}]',
'sortBy' => '[["updatedAt", "desc"]]',
'filters' => '[{"file_link_origin_id":{"operator":"=","values":["123"]}},{"description":{"operator":"~","values":["search query"]}}]',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
],
[
'user', 'work_packages',
[
'filters' => '[{"subject":{"operator":"~","values":["search query"]}},{"status":{"operator":"!","values":["14"]}}]',
'sortBy' => '[["updatedAt", "desc"]]',
'filters' => '[{"subject":{"operator":"~","values":["search query"]}}]',
'sortBy' => '[["status","asc"],["updatedAt","desc"]]',
]
]
)
Expand Down