feat: improvements and tests

config/mail-scheduler.php

@@ -3,9 +3,62 @@
 declare(strict_types=1);
 
 return [
-
+ /*
+ |--------------------------------------------------------------------------
+ | Max attempts
+ |--------------------------------------------------------------------------
+ |
+ | Can be used to define the maximum number of attempts to send an email.
+ | Each time an email fails to send, the number of attempts is incremented.
+ |
+ | default: 3
+ */
  'max_attempts' => (int) env('MAIL_SCHEDULER_MAX_ATTEMPTS', 3),
 
+ /*
+ |--------------------------------------------------------------------------
+ | Batch size
+ |--------------------------------------------------------------------------
+ |
+ | Can be used to define the number of scheduled emails to send in a batch.
+ |
+ | default: 100
+ */
  'batch_size' => (int) env('MAIL_SCHEDULER_BATCH_SIZE', 100),
 
+ /*
+ |--------------------------------------------------------------------------
+ | Auto schedule
+ |--------------------------------------------------------------------------
+ |
+ | By setting this option to true, the package will auto register into the
+ | Laravel scheduler.
+ |
+ | default: true
+ */
+ 'auto_schedule' => (bool) env('MAIL_SCHEDULER_AUTO_SCHEDULE', true),
+
+ /*
+ |--------------------------------------------------------------------------
+ | Auto schedule CRON expression
+ |--------------------------------------------------------------------------
+ |
+ | If auto schedule is enabled, this CRON expression will be used to schedule
+ | the command to run.
+ |
+ | default: every five minutes
+ */
+ 'schedule_cron' => env('MAIL_SCHEDULER_SCHEDULE_CRON', '*/5 * * * *'),
+
+ /*
+ |--------------------------------------------------------------------------
+ | Table name
+ |--------------------------------------------------------------------------
+ |
+ | Can be used to define a custom table name for the scheduled emails models.
+ |
+ | default: scheduled_emails
+ */
+ 'table_name' => env('MAIL_SCHEDULER_TABLE_NAME', 'scheduled_emails'),
+
 ];

database/migrations/create_scheduled_emails_table.php

@@ -10,22 +10,19 @@
 {
  public function up(): void
  {
- Schema::create('scheduled_emails', function (Blueprint $table) {
+ Schema::create(config('mail-scheduler.table_name'), function (Blueprint $table) {
  $table->id();
-
  $table->json('recipients');
  $table->longText('mailable');
  $table->string('status')->index();
  $table->unsignedInteger('attempts')->default(0);
  $table->string('error')->nullable();
  $table->text('stacktrace')->nullable();
- $table->dateTime('attempted_at')->nullable();
- $table->unsignedBigInteger('source_id')->nullable();
- $table->string('source_type')->nullable();
+ $table->nullableMorphs('source');
+ $table->timestamp('attempted_at')->nullable();
+ $table->timestamps();
 
  $table->index(['status', 'attempts', 'created_at']);
-
- $table->timestamps();
  });
  }
 };

phpunit.xml

@@ -21,17 +21,15 @@
  <testsuites>
  <testsuite name="Mail scheduler Test suite">
  <directory suffix="Test.php">./tests/Feature</directory>
+ <directory suffix="Test.php">./tests/Unit</directory>
  </testsuite>
  </testsuites>
  <php>
  <env name="APP_ENV" value="testing"/>
  <env name="APP_KEY" value="base64:IiOzvjsOE18pPH+96mKNbE7ilEwkBg4pdayiOZrbRrs="/>
  <env name="BCRYPT_ROUNDS" value="4"/>
  <env name="CACHE_DRIVER" value="array"/>
- <env name="DB_CONNECTION" value="mysql"/>
- <env name="DB_DATABASE" value="laravel_mail_scheduler"/>
- <env name="DB_USERNAME" value="root"/>
- <env name="DB_PASSWORD" value=""/>
+ <env name="DB_CONNECTION" value="testing"/>
  <env name="MAIL_MAILER" value="array"/>
  <env name="QUEUE_CONNECTION" value="sync"/>
  <env name="SESSION_DRIVER" value="array"/>

src/Casts/SerializedMailable.php

@@ -23,10 +23,6 @@ class SerializedMailable implements CastsAttributes
  */
  public function get($model, string $key, $value, array $attributes): ?Mailable
  {
- if (!filled($value)) {
- return null;
- }
-
  return tap(unserialize($value), function ($mailable) {
  if (!$mailable instanceof Mailable) {
  throw NotAMailable::instanceOf($mailable::class);
@@ -47,16 +43,11 @@ public function get($model, string $key, $value, array $attributes): ?Mailable
  */
  public function set($model, string $key, $value, array $attributes): ?string
  {
- if (!filled($value)) {
- return null;
+ if (!$value instanceof Mailable) {
+ throw NotAMailable::instanceOf($value::class);
  }
 
- return tap($value, function ($mailable) {
- if (!$mailable instanceof Mailable) {
- throw NotAMailable::instanceOf($mailable::class);
- }
-
- return serialize($mailable);
- });
+ // todo encrypt with ShouldBeEncrypted
+ return serialize($value);
  }
 }

src/Casts/SerializedObject.php

@@ -17,9 +17,9 @@ class SerializedObject implements CastsAttributes
  * @param array $attributes
  * @return mixed
  */
- public function get($model, string $key, $value, array $attributes): mixed
+ public function get($model, string $key, $value, array $attributes): array
  {
- return filled($value) ? unserialize($value) : null;
+ return filled($value) ? unserialize($value) : [];
  }
 
  /**
@@ -33,6 +33,6 @@ public function get($model, string $key, $value, array $attributes): mixed
  */
  public function set($model, string $key, $value, array $attributes): ?string
  {
- return filled($value) ? serialize($value) : null;
+ return filled($value) ? serialize($value) : serialize([]);
  }
 }

src/MailSchedulerServiceProvider.php

@@ -4,6 +4,8 @@
 
 namespace Oneduo\MailScheduler;
 
+use Illuminate\Console\Scheduling\Schedule;
+use Oneduo\MailScheduler\Console\Commands\SendEmails;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -15,6 +17,19 @@ public function configurePackage(Package $package): void
  ->name('laravel-mail-scheduler')
  ->hasConfigFile()
  ->hasMigration('create_scheduled_emails_table')
+ ->hasCommands(SendEmails::class)
  ->runsMigrations();
  }
+
+ public function boot()
+ {
+ parent::boot();
+
+ if (config('mail-scheduler.auto_schedule') === true) {
+ $schedule = app(Schedule::class);
+
+ $schedule->command(SendEmails::class)
+ ->cron(config('mail-scheduler.schedule_cron'));
+ }
+ }
 }

src/Models/ScheduledEmail.php

@@ -4,6 +4,7 @@
 
 namespace Oneduo\MailScheduler\Models;
 
+use Illuminate\Contracts\Mail\Mailable;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Oneduo\MailScheduler\Casts\SerializedMailable;
@@ -70,4 +71,15 @@ public static function serializeWithAttributes(array $attributes): array
  ], $attributes)
  ))->jsonSerialize();
  }
