chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: "Regular tasks"
|
||||
description: "The simplest type of task which can be triggered from elsewhere in your code."
|
||||
---
|
||||
|
||||
import OpenaiRetry from "/snippets/code/openai-retry.mdx"
|
||||
|
||||
They are defined using the `task()` function and can be [triggered](/triggering) from your backend or inside another task.
|
||||
|
||||
Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/config/config-file), and you [can configure them](/tasks/overview#defining-a-task).
|
||||
|
||||
## Example tasks
|
||||
|
||||
### A task that does an OpenAI call with retrying
|
||||
|
||||
Sometimes OpenAI calls can take a long time to complete, or they can fail. This task will retry if the API call fails completely or if the response is empty.
|
||||
|
||||
<OpenaiRetry />
|
||||
|
||||
### A Task that sends emails in a sequence with delays in between
|
||||
|
||||
This example uses Resend to send a sequence of emails over several days.
|
||||
|
||||
Each email is wrapped in `retry.onThrow`. This will retry the block of code if an error is thrown. This is useful when you don't want to retry the whole task, but just a part of it. The entire task will use the default retrying, so can also retry.
|
||||
|
||||
Additionally this task uses `wait.for` to wait for a certain amount of time before sending the next email. During the waiting time, the task will be paused and will not consume any resources.
|
||||
|
||||
```ts /trigger/email-sequence.ts
|
||||
import { Resend } from "resend";
|
||||
|
||||
const resend = new Resend(process.env.RESEND_ASP_KEY);
|
||||
|
||||
export const emailSequence = task({
|
||||
id: "email-sequence",
|
||||
run: async (payload: { userId: string; email: string; name: string }) => {
|
||||
console.log(`Start email sequence for user ${payload.userId}`, payload);
|
||||
|
||||
//send the first email immediately
|
||||
const firstEmailResult = await retry.onThrow(
|
||||
async ({ attempt }) => {
|
||||
const { data, error } = await resend.emails.send({
|
||||
from: "hello@trigger.dev",
|
||||
to: payload.email,
|
||||
subject: "Welcome to Trigger.dev",
|
||||
html: `<p>Hello ${payload.name},</p><p>Welcome to Trigger.dev</p>`,
|
||||
});
|
||||
|
||||
if (error) {
|
||||
//throwing an error will trigger a retry of this block
|
||||
throw error;
|
||||
}
|
||||
|
||||
return data;
|
||||
},
|
||||
{ maxAttempts: 3 }
|
||||
);
|
||||
|
||||
//then wait 3 days
|
||||
await wait.for({ days: 3 });
|
||||
|
||||
//send the second email
|
||||
const secondEmailResult = await retry.onThrow(
|
||||
async ({ attempt }) => {
|
||||
const { data, error } = await resend.emails.send({
|
||||
from: "hello@trigger.dev",
|
||||
to: payload.email,
|
||||
subject: "Some tips for you",
|
||||
html: `<p>Hello ${payload.name},</p><p>Here are some tips for you…</p>`,
|
||||
});
|
||||
|
||||
if (error) {
|
||||
//throwing an error will trigger a retry of this block
|
||||
throw error;
|
||||
}
|
||||
|
||||
return data;
|
||||
},
|
||||
{ maxAttempts: 3 }
|
||||
);
|
||||
|
||||
//etc...
|
||||
},
|
||||
});
|
||||
```
|
||||
Reference in New Issue
Block a user