Merge pull request #108 from TheDragonCode/1.x

Added `FeedGenerationException` and `FailedFeed` for error handling

Author: andrey-helldar

src/Exceptions/FeedGenerationException.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Exceptions;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+use RuntimeException;
+use Throwable;
+
+class FeedGenerationException extends RuntimeException
+{
+    /** @var class-string<Feed> */
+    public readonly string $feed;
+
+    /**
+     * @param  class-string<Feed>  $feed
+     */
+    public function __construct(string $feed, Throwable $e)
+    {
+        parent::__construct($e->getMessage(), previous: $e);
+
+        $this->feed = $feed;
+    }
+
+    /**
+     * @return class-string<Feed>
+     */
+    public function getFeed(): string
+    {
+        return $this->feed;
+    }
+}

src/Services/GeneratorService.php

@@ -5,12 +5,14 @@
 namespace DragonCode\LaravelFeed\Services;
 
 use DragonCode\LaravelFeed\Converters\Converter;
+use DragonCode\LaravelFeed\Exceptions\FeedGenerationException;
 use DragonCode\LaravelFeed\Feeds\Feed;
 use DragonCode\LaravelFeed\Helpers\ConverterHelper;
 use DragonCode\LaravelFeed\Queries\FeedQuery;
 use Illuminate\Console\OutputStyle;
 use Illuminate\Database\Eloquent\Collection;
 use Symfony\Component\Console\Helper\ProgressBar;
+use Throwable;
 
 use function blank;
 use function get_class;
@@ -29,17 +31,25 @@ public function feed(Feed $feed, ?OutputStyle $output = null): void
         $file = $this->openFile(
             $path = $feed->path()
         );
+        try {
+            $file = $this->openFile(
+                $path = $feed->path()
+            );
 
-        $this->performHeader($file, $feed);
-        $this->performRoot($file, $feed, true);
-        $this->performInfo($file, $feed);
-        $this->performRoot($file, $feed, false);
-        $this->performItem($file, $feed, $output);
-        $this->performFooter($file, $feed);
+            $this->performHeader($file, $feed);
+            $this->performRoot($file, $feed, true);
+            $this->performInfo($file, $feed);
+            $this->performRoot($file, $feed, false);
+            $this->performItem($file, $feed, $output);
+            $this->performFooter($file, $feed);
 
-        $this->release($file, $path);
+            $this->release($file, $path);
 
         $this->setLastActivity($feed);
+            $this->setLastActivity($feed);
+        } catch (Throwable $e) {
+            throw new FeedGenerationException(get_class($feed), $e);
+        }
     }
 
     protected function performItem($file, Feed $feed, ?OutputStyle $output): void // @pest-ignore-type

tests/Feature/Events/FailedTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\LaravelFeed\Commands\FeedGenerateCommand;
+use DragonCode\LaravelFeed\Exceptions\FeedGenerationException;
+use DragonCode\LaravelFeed\Models\Feed;
+use Illuminate\Support\Facades\Event;
+use Workbench\App\Feeds\FailedFeed;
+
+use function Pest\Laravel\artisan;
+
+test('failed', function () {
+    Event::fake();
+
+    $feed = Feed::create([
+        'class' => FailedFeed::class,
+        'title' => 'Failed',
+    ]);
+
+    artisan(FeedGenerateCommand::class, ['feed' => $feed->id])
+        ->assertSuccessful()
+        ->run();
+})->throws(
+    exception       : FeedGenerationException::class,
+    exceptionMessage: 'Something went wrong while generating the feed.'
+);

workbench/app/Feeds/FailedFeed.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Feeds;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Workbench\App\Feeds\Items\FailedFeedItem;
+use Workbench\App\Models\User;
+
+class FailedFeed extends Feed
+{
+    public function builder(): Builder
+    {
+        return User::query();
+    }
+
+    public function item(Model $model): FeedItem
+    {
+        return new FailedFeedItem($model);
+    }
+}

workbench/app/Feeds/Items/FailedFeedItem.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Feeds\Items;
+
+use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
+use RuntimeException;
+
+class FailedFeedItem extends FeedItem
+{
+    public function toArray(): array
+    {
+        throw new RuntimeException(
+            'Something went wrong while generating the feed.'
+        );
+    }
+}