jiantw83
e2b08f04a3
異常回報依 wiki 讀取的結束碼分流，只有頁面確定不存在才套範本建新頁。 版本閘門與重啟閘門的豁免清單各補上 hook 修復技能。 階段閘門把計畫階段移出擋人名單，改成只注入提醒。 錯誤掃描的自家 hook 判定補齊九支腳本，並加一條路徑判定。 修復技能與接線技能的內文改成真的走得到的路徑與真的存在的關卡數。 原本 wiki 讀取失敗會一路落到套範本那一步，金鑰失效或 API 出狀況時， 就拿一份空白範本蓋掉整份異常目錄，而寫入不做合併也不留備份，蓋掉就救不回來。 兩道閘門把唯一的 hook 修復路徑一起擋住，hook 一壞就沒有任何方法修回來， 閘門等於鎖掉解除自己的路徑。工作包閘門擋下計畫階段是誤擋： 計畫是純邏輯階段、不碰程式碼，而閘門只知道有 PR 未合併，判不出跟新計畫有沒有關聯。 自家 hook 判定只認得早期那五支，後來加的四支出錯會被當成第三方的，只回報不修正。 修復技能裡三個指向流程的路徑指到不存在的位置，照著走一定撲空； 接線流程寫四道關卡，實際上有五道，兩段中文說明也混在英文內文裡。 異常目錄改成先讀回舊頁、把新列附在文末、再整頁寫回；讀不回來就放棄寫目錄頁並回報， 寧可少一列索引，也不覆蓋別人的紀錄。兩份豁免清單各補一項，理由逐項寫在腳本檔頭。 計畫階段改印提醒後放行，放棄的在製品上限與代價一併寫在檔頭。 自家 hook 判定逐支列出腳本名，再加一條安裝路徑判定，日後新增 hook 忘了補清單也還認得出來。 三個路徑改指到擁有它的技能組，關卡數改成五道並逐關寫明結束碼，兩段中文說明改回英文。 版本閘門在同一次改動另補唯讀的建議子命令，把版本比對表收斂成一行結論， 部署技能不必自己再解一次那張表。
165 lines
7.6 KiB
Bash
Executable File
165 lines
7.6 KiB
Bash
Executable File
#!/usr/bin/env sh
|
||
# report-error.sh — 失敗回報流程：把一筆 hook 或工具異常寫成 wiki 的 ERROR_{HASH}，
|
||
# 並在 ERROR_CONTENTS 附上一列索引。頁面內容套用 templates/ 的兩份範本，
|
||
# 範本是文案的唯一來源，本腳本只填欄位；真正寫進 wiki 前，還會先走
|
||
# Gitea 寫入確認。
|
||
#
|
||
# 用法:
|
||
# report-error.sh --hook {名稱} --exit {碼} --summary {摘要}
|
||
# [--repo {owner}/{repo}] [--cli {名稱}] [--session {id}]
|
||
# [--source {stdin|env|command}] [--symptom {現象}]
|
||
# [--cause {可能原因}] [--action {處理結果}]
|
||
# 相關輸出（stdout／stderr 摘要）由標準輸入讀入，可省略。
|
||
#
|
||
# 輸出:
|
||
# 成功印出「{頁名} {網址}」一行。
|
||
# wiki 位置解析不出來（JSC_WIKI_REPO_ERROR 與 JSC_WIKI_REPO 都沒設，或找不到
|
||
# gitea.sh）時安靜降級：不輸出、exit 0。回報失敗不該再變成一次失敗。
|
||
# 寫入 wiki 失敗才以 exit 4 回報，訊息走 stderr。
|
||
#
|
||
# 結束碼: 0=已寫入 wiki 並印出「{頁名} {網址}」，或安靜降級（找不到 gitea.sh、解析不出
|
||
# wiki 存取庫、算不出 HASH、建不出暫存檔）——回報失敗不該再變成一次失敗
|
||
# 2=用法錯誤（缺 --hook 或 --summary）
|
||
# 4=寫入 wiki 失敗（異常頁與索引目錄頁，任一支寫不進去就算），或目錄頁的舊內容
|
||
# 讀不回來（wiki-get 回 7 金鑰失效、8 其他 API 失敗）而放棄寫入；訊息走 stderr。
|
||
# 讀不回來就不寫，是為了不拿範本蓋掉一份還在的目錄頁
|
||
# 註: 本檔以 `. "$ROOT/hooks/lib.sh"` 載入共用函式，沒有接 `|| true`。lib.sh 讀不到時 sh 會
|
||
# 就地結束並回 2，跟用法錯誤同碼；分不出是哪一種時，先確認 hooks/lib.sh 在不在。
|
||
#
|
||
# 頁名:
|
||
# ERROR_{HASH}，HASH 取「{owner}/{repo} {hook} {時間}」的 SHA-1 前 8 碼（共用 hash 規則）。
|
||
# 時間放進 hash：同一種失敗再發生時要另開新頁，不覆寫舊紀錄。
|
||
#
|
||
# 誰來呼叫:
|
||
# 由操作者手動執行，或由技能步驟執行（`jsc-hooks:hooks-install` 在 wire-cli.sh 回報
|
||
# status=failed 時呼叫）。**不接在失敗的 hook 上自動觸發**：hook 一律安靜 exit 0，
|
||
# 而且自我回報要走網路寫 wiki，失敗的 hook 再去回報自己會疊出迴圈。
|
||
set -u
|
||
HERE=$(cd "$(dirname "$0")" && pwd)
|
||
ROOT=$(cd "$HERE/.." && pwd)
|
||
. "$ROOT/hooks/lib.sh"
|
||
STDIN_JSON="" # 本腳本的標準輸入是錯誤輸出摘要，不是 JSON
|
||
|
||
hook=""; code=""; summary=""; repo=""; cli=""; session=""
|
||
source_kind=""; symptom=""; cause=""; action=""
|
||
while [ $# -gt 0 ]; do
|
||
case "$1" in
|
||
--hook) hook="${2:-}"; shift 2 ;;
|
||
--exit) code="${2:-}"; shift 2 ;;
|
||
--summary) summary="${2:-}"; shift 2 ;;
|
||
--repo) repo="${2:-}"; shift 2 ;;
|
||
--cli) cli="${2:-}"; shift 2 ;;
|
||
--session) session="${2:-}"; shift 2 ;;
|
||
--source) source_kind="${2:-}"; shift 2 ;;
|
||
--symptom) symptom="${2:-}"; shift 2 ;;
|
||
--cause) cause="${2:-}"; shift 2 ;;
|
||
--action) action="${2:-}"; shift 2 ;;
|
||
*) shift ;;
|
||
esac
|
||
done
|
||
if [ -z "$hook" ] || [ -z "$summary" ]; then
|
||
echo "用法：report-error.sh --hook {名稱} --exit {碼} --summary {摘要} [...]" >&2
|
||
exit 2
|
||
fi
|
||
|
||
gsh=$(jsc_gitea_sh) || exit 0
|
||
wrepo=$(sh "$gsh" wiki-repo ERROR 2>/dev/null) || exit 0
|
||
[ -n "$wrepo" ] || exit 0
|
||
|
||
# 存取庫名稱未指定就取工作目錄的 origin（只用來標記異常屬於哪個存取庫）
|
||
if [ -z "$repo" ]; then
|
||
origin=$(git config --get remote.origin.url 2>/dev/null || true)
|
||
repo=$(printf '%s' "$origin" \
|
||
| sed -n 's#.*[/:]\([^/]*\)/\([^/]*\)$#\1/\2#p' | sed 's/\.git$//')
|
||
fi
|
||
[ -n "$repo" ] || repo="-"
|
||
[ -n "$cli" ] || cli=$(cli_name)
|
||
[ -n "$session" ] || session=$(session_id)
|
||
[ -n "$code" ] || code="-"
|
||
[ -n "$source_kind" ] || source_kind="command"
|
||
[ -n "$symptom" ] || symptom="$summary"
|
||
[ -n "$cause" ] || cause="待查"
|
||
[ -n "$action" ] || action="待處理"
|
||
|
||
ts=$(date +'%Y-%m-%d %H:%M:%S')
|
||
ticket_ts=$(date +'%Y%m%d_%H%M%S')
|
||
if [ -t 0 ]; then detail=""; else detail=$(cat 2>/dev/null | tr '\n' ' ' | cut -c1-500); fi
|
||
[ -n "$detail" ] || detail="（無）"
|
||
# 摘要與相關輸出都落在 markdown 表格欄位裡，半形 | 會把欄位切斷，改成全形
|
||
detail=$(printf '%s' "$detail" | sed 's/|/｜/g')
|
||
summary=$(printf '%s' "$summary" | sed 's/|/｜/g')
|
||
|
||
hash=$(sh "$gsh" hash-id "$repo $hook $ts" 2>/dev/null) || exit 0
|
||
[ -n "$hash" ] || exit 0
|
||
page="ERROR_$hash"
|
||
|
||
# sed 取代值要先轉義：& 與分隔字元 | 會被 sed 當語法，換行會整行斷掉
|
||
esc() { printf '%s' "$1" | tr '\n' ' ' | sed 's/[\\&|]/\\&/g'; }
|
||
fill() { sed "s|$1|$(esc "$2")|g"; }
|
||
|
||
tmp_page=$(mktemp) || exit 0
|
||
tmp_list=$(mktemp) || { rm -f "$tmp_page"; exit 0; }
|
||
trap 'rm -f "$tmp_page" "$tmp_list"' EXIT
|
||
|
||
fill '{HASH}' "$hash" < "$ROOT/templates/error-page.md" \
|
||
| fill '{yyyy-MM-dd HH:mm:ss}' "$ts" \
|
||
| fill '{owner}/{repo}' "$repo" \
|
||
| fill '{cli}' "$cli" \
|
||
| fill '{session_id}' "$session" \
|
||
| fill '{hook_name}' "$hook" \
|
||
| fill '{exit_code}' "$code" \
|
||
| fill '{error_summary}' "$summary" \
|
||
| fill '{現象描述}' "$symptom" \
|
||
| fill '{可能原因}' "$cause" \
|
||
| fill '{處理方式}' "$action" \
|
||
| fill '{stdin / env / command}' "$source_kind" \
|
||
| fill '{stdout / stderr 摘要}' "$detail" \
|
||
| fill '{yyyyMMdd}_{HHmmss}' "$ticket_ts" > "$tmp_page"
|
||
|
||
row=$(printf '| %s | [[%s|%s]] | %s | %s | %s | %s |' \
|
||
"$ts" "$hook 異常 $ts" "$page" "$repo" "$hook" "$code" "$summary")
|
||
|
||
build_contents() { # 用範本建一份全新的目錄頁；只有確定舊頁不存在時才可以呼叫
|
||
fill '{yyyy-MM-dd HH:mm:ss}' "$ts" < "$ROOT/templates/error-contents.md" \
|
||
| fill '{HASH}' "$hash" \
|
||
| fill '{error title}' "$hook 異常 $ts" \
|
||
| fill '{owner}/{repo}' "$repo" \
|
||
| fill '{hook_name}' "$hook" \
|
||
| fill '{exit_code}' "$code" \
|
||
| fill '{error_summary}' "$summary" > "$tmp_list"
|
||
}
|
||
|
||
# 異常目錄頁一律附加，不整頁覆蓋。頁上每一列都是別人回報的異常，本腳本沒有從別處讀過
|
||
# 那些列，所以先把舊頁讀回來、把新列附在文末（最新一筆在最後），再整頁寫回。
|
||
# 這個語意完全靠「讀得回舊內容」撐著，因此依 wiki-get 的結束碼分流：
|
||
# 0 → 讀到既有內容，附加新列（讀得到但整頁是空的，沒有既有列會被蓋掉，套範本才安全）
|
||
# 4 → 頁面真的還不存在，只有這個碼可以用範本建立新頁
|
||
# 7 → 金鑰失效或權限不足，舊內容未知，放棄目錄頁寫入
|
||
# 8 → 其他 API 失敗，舊內容一樣未知，處置同 7
|
||
# 為什麼 7 與 8 不能當成「頁面不存在」：拿範本蓋掉一份讀不回來的目錄頁，等於刪光所有既有
|
||
# 列，而 wiki-put 不做合併、也不留備份，蓋掉就救不回來。
|
||
sh "$gsh" wiki-get "$wrepo" ERROR_CONTENTS > "$tmp_list" 2>/dev/null
|
||
get_code=$?
|
||
contents_skip=''
|
||
case "$get_code" in
|
||
0) if [ -s "$tmp_list" ]; then printf '%s\n' "$row" >> "$tmp_list"; else build_contents; fi ;;
|
||
4) build_contents ;;
|
||
*) contents_skip=$get_code ;;
|
||
esac
|
||
|
||
if ! sh "$gsh" wiki-put "$wrepo" "$page" "$tmp_page" >/dev/null 2>&1; then
|
||
echo "[jsc] 寫入 $page 失敗（$wrepo）。" >&2
|
||
exit 4
|
||
fi
|
||
if [ -n "$contents_skip" ]; then
|
||
echo "[jsc] 讀取 ERROR_CONTENTS 失敗（$wrepo，wiki-get 結束碼 $contents_skip），舊內容未知，不寫目錄頁；$page 已建立。" >&2
|
||
exit 4
|
||
fi
|
||
if ! sh "$gsh" wiki-put "$wrepo" ERROR_CONTENTS "$tmp_list" >/dev/null 2>&1; then
|
||
echo "[jsc] 寫入 ERROR_CONTENTS 失敗（$wrepo），$page 已建立。" >&2
|
||
exit 4
|
||
fi
|
||
|
||
url=$(sh "$gsh" wiki-url "$wrepo" "$page" 2>/dev/null || true)
|
||
printf '%s %s\n' "$page" "$url"
|