Fix Discord field value min length check

Author: carlbennett

src/Controllers/Document/Create.php

@@ -94,6 +94,7 @@ protected function handlePost(): void
 
     if ($event->commit())
     {
+      if (empty($brief)) $brief = '*empty*';
       $embed = Logger::initDiscordEmbed($event, $document->getURI(), [
         'Title' => $title,
         'Brief' => $brief,

src/Controllers/Document/Delete.php

@@ -57,20 +57,26 @@ public function invoke(?array $args): bool
 
       if ($event->commit())
       {
+        $brief = $this->model->document->getBrief(false);
+        if (empty($brief)) $brief = '*empty*';
+
         $content = $this->model->document->getContent(false);
         $markdown = $this->model->document->isMarkdown();
         $user = $this->model->document->getUser();
+
         $embed = Logger::initDiscordEmbed($event, $this->model->document->getURI(), [
           'Title' => $this->model->document->getTitle(),
-          'Brief' => $this->model->document->getBrief(false),
+          'Brief' => $brief,
           'Markdown' => $markdown ? ':white_check_mark:' : ':x:',
           'Authored by' => !\is_null($user) ? $user->getAsMarkdown() : '*Anonymous*',
           'Deleted by' => $this->model->active_user->getAsMarkdown(),
         ]);
+
         $desc = \substr($content, 0, \min(\BNETDocs\Libraries\Discord\Embed::MAX_DESCRIPTION - 13, \strlen($content) - 13));
         if (\strlen($desc) != \strlen($content)) $desc .= '…';
         if (!$markdown) $desc = '```' . \PHP_EOL . $desc . \PHP_EOL . '```';
         $embed->setDescription($desc);
+
         Logger::logToDiscord($event, $embed);
       }
     }

src/Controllers/Document/Edit.php

@@ -107,20 +107,26 @@ protected function handlePost(): void
 
     if ($event->commit())
     {
+      $brief = $this->model->document->getBrief(false);
+      if (empty($brief)) $brief = '*empty*';
+
       $content = $this->model->document->getContent(false);
       $markdown = $this->model->document->isMarkdown();
       $user = $this->model->document->getUser();
+
       $embed = Logger::initDiscordEmbed($event, $this->model->document->getURI(), [
         'Title' => $this->model->document->getTitle(),
-        'Brief' => $this->model->document->getBrief(false),
+        'Brief' => $brief,
         'Markdown' => $markdown ? ':white_check_mark:' : ':x:',
         'Authored by' => !\is_null($user) ? $user->getAsMarkdown() : '*Anonymous*',
         'Edited by' => $this->model->active_user->getAsMarkdown(),
       ]);
+
       $desc = \substr($content, 0, \min(\BNETDocs\Libraries\Discord\Embed::MAX_DESCRIPTION - 13, \strlen($content) - 13));
       if (\strlen($desc) != \strlen($content)) $desc .= '…';
       if (!$markdown) $desc = '```' . \PHP_EOL . $desc . \PHP_EOL . '```';
       $embed->setDescription($desc);
+
       Logger::logToDiscord($event, $embed);
     }
   }

src/Libraries/Discord/EmbedField.php

@@ -11,6 +11,7 @@ class EmbedField implements \JsonSerializable
 {
   public const MAX_NAME = 256;
   public const MAX_VALUE = 1024;
+  public const MIN_VALUE = 1;
 
   protected bool $inline;
   protected string $name;
@@ -53,11 +54,23 @@ public function setName(string $name): void
 
   public function setValue(int|float|string|bool $value): void
   {
-    if (is_string($value) && strlen($value) > self::MAX_VALUE)
+    if (is_string($value))
     {
-      throw new LengthException(sprintf(
-        'Discord forbids value longer than %d characters', self::MAX_VALUE
-      ));
+      if (strlen($value) > self::MAX_VALUE)
+      {
+        throw new LengthException(sprintf(
+          'Discord forbids value longer than %d characters', self::MAX_VALUE
+        ));
+      }
+      else if (strlen($value) < self::MIN_VALUE)
+      {
+        // It's necessary to check for short values because Discord replies with a 400 Bad Request
+        // if the `field.value` is empty; this is *NOT* documented in Discord's Developers Docs:
+        // <https://discord.com/developers/docs/resources/message#embed-object-embed-field-structure>
+        throw new LengthException(sprintf(
+          'Discord forbids value shorter than %d characters', self::MIN_VALUE
+        ));
+      }
     }
 
     $this->value = $value;