Command: Add debug item list commands

Signed-off-by: Sean Molenaar <sean@seanmolenaar.eu>

.github/workflows/api-integration-tests.yml

@@ -126,9 +126,17 @@ jobs:
         working-directory: ../server
         run: |
           ./occ news:feed:add 'admin' "https://nextcloud.com/blog/feed/"
+          ./occ news:feed:add 'admin' "https://github.com/nextcloud/news/releases.atom"
           ./occ news:feed:list 'admin' | grep 'nextcloud\.com'
           ./occ news:feed:list 'admin' | grep -F '"faviconLink": "https:\/\/nextcloud.com\/media\/screenshot-150x150.png"'
 
+      - name: Functional tests items
+        working-directory: ../server
+        run: |
+          ./occ news:item:list-feed "admin" $(./occ news:feed:list 'admin' | grep 'github\.com' -1  | head -1 | grep -oE '[0-9]*') --limit 200 | grep '15.3.2'
+          ./occ news:item:list-folder "admin" --limit 200 | grep '15.3.2'
+          ./occ news:item:list "admin" --limit 200 | grep '15.3.2'
+
       - name: Functional tests opml
         working-directory: ../server
         run: ./occ news:opml:export 'admin' | grep 'nextcloud\.com'
@@ -138,6 +146,7 @@ jobs:
         run: |
           ./occ news:folder:delete 'admin' $(./occ news:folder:list 'admin' | grep 'Something' -1  | head -1 | grep -oE '[0-9]*')
           ./occ news:feed:delete 'admin' $(./occ news:feed:list 'admin' | grep 'nextcloud\.com' -1  | head -1 | grep -oE '[0-9]*')
