Skip to content

Commit aaa08fd

Browse files
kiritokatkliankiritokatklian
authored
[Update] Send long log as file (#41)
- Added new tests - Updated RichRecordConverter to send text longer than 2000 as file too
1 parent 01ed365 commit aaa08fd

File tree

2 files changed

+52
-5
lines changed

2 files changed

+52
-5
lines changed

‎src/DiscordLogger/Converters/RichRecordConverter.php

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace MarvinLabs\DiscordLogger\Converters;
44

55
use Illuminate\Support\Arr;
6+
use MarvinLabs\DiscordLogger\Contracts\DiscordWebHook;
67
use MarvinLabs\DiscordLogger\Discord\Embed;
78
use MarvinLabs\DiscordLogger\Discord\Exceptions\ConfigurationIssue;
89
use MarvinLabs\DiscordLogger\Discord\Message;
@@ -20,17 +21,17 @@ public function buildMessages(array $record): array
2021
$this->addMainEmbed($mainMessage, $record);
2122
$this->addContextEmbed($mainMessage, $record);
2223
$this->addExtrasEmbed($mainMessage, $record);
23-
24-
$stackTraceMessage = null;
24+
$fileMessage = null;
2525
$stacktrace = $this->getStacktrace($record);
26+
2627
if ($stacktrace !== null)
2728
{
2829
switch ($this->stackTraceMode($stacktrace))
2930
{
3031
case 'file':
3132
// Discord webhooks do not support EMBED + FILE at the same time. Hence another message has to be sent
32-
$stackTraceMessage = Message::make()->file($stacktrace, $this->getStacktraceFilename($record));
33-
$this->addGenericMessageFrom($stackTraceMessage);
33+
$fileMessage = Message::make()->file($stacktrace, $this->getStacktraceFilename($record));
34+
$this->addGenericMessageFrom($fileMessage);
3435
break;
3536

3637
case 'inline' :
@@ -41,8 +42,13 @@ public function buildMessages(array $record): array
4142
throw new ConfigurationIssue('Invalid value for configuration `discord-logger.stacktrace`');
4243
}
4344
}
45+
elseif (strlen($record['message']) > DiscordWebHook::MAX_CONTENT_LENGTH)
46+
{
47+
$fileMessage = Message::make()->file($record['message'], $this->getStacktraceFilename($record));
48+
$this->addGenericMessageFrom($fileMessage);
49+
}
4450

45-
return $stackTraceMessage !== null ? [$mainMessage, $stackTraceMessage] : [$mainMessage];
51+
return $fileMessage !== null ? [$mainMessage, $fileMessage] : [$mainMessage];
4652
}
4753

4854
protected function addMainEmbed(Message $message, array $record): void

