mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-12-31 20:08:40 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #7588 from KevinSJ/feat/filter-by-http-status

Browse source 
Add http_status filter to /api/entries
This commit is contained in:
Jérémy Benoist 2024-09-06 09:34:34 +02:00 committed by GitHub
commit 1b8960edc4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 94 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
fixtures/EntryFixtures.php
View file

@ -87,6 +87,17 @@ class EntryFixtures extends Fixture implements DependentFixtureInterface
'tags' => ['bar-tag'],
'is_not_parsed' => true,
],
'entry7' => [
'user' => 'admin-user',
'url' => 'http://0.0.0.0/entry7',
'reading_time' => 12,
'domain' => 'redirect.io',
'mime' => 'text/html',
'title' => 'test title entry7',
'http_status' => '302',
'content' => 'This is redirect/o/',
'language' => 'de',
],
];
foreach ($entries as $reference => $item) {
@ -133,6 +144,10 @@ class EntryFixtures extends Fixture implements DependentFixtureInterface
$entry->setNotParsed($item['is_not_parsed']);
}
if (isset($item['http_status'])) {
$entry->setHttpStatus($item['http_status']);
}
$manager->persist($entry);
$this->addReference($reference, $entry);
}

16
src/Controller/Api/EntryRestController.php
View file

@ -280,6 +280,18 @@ class EntryRestController extends WallabagRestController
* example="example.com",
* )
* ),
* @OA\Parameter(
* name="http_status",
* in="query",
* description="filter entries with matching http status code",
* required=false,
* @OA\Schema(
* type="integer",
* minimum=100,
* maximum=527,
* example="200",
* )
* ),
* @OA\Response(
* response="200",
* description="Returned when successful"
@ -306,6 +318,7 @@ class EntryRestController extends WallabagRestController
$since = $request->query->get('since', 0);
$detail = strtolower($request->query->get('detail', 'full'));
$domainName = (null === $request->query->get('domain_name')) ? '' : (string) $request->query->get('domain_name');
$httpStatus = (!\array_key_exists((int) $request->query->get('http_status'), Response::$statusTexts)) ? null : (int) $request->query->get('http_status');
try {
/** @var Pagerfanta $pager */
@ -320,7 +333,8 @@ class EntryRestController extends WallabagRestController
$tags,
$detail,
$domainName,
$isNotParsed
$isNotParsed,
$httpStatus
);
} catch (\Exception $e) {
throw new BadRequestHttpException($e->getMessage());

7
src/Repository/EntryRepository.php
View file

@ -285,13 +285,14 @@ class EntryRepository extends ServiceEntityRepository
* @param string $tags
* @param string $detail 'metadata' or 'full'. Include content field if 'full'
* @param string $domainName
* @param int $httpStatus
* @param bool $isNotParsed
*
* @todo Breaking change: replace default detail=full by detail=metadata in a future version
*
* @return Pagerfanta
*/
public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full', $domainName = '', $isNotParsed = null)
public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full', $domainName = '', $isNotParsed = null, $httpStatus = null)
{
if (!\in_array(strtolower($detail), ['full', 'metadata'], true)) {
throw new \Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
@ -350,6 +351,10 @@ class EntryRepository extends ServiceEntityRepository
}
}
if (\is_int($httpStatus)) {
$qb->andWhere('e.httpStatus = :httpStatus')->setParameter('httpStatus', $httpStatus);
}
if (\is_string($domainName) && '' !== $domainName) {
$qb->andWhere('e.domainName = :domainName')->setParameter('domainName', $domainName);
}

2
tests/Command/ExportCommandTest.php
View file

@ -47,7 +47,7 @@ class ExportCommandTest extends WallabagTestCase
'username' => 'admin',
]);
$this->assertStringContainsString('Exporting 5 entrie(s) for user admin...', $tester->getDisplay());
$this->assertStringContainsString('Exporting 6 entrie(s) for user admin...', $tester->getDisplay());
$this->assertStringContainsString('Done', $tester->getDisplay());
$this->assertFileExists('admin-export.json');
}

45
tests/Controller/Api/EntryRestControllerTest.php
View file

