English for Restate Developers

Обговорення Restate зосереджені на тривалому виконанні, концепції, яка не знайома командам, які використовують прості послуги запит-відповідь, тому словник повинен охоплювати журналювання, відтворення і гарантії, які дозволяють потоку роботи пережити аварію в середині виконання.

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

** Тривале виконання ** — модель програмування, у якій поступ функції зберігається крок за кроком, отже, якщо процес завершиться аварійно, він буде відновлено з того місця, де його було припинено, замість того, щоб перезапускати з нуля.

• “Тривале виконання є причиною того, чому цей робочий процес пережив перезапуск підрозділу у середині оплати — він відновив роботу з останнього виконаного кроку замість подвійного стягнення коштів з клієнта.” *

** Журнал виконання ** — тривалий запис, який можна лише додати, кожного кроку, який виконано тривалою функцією, який програма Restate відтворює знову, щоб відновити стан після помилки або перезапуску. “Журнал виконання показує, які кроки було виконано до аварії — саме так програма Restate знає, що не повторювати крок оплати при відновленні.”

** Ідемотентне повторення ** — гарантія того, що повторне виконання завершених кроків тривалої функції під час відновлення не повторює їх побічні ефекти, а лише відновлює стан у пам’ яті з журналу.

• “Неможливість повторення означає, що крок електронної пошти не надсилатиме другого підтвердження — програма Restate розпізнає його як вже виконаний і просто повторює запис результату.” *

** Віртуальний об’ єкт ** — абстракція Перезапис, що представляє однопоточна, станова сутність (наприклад, сеанс одного користувача), яка обробляє свої виклики послідовно, уникаючи умов переслідування без ручного блокування.

• “Ми створили модель кошика покупок як віртуального об’ єкта, тому одночасні оновлення від одного користувача обробляються одне за одним, без написання коду блокування.” *

** Семантика « тільки- но » ** — гарантія того, що дану дію буде ефективно виконано лише один раз, навіть після повторних спроб або аварій, що забезпечується такими стійкими структурами виконання, як Restate, без потреби реалізації програмою власної логіки дедуплікації. “Ми повністю вилучили нашу нетипову таблицю дедуплікації — семантика точного повторення для цього обробника вже гарантує, що плата не буде застосована двічі.”

Звичайні фрази

• «Це робочий процес насправді використовує тривале виконання, або аварія тут втратить прогрес і перезавантажиться з верхньої частини?»
• Чи показує журнал виконання, звідки це відновлено, або щось пішло не так під час перегляду?»
• Чи гарантована тут ідемпотентна повторна гра, чи має цей крок побічну дію, яка б підвищила ризик повторного пострілу?»
• Чи варто це моделювати як віртуальний об’єкт, щоб уникнути гоночних умов, які ми бачимо на одночасних оновленнях?»
• «Чи ми насправді потребуємо семантику точно-один раз тут, або принаймні один раз з нашою власною логікою дедупу достатньо?»

Приклади висловлювань

Пояснення гарантії стійкості для зацікавлених сторін: “Тривале виконання означає, що цей поток обробки замовлень може пережити перезапуск розгортання в середині польоту — він відновлюється з останнього завершеного кроку, він не починається знову.”

Перегляд проекту потоку робіт:

• “Модельуйте це як віртуальний об’ єкт — зараз два одночасних запиту для одного користувача можуть переслідувати один одного, і віртуальний об’ єкт автоматично серіалізує їх для вас.” *

Зневадження проблеми відновлення: “Перевірити журнал виконання для цього виклику — якщо повторення idempotent працює правильно, ми не повинні бачити, що цей крок сповіщення викликається двічі.”

Професійні поради

• Поясніть тривале виконання конкретним прикладом відновлення після аварії — це абстрактно, поки ви не покажете, що означає «продовження роботи з того місця, де вона була припинена» для реального потоку роботи.
• Вказувати на журнал ** виконання ** під час зневадження проблеми відновлення — це основна інформація про те, що було виконано до аварії.
• Явно підтверджувати idempotent replay для будь- якого кроку з зовнішнім побічним ефектом (наприклад, надсилання електронної пошти, зарядження картки) — ця властивість запобігає дублюванню дій у відновленні.
• Використовуйте ** віртуальний об’ єкт ** для опису будь- якої сутності, що потребує серіалізованої, по- ключовій обробки — це переформулює проблему одночасності як вибір моделювання замість проблеми блокування.

