Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[10.x] Support Inline Attachments within Markdown Mailable #47603

Merged
merged 8 commits into from
Jul 3, 2023
Merged

[10.x] Support Inline Attachments within Markdown Mailable #47603

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
26b1881
failing test
cosmastech Jun 28, 2023
d4bdbbb
leverage closure for rendering markdown
cosmastech Jun 28, 2023
116186a
passing test
cosmastech Jun 28, 2023
af07ce4
fix unrelated test expectations
cosmastech Jun 28, 2023
15a1ede
Update MailChannel.php
taylorotwell Jun 29, 2023
3a91db8
clone Markdown converter to avoid overwriting theme overwriting
cosmastech Jun 30, 2023
8294bc8
add test to prove that default theme is used
cosmastech Jun 30, 2023
a82d8b0
set default markdown theme
cosmastech Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/Illuminate/Notifications/Channels/MailChannel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Illuminate\Notifications\Channels;

use Illuminate\Container\Container;
use Illuminate\Contracts\Mail\Factory as MailFactory;
use Illuminate\Contracts\Mail\Mailable;
use Illuminate\Contracts\Queue\ShouldQueue;
Expand Down Expand Up @@ -95,13 +96,19 @@ protected function buildView($message)
return $message->view;
}

if (property_exists($message, 'theme') && ! is_null($message->theme)) {
$this->markdown->theme($message->theme);
/**
* We clone the Markdown instance so that setting a theme doesn't
* carry over to subsequent calls to build the view.
*/
$markdown = clone $this->markdown;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather to have an implementation exactly like my pull request, and simply access the instance of markdown ($this->markdown) within the closure, to set the theme based on the message, right before call the renders.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added what I think you requested. If the code changes look good, I can go and fix the tests that are failing due to Mockery expectations.

That said, I respectfully disagree with this approach. Why even bother passing a default theme to the Markdown class if we are always going to manually fetch the markdown theme from config() every time it's used?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this would be better if there was a PendingRender class or something. Maybe an idea for 11.x


if (! is_null($theme = $message->theme ?? null)) {
$markdown->theme($theme);
}

return [
'html' => $this->markdown->render($message->markdown, $message->data()),
'text' => $this->markdown->renderText($message->markdown, $message->data()),
'html' => fn ($messageData = []) => $markdown->render($message->markdown, array_merge($message->data(), $messageData)),
'text' => fn ($messageData = []) => $markdown->renderText($message->markdown, array_merge($message->data(), $messageData)),
];
}

Expand Down
Empty file added tests/Integration/Notifications/Fixtures/mail/blank.blade.php
View file
Open in desktop
Empty file.
1 change: 1 addition & 0 deletions tests/Integration/Notifications/Fixtures/mail/color-test.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
body{color: test;}
1 change: 1 addition & 0 deletions tests/Integration/Notifications/Fixtures/markdown.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Embed content: {{ $message->embed(__FILE__) }}
154 changes: 81 additions & 73 deletions tests/Integration/Notifications/SendingMailNotificationsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@
use Illuminate\Support\Facades\View;
use Illuminate\Support\Str;
use Mockery as m;
use Mockery\MockInterface;
use Orchestra\Testbench\TestCase;