@ -170,6 +170,50 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertSame('application/json', $this->client->getResponse()->headers->get('Content-Type'));
}
public function testGetEntriesByHttpStatusWithMatching()
{
$this->client->request('GET', '/api/entries?http_status=302');
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
$content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertGreaterThanOrEqual(1, \count($content));
$this->assertNotEmpty($content['_embedded']['items']);
$this->assertSame(1, $content['total']);
$this->assertSame(1, $content['page']);
$this->assertGreaterThanOrEqual(1, $content['pages']);
$this->assertSame('test title entry7', $content['_embedded']['items'][0]['title']);
$this->assertSame('302', $content['_embedded']['items'][0]['http_status']);
$this->assertSame('application/json', $this->client->getResponse()->headers->get('Content-Type'));
}
public function testGetEntriesByHttpStatusNoMatching()
{
$this->client->request('GET', '/api/entries?http_status=404');
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
$content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertGreaterThanOrEqual(1, \count($content));
$this->assertEmpty($content['_embedded']['items']);
$this->assertSame(0, $content['total']);
$this->assertSame(1, $content['page']);
$this->assertGreaterThanOrEqual(1, $content['pages']);
$this->assertSame('application/json', $this->client->getResponse()->headers->get('Content-Type'));
}
public function testGetEntriesWithBadHttpStatusParam()
{
$this->client->request('GET', '/api/entries?http_status=10000');
$this->assertSame(200, $this->client->getResponse()->getStatusCode());
}
public function testGetEntriesWithFullOptions()
{
$this->client->request('GET', '/api/entries', [
@ -183,6 +227,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
'since' => 1443274283,
'public' => 0,
'notParsed' => 0,
'http_status' => 200,
]);
$this->assertSame(200, $this->client->getResponse()->getStatusCode());

24
tests/Controller/EntryControllerTest.php
View file

@ -106,14 +106,14 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->request('GET', '/');
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
// Good URL
$client->request('GET', '/bookmarklet', ['url' => $this->url]);
$this->assertSame(302, $client->getResponse()->getStatusCode());
$client->followRedirect();
$crawler = $client->request('GET', '/');
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(6, $crawler->filter($this->entryDataTestAttribute));
$em = $client->getContainer()
->get(EntityManagerInterface::class);
@ -803,7 +803,7 @@ class EntryControllerTest extends WallabagTestCase
$client = $this->getTestClient();
$crawler = $client->request('GET', '/all/list');
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(6, $crawler->filter($this->entryDataTestAttribute));
$entry = new Entry($this->getLoggedInUser());
$entry->setUrl($this->url);
@ -812,7 +812,7 @@ class EntryControllerTest extends WallabagTestCase
$this->getEntityManager()->flush();
$crawler = $client->request('GET', '/all/list');
$this->assertCount(6, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(7, $crawler->filter($this->entryDataTestAttribute));
$form = $crawler->filter('button[id=submit-filter]')->form();
@ -822,7 +822,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(6, $crawler->filter($this->entryDataTestAttribute));
}
public function testFilterOnReadingTimeOnlyLower()
@ -867,7 +867,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$entry = new Entry($this->getLoggedInUser());
$entry->setUrl($this->url);
@ -877,7 +877,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(6, $crawler->filter($this->entryDataTestAttribute));
}
public function testFilterOnCreationDate()
@ -908,7 +908,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$data = [
'entry_filter[createdAt][left_date]' => $today->format('Y-m-d'),
@ -917,7 +917,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
$data = [
'entry_filter[createdAt][left_date]' => '1970-01-01',
@ -1394,7 +1394,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(8, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(9, $crawler->filter($this->entryDataTestAttribute));
}
public function testSearch()
@ -1418,7 +1418,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
// Add a check with useless spaces before and after the search term
$crawler = $client->request('GET', '/unread/list');
@ -1430,7 +1430,7 @@ class EntryControllerTest extends WallabagTestCase
$crawler = $client->submit($form, $data);
$this->assertCount(4, $crawler->filter($this->entryDataTestAttribute));
$this->assertCount(5, $crawler->filter($this->entryDataTestAttribute));
// Search on starred list
$crawler = $client->request('GET', '/starred/list');