Практичні вправи

1. Поясніть колегі, як виконувати постійний поток робіт, який завершується аварійно і його слід відновити без повторення виконаних кроків.
2. Описати, чому повторення idempotent важливе, особливо для кроків, які надсилають електронні листи або стягують платежі.
3. Напишіть речення, у якому буде запропоновано використовувати віртуальний об’ єкт для виправлення умови перегонів при одночасному оновленні одного і того ж об’ єкта.

Національний мовний стандарт: підготовка до впровадження

Як розробник Restate, ви не просто будуєте системи; ви повідомляєте складні ідеї про довговічність, стійкість до помилок і управління станом. Для не-рідних англомовних носіїв, це може бути особливо складним, тому що сама термінологія часто має шари значення за межами буквального визначення. Це не просто про те, щоб знати * що * “точно-один раз” означає - це про передачу цього розуміння чітко і чітко колегам, які можуть мати різні джерела або рівень знайомства з цими поняттями. Ключовим є перейти від перекладу на слово до створення ваших ідей таким чином, щоб вони відповідали більшій аудиторії, передбачаючи потенційні точки заплутаності.

Одна часті перешкоди виникають під час перегляду коду. Розглянемо цей сценарій: рецензент залишає коментар « Цей потік не стійкий до перехідних помилок мережі ». Хоча це технічно вірно — тобто, робочий потік може зазнати невдачі, якщо виникне тимчасова проблема з’ єднання — це може здатися обвинувачуючим або надто технічним. Більш конструктивним підходом було б: «Чи можемо ми додати логіку повторних спроб тут у випадку періодичних проблем з мережею? Можливо, обгорнути виклик API у блок try...catch і реалізувати експоненційне відновлення?» Зауважте, що це переносить фокус на * розв’ язання *, а не просто на вказівку на потенційну проблему. Аналогічно, розмови Slack можуть швидко застрягти, якщо ви використовуєте жаргон без пояснення. Замість того, щоб сказати «Ми повинні забезпечити ідемпотентність», спробуйте «Давайте переконаємося, що запуск цього процесу кілька разів має той же ефект, що і запуск одного разу — запобігання дублювання операцій»

Іншою областю, де чіткість є критичним є в описах Pull Request (PR). Хороший опис PR повинен чітко сформулювати * чому * ви робите зміну і як вона пов’язана з основними принципами Restate. Наприклад, замість « Впроваджено нове ведення журналу », кращим описом може бути: « Додано докладне ведення журналу навколо кроку обробки повідомлення, щоб полегшити зневадження у випадку порушення гарантій точного одноразового використання. » Це дозволяє нам відстежувати окремі повідомлення через робочий потік і підтверджувати їх успішну доставку. ”

Нарешті, пам’ятайте, що активне слухання так само важливо, як і чітке мовлення. Якщо хтось використовує термін, якого ви не розумієте, ввічливо попросіть про пояснення — « Чи можете ви розібратися, що ви маєте на увазі під « тривалим виконанням » у цьому контексті? » Не бійтеся розбивати складні ідеї на менші, більш зрозумілі частини. Терпіння і готовність пояснити ваші аргументи допоможуть вам у покращенні співпраці і забезпечать, що всі будуть розуміти цілі вашого проекту Restate.

Ось приклад, який показує, як ви можете використовувати restatesql для перевірки семантики точного одиничного повторення:

import restatesql

query = """
SELECT COUNT(*) FROM messages WHERE workflow_id = 'my-workflow' AND message_id = '12345'
"""

result = restatesql.execute(query)

if result[0][0] == 0:
  print("Message 12345 was successfully processed exactly once.")
else:
  print("Warning! Message 12345 appears to have been processed more than once.")