English Vocabulary for Inngest Background Jobs

Inngest — це платформа для роботи у фоновому режимі без сервера, яка надає вам змогу писати надійні, багатокрокові функції на мовах TypeScript або Python без керування чергами, працівниками або інфраструктурою. Його розроблено для епохи безсерверного виконання — ваші функції виконуються як окремі кроки, які можуть перебувати у стані сну, чекати на події і автоматично повторювати спроби, причому всі ці дії можна виконати без тривалого запущеного процесу сервера. Якщо ваша команда використовує Inngest для обробки фонових даних, виконання запланованих завдань або складних потоків робіт, розуміння його словника допоможе вам розробляти кращі функції, зневаджувати помилки і чітко розуміти перегляди архітектури. У цьому повідомленні описано основні терміни інтеграції.

Ключовий словник

** createFunction ** Основний API Inngest для визначення функції фону. Ви викликаєте inngest.createFunction() з об’ єктом налаштування (включаючи ідентифікатор функції і тригер) і функцією обробки. Обробник отримує event і step об’єкти як аргументи і визначає логіку функції.

• Приклад: « Створити функцію Inngest з createFunction для обробки після- покупки — передати назву події тригера і написати кроки для надсилання електронної пошти з підтвердженням, оновлення запасів і повідомлення складу. » *

** Тригер (подія / cron) ** Умова, яка викликає виконання функції Inngest. Тригер події запускається, коли до Inngest надсилається подія з певною назвою. Тригер cron запускає дію за розкладом, визначеним у виразі cron. Одна функція може мати один тригер.

• Приклад: « Використовуйте тригер події на user.signup для потоку роботи з підготовки до роботи і тригер cron з 0 8 * * 1 для ранкової електронної пошти з підсумками за понеділок — кожен тип тригера обслуговує різні випадки використання. » *

Крок.Біг Метод, який обгортає одиницю роботи всередині кроку інтеграції. Якщо виконання кроків зазнає невдачі, їх автоматично повторюють, а результати їх виконання записуються у пам’ ять — якщо функцію буде виконано знову (через аварію або перевиконання часу очікування), виконані кроки не буде виконано знову. Це робить багатокрокові функції безпечними для повторного виконання. Приклад: “Загорнути кожен зовнішній виклик API в step.run, щоб якщо функція зазнає невдачі після виклику Stripe, але перед надсиланням електронної пошти з підтвердженням, плата Stripe не буде зроблена знову при повторному спробі.”

Спить Метод, який призупиняє функцію Inngest на вказаний час — секунди, хвилини, години або дні — без використання обчислювальних ресурсів під час паузи. Після закінчення періоду сну функція буде відновлено з того місця, де вона була припинена.

• Приклад: « Скористайтеся step.sleep('3 days'), щоб призупинити пробний поток нагадування — функція буде відновлено автоматично через три дні після початку пробного періоду і буде надіслано нагадування електронною поштою без будь- якого завдання cron або запланованого завдання. » *

** Ключ одночасності ** Параметри налаштування, які обмежують кількість екземплярів функції, які можна запустити одночасно для вказаного значення ключа. Наприклад, встановлення ключа одночасності event.data.user_id забезпечує, що тільки один екземпляр функції виконується на користувача в один момент часу, запобігаючи умовам гонки. Приклад: «Додати ключ одночасності на event.data.account_id для функції синхронізації розрахунків — ми не хочемо, щоб дві задачі синхронізації виконувалися одночасно для одного облікового запису, інакше ми отримаємо дублікат платежу.»

Скасовано Можливість зупинити запущену або неактивну функцію Inngest за допомогою події. Ви налаштовуєте подію скасування у визначенні функції, і після надсилання цієї події Inngest автоматично скасує всі відповідні запущені екземпляри функції. Корисно для скасування потоків робіт, коли змінюється стан користувача. Приклад: «Налаштувати скасування на user.deleted для послідовності запуску — якщо користувач вилучає свій обліковий запис під час виконання послідовності, ми не хочемо продовжувати надсилати йому електронні листи.»

Потрібна інформація про подію Об’ єкт даних, надісланий з подією Inngest. Він містить name (рядок типу події) і data об’єкт з довільними полями. Корисна нагрузка доступна в обробнику функцій як event.data і також використовується для пошуку відповідності в правилах одночасності ключів і скасування. Приклад: “Упевніться, що вантаж події order.placed включає поля order_id, user_id і total_amount — функція виконання потребує всіх трьох, щоб обробити замовлення правильно.”

Як використовувати цей словник

Обговорення архітектури Inngest зазвичай зосереджено на кроці розробки — « як розбити цей поток роботи на відокремлені, повторювані кроки? » — і виборі тригера — « чи слід керувати цим за допомогою подій чи планувати? » Ключовим моментом, який слід вказати, є те, що межі step.run визначають як одиниці повторення, так і контрольні точки: якщо функція завершиться аварійно, Inngest повторить процес з останнього завершеного кроку, а не з початку.

Обговорення одночасності і скасування відбуваються, коли команди інтегрують Inngest з діями, які виконуються користувачем. « Що станеться, якщо користувач двічі швидко запустить цю функцію? » призведе до обговорення ключів одночасності. « Що станеться, якщо користувач скасує свою підписку у середині потоку роботи? » призведе до обговорення налаштування скасування.

