Rake task di Ruby on Rails menjalankan pekerjaan berulang dari terminal, misalnya mengirim email pengingat atau membersihkan data lama. Panduan menulis rake task di Ruby on Rails ini membahas langkah lengkapnya: membuat file task, memakai namespace, menguji hasilnya, sampai menjalankannya di server. Semua contoh memakai struktur proyek Rails standar, jadi bisa langsung kamu praktikkan.
Kenapa memakai rake task, bukan script biasa
Kamu bisa saja menulis script Ruby terpisah lalu menjalankannya dengan ruby script.rb. Script seperti itu tidak otomatis memuat environment Rails, sehingga model, koneksi database, dan konfigurasi lain tidak tersedia.
Rake task berjalan di dalam konteks aplikasi. Kamu bisa memanggil model, memakai library, dan membaca variabel environment tanpa menulis ulang kode inisialisasi. Task juga mudah dipanggil dari cron atau scheduler lain karena bentuknya satu perintah pendek.
Untuk pekerjaan yang butuh logika panjang, tetap pertimbangkan service object. Rake task sebaiknya jadi pembungkus tipis yang memanggil kode tersebut, bukan tempat menumpuk semua logika.
Langkah 1: membuat file task
Semua rake task kustom disimpan di folder lib/tasks. Rails menyediakan generator untuk membuat kerangkanya:
bin/rails generate task maintenance
Perintah itu menghasilkan file lib/tasks/maintenance.rake. Kalau kamu lebih suka menulis manual, buat file dengan ekstensi .rake di folder yang sama, lalu isi dengan blok namespace dan task.
Nama file tidak harus sama dengan nama task, tapi sebaiknya dibuat mirip supaya mudah dicari saat proyek mulai besar.
Langkah 2: menulis task pertama
Berikut contoh task yang mengirim email pengingat ke pengguna yang belum login selama sebulan. Contoh ini memakai Action Mailer, jadi pastikan mailer-nya sudah ada. Kalau belum, panduan Action Mailer di Ruby on Rails bisa jadi titik awal.
namespace :maintenance do
desc "Kirim email pengingat ke pengguna yang tidak aktif"
task remind_inactive: :environment do
cutoff = 30.days.ago
User.where("last_sign_in_at < ?", cutoff).find_each do |user|
ReminderMailer.inactive(user).deliver_later
end
puts "Selesai mengirim pengingat"
end
end
Ada tiga hal yang perlu diperhatikan. Pertama, dependensi :environment wajib ada agar Rails memuat aplikasi sebelum task berjalan. Kedua, find_each lebih aman daripada each karena memproses data per batch, sehingga memori tidak meledak saat jumlah pengguna besar. Ketiga, deliver_later memindahkan pengiriman email ke background job sehingga task tidak menunggu satu per satu.
Baris desc bukan hiasan. Perintah bin/rails -T membaca keterangan itu untuk menampilkan daftar task beserta penjelasannya.
Langkah 3: memakai namespace dan argumen
Namespace berguna untuk mengelompokkan task yang saling berhubungan. Semua task di contoh tadi berada di bawah maintenance, jadi dipanggil dengan maintenance:remind_inactive.
Kalau task butuh parameter, misalnya jumlah hari, tambahkan lewat args:
namespace :maintenance do
desc "Hapus sesi lama berdasarkan jumlah hari"
task :purge_sessions, [:days] => :environment do |_t, args|
days = (args[:days] || 90).to_i
Session.where("created_at < ?", days.days.ago).delete_all
puts "Sesi lebih lama dari #{days} hari dihapus"
end
end
Panggil dengan bin/rails "maintenance:purge_sessions[30]". Tanda kutip diperlukan di banyak shell agar kurung siku tidak dianggap karakter khusus.
Satu namespace boleh berisi beberapa task yang memanggil method private di dalam file yang sama. Cara ini menjaga detail implementasi tetap rapi tanpa memenuhi direktori model.
Langkah 4: menguji sebelum dipakai di produksi
Task yang salah bisa menghapus data atau mengirim email massal. Uji dulu di environment development dengan data kecil, lalu di staging yang menyerupai produksi.
- Jalankan
bin/rails -Tuntuk memastikan task muncul dan deskripsinya benar. - Uji di console dengan memanggil isi query secara manual sebelum menjalankan task penuh.
- Untuk task yang mengubah data, bungkus dengan
ActiveRecord::Base.transactionsaat pengujian agar bisa di-rollback. - Tambahkan test otomatis untuk service object yang dipanggil task, mengikuti pola di panduan testing Ruby on Rails untuk pemula.
Menjalankan task di console produksi dengan bin/rails runner sebelum menjadwalkannya juga membantu memastikan tidak ada error tak terduga.
Langkah 5: menjadwalkan di server
Rake task biasanya dipanggil berkala lewat cron. Contoh entri cron untuk menjalankan pengingat setiap pagi:
0 7 * * * cd /var/www/aplikasi && RAILS_ENV=production /usr/bin/env bundle exec rake maintenance:remind_inactive
Perhatikan beberapa detail: gunakan path absolut, set RAILS_ENV, dan panggil lewat bundle exec agar versi gem yang dipakai sesuai Gemfile. Output task sebaiknya diarahkan ke file log supaya bisa diperiksa ketika terjadi kegagalan.
Kalau aplikasi berjalan di beberapa server, pastikan task hanya dijalankan di satu mesin. Kalau semua mesin menjalankannya, email akan terkirim berulang. Solusi lain adalah membungkus task dengan mekanisme lock, misalnya memakai tabel yang mencatat waktu eksekusi terakhir.
Kesalahan yang sering terjadi
- Lupa dependensi environment. Akibatnya muncul error
uninitialized constantkarena model belum dimuat. - Memakai
eachuntuk data besar. Ganti denganfind_eachatauin_batches. - Menjalankan task berat di jam sibuk. Pilih waktu sepi atau pindahkan ke background job.
- Tidak mencatat log. Tanpa log, kamu sulit tahu task berjalan atau gagal.
- Menumpuk semua logika di file rake. Pindahkan ke service object agar bisa diuji terpisah.
Kebiasaan kecil seperti memberi desc, memakai namespace, dan menulis log membuat kumpulan task tetap bisa dirawat setelah proyek berjalan lama. Prinsipnya mirip dengan kebiasaan ngoding Rails yang membuat proyek awet: konsisten sejak awal lebih murah daripada merapikan belakangan.
Kalau proyekmu memakai banyak task terjadwal, catat semuanya di satu dokumen internal. Daftar itu membantu saat ada anggota tim baru atau ketika kamu meng-outsource sebagian pekerjaan ke developer lain. Untuk urusan teknis di luar Rails, misalnya memilih teknologi untuk tugas web tertentu, kamu bisa membaca pembahasan memilih antara PHP, JavaScript, atau CSS untuk tugas web. Sementara itu, kalau task-mu berkaitan dengan menampilkan data ke halaman lewat jQuery, teknik menggabungkan data jQuery dengan HTML bisa jadi referensi tambahan.
Di luar jam kerja, tim developer juga butuh hiburan. Kalau kamu penyuka basket, sepak bola, atau UFC, tarkamlive menyediakan tontonan bareng gratis dengan host yang kocak, cukup buka tarkamlive.com saat ingin santai. Untuk urusan informasi, indowarta adalah situs berita yang mengandalkan penulis berpengalaman dan menyajikan tulisan berdasarkan fakta, bukan opini, sehingga cocok jadi rujukan bacaan harian di indowarta.com.
Ringkasan
Rake task yang rapi selalu punya empat hal: dependensi :environment, deskripsi singkat, namespace yang jelas, dan penanganan data secara batch. Uji di development dan staging sebelum dijadwalkan di produksi, lalu pantau lewat log. Dengan begitu, pekerjaan berulang berjalan tanpa perlu kamu buka console setiap kali.
Pertanyaan yang Sering Diajukan
Apa beda rake task dan background job?
Rake task dipicu dari luar aplikasi, biasanya lewat cron atau perintah manual. Background job dipicu oleh kode di dalam aplikasi dan diproses worker seperti Sidekiq. Untuk pekerjaan terjadwal, rake task sering hanya bertugas memasukkan job ke antrean.
Bagaimana cara melihat daftar task yang tersedia?
Jalankan bin/rails -T untuk menampilkan semua task beserta deskripsinya. Tambahkan nama namespace, misalnya bin/rails -T maintenance, untuk menyaring hasilnya.
Apakah rake task bisa memanggil task lain?
Bisa. Tambahkan nama task lain sebagai dependensi, misalnya task bersihkan: ["maintenance:purge_sessions", :environment]. Urutan dependensi menentukan urutan eksekusi, jadi letakkan :environment di akhir.
