Англійська мова для Encore.ts Developers

Обговорення Encore.ts змішують терміни backend framework з словником інфраструктури, оскільки весь хід framework генерує хмарну інфраструктуру з анотації коду, а не окремих конфігураційних файлів.

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

Service — одиниця верхнього рівня коду Encore.ts, оголошена зі спеціальною структурою каталогів, яку фреймворк розглядає як незалежно розгортається мікросервіс з власною поверхнею API.

• “Пересунути логіку сповіщень у власну службу замість теки всередині головного API — таким чином вона отримає власні межі служби і зможе масштабуватися окремо.” *

Інфраструктура з коду — підхід Encore.ts до забезпечення баз даних, черг та інших хмарних ресурсів автоматично на основі того, як вони декларуються в коді програми, а не написані вручну Terraform або CloudFormation. “Ми не написали жодної Terraform для цієї черги — інфраструктура з коду обробляла її на основі декларації Topic.”

** Публікація/ підтема ** — канал повідомлень з назвою, оголошений у коді, на який служби публікують події і підписуються, з Encore. ts, який керує базовим брокером повідомлень.

• “Опублікувати подію OrderPlaced до теми замість виклику служби доставки безпосередньо — це роз’ єднає ці дві служби і дозволить нам додати більше підписників пізніше.” *

** Панель локального розробника ** — вбудований веб-інтерфейс Encore.ts, який візуалізує виклики API, сліди і архітектуру сервісу під час роботи локально, без додаткових інструментів. “Перевірте локальний панелі розробників перед додаванням більшої кількості записів у журнал — він вже відстежує повний запит по всіх службах.”

** API contract ** — типова форма запиту і відповіді для кінцевої точки, визначена безпосередньо у коді, яку Encore. ts використовує для автоматичного створення документації і клієнтських SDK. “Спочатку оновіть контракт API — створений клієнт і документація буде автоматично оновлено після зміни типів.”

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

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

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

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

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

Перегляд запиту на звантаження: “Контракт API змінився, але виклики клієнта не були оновлені — відтворіть SDK перед об’ єднанням.”

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

• Використовуйте infrastructure from code, коли пояснюєте, як ресурс був створений — це заголовна функція фрейму і сигналізує про те, що ви розумієте модель розгортання.
• Використовуйте service навмисно, щоб мати на увазі розгортання Encore.ts верхнього рівня, а не просто “файл” або “теку” - фреймворк розглядає межу як значущу.
• Спостерігати за ** локальною панеллю розробки ** під час зневадження проблем між службами, замість того, щоб спочатку звертатися до зовнішніх інструментів відстеження.
• Викликати зміни до ** API контракту ** явно в описах PR — це сигналізує нижнім користувачам і створеним клієнтам, що можуть знадобитися оновлення.

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

1. Поясніть, що означає «інфраструктура з коду» і як вона відрізняється від написання Terraform вручну.
2. Описати різницю між викликом служби безпосередньо і публікацією у публікації/ підтемі.
3. Напишіть речення, у якому поясните, для чого потрібна панель локальних розробок під час зневадження.

Навигація Nuance: Common Phrasing in Encore.ts Discussions (англійською)

Як розробники, що працюють з Encore.ts, ви швидко усвідомите, що технічне спілкування не просто про передачу інформації; це про те, щоб зробити це чітко, коротко і з повагою - особливо при співпраці між командами і потенційно різними культурними традиціями. Багато з основних концепцій - послуги, публікації / підтеми, інфраструктура-як-код - легко перекладаються, але їх * використання * в професійних умовах часто вимагає спеціального реєстру, який приоритизує точність і уникає двозначності. Необов’ язкового « ця служба не працює » недостатньо; вам потрібно сформулювати * чому *, запропонувати потенційні рішення або обсяг проблеми. Аналогічно, просто сказати «виправити цю тему» не має контексту. Це розуміння впливу на систему і ефективне поширення цього розуміння.

Частий сценарій включає перегляд коду. Отримання коментаря на кшталт « Потрібно більше обробки помилок » може здатися неоднозначним. Краще відповідь - і один, що демонструє, що ви зрозуміли занепокоєння рецензента - буде: “Я ціную відгук щодо обробки помилок. Я додаю блок try/ catch для обробки потенційних помилок мережі під час отримання даних, як це описано у документації служби. За допомогою цього пункту можна записати у журнал певний тип помилки для зневадження. Зауважте, що за допомогою цього пункту можна розширити початковий коментар про деталі, які можна використовувати, і посилання на відповідні ресурси. Це не просто питання вирішення проблеми; це питання продемонструвати розуміння і активний підхід. Інша поширена фраза — «Розгляньте від’єднання цього» — пропонуючи зміну, яка рефакторизує компоненти для кращої модульності, часто з огляду на проблеми з підтримкою або масштабованістю.

Крім того, чітке спілкування в каналах Slack навколо описів PR є критичним. Проста « Виправлена помилка » не є достатньою для виправдання запитів на збирання. Замість цього, ви хочете щось на зразок: “PR # 1234 - Розв’язано проблему з автентифікацією користувача через умови гонки під час оновлення токенів. Додано всеохопні тести модулів і відповідно оновлено документацію. Ця зміна відповідає архітектурі служби, описаній у найновішому документі з розробки. » Знову ж таки, ключовими є подробиці — опис проблеми, рішення, процедури тестування і будь- які пов’ язані з цим оновлення документації. Це стосується надання достатньої кількості контексту для переглядачів, щоб швидко оцінити вплив ваших змін.

# Example: Monitoring a Pub/Sub Topic using gcloud (Google Cloud SDK)
gcloud pubsub topics describe my-topic --project my-project

Ця команда, якщо використовувати її в повідомленні Slack або описі PR, демонструє знайомство з хмарною інфраструктурою Google і інструментами, використовуваними для управління нею. Це невеликий приклад, але підкреслення цих технічних навичок через точну мову будує впевненість і сприяє плавнішій співпраці в команді розробників Encore.ts.