+
+ public static function fromMailable(Mailable $mailable, array $recipients, ?Model $source = null): static
+ {
+ return static::query()->create([
+ 'mailable' => $mailable,
+ 'recipients' => $recipients,
+ 'status' => EmailStatus::PENDING,
+ 'source_id' => $source?->getKey(),
+ 'source_type' => $source?->getMorphClass(),
+ ]);
+ }
 }

tests/Feature/SendEmailsTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Support\Facades\Mail;
+use Oneduo\MailScheduler\Console\Commands\SendEmails;
+use Oneduo\MailScheduler\Enums\EmailStatus;
+use Oneduo\MailScheduler\Models\ScheduledEmail;
+use Oneduo\MailScheduler\Tests\Support\TestMailable;
+use function Pest\Laravel\artisan;
+
+it('runs the command and sends the scheduled emails', function () {
+ Mail::fake();
+
+ collect(range(1, 10))
+ ->each(fn() => ScheduledEmail::fromMailable(mailable(), recipients()));
+
+ artisan(SendEmails::class)->assertOk();
+
+ Mail::assertSent(TestMailable::class);
+});
+
+it('fails to send scheduled emails without recipients', function () {
+ Mail::fake();
+
+ collect(range(1, 10))
+ ->each(fn() => ScheduledEmail::fromMailable(mailable(), []));
+
+ artisan(SendEmails::class)->assertOk();
+
+ $statuses = ScheduledEmail::query()->pluck('status');
+
+ expect($statuses->filter(fn(EmailStatus $status) => $status !== EmailStatus::ERROR))->toBeEmpty();
+});

tests/Pest.php

@@ -2,6 +2,22 @@
 
 declare(strict_types=1);
 
+use Illuminate\Foundation\Testing\LazilyRefreshDatabase;
+use Illuminate\Mail\Mailable;
+use Oneduo\MailScheduler\Tests\Support\TestMailable;
 use Oneduo\MailScheduler\Tests\TestCase;
 
-uses(TestCase::class)->in('Feature');
+uses(TestCase::class)->in(__DIR__);
+uses(LazilyRefreshDatabase::class)->in(__DIR__);
+
+function mailable(): Mailable
+{
+ return new TestMailable();
+}
+
+function recipients(): array
+{
+ return [
+ ...collect(range(1, 10))->map(fn () => fake()->email),
+ ];
+}

tests/Support/TestMailable.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Oneduo\MailScheduler\Tests\Support;
+
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+
+class TestMailable extends Mailable implements ShouldBeEncrypted
+{
+ public function envelope(): Envelope
+ {
+ return new Envelope(
+ subject: 'Test subject',
+ );
+ }
+
+ public function content(): Content
+ {
+ return new Content(
+ text: 'Test content',
+ );
+ }
+}

tests/Support/TestModel.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Oneduo\MailScheduler\Tests\Support;
+
+use Illuminate\Database\Eloquent\Model;
+
+class TestModel extends Model
+{
+}

tests/TestCase.php

@@ -4,14 +4,15 @@
 
 namespace Oneduo\MailScheduler\Tests;
 
+use Oneduo\MailScheduler\MailSchedulerServiceProvider;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 class TestCase extends Orchestra
 {
  protected function getPackageProviders($app): array
  {
  return [
-
+ MailSchedulerServiceProvider::class,
  ];
  }
 }