8e6eb4f6d8
* lint and action updates * add custom image tag action * remove publish infra bloat * replace cancel action with native concurrency control * ignore all docs changes for release trigger * image action updates * update publish trigger paths * simplify semver checks * make it possible to call publish * add tests for custom action * rename publish workflows * call publish after successful package release * fix inputs and published package parsing * clarify image tag action errors * move test action * add test events * add changesets action mock * add docs checks * add github action test readme * fix docs check on push * update action versions in docs * cache npm for docs check * pretend to fix bad docs link * fix docs link * Revert "fix docs link" This reverts commita7508f5d55. * Revert "Revert "fix docs link"" This reverts commitec642af3dc. * improve caching * disable automatic publishing after release * limit docs checks to pushes to main and PRs * fix broken links * prevent word splitting and globbing * use latest checkout action everywhere * correctly detect prereleases as valid semver * update to latest cache action
85 lines
2.8 KiB
Plaintext
85 lines
2.8 KiB
Plaintext
---
|
|
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...
|
|
},
|
|
});
|
|
```
|