class SendingMailNotificationsTest extends TestCase
{
public $mailFactory;
public $mailer;
public $markdown;
public MailFactory&MockInterface $mailFactory;
public Mailer&MockInterface $mailer;
public Markdown&MockInterface $markdown;

protected function tearDown(): void
{
Expand Down Expand Up @@ -77,39 +78,67 @@ public function testMailIsSent()
$this->markdown->shouldReceive('render')->once()->andReturn('htmlContent');
$this->markdown->shouldReceive('renderText')->once()->andReturn('textContent');

$this->mailer->shouldReceive('send')->once()->with(
['html' => 'htmlContent', 'text' => 'textContent'],
array_merge($notification->toMail($user)->toArray(), [
'__laravel_notification_id' => $notification->id,
'__laravel_notification' => get_class($notification),
'__laravel_notification_queued' => false,
]),
m::on(function ($closure) {
$message = m::mock(Message::class);
$this->setMailerSendAssertions($notification, $user, function($closure) {
$message = m::mock(Message::class);

$message->shouldReceive('to')->once()->with(['taylor@laravel.com']);
$message->shouldReceive('to')->once()->with(['taylor@laravel.com']);

$message->shouldReceive('cc')->once()->with('cc@deepblue.com', 'cc');
$message->shouldReceive('cc')->once()->with('cc@deepblue.com', 'cc');

$message->shouldReceive('bcc')->once()->with('bcc@deepblue.com', 'bcc');
$message->shouldReceive('bcc')->once()->with('bcc@deepblue.com', 'bcc');

$message->shouldReceive('from')->once()->with('jack@deepblue.com', 'Jacques Mayol');
$message->shouldReceive('from')->once()->with('jack@deepblue.com', 'Jacques Mayol');

$message->shouldReceive('replyTo')->once()->with('jack@deepblue.com', 'Jacques Mayol');
$message->shouldReceive('replyTo')->once()->with('jack@deepblue.com', 'Jacques Mayol');

$message->shouldReceive('subject')->once()->with('Test Mail Notification');
$message->shouldReceive('subject')->once()->with('Test Mail Notification');

$message->shouldReceive('priority')->once()->with(1);
$message->shouldReceive('priority')->once()->with(1);

$closure($message);
$closure($message);

return true;
});

return true;
})
);

$user->notify($notification);
}

private function setMailerSendAssertions(
Notification $notification,
NotifiableUser $user,
callable $callbackExpectationClosure
) {
$this->mailer->shouldReceive('send')->once()->withArgs(function(...$args) use ($notification, $user, $callbackExpectationClosure){
$viewArray = $args[0];

if (!m::on(fn($closure) => $closure() === 'htmlContent')->match($viewArray['html'])) {
return false;
}

if (!m::on(fn($closure) => $closure() === 'textContent')->match($viewArray['text'])) {
return false;
}

$data = $args[1];

$expected = array_merge($notification->toMail($user)->toArray(), [
'__laravel_notification_id' => $notification->id,
'__laravel_notification' => get_class($notification),
'__laravel_notification_queued' => false,
]);

if (array_keys($data) !== array_keys($expected)) {
return false;
}
if (array_values($data) !== array_values($expected)) {
return false;
}

return m::on($callbackExpectationClosure)->match($args[2]);
});
}

public function testMailIsSentToNamedAddress()
{
$notification = new TestMailNotification;
Expand All @@ -123,35 +152,27 @@ public function testMailIsSentToNamedAddress()
$this->markdown->shouldReceive('render')->once()->andReturn('htmlContent');
$this->markdown->shouldReceive('renderText')->once()->andReturn('textContent');

$this->mailer->shouldReceive('send')->once()->with(
['html' => 'htmlContent', 'text' => 'textContent'],
array_merge($notification->toMail($user)->toArray(), [
'__laravel_notification_id' => $notification->id,
'__laravel_notification' => get_class($notification),
'__laravel_notification_queued' => false,
]),
m::on(function ($closure) {
$message = m::mock(Message::class);
$this->setMailerSendAssertions($notification, $user, function($closure) {
$message = m::mock(Message::class);

$message->shouldReceive('to')->once()->with(['taylor@laravel.com' => 'Taylor Otwell', 'foo_taylor@laravel.com']);
$message->shouldReceive('to')->once()->with(['taylor@laravel.com' => 'Taylor Otwell', 'foo_taylor@laravel.com']);

$message->shouldReceive('cc')->once()->with('cc@deepblue.com', 'cc');
$message->shouldReceive('cc')->once()->with('cc@deepblue.com', 'cc');

$message->shouldReceive('bcc')->once()->with('bcc@deepblue.com', 'bcc');
$message->shouldReceive('bcc')->once()->with('bcc@deepblue.com', 'bcc');

$message->shouldReceive('from')->once()->with('jack@deepblue.com', 'Jacques Mayol');
$message->shouldReceive('from')->once()->with('jack@deepblue.com', 'Jacques Mayol');

$message->shouldReceive('replyTo')->once()->with('jack@deepblue.com', 'Jacques Mayol');
$message->shouldReceive('replyTo')->once()->with('jack@deepblue.com', 'Jacques Mayol');

$message->shouldReceive('subject')->once()->with('Test Mail Notification');
$message->shouldReceive('subject')->once()->with('Test Mail Notification');

$message->shouldReceive('priority')->once()->with(1);
$message->shouldReceive('priority')->once()->with(1);

$closure($message);
$closure($message);

return true;
})
);
return true;
});

$user->notify($notification);
}
Expand All @@ -168,25 +189,17 @@ public function testMailIsSentWithSubject()
$this->markdown->shouldReceive('render')->once()->andReturn('htmlContent');
$this->markdown->shouldReceive('renderText')->once()->andReturn('textContent');

$this->mailer->shouldReceive('send')->once()->with(
['html' => 'htmlContent', 'text' => 'textContent'],
array_merge($notification->toMail($user)->toArray(), [
'__laravel_notification_id' => $notification->id,
'__laravel_notification' => get_class($notification),
'__laravel_notification_queued' => false,
]),
m::on(function ($closure) {
$message = m::mock(Message::class);
$this->setMailerSendAssertions($notification, $user, function($closure) {
$message = m::mock(Message::class);

$message->shouldReceive('to')->once()->with(['taylor@laravel.com']);
$message->shouldReceive('to')->once()->with(['taylor@laravel.com']);

$message->shouldReceive('subject')->once()->with('mail custom subject');
$message->shouldReceive('subject')->once()->with('mail custom subject');

$closure($message);
$closure($message);

return true;
})
);
return true;
});

$user->notify($notification);
}
Expand All @@ -203,25 +216,18 @@ public function testMailIsSentToMultipleAddresses()
$this->markdown->shouldReceive('render')->once()->andReturn('htmlContent');
$this->markdown->shouldReceive('renderText')->once()->andReturn('textContent');