Приклад розмови

** Саша: ** Функція обробки замовлення зазнає невдачі на півдорозі — Stripe проводить обчислення, але виклик API виконання зазнає невдачі. Мы также видим дубликаты обвинений при повторных попытках. Сходи загорнутi в step.run? Якщо виклик Stripe не знаходиться у кроці, його буде виконано знову при кожній спробі. Нет, не так. Я обгортаю обидва виклики в окремі блоки step.run — таким чином Stripe стягує лише один раз, навіть якщо крок виконання зазнає невдачі і повторюється. ** Lee: ** Также добавьте ключ одновременности на order_id так что мы не можем обрабатывать один и тот же запрос дважды параллельно.

Practice

1. Створити функцію Inngest для послідовності запуску користувача: негайно надіслати привітальну ел. пошту, зачекати 3 дні, надіслати підказку ел. поштою, зачекати 7 днів, надіслати пропозицію щодо оновлення. Напишіть кожен крок англійською мовою, назвавши методи інтеграції, які ви використовуватимете.
2. Поясніть колегі, чому обгортання коду в step.run важливо для надійності. Використовуйте слова “повторна спроба”, “запам’ятовування”, “неможливість” і “контрольний пункт” у своєму поясненні.
3. Наведіть приклад потоку дій, у якому використовуватиметься як ключ одночасності, так і правило скасування. Описати бізнес- сценарій, чому кожен з них потрібен, і що могло б статися без них.

На практиці: Навігація зворотного зв’язку та співпраця з Inngest

Погляньмо правді в очі: вивчення нового технічного інструмента - це одне; ефективне спілкування про нього в професійному середовищі - особливо, коли ви все ще розвиваєте свою англійську мову - це інше. Це не тільки про те, щоб знати слова для createFunction або event, але також як обговорювати дискусії, запитувати зміни і чітко пояснити свої аргументи. Поширений сценарій включає отримання зворотнього зв’язку на PR, який використовує Inngest. Уявіть собі таке: ви провели останні кілька днів у створенні нового потоку робіт для спостереження за змінами у схемі бази даних за допомогою тригерів cron, з метою попередження у майже реальному часі. Ви надсилаєте свій код, створюєте запит на завантаження, а потім отримуєте коментар від Сари під час перегляду коду. Він пише: «Це хороша робота, але я турбуюся про ключ одночасності тут. Ми бачимо стрімке зростання використання процесора, коли декілька змін схем відбуваються одночасно. Чи можете ви дослідити зменшення одночасності або додати деякі дрослінг логіки?”

А теперь, как ты конструктивно отвечаешь? Просто сказати «Гаразд, дякую» недостатньо. Вам нужно продемонстрировать понимание и желание решить эту проблему. Хорошою відповіддю може бути: « Дякую, що позначила це, Сара! Я вдячний, що ти вказала на потенційні піки процесорного навантаження. Я використовував ключ одночасності 5 на цьому кроці, тому що хотів переконатися, що ми швидко захопили всі зміни схеми. Я погоджуюсь, що це, ймовірно, сприяє проблемі. Я збираюся дослідити зменшення його і, можливо, додавання деяких викликів step.sleep після кожної зміни, щоб забезпечити трохи буфера. Чи могли б ви поділитися своїми думками щодо того, який рівень одночасності є найбільш підходящим, враховуючи наші поточні навантаження? Можливо, ми можемо експериментувати з різними значеннями у середовищі тестування. » Зауважте, що у цій відповіді підтверджується отриманий зворотній зв’ язок, пояснюється * чому * ви зробили початковий вибір (продемонстровано процес мислення) і пропонується спільне рішення. Це про те, щоб показати, що ви активно слухаєте і вносите свій внесок у більш міцний робочий процес. Аналогічно, при описі PR за допомогою Inngest, чіткість є найважливішою – «Ця PR вводить новий createFunction, викликаний змінами схеми бази даних через завдання cron. Функція використовує step.run для виконання ряду кроків, включаючи перевірку даних і попередження. ”

Крім того, не бійтеся задати прояснюючі питання. Якщо ви не впевнені щодо чогось, пов’ язаного з Inngest, наприклад, щодо наслідків використання певного ключа одночасності або розуміння того, як працюють тригери cron, попросити про пояснення * завжди * краще, ніж робити це на сліпо. Це показує ініціативу і бажання навчатися. Пам’ятайте, що ефективне спілкування не тільки про технічну точність; це про будівництво довіри і сприяння співпраці в межах вашої команди. Це включає у себе активне документування обґрунтування ваших налаштувань Inngest — пояснення * чому* ви обираєте певний тригер, параметр одночасності або порядок кроків може бути надзвичайно цінним для майбутніх супровідників.

# Example: Scheduling a cron trigger to run daily at 3 AM using Inngest
ingest schedule create --name "DailySchemaCheck" \
  --cron "0 3 * * *" \
  --event "schema_change" \
  --createFunction "my_schema_check_function"

За допомогою цієї команди можна продемонструвати основні параметри планування, підсвічуючи ключові компоненти: name, вираз cron для запуску, тип події ( schema_change ) і функцію, яку слід виконати. Зрозуміти ці елементи дуже важливо під час обговорення або зміни потоків робіт Inngest з вашою командою.