From 4454ceaaea8b53a4725e4dc79356dbaa7cea46f7 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Sat, 28 Oct 2023 17:44:40 +0200 Subject: [PATCH 1/2] Update image factory to specify the file causing the exception --- .../src/Framework/Factories/BlogPostDataFactory.php | 5 ++++- .../src/Framework/Factories/FeaturedImageFactory.php | 9 ++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/packages/framework/src/Framework/Factories/BlogPostDataFactory.php b/packages/framework/src/Framework/Factories/BlogPostDataFactory.php index a8dbfc599f9..8eb80a3d401 100644 --- a/packages/framework/src/Framework/Factories/BlogPostDataFactory.php +++ b/packages/framework/src/Framework/Factories/BlogPostDataFactory.php @@ -41,10 +41,13 @@ class BlogPostDataFactory extends Concerns\PageDataFactory implements BlogPostSc protected readonly ?PostAuthor $author; protected readonly ?FeaturedImage $image; + private readonly string $filePath; + public function __construct(CoreDataObject $pageData) { $this->matter = $pageData->matter; $this->markdown = $pageData->markdown; + $this->filePath = $pageData->sourcePath; $this->description = $this->makeDescription(); $this->category = $this->makeCategory(); @@ -98,7 +101,7 @@ protected function makeAuthor(): ?PostAuthor protected function makeImage(): ?FeaturedImage { if ($this->getMatter('image')) { - return FeaturedImageFactory::make($this->matter); + return FeaturedImageFactory::make($this->matter, $this->filePath); } return null; diff --git a/packages/framework/src/Framework/Factories/FeaturedImageFactory.php b/packages/framework/src/Framework/Factories/FeaturedImageFactory.php index 5501edf8169..a844ae1cf56 100644 --- a/packages/framework/src/Framework/Factories/FeaturedImageFactory.php +++ b/packages/framework/src/Framework/Factories/FeaturedImageFactory.php @@ -30,6 +30,7 @@ class FeaturedImageFactory extends Concerns\PageDataFactory implements FeaturedI public function __construct( private readonly FrontMatter $matter, + private readonly ?string $filePath = null, ) { $this->source = $this->makeSource(); $this->altText = $this->getStringMatter('image.altText'); @@ -58,9 +59,9 @@ public function toArray(): array ]; } - public static function make(FrontMatter $matter): FeaturedImage + public static function make(FrontMatter $matter, ?string $filePath = null): FeaturedImage { - return new FeaturedImage(...(new static($matter))->toArray()); + return new FeaturedImage(...(new static($matter, $filePath))->toArray()); } protected function makeSource(): string @@ -68,9 +69,7 @@ protected function makeSource(): string $value = $this->getStringMatter('image') ?? $this->getStringMatter('image.source'); if (empty($value)) { - // Todo, we might want to add a note about which file caused the error. - // We could also check for these before calling the factory, and just ignore the image if it's not valid. - throw new RuntimeException('No featured image source was found'); + throw new RuntimeException(sprintf('No featured image source was found in "%s"', $this->filePath ?? 'unknown file')); } if (FeaturedImage::isRemote($value)) { From 9081af72a2b9d28206a9faa5eb37813f0e2d253c Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Sat, 28 Oct 2023 17:47:46 +0200 Subject: [PATCH 2/2] Update RELEASE_NOTES.md --- RELEASE_NOTES.md | 1 + 1 file changed, 1 insertion(+) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index b3ce7020324..2641f145928 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -20,6 +20,7 @@ This serves two purposes: - Updated the realtime compiler server configuration options in https://github.com/hydephp/develop/pull/1395 (backwards compatible) - Updated the realtime compiler to generate the documentation search index each time it's requested in https://github.com/hydephp/develop/pull/1405 (fixes https://github.com/hydephp/develop/issues/1404) - Updated the navigation menu generator to remove duplicates after running the sorting method in https://github.com/hydephp/develop/pull/1407 (fixes https://github.com/hydephp/develop/issues/1406) +- Updated the exception message caused by missing source option for featured images to include the path of the file that caused the error in https://github.com/hydephp/develop/pull/1409 ### Deprecated - for soon-to-be removed features.