Waafir
本页面为机器翻译,尚待人工审核,可能存在错误。

导入后排查部分失败错误

本方案展示如何在工作进程完成后,排查异步导入的逐行错误。状态端点每次读取时都会提供一小份错误样本;同一端点的分页错误模式则会流式返回每一条错误,包括行号、错误代码、错误消息和原始行负载。

出现 partial / failed 状态时

单个错误行绝不会中止导入——Waafir 的工作进程会独立验证每一行,持久化每个有效行,并为每个错误行写入一条逐行错误记录。随后,导入会进入以下两种终态之一:

  • partial——至少有一行成功,并且至少有一行失败。有效行已落库;无效行可通过本方案查询。
  • failed——没有任何行成功。要么每一行都无效,要么导入遇到了致命错误(NDJSON 格式错误、文件读取失败、工作进程异常);在后一种情况下,errorSummary 会包含一个致命错误结构。

对于这两种终态,下面的方案都是深入排查的合适工具。

错误信息的结构

状态端点(GET /api/v1/monitoring/loan/imports/{id})返回一个 errorSummary 字段,它根据发生的情况具有两种结构:

  • 行级错误(partial 以及大多数 failed 运行的常见情况):errorSummary 为 { samples, totals }。samples 数组以 { rowNumber, errorCode, errorMessage, rawRow } 的形式包含前十条错误。totals 字段提供汇总计数。
  • 致命错误(在处理任何行之前就已终止的导入):errorSummary 为 { fatal }——一条描述工作进程级故障的错误。

如需查看前十条之后的错误,请使用分页错误模式:GET /api/v1/monitoring/loan/imports/{id}?errors=true&limit=&offset=。

方案

# curl — inspect a partial / failed import's errors
set -euo pipefail

PAT="${WAAFIR_PAT}"
BASE_URL="${WAAFIR_BASE_URL:-https://app.waafir.io}"
IMPORT_ID="${1:?supply the import id}"

# Step 1 — fetch the terminal status, see the error summary.
STATUS=$(curl -fsS "${BASE_URL}/api/v1/monitoring/loan/imports/${IMPORT_ID}" \
  -H "Authorization: Bearer ${PAT}")

echo "status:" && echo "$STATUS" | jq '{status, rowCountProcessed, rowCountSucceeded, rowCountFailed}'
echo "first ten errors (sampled):"
echo "$STATUS" | jq '.errorSummary'

# Step 2 — page through every row error. Limit/offset are bounded
# (limit max 100; default 20).
LIMIT=100
OFFSET=0
TOTAL_FAILED=$(echo "$STATUS" | jq -r .rowCountFailed)

while [ "${OFFSET}" -lt "${TOTAL_FAILED}" ]; do
  PAGE=$(curl -fsS \
    "${BASE_URL}/api/v1/monitoring/loan/imports/${IMPORT_ID}?errors=true&limit=${LIMIT}&offset=${OFFSET}" \
    -H "Authorization: Bearer ${PAT}")
  echo "$PAGE" | jq -c '.items[] | {rowNumber, errorCode, errorMessage}'
  OFFSET=$((OFFSET + LIMIT))
done
// TypeScript — inspect a partial / failed import's errors
const PAT = process.env.WAAFIR_PAT!;
const BASE_URL = process.env.WAAFIR_BASE_URL ?? "https://app.waafir.io";
const importId = process.argv[2];
if (!importId) throw new Error("usage: ts-node inspect.ts <importId>");

const auth = { Authorization: `Bearer ${PAT}` };

// Step 1 — terminal status + error summary.
const statusRes = await fetch(`${BASE_URL}/api/v1/monitoring/loan/imports/${importId}`, {
    headers: auth,
});
type Status = {
    status: string;
    rowCountProcessed: number;
    rowCountSucceeded: number;
    rowCountFailed: number;
    errorSummary: unknown;
};
const status = (await statusRes.json()) as Status;
console.log("status:", {
    status: status.status,
    rowCountProcessed: status.rowCountProcessed,
    rowCountSucceeded: status.rowCountSucceeded,
    rowCountFailed: status.rowCountFailed,
});
console.log("error summary (first ten):", status.errorSummary);

// Step 2 — page through every row error.
type RowError = {
    rowNumber: number;
    errorCode: string;
    errorMessage: string;
    rawRow: unknown;
    createdAt: string;
};
const limit = 100;
for (let offset = 0; offset < status.rowCountFailed; offset += limit) {
    const url = `${BASE_URL}/api/v1/monitoring/loan/imports/${importId}?errors=true&limit=${limit}&offset=${offset}`;
    const pageRes = await fetch(url, { headers: auth });
    const page = (await pageRes.json()) as { items: RowError[]; limit: number; offset: number };
    for (const error of page.items) {
        console.log({
            rowNumber: error.rowNumber,
            errorCode: error.errorCode,
            errorMessage: error.errorMessage,
        });
    }
}
# python — inspect a partial / failed import's errors
import os
import sys
import requests

PAT = os.environ["WAAFIR_PAT"]
BASE_URL = os.environ.get("WAAFIR_BASE_URL", "https://app.waafir.io")
import_id = sys.argv[1] if len(sys.argv) > 1 else None
if not import_id:
    raise SystemExit("usage: python inspect.py <importId>")

auth = {"Authorization": f"Bearer {PAT}"}

# Step 1 — terminal status + error summary.
status = requests.get(
    f"{BASE_URL}/api/v1/monitoring/loan/imports/{import_id}",
    headers=auth,
    timeout=30,
).json()
print("status:", {
    "status": status["status"],
    "rowCountProcessed": status["rowCountProcessed"],
    "rowCountSucceeded": status["rowCountSucceeded"],
    "rowCountFailed": status["rowCountFailed"],
})
print("error summary (first ten):", status.get("errorSummary"))

# Step 2 — page through every row error.
LIMIT = 100
offset = 0
total_failed = status["rowCountFailed"]
while offset < total_failed:
    page = requests.get(
        f"{BASE_URL}/api/v1/monitoring/loan/imports/{import_id}",
        params={"errors": "true", "limit": LIMIT, "offset": offset},
        headers=auth,
        timeout=30,
    ).json()
    for error in page["items"]:
        print({
            "rowNumber": error["rowNumber"],
            "errorCode": error["errorCode"],
            "errorMessage": error["errorMessage"],
        })
    offset += LIMIT

验证要点

对于 partial 导入,rowCountSucceeded 与 rowCountFailed 之和等于 rowCountProcessed,并且 rowCountSucceeded 不为零。对于 failed 导入,rowCountSucceeded 为零——要么每一个可处理的行都未通过验证,要么 errorSummary.fatal 字段描述了一个工作进程级故障。

rowNumber 字段是 NDJSON 文件中从 1 开始计数的行号。将其映射回您的源数据行,即可找到出错的记录,修正它们,然后重新提交——可以只提交修正后的行,也可以提交整个文件(为新的意图使用一个新的幂等键——参见重试方案)。

rawRow 字段包含 Waafir 接收到的已解析负载(便于您核实传输结构与您的代码生成的内容一致);errorCode 是所触发验证规则的稳定标识符(便于您将成组的错误与修复清单进行匹配)。