Laravel Task Scheduling

Dalam artikel ini kita akan belajar tentang schedule / penjadwalan pada laravel, saya akan berusaha sebisa mungkin untuk menjelaskan case ini agar Anda dapat mengerti dengan baik.

Instal Laravel

Kita akan mulai dari awal disini, sehingga kita akan lakukan dari yang pertama kali yaitu instalasi laravel nya, buka terminal Anda dan jalankan perintah berikut.

1laravel new schedule
2
bashCopy

Jika Anda tidak bisa instal laravel menggunakan laravel cli, Anda bisa menggunakan composer seperti berikut ini:

1composer create-project laravel/laravel schedule
2
bashCopy

Jika sudah, sekarang kita akan menjalankan perintah migrate, namun sebelum itu, pastikan dulu Anda sudah mempunyai database dan kemudian sesuaikan pada file .env.

1DB_CONNECTION=mysql
2DB_HOST=127.0.0.1
3DB_PORT=3306
4DB_DATABASE=schedule
5DB_USERNAME=root
6DB_PASSWORD=
7
envCopy

Setelah itu, mari kita lakukan migrate dengan menjalan perintah berikut.

1php artisan migrate
2
bashCopy

Factories dan Seeders

Oia, sepertinya kita butuh data untuk itu. Oleh karena itu, mari kita lakukan itu dengan factory. By default, laravel akan membawa yang factory untuk User yang itu bisa dilihat di database/factories/UserFactory.php, dan jika kita buka file nya kurang lebih akan seperti ini:

1<?php
2
3namespace Database\Factories;
4
5use Illuminate\Database\Eloquent\Factories\Factory;
6use Illuminate\Support\Str;
7
8/**
9 * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
10 */
11class UserFactory extends Factory
12{
13    public function definition(): array
14    {
15        return [
16            'name' => fake()->name(),
17            'email' => fake()->unique()->safeEmail(),
18            'email_verified_at' => now(),
19            'password' => bcrypt('password'),
20            'remember_token' => Str::random(10),
21        ];
22    }
23
24    public function unverified(): static
25    {
26        return $this->state(fn (array $attributes) => [
27            'email_verified_at' => null,
28        ]);
29    }
30}
31
phpCopy

Sebelum kita menjalankan nya, saya akan modifikasi dulu terlebih dahulu untuk field created_at and updated_at nya jadi random.

1public function definition(): array
2{
3    return [
4        'name' => fake()->name(),
5        'email' => fake()->unique()->safeEmail(),
6        'email_verified_at' => now(),
7        'password' => bcrypt('password'),
8        'remember_token' => Str::random(10),
9        'created_at' => $createdAt = collect([
10            now()->subMonth(2),
11            now()->subMonth(1),
12            now()->subWeek(2),
13            now()->subWeek(1),
14            now()
15        ])->random(1)->first(),
16        'updated_at' => $createdAt,
17    ];
18}
19
phpCopy

Setalah itu, silakan hilangkan komentar factory pada file database/seeders/DatabaseSeeder.php.

1<?php
2
3namespace Database\Seeders;
4
5use Illuminate\Database\Seeder;
6
7class DatabaseSeeder extends Seeder
8{
9    public function run(): void
10    {
11        \App\Models\User::factory(30)->create();
12
13        // \App\Models\User::factory()->create([
14        //     'name' => 'Test User',
15        //     'email' => '[email protected]',
16        // ]);
17    }
18}
19
phpCopy

Jika sudah, sekarang kita buka terminal kembali, dan sekarang kita akan menjalankan perintah untuk seeder nya seperti:

1php artisan migrate:fresh --seed
2
bashCopy

Dan jika sudah, harusnya pada tabel users akan sudah terbuat user sampai 30 dengan masing-masing created_at dan updated_at berbeda. Untuk melihatnya Anda bisa langsung pergi ke tinker dengan menjalankan perintah berikut:

1php artisan tinker
2
bashCopy

Dan kemudian pluck created_at nya seperti:

1Psy Shell v0.11.9 (PHP 8.1.11 — cli) by Justin Hileman
2> App\Models\User::pluck('created_at');
3
bashCopy

Dan harusnya output yang keluar pastinya seperti berikut:

1= Illuminate\Support\Collection {#4639
2    all: [
3      Illuminate\Support\Carbon @1669116509 {#4636
4        date: 2022-11-22 11:28:29.0 UTC (+00:00),
5      },
6      Illuminate\Support\Carbon @1667906909 {#4635
7        date: 2022-11-08 11:28:29.0 UTC (+00:00),
8      },
9      Illuminate\Support\Carbon @1668511709 {#4634
10        date: 2022-11-15 11:28:29.0 UTC (+00:00),
11
bashCopy

Perhatikan pada date nya, mereka sudah berbeda-beda jika Anda perhatikan baik-baik. Tetapi tidak cukup hanya itu, disini kita akan buat sampel bagaimana membuat schedule untuk menghapus pengguna yang tidak melakukan verifikasi email yang mana telah mendaftar 1/2 bulan lalu.

Make oleh karena itu, kita akan langsung directly dari tinker melakukan factory nya dengan state unverified yant telah di sediakan oleh laravel yaitu.

1public function unverified(): static
2{
3    return $this->state(fn (array $attributes) => [
4        'email_verified_at' => null,
5    ]);
6}
7
phpCopy

Nah untuk itu, buka silakan masuk lagi ke tinker dengan menjalankan php artisan tinker, setelah itu lakukan perintah berikut.

1> App\Models\User::factory(30)->unverified()->create();
2
bashCopy

Setelah itu, maka kita akan mempunyai total 60 pengguna, 30 yang verified dan 30 lagi tidak verified. Verified akan di lihat dari null nya field dari email_verified_at nya.

Sehingga sekarang, jika kita buat di tinker perintah:

1> App\Models\User::whereNull('email_verified_at')->count();
2= 30
3
bashCopy

Model Pruning

Yang paling pertama, mari kita buat pruning untuk tabel user ini, jadi kita akan melakukan penghapusan secara otomatis jika user tidak melakukan verifikasi selama 1/2 bulan misalnya.

Pertama sekali, untuk menggunakan pruning ini, kita harus memasukkan trait yang namanya Prunable. Untuk itu, buka model User.php dan tambahkan dia seperti:

1...
2use Illuminate\Database\Eloquent\Prunable;
3
4class User extends Authenticatable
5{
6    use HasApiTokens, HasFactory, Notifiable, Prunable;
7
phpCopy

Setelah itu, kita akan menambahkan metode baru pada model ini dengan nama prunable seperti:

1class User extends Authenticatable
2{
3    use HasApiTokens, HasFactory, Notifiable, Prunable;
4
5    protected $fillable = ['name', 'email', 'password'];
6
7    protected $hidden = ['password', 'remember_token'];
8
9    protected $casts = ['email_verified_at' => 'datetime'];
10
11    public function prunable()
12    {
13        return static::whereNull('email_verified_at')
14                ->where('created_at', '<=', now()
15                ->subMonth());
16    }
17}
18
phpCopy

Isi dari query tersebut adalah untuk memastikan kita akan mengapus user yang tidak verifikasi selama 1 bulan terakhir. Dan sekarang, Anda bisa buka file app/Console/Kernel.php untuk memasukkan schedule dengan menambahkan nya tepat di dalam methode schedule seperti:

1class Kernel extends ConsoleKernel
2{
3    protected function schedule(Schedule $schedule): void
4    {
5        $schedule->command('model:prune')->weekly();
6        // $schedule->command('inspire')->hourly();
7    }
8    
9    protected function commands(): void{...}
10}
11
phpCopy

Setelah itu, kita akan memeriksa apakah schedule itu sudah masuk atau belum di dalam tasklist nya dengan menjalankan perintah berikut:

1php artisan schedule:list
2
bashCopy

Maka harusnya, output yang dihasilkan kurang lebih akan seperti ini:

10 0 * * 0  php artisan model:prune ........................ Next Due: 4 days from now
2
bashCopy

Nah, untuk menjalankannya, kita menggunakan perintah schedule:run seperti:

1php artisan schedule:run
2
bashCopy

Dan harusnya, yang muncul adalah seperti:

1INFO  No scheduled commands are ready to run.
2
bashCopy

Arti dari info tersebut adalah tidak ada belum schedule yang mau di jalankan. Masuk akal memang, karena jika kita perhatikan tadi pada list schedule nya, itu akan di jalankan 4 hari lagi dari sekarang. Maka untuk itu, kita bisa modifikasi dia dengan cara mengganti weekly() dengan everyMinute() untuk contoh ini saja.

1class Kernel extends ConsoleKernel
2{
3    protected function schedule(Schedule $schedule): void
4    {
5        $schedule->command('model:prune')->everyMinute();
6        // $schedule->command('inspire')->hourly();
7    }
8    
9    protected function commands(): void{...}
10}
11
phpCopy

Pastinya jika ini di production, harusnya untuk case ini kita bisa jalankan sekali seminggu saja, namun untuk test saja, kita akan buat dia everyMinute agar kita yang mana telah di hapusnya.

Menjalankan Schedule di Lokal

Sekarang, untuk menjalankan schedule tersebut di background, kita bisa menggunakan perintah schedule:work seperti berikut:

1php artisan schedule:work
2
bashCopy

Sekarang jika Anda lihat outputnya setelah 1 menit akan seperti berikut:

1 INFO  Running schedule tasks every minute.
2
3  2022-11-22 11:55:00 Running ['artisan' model:prune] ............. 234ms DONE
4  ⇂ '/opt/homebrew/Cellar/php/8.1.11/bin/php' 'artisan' model:prune > '/dev/null' 2>&1
5
bashCopy

Dan perintah tersebut akan terus jalan setiap 1 menit. Maka nya sekarang di saya sudah 2 kali:

1  INFO  Running schedule tasks every minute.
2
3  2022-11-22 11:55:00 Running ['artisan' model:prune] ............. 234ms DONE
4  ⇂ '/opt/homebrew/Cellar/php/8.1.11/bin/php' 'artisan' model:prune > '/dev/null' 2>&1
5
6  2022-11-22 11:56:00 Running ['artisan' model:prune] ............. 183ms DONE
7  ⇂ '/opt/homebrew/Cellar/php/8.1.11/bin/php' 'artisan' model:prune > '/dev/null' 2>&1
8
bashCopy

Anda bisa tekan ctrl+c untuk menghentikan perintahnya. Dan sekarang, mari kita kembali ke tinker untuk menjalakan perintah yang tadi yaitu melihat jumlah yang tidak verifikasi tinggal berapa:

1php artisan tinker
2
bashCopy

Dan jalankan query seperti yang tadi:

1User::whereNull('email_verified_at')->count()
2= 20
3
bashCopy

Karena tadi kita buat random, maka hasilnya harusnya beda dengan Anda, kalau di saya hasilnya 20 seperti yang Anda lihat di atas, mungkin Anda bisa saja entah berapa, karena tergantung field created_at yang telah dibuat factory tadi.

Pastinya Anda akan menggunakan php artisan schedule:run pada saat production mode.

Dalam artikel ini, kita hanya memperaktekkan everyMinute, namun sebenarnya itu terserah Anda. Seperti yang saya bilang, harusnya untuk case ini, biasa saya hanya melakukan weekly dari pada everyMinute, karena jika ini terus-terus di jalankan, beban pada server akan semakin besar.

Daftar Penjadwalan

Berikut ini adalah metode-metode yang bisa Anda gunakan untuk pilihan waktu menjalankannya.

Metode di atas itu semua dari dokumentasi yang sudah saya artikan ke bahasa.

Hati - Hati

Pastikan untuk command schedule nya sudah cocok dengan crontab nya. Jika kalian menggunakan model 1/2 jam seperti misalnya menjalankan 04:30, maka pastikan Anda juga sudah yakin bahwa crontab nya jalan setiap 30 menit.

1$schedule->command('backup:run --only-db')->daily()->at('04.30');
2
phpCopy

Karena jika crontab jalan setiap 1 jam, maka schedule di atas tidak akan pernah jalan. Jadi pastikan Anda telah membuat sinkronisasi yang pasti antara crontab dan juga perintah schedule nya.

Penting Untuk Dipahami

Bayangkan jika kalian mempunyai beberapa tugas schedule, yang dari salah satunya itu mempunyai tugas yang sangat banyak dan lama.

By default, schedule akan menjalankan tergantung letak dari tugas yang di definisikan. Jadi jika kita punya tugas A,B,C dalam satu waktu, maka dia akan di order dari yang pertama.

Bayangkan jika B mempunyai tugas yang sangat lama, maka C akan terus menggu hingga B selesai, nah untuk itu, kita bisa menambahkan metode runInBackground setelah waktu yang di tentukan seperti:

1$schedule->command('analytics:report')
2         ->daily()
3         ->runInBackground();
4
phpCopy

Dengan begitu, C tidak akan menunggu B kelar, baru jalan.

Produksi

Jika kalian menggunakan Laravel forge, maka hal tersebut akan sangat mudah untuk di lakukan pada menu scheduler.

Dan jika kalian tidak menggunakan Laravel forge, harusnya kalian bisa menggunakan Crontab untuk menjalankan sechedule itu.

Semoga artikel ini dapat bermanfaat untuk kita semua ya. Jika ada salah kata saya mohon maaf. Saya Irsyad, dan sampai jumpa lagi.