Skip to Content

enqueue

Đưa một việc chậm vào hàng đợi để chạy sau trong một file *.job.ts, có thử lại khi lỗi. Request trả lời ngay, không phải chờ.

Cách dùng

app/invoices/[id:int]/send/post.ts
import { enqueue } from "manh/jobs"; import { markSending } from "../../repository"; export default async (c, { user, param }) => { const inv = await markSending(user, param.id); enqueue("app/invoices/send.job.ts", { invoiceId: inv.id }); // chạy càng sớm càng tốt return inv; };
app/invoices/send.job.ts
import { email } from "manh/email"; import { getInvoice } from "./repository"; export default async function (payload: { invoiceId: number }) { const inv = await getInvoice(payload.invoiceId); await email({ to: inv.customerEmail, subject: `Hoá đơn ${inv.code}`, html: renderInvoice(inv) }); }

Chỉ dùng trong file .ts: handler, cron, job.

Chữ ký

manh/jobs
function enqueue(path: string, payload?: unknown, opts?: { delaySeconds?: number }): string | null;

Tham số

  • path: đường dẫn đầy đủ tới file job, dạng app/…/<tên>.job.ts. Sai dạng thì hàm ném lỗi.
  • payload: dữ liệu JSON đưa cho job. Chỉ gửi id; tổng payload các job trong một request tối đa 32 KB.
  • opts.delaySeconds: chờ bao nhiêu giây rồi mới chạy, tối đa 30 ngày (2.592.000 giây). Bỏ trống là chạy ngay khi được.

Trả về

Mã của job (chuỗi). Job được đưa vào hàng đợi khi request trả response. Gọi ngoài một request của app thì hàm không làm gì và trả null.

Ví dụ

Nhắc hạn sau 3 ngày:

app/invoices/repository.ts
enqueue("app/reminders/due.job.ts", { invoiceId: inv.id }, { delaySeconds: 3 * 86400 });
  • Job lỗi (ném lỗi hoặc trả 5xx) được thử lại, tổng cộng tối đa 3 lần, cách nhau 30 rồi 60 giây. File job đã bị xoá ở bản deploy sau thì job hỏng ngay, không thử lại.
  • Vì có thể chạy lại, job phải an toàn khi chạy hai lần.
  • Xem các lần chạy và lỗi ở mục Vận hành › Việc nền của không gian làm việc.

Bước tiếp theo

Cập nhật