@mikitasazan/notify 1.1.2 → 1.2.0

package/dist/events.d.ts

@@ -12,12 +12,15 @@
 export type Project = 'playhub' | 'one-q' | 'arvent' | 'game-publisher' | 'vault' | 'mac-config' | 'alitools';
 /**
  * Стабильный машинный ключ задачи — последняя строка каждой карточки, вида
- * `#проект/ключ`. По нему дневной разборщик сверяет «это 🔴 уже закрыто более
- * поздней карточкой того же ключа?» без сравнения человеческих формулировок,
- * которые меняются. Необязателен: без него ключ выводится из типа и заголовка
- * (см. `render.ts`), но выведенный наследует хрупкость формулировки — наши
- * регулярные отправители передают его явно. В stdout CLI ключ не попадает
- * никогда: сторож на VPS разбирает stdout по словам `sent|failed|skipped`.
+ * `#ключ` (без названия проекта: карточка и так лежит в форуме своего
+ * проекта — `targets()` не шлёт её в чужой). По нему дневной разборщик
+ * сверяет «это 🔴 уже закрыто более поздней карточкой того же ключа?» без
+ * сравнения человеческих формулировок, которые меняются. Необязателен: без
+ * него ключ выводится из типа и заголовка (см. `render.ts`), но выведенный
+ * наследует хрупкость формулировки — наши регулярные отправители передают
+ * его явно. В вывод CLI (stderr, и его же сторож на VPS читает объединённым
+ * потоком по словам `sent|failed|skipped`) ключ не попадает никогда — новое
+ * слово там ослепило бы сторожа.
  */
 type Keyed = {
     key?: string;

package/dist/render.js

@@ -36,7 +36,10 @@ export const clampMessage = (text, limit = 4000) => {
     }
     const body = cut.slice(0, end);
     // Кламп мог отрезать закрывающие теги — добираем их, чтобы разметка сошлась.
-    const tail = ['b', 'a', 'i', 'code']
+    // blockquote — с приходом цитаты для примечаний/деталей длинный detail режется
+    // прямо посередине неё, и без этого тега Telegram отвечал бы 400 на незакрытую
+    // цитату (regex `<blockquote[ >]` ловит и вариант с атрибутом `expandable`).
+    const tail = ['b', 'a', 'i', 'code', 'blockquote']
         .filter((t) => {
         const opened = (body.match(new RegExp(`<${t}[ >]`, 'g')) ?? []).length;
         const closed = (body.match(new RegExp(`</${t}>`, 'g')) ?? []).length;
@@ -47,10 +50,23 @@ export const clampMessage = (text, limit = 4000) => {
     return `${body}${tail}\n…`;
 };
 const header = (icon, title, project) => `${icon} <b>${esc(title)}</b> · ${esc(project)}`;
-// Значение — жирным: канон формата (bot-message-formatting-canon) — иконка-лид,
-// факты построчно, значения выделены; метка остаётся обычной, чтобы глаз
-// цеплялся за содержимое, а не за служебное слово.
-const kv = (label, value) => value === undefined || value === '' ? null : `${esc(label)}: <b>${esc(value)}</b>`;
+// Тире, не жирное значение: сплошной жирный текст в первой версии карточки
+// читался как крик (жалоба владельца 18.08). Иконка-лид уже держит внимание
+// на заголовке, факты идут построчно и без выделения — глаз сам находит
+// цифру рядом с меткой.
+const kv = (label, value) => value === undefined || value === '' ? null : `${esc(label)} — ${esc(value)}`;
+// Длинное пояснение (примечание, детали инцидента) — цитатой: у Telegram это
+// полоска слева и лёгкий отступ, читается как «подробности», а не как часть
+// заголовка. Длиннее ~400 знаков — цитата сворачивается сама (`expandable`,
+// Bot API), иначе стектрейс или дамп лога растягивает карточку на весь экран.
+const EXPAND_AT = 400;
+const note = (text) => {
+    if (!text) {
+        return null;
+    }
+    const body = esc(text);
+    return body.length > EXPAND_AT ? `<blockquote expandable>${body}</blockquote>` : `<blockquote>${body}</blockquote>`;
+};
 const link = (url, label) => url ? `<a href="${esc(url)}">${esc(label)}</a>` : null;
 const join = (parts) => parts.filter((p) => p !== null).join('\n');
 /** Список позиций — общий для `job` и `report`, чтобы они не разъехались. */
@@ -70,7 +86,7 @@ const renderDeploy = (e) => {
         commitLine,
         kv('откуда', e.via),
         kv('куда', e.target),
-        kv('примечание', e.note),
+        note(e.note),
         link(e.url, 'Открыть логи')
     ]);
 };
@@ -82,7 +98,7 @@ const renderJob = (e) => {
         ...(e.stats ?? []).map(([label, value]) => kv(label, value)),
         items.length > 0 ? '' : null,
         ...items,
-        kv('примечание', e.note),
+        note(e.note),
         link(e.url, 'Подробнее')
     ]);
 };