$this->mailer->shouldReceive('send')->once()->with(
['html' => 'htmlContent', 'text' => 'textContent'],
array_merge($notification->toMail($user)->toArray(), [
'__laravel_notification_id' => $notification->id,
'__laravel_notification' => get_class($notification),
'__laravel_notification_queued' => false,
]),
m::on(function ($closure) {
$message = m::mock(Message::class);
$this->setMailerSendAssertions($notification, $user, function($closure) {
$message = m::mock(Message::class);

$message->shouldReceive('to')->once()->with(['foo_taylor@laravel.com', 'bar_taylor@laravel.com']);
$message->shouldReceive('to')->once()->with(['foo_taylor@laravel.com', 'bar_taylor@laravel.com']);

$message->shouldReceive('subject')->once()->with('mail custom subject');
$message->shouldReceive('subject')->once()->with('mail custom subject');

$closure($message);
$closure($message);

return true;
});

return true;
})
);

$user->notify($notification);
}
Expand Down Expand Up @@ -332,6 +338,8 @@ public function testMailIsSentUsingMailMessageWithPlainOnly()

$user->notify($notification);
}


}

class NotifiableUser extends Model
Expand Down
118 changes: 118 additions & 0 deletions tests/Integration/Notifications/SendingMailableNotificationsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<?php

namespace Illuminate\Tests\Integration\Notifications;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Facades\View;
use Orchestra\Testbench\TestCase;

class SendingMailableNotificationsTest extends TestCase
{
public $mailer;

protected function getEnvironmentSetUp($app)
{
$app['config']->set('mail.driver', 'array');

$app['config']->set('app.locale', 'en');

$app['config']->set('mail.markdown.theme', 'blank');

View::addLocation(__DIR__.'/Fixtures');
}

protected function setUp(): void
{
parent::setUp();

Schema::create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('email');
$table->string('name')->nullable();
});
}

public function testMarkdownNotification()
{
$user = MailableNotificationUser::forceCreate([
'email' => 'nuno@laravel.com',
]);

$user->notify(new MarkdownNotification());

$email = app('mailer')->getSymfonyTransport()->messages()[0]->getOriginalMessage()->toString();

$cid = explode(' cid:', str($email)->explode("\r\n")
->filter(fn ($line) => str_contains($line, 'Embed content: cid:'))
->first())[1];

$this->assertStringContainsString(<<<EOT
Content-Type: application/x-php; name=$cid\r
Content-Transfer-Encoding: base64\r
Content-Disposition: inline; name=$cid; filename=$cid\r
EOT, $email);
}

public function testCanSetTheme()
{
$user = MailableNotificationUser::forceCreate([
'email' => 'nuno@laravel.com',
]);

$user->notify(new MarkdownNotification('color-test'));
$mailTransport = app('mailer')->getSymfonyTransport();
$email = $mailTransport->messages()[0]->getOriginalMessage()->toString();

$bodyStyleLine =str($email)->explode("\r\n")
->filter(fn ($line) => str_contains($line, '<body style='))
->first();

$this->assertStringContainsString('color: test', $bodyStyleLine);

// confirm passing no theme resets to the app's default theme
$user->notify(new MarkdownNotification());

$email = $mailTransport->messages()[1]->getOriginalMessage()->toString();

$this->assertNull(str($email)->explode("\r\n")
->filter(fn ($line) => str_contains($line, '<body style='))
->first());
}
}


class MailableNotificationUser extends Model
{
use Notifiable;

public $table = 'users';
public $timestamps = false;
}


class MarkdownNotification extends Notification
{
public function __construct(
private readonly ?string $theme = null
){}
public function via($notifiable): array
{
return ['mail'];
}

public function toMail($notifiable): MailMessage
{
$message = (new MailMessage)->markdown('markdown');

if (! is_null($this->theme)) {
$message->theme($this->theme);
}

return $message;
}
}