‎tests/Converters/RichLoggerMessagesTest.php

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,45 @@ public function includes_stacktrace_as_file_when_attachment_enabled()
8484
], $messages[1]);
8585
$this->assertStringContainsString($exception->getTraceAsString(), $messages[1]->file['contents']);
8686
}
87+
88+
/** @test */
89+
public function includes_message_as_file_when_longer_than_2000_characters()
90+
{
91+
$this->config->set('discord-logger.emojis.CRITICAL', null);
92+
93+
$description = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ut mi eu magna tempus auctor ac at ante. Quisque pulvinar, justo pretium ultricies auctor, risus eros mattis velit, quis rutrum tortor orci et urna. Sed suscipit nibh vel accumsan hendrerit. Etiam non elit nec diam auctor interdum. Morbi quam ligula, pharetra non felis sit amet, pulvinar venenatis ex. Sed suscipit, urna quis varius congue, urna lorem fermentum ipsum, in consectetur elit sapien non tortor. Nulla facilisi. Sed maximus metus quam, a venenatis sapien aliquet eu. Pellentesque lacinia urna non porta ornare. Donec elementum faucibus nibh at vulputate. Nulla consectetur facilisis ligula ut tempus. Mauris molestie risus in neque commodo, ac iaculis nibh lobortis. Nullam non condimentum dolor, ut tempus arcu. Duis eget lacus sit amet neque rutrum sagittis. Vestibulum suscipit aliquam ipsum ut accumsan. Phasellus dictum vulputate velit sit amet interdum. Nullam sed cursus dolor, eu bibendum ipsum. Sed facilisis, lectus non finibus porta, erat lorem ornare neque, nec pretium ipsum sem id risus. In consectetur auctor ullamcorper. Sed quis arcu vel metus mattis sollicitudin sit amet et risus. Sed metus felis, aliquam at consectetur ac, iaculis ut neque. Phasellus quis nisl justo. Nulla lorem velit, bibendum ornare urna ut, pulvinar tempus dui. Vestibulum non pellentesque arcu. Fusce pretium massa elit, at congue ante porttitor sed. Aliquam erat volutpat. Nulla quam lectus, volutpat quis felis non, pharetra porttitor erat. Aliquam nunc felis, mattis pulvinar varius eu, fermentum et ligula. Proin tempor purus tempus rhoncus bibendum.Vestibulum magna tortor, vehicula eget neque id, aliquet pretium eros. Nulla ut justo rutrum mauris aliquam accumsan. Vestibulum non fringilla purus, eu faucibus lacus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus blandit risus libero, non ornare massa consequat in. Curabitur nec lectus nec purus pretium placerat. Nam interdum, nibh eu faucibus elementum, tortor justo hendrerit ante, quis fermentum dolor nulla a dolor. Donec auctor ut tortor sed faucibus. Maecenas et tellus a ex malesuada commodo. Aliquam mi arcu, dictum mattis egestas et, ultricies ut eros. Pellentesque eu elit felis. Aenean ut vestibulum libero, ut consequat turpis.';
94+
$embedDescription = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ut mi eu magna tempus auctor ac at ante. Quisque pulvinar, justo pretium ultricies auctor, risus eros mattis velit, quis rutrum tortor orci et urna. Sed suscipit nibh vel accumsan hendrerit. Etiam non elit nec diam auctor interdum. Morbi quam ligula, pharetra non felis sit amet, pulvinar venenatis ex. Sed suscipit, urna quis varius congue, urna lorem fermentum ipsum, in consectetur elit sapien non tortor. Nulla facilisi. Sed maximus metus quam, a venenatis sapien aliquet eu. Pellentesque lacinia urna non porta ornare. Donec elementum faucibus nibh at vulputate. Nulla consectetur facilisis ligula ut tempus. Mauris molestie risus in neque commodo, ac iaculis nibh lobortis. Nullam non condimentum dolor, ut tempus arcu. Duis eget lacus sit amet neque rutrum sagittis. Vestibulum suscipit aliquam ipsum ut accumsan. Phasellus dictum vulputate velit sit amet interdum. Nullam sed cursus dolor, eu bibendum ipsum. Sed facilisis, lectus non finibus porta, erat lorem ornare neque, nec pretium ipsum sem id risus. In consectetur auctor ullamcorper. Sed quis arcu vel metus mattis sollicitudin sit amet et risus. Sed metus felis, aliquam at consectetur ac, iaculis ut neque. Phasellus quis nisl justo. Nulla lorem velit, bibendum ornare urna ut, pulvinar tempus dui. Vestibulum non pellentesque arcu. Fusce pretium massa elit, at congue ante porttitor sed. Aliquam erat volutpat. Nulla quam lectus, volutpat quis felis non, pharetra porttitor erat. Aliquam nunc felis, mattis pulvinar varius eu, fermentum et ligula. Proin tempor purus tempus rhoncus bibendum.Vestibulum magna tortor, vehicula eget neque id, aliquet pretium eros. Nulla ut justo rutrum mauris aliquam accumsan. Vestibulum non fringilla purus, eu faucibus lacus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus blandit risus libero, non ornare massa consequat in. Curabitur nec lectus nec purus pretium placerat. Nam interdum,...';
95+
$messages = $this->warning($description);
96+
97+
MessageAssertions::assertMessagePartialMatch([
98+
'embeds' => [
99+
0 => ['title' => ':flushed: `[2000-01-01 12:13:14] Laravel.WARNING`',
100+
'description' => ':black_small_square: `' . $embedDescription],
101+
],
102+
], $messages[0]);
103+
104+
MessageAssertions::assertMessagePartialMatch([
105+
'file' => ['filename' => '20000101121314_stacktrace.txt'],
106+
], $messages[1]);
107+
108+
$this->assertStringContainsString($description, $messages[1]->file['contents']);
109+
}
110+
111+
/** @test */
112+
public function includes_only_message_when_less_than_2000_characters()
113+
{
114+
$this->config->set('discord-logger.emojis.CRITICAL', null);
115+
116+
$description = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ut mi eu magna tempus auctor ac at ante. Quisque pulvinar, justo pretium ultricies auctor, risus eros mattis velit, quis rutrum tortor orci et urna. Sed suscipit nibh vel accumsan hendrerit. Etiam non elit nec diam auctor interdum. Morbi quam ligula, pharetra non felis sit amet, pulvinar venenatis ex. Sed suscipit, urna quis varius congue, urna lorem fermentum ipsum, in consectetur elit sapien non tortor. Nulla facilisi. Sed maximus metus quam, a venenatis sapien aliquet eu. Pellentesque lacinia urna non porta ornare. Donec elementum faucibus nibh at vulputate. Nulla consectetur facilisis ligula ut tempus. Mauris molestie risus in neque commodo, ac iaculis nibh lobortis. Nullam non condimentum dolor, ut tempus arcu. Duis eget lacus sit amet neque rutrum sagittis. Vestibulum suscipit aliquam ipsum ut accumsan. Phasellus dictum vulputate velit sit amet interdum. Nullam sed cursus dolor, eu bibendum ipsum. Sed facilisis, lectus non finibus porta, erat lorem ornare neque, nec pretium ipsum sem id risus. In consectetur auctor ullamcorper. Sed quis arcu vel metus mattis sollicitudin sit amet et risus. Sed metus felis, aliquam at consectetur ac, iaculis ut neque. Phasellus quis nisl justo. Nulla lorem velit, bibendum ornare urna ut, pulvinar tempus dui. Vestibulum non pellentesque arcu. Fusce pretium massa elit, at congue ante porttitor sed. Aliquam erat volutpat. Nulla quam lectus, volutpat quis felis non, pharetra porttitor erat. Aliquam nunc felis, mattis pulvinar varius eu, fermentum et ligula. Proin tempor purus tempus rhoncus bibendum.Vestibulum magna tortor, vehicula eget neque id, aliquet pretium eros. Nulla ut justo rutrum mauris aliquam accumsan. Vestibulum non fringilla purus, eu faucibus lacus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus blandit risus libero, non ornare massa consequat in. Curabitur nec lectus nec purus pretium placerat.';
117+
$messages = $this->warning($description);
118+
119+
MessageAssertions::assertMessagePartialMatch([
120+
'embeds' => [
121+
0 => ['title' => ':flushed: `[2000-01-01 12:13:14] Laravel.WARNING`',
122+
'description' => ':black_small_square: `' . $description . '`'],
123+
],
124+
], $messages[0]);
125+
126+
$this->assertArrayNotHasKey(1, $messages);
127+
}
87128
}

0 commit comments

Comments
 (0)