+          ./occ news:feed:delete 'admin' $(./occ news:feed:list 'admin' | grep 'github\.com' -1  | head -1 | grep -oE '[0-9]*')
 
       - name: Prep PHP tests
         working-directory: ../server/apps/news

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is almost based on [Keep a Changelog](https://keepachangelog.com/en/1
 - Stop returning all feeds after marking folder as read.
 - Always fetch favicon (#1164)
 - Use feed logo instead of favicon if it exists and is square
+- Add CI for item lists
 
 ### Fixed
 

appinfo/info.xml

@@ -70,6 +70,9 @@ Before you update to a new version, [check the changelog](https://github.com/nex
         <command>OCA\News\Command\Config\FeedDelete</command>
         <command>OCA\News\Command\Config\FeedDelete</command>
         <command>OCA\News\Command\Config\OpmlExport</command>
+        <command>OCA\News\Command\Debug\ItemList</command>
+        <command>OCA\News\Command\Debug\FolderItemList</command>
+        <command>OCA\News\Command\Debug\FeedItemList</command>
     </commands>
 
     <settings>

lib/Command/Debug/FeedItemList.php

@@ -0,0 +1,99 @@
+<?php
+declare(strict_types=1);
+
+namespace OCA\News\Command\Debug;
+
+use OCA\News\Controller\ApiPayloadTrait;
+use OCA\News\Service\ItemServiceV2;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class ItemList
+ *
+ * @package OCA\News\Command
+ */
+class FeedItemList extends Command
+{
+    use ApiPayloadTrait;
+
+    /**
+     * @var ItemServiceV2 service for the items.
+     */
+    protected $itemService;
+
+    public function __construct(ItemServiceV2 $itemService)
+    {
+        parent::__construct(null);
+
+        $this->itemService = $itemService;
+    }
+
+    /**
+     * Configure command
+     *
+     * @return void
+     */
+    protected function configure()
+    {
+        $this->setName('news:item:list-feed')
+            ->setDescription('List all items in a feed')
+            ->addArgument('user-id', InputArgument::REQUIRED, 'User to list the items for')
+            ->addArgument('feed', InputArgument::REQUIRED, 'Feed to list the items for')
+            ->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit for item amount', 40)
+            ->addOption('offset', 'o', InputOption::VALUE_REQUIRED, 'Item list offset', 0)
+            ->addOption('reverse-sort', null, InputOption::VALUE_NONE, 'Item list sorting')
+            ->addOption('hide-read', null, InputOption::VALUE_NONE, 'Hide read items');
+    }
+
+    /**
+     * Execute command
+     *
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     *
+     * @return int|void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $user = $input->getArgument('user-id');
+
+        $feed = $input->getArgument('feed');
+        if (!is_numeric($feed)) {
+            $output->writeln('Invalid Type!');
+            return 255;
+        }
+
+        $limit = $input->getOption('limit');
+        if (!is_numeric($limit)) {
+            $output->writeln('Invalid limit!');
+            return 255;
+        }
+
+        $offset = $input->getOption('offset');
+        if (!is_numeric($offset)) {
+            $output->writeln('Invalid offset!');
+            return 255;
+        }
+
+        $reverseSort = $input->getOption('reverse-sort');
+        $hideRead = $input->getOption('hide-read');
+
+        $items = $this->itemService->findAllInFeedWithFilters(
+            $user,
+            intval($feed),
+            intval($limit),
+            intval($offset),
+            $hideRead,
+            $reverseSort,
+            []
+        );
+
+        $output->writeln(json_encode($this->serialize($items), JSON_PRETTY_PRINT));
+
+        return 0;
+    }
+}

lib/Command/Debug/FolderItemList.php

@@ -0,0 +1,100 @@
+<?php
+declare(strict_types=1);
+
+namespace OCA\News\Command\Debug;
+
+use OCA\News\Controller\ApiPayloadTrait;
+use OCA\News\Service\ItemServiceV2;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class ItemList
+ *
+ * @package OCA\News\Command
+ */
+class FolderItemList extends Command
+{
+    use ApiPayloadTrait;
+
+    /**
+     * @var ItemServiceV2 service for the items.
+     */
+    protected $itemService;
+
+    public function __construct(ItemServiceV2 $itemService)
+    {
+        parent::__construct(null);
+
+        $this->itemService = $itemService;
+    }
+
+    /**
+     * Configure command
+     *
+     * @return void
+     */
+    protected function configure()
+    {
+        $this->setName('news:item:list-folder')
+            ->setDescription('List all items in a folder')
+            ->addArgument('user-id', InputArgument::REQUIRED, 'User to list the items for')
+            ->addArgument('folder', InputArgument::OPTIONAL, 'Folder to list the items for')
+            ->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit for item amount', 40)
+            ->addOption('offset', 'o', InputOption::VALUE_REQUIRED, 'Item list offset', 0)
+            ->addOption('reverse-sort', null, InputOption::VALUE_NONE, 'Item list sorting')
+            ->addOption('hide-read', null, InputOption::VALUE_NONE, 'Hide read items');
+    }
+
+    /**
+     * Execute command
+     *
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     *
+     * @return int|void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $user = $input->getArgument('user-id');
+
+        $folder = $input->getArgument('folder');
+        if (!is_null($folder) && !is_numeric($folder)) {
+            $output->writeln('Invalid folder ID!');
+            return 255;
+        }
+
+        $limit = $input->getOption('limit');
+        if (!is_numeric($limit)) {
+            $output->writeln('Invalid limit!');
+            return 255;
+        }
+
+        $offset = $input->getOption('offset');
+        if (!is_numeric($offset)) {
+            $output->writeln('Invalid offset!');
+            return 255;
+        }
+
+        $folder = is_null($folder) ? $folder : intval($folder);
+        $reverseSort = $input->getOption('reverse-sort');
+        $hideRead = $input->getOption('hide-read');
+
+        $items = $this->itemService->findAllInFolderWithFilters(
+            $user,
+            $folder,
+            intval($limit),
+            intval($offset),
+            $hideRead,
+            $reverseSort,
+            []
+        );
+
+        $output->writeln(json_encode($this->serialize($items), JSON_PRETTY_PRINT));
+
+        return 0;
+    }
+}

lib/Command/Debug/ItemList.php

@@ -0,0 +1,94 @@
+<?php
+declare(strict_types=1);
+
+namespace OCA\News\Command\Debug;
+
+use OCA\News\Controller\ApiPayloadTrait;
+use OCA\News\Db\ListType;
+use OCA\News\Service\ItemServiceV2;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class ItemList
+ *
+ * @package OCA\News\Command
+ */
+class ItemList extends Command
+{
+    use ApiPayloadTrait;
+
+    /**
+     * @var ItemServiceV2 service for the items.
+     */
+    protected $itemService;
+
+    public function __construct(ItemServiceV2 $itemService)
+    {
+        parent::__construct(null);
+
+        $this->itemService = $itemService;
+    }
+
+    /**
+     * Configure command
+     *
+     * @return void
+     */
+    protected function configure()
+    {
+        $this->setName('news:item:list')
+            ->setDescription('List all items')
+            ->addArgument('user-id', InputArgument::REQUIRED, 'User to list the items for')
+            ->addOption('type', 't', InputOption::VALUE_REQUIRED, 'Item type', ListType::ALL_ITEMS)
+            ->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit for item amount', 40)
+            ->addOption('offset', 'o', InputOption::VALUE_REQUIRED, 'Item list offset', 0)
+            ->addOption('reverse-sort', 'r', InputOption::VALUE_NONE, 'Item list sorting');
+    }
+
+    /**
+     * Execute command
+     *
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     *
+     * @return int|void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $user = $input->getArgument('user-id');
+
+        $type = $input->getOption('type');
+        if (!is_numeric($type)) {
+            $output->writeln('Invalid Type!');
+            return 255;
+        }
+        $limit = $input->getOption('limit');
+        if (!is_numeric($limit)) {
+            $output->writeln('Invalid limit!');
+            return 255;
+        }
+        $offset = $input->getOption('offset');
+        if (!is_numeric($offset)) {
+            $output->writeln('Invalid offset!');
+            return 255;
+        }
+        $reverseSort = $input->getOption('reverse-sort');
+
+        $items = $this->itemService->findAllWithFilters(
+            $user,
+            intval($type),
+            intval($limit),
+            intval($offset),
+            $reverseSort,
+            []
+        );
+
+        $output->writeln(json_encode($this->serialize($items), JSON_PRETTY_PRINT));
+
+        return 0;
+    }
+}