@@ -146,14 +162,14 @@ const renderIssue = (e) => {
         link(e.url, 'Открыть задачу')
     ]);
 };
-const renderIncident = (e) => join([header('🚨', 'Инцидент', e.project), esc(e.title), e.detail ? esc(e.detail) : null, link(e.url, 'Подробнее')]);
+const renderIncident = (e) => join([header('🚨', 'Инцидент', e.project), esc(e.title), note(e.detail), link(e.url, 'Подробнее')]);
 const renderHeartbeatMiss = (e) => join([
     header('🔴', `Не отметилась: ${e.job}`, e.project),
     kv('последний раз', e.lastSeen),
     kv('ожидалось', e.expected)
 ]);
 // Подпись файла — та же карточка, но лимит Telegram у caption свой: 1024.
-const renderFile = (e) => join([header('📄', e.title, e.project), kv('примечание', e.note)]);
+const renderFile = (e) => join([header('📄', e.title, e.project), note(e.note)]);
 const RENDERERS = {
     deploy: renderDeploy,
     job: renderJob,
@@ -166,11 +182,15 @@ const RENDERERS = {
     file: renderFile
 };
 /**
- * Ключ задачи — последняя строка карточки: `#проект/ключ` в <code>. Явный
- * `key` побеждает; выведенный строится из заголовка и наследует хрупкость
- * формулировки — регулярные отправители передают явный. Ключ переживает
- * MTProto-чтение (это простой текст, не разметка), по нему разборщик сверяет
- * 🔴 с более поздней успешной карточкой той же задачи.
+ * Ключ задачи — последняя строка карточки: `#ключ` курсивом в <code>. Без
+ * названия проекта: `targets()` никогда не шлёт карточку в чужой форум,
+ * проект и так на виду в заголовке («· mac-config»), а дублирующий префикс
+ * только растягивал тег на лишнюю строку в узком экране телефона (жалоба
+ * владельца 18.08). Явный `key` побеждает; выведенный строится из заголовка
+ * и наследует хрупкость формулировки — регулярные отправители передают явный.
+ * Ключ переживает MTProto-чтение (простой текст, не разметка), по нему
+ * разборщик сверяет 🔴 с более поздней успешной карточкой той же задачи —
+ * внутри чата одного проекта, где ключ и так уникален.
  */
 const slug = (raw) => raw
     .toLowerCase()
@@ -198,9 +218,9 @@ export const eventKey = (e) => {
                 return e.type;
         }
     };
-    return `#${slug(e.project)}/${e.key ? slug(e.key) : fallback()}`;
+    return e.key ? slug(e.key) : fallback();
 };
-const keyLine = (e) => `<code>${esc(eventKey(e))}</code>`;
+const keyLine = (e) => `<i><code>#${esc(eventKey(e))}</code></i>`;
 /**
  * Рендерит событие в готовый HTML-текст, обрезанный под лимит Telegram.
  * Ключ добавляется ПОСЛЕ обрезки, с зарезервированным местом: обрезанная

package/dist/send.js

@@ -309,6 +309,8 @@ export const sendReport = async (project, html, key) => {
         return 'skipped';
     }
     const forum = ROUTES[project];
-    const tag = key ? `\n<code>#${project}/${key}</code>` : '';
+    // Без проекта — как и render.ts: карточка уже лежит в форуме своего
+    // проекта, дублировать его в теге незачем.
+    const tag = key ? `\n<i><code>#${key}</code></i>` : '';
     return deliver([{ chat: forum.chat, thread: forum.ops, silent: true }], clampMessage(html) + tag);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikitasazan/notify",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Единая типизированная отправка Telegram-уведомлений (форум-темы, маршрутизация, ретраи) для всех проектов",
   "type": "module",
   "license": "MIT",