@lark-apaas/miaoda-cli 0.1.2 → 0.1.3-alpha.4bf312e

package/dist/cli/handlers/observability/trace.js

@@ -0,0 +1,102 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleObservabilityTraceList = handleObservabilityTraceList;
+exports.handleObservabilityTraceGet = handleObservabilityTraceGet;
+const api = __importStar(require("../../../api/index"));
+const output_1 = require("../../../utils/output");
+const args_1 = require("../../../utils/args");
+const index_1 = require("../../../api/observability/index");
+const helpers_1 = require("./helpers");
+/** miaoda observability trace list */
+async function handleObservabilityTraceList(opts) {
+    const appID = opts.appId;
+    const appEnv = "runtime";
+    const limit = (0, helpers_1.validateLimit)(opts.limit ?? 50);
+    // 过滤 key 对齐 BAM Span 字段名：
+    //   - 顶层字段：traceID（注意大小写）
+    //   - attributes 业务字段：user_id（snake_case）
+    //   - 入口 span：BAM 没有 entrySpanName fieldFilter，统一走 fuzzyFilter（trace endpoint
+    //     默认作用于 span name），所以 --root-span 不进 fieldFilters
+    const fieldFilters = (0, helpers_1.buildFieldFilters)([
+        { key: "trace_id", value: opts.traceId ? (0, helpers_1.eqFilter)(opts.traceId) : undefined },
+        { key: "user_id", value: opts.userId ? (0, helpers_1.eqFilter)(opts.userId, "i64") : undefined },
+    ]);
+    const req = {
+        appID,
+        appEnv,
+        startTimestampNs: (0, helpers_1.parseToNs)(opts.since),
+        endTimestampNs: (0, helpers_1.parseToNs)(opts.until),
+        limit,
+        pageToken: opts.cursor,
+        fieldFilters,
+        fuzzyFilter: opts.rootSpan ? (0, helpers_1.fuzzyFilter)(opts.rootSpan) : undefined,
+    };
+    const resp = await api.observability.searchTraces(req);
+    emitSearchTracesResponse(resp);
+}
+function emitSearchTracesResponse(resp) {
+    (0, output_1.emit)({
+        data: resp.spans ?? [],
+        next_cursor: resp.hasMore ? resp.nextPageToken : null,
+        has_more: resp.hasMore,
+    }, index_1.spanSchema);
+}
+/** miaoda observability trace get <trace-id> */
+async function handleObservabilityTraceGet(opts) {
+    if (!opts.traceId)
+        (0, args_1.failArgs)("<trace-id> 必填");
+    const appID = opts.appId;
+    const appEnv = "runtime";
+    const resp = await api.observability.getTraces({
+        appID,
+        appEnv,
+        traceID: opts.traceId,
+        withLogSeverityCount: opts.withLogSeverityCount,
+    });
+    emitGetTraceResponse(resp);
+}
+function emitGetTraceResponse(resp) {
+    // JSON 模式：保持单条信封语义，便于下游一次解析
+    if ((0, output_1.isJsonMode)()) {
+        (0, output_1.emit)({
+            data: { spans: resp.spans ?? [], isBreak: resp.isBreak },
+        });
+        return;
+    }
+    // Pretty 模式：先打头部 key-value（断链状态等元信息），再按 spanSchema 渲染主表
+    (0, output_1.emit)({ data: { isBreak: resp.isBreak } });
+    (0, output_1.emit)({ data: resp.spans ?? [] }, index_1.spanSchema);
+}

package/dist/main.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const index_1 = require("./cli/commands/index");
+const shared_1 = require("./cli/commands/shared");
 const help_1 = require("./cli/help");
 const config_1 = require("./utils/config");
 const log_id_1 = require("./utils/log_id");
@@ -20,11 +21,14 @@ const program = new commander_1.Command();
 const { version } = package_json_1.default;
 program
     .name("miaoda")
-    .description("妙搭平台 CLI，提供数据服务、文件存储、插件管理等命令行操作。")
+    .description("妙搭平台 CLI，提供数据服务、文件存储等命令行操作。")
     .usage("<command> [flags]")
     .version(version, "-v, --version", "显示版本号")
     .option("--json [fields]", "JSON 输出，可选字段级选择")
-    .option("--output <format>", "输出格式（pretty|json）", "pretty")
+    .addOption(new commander_1.Option("--output <format>", "输出格式（pretty | json，大小写不敏感）")
+    .choices(["pretty", "json"])
+    .argParser((0, shared_1.caseInsensitiveChoice)(["pretty", "json"]))
+    .default("pretty"))
     .option("--verbose", "debug 日志到 stderr")
     .helpOption("-h, --help", "显示帮助信息")
     .hook("preAction", (_thisCmd, actionCmd) => {

package/dist/utils/args.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.failArgs = failArgs;
+const error_1 = require("./error");
+/** 参数校验失败时抛出；命令层可配合 withHelp 自动打 help。 */
+function failArgs(message) {
+    throw new error_1.AppError("ARGS_INVALID", message);
+}

package/dist/utils/devops-error.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapDevopsError = mapDevopsError;
+const error_1 = require("./error");
+/**
+ * 把 BAM lark.apaas.devops 的业务码（数字字符串）映射成 CLI 错误码。
+ * 来源：服务端技术方案 wiki L7P8wlNQ5iyShLkxzlOcCo8LnTg「业务错误码映射表」。
+ *
+ * 放在 utils 下而不是某个具体 api 域里：app / deploy 都跑在 lark.apaas.devops
+ * 这同一 PSM，业务码命名空间也共享；boundaries 规则又禁止 api 域间互引。
+ */
+function mapDevopsError(bizCode, message) {
+    switch (bizCode) {
+        case "400002577":
+        case "400002569":
+            return new error_1.AppError("APP_NOT_FOUND", message, {
+                next_actions: ["Run `miaoda app list` to see available apps"],
+            });
+        case "400002579":
+            return new error_1.AppError("APP_PERMISSION_DENIED", message);
+        case "400002575":
+            return new error_1.AppError("INVALID_ARG_VALUE", message, {
+                next_actions: ["缩短 --name / --description 后重试（后端有长度限制）"],
+            });
+        default:
+            return undefined;
+    }
+}

package/dist/utils/git.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentGitBranch = getCurrentGitBranch;
+const node_child_process_1 = require("node:child_process");
+/**
+ * 读取 cwd 所在仓库的当前分支名。
+ *
+ * 不在 git 仓库、git 不可用、或处于 detached HEAD 时返回 undefined，
+ * 让调用方决定回退策略（如交给后端使用应用默认分支）。
+ */
+function getCurrentGitBranch(cwd = process.cwd()) {
+    let result;
+    try {
+        result = (0, node_child_process_1.spawnSync)("git", ["rev-parse", "--abbrev-ref", "HEAD"], {
+            cwd,
+            encoding: "utf8",
+            stdio: ["ignore", "pipe", "ignore"],
+        });
+    }
+    catch {
+        return undefined;
+    }
+    if (result.status !== 0)
+        return undefined;
+    const branch = result.stdout.trim();
+    if (!branch || branch === "HEAD")
+        return undefined;
+    return branch;
+}

package/dist/utils/http.js

@@ -6,7 +6,12 @@ exports.resetHttpClient = resetHttpClient;
 exports.setHttpClient = setHttpClient;
 exports.setRuntimeHttpClient = setRuntimeHttpClient;
 exports.applyCanaryHeader = applyCanaryHeader;
+exports.postInnerApi = postInnerApi;
+exports.getInnerApi = getInnerApi;
 const http_client_1 = require("@lark-apaas/http-client");
+const error_1 = require("./error");
+const config_1 = require("./config");
+const logger_1 = require("./logger");
 let adminClient;
 let runtimeClient;
 /**
@@ -65,3 +70,116 @@ function applyCanaryHeader(reqConfig) {
     reqConfig.headers = headers;
     return reqConfig;
 }
+/** 走管理端 innerapi 的 POST + 信封解析 */
+async function postInnerApi(url, body, opts) {
+    const startMs = logRequestStart("POST", url, body);
+    let response;
+    try {
+        response = await getHttpClient().post(url, body);
+    }
+    catch (err) {
+        logResponseFailure("POST", url, err, startMs);
+        throw err;
+    }
+    logResponseEnd("POST", url, response, startMs);
+    return handleInnerEnvelope(response, url, opts);
+}
+/** 走管理端 innerapi 的 GET + 信封解析 */
+async function getInnerApi(url, opts) {
+    const startMs = logRequestStart("GET", url);
+    let response;
+    try {
+        response = await getHttpClient().get(url);
+    }
+    catch (err) {
+        logResponseFailure("GET", url, err, startMs);
+        throw err;
+    }
+    logResponseEnd("GET", url, response, startMs);
+    return handleInnerEnvelope(response, url, opts);
+}
+async function handleInnerEnvelope(response, url, opts) {
+    if (!response.ok) {
+        throw new error_1.HttpError(response.status, url, `${opts.errPrefix}: ${String(response.status)} ${response.statusText}`);
+    }
+    const result = await response.json();
+    if (typeof result === "object" && result !== null && "status_code" in result) {
+        const env = result;
+        if (env.status_code !== undefined && env.status_code !== "0") {
+            const msg = env.message ?? env.error_msg ?? "unknown error";
+            // verbose: 把完整业务错误信封打到 stderr，便于追溯
+            if ((0, config_1.getConfig)().verbose) {
+                (0, logger_1.debug)(`  envelope: ${truncateForLog(safeStringify(env), 1000)}`);
+            }
+            const mapped = opts.mapErr?.(env.status_code, msg);
+            if (mapped)
+                throw mapped;
+            throw new error_1.AppError(opts.defaultErrCode ?? "INTERNAL_API_ERROR", `${opts.errPrefix}: ${msg}`);
+        }
+        // status_code = "0"：data 存在则解封；否则 envelope 自身就是业务体
+        if (env.data)
+            return env.data;
+        return result;
+    }
+    return result;
+}
+// ── verbose 调试日志 ────────────
+//
+// 仅作用于 inner-api 链路（postInnerApi / getInnerApi），即 app / deploy /
+// observability 三个域。--verbose 关闭时所有 helper 都直接退出，零开销。
+function logRequestStart(method, url, body) {
+    const startMs = Date.now();
+    if (!(0, config_1.getConfig)().verbose)
+        return startMs;
+    (0, logger_1.debug)(`→ ${method} ${url}`);
+    if (body !== undefined) {
+        (0, logger_1.debug)(`  body: ${truncateForLog(safeStringify(body), 1000)}`);
+    }
+    return startMs;
+}
+function logResponseEnd(method, url, response, startMs) {
+    if (!(0, config_1.getConfig)().verbose)
+        return;
+    const elapsedMs = Date.now() - startMs;
+    const logid = pickLogid(response.headers);
+    const tail = logid ? ` logid=${logid}` : "";
+    (0, logger_1.debug)(`← ${method} ${url} ${String(response.status)} ${String(elapsedMs)}ms${tail}`);
+}
+/**
+ * http-client 在 4xx/5xx / 网络错误时直接 reject（不返回 Response）；
+ * 这条路径下 logResponseEnd 不会跑——这里专门补一行，尽可能从 HttpError
+ * 上抠出 status / logid，让 verbose 仍能看到失败请求的关键信息。
+ */
+function logResponseFailure(method, url, err, startMs) {
+    if (!(0, config_1.getConfig)().verbose)
+        return;
+    const elapsedMs = Date.now() - startMs;
+    // @lark-apaas/http-client 的 HttpError.response: Response | undefined
+    const e = err;
+    const status = e.response?.status;
+    const logid = e.response?.headers ? pickLogid(e.response.headers) : null;
+    const statusPart = status !== undefined ? String(status) : "ERR";
+    const logidPart = logid ? ` logid=${logid}` : "";
+    const msgPart = e.message ? ` (${e.message})` : "";
+    (0, logger_1.debug)(`✗ ${method} ${url} ${statusPart} ${String(elapsedMs)}ms${logidPart}${msgPart}`);
+}
+/** BAM gateway 在不同 PSM/版本上 logid 落在不同 header；按命中顺序取第一个非空。 */
+function pickLogid(headers) {
+    return (headers.get("x-tt-logid") ??
+        headers.get("x-logid") ??
+        headers.get("logid") ??
+        headers.get("x-tt-trace-tag"));
+}
+function safeStringify(v) {
+    try {
+        return JSON.stringify(v);
+    }
+    catch {
+        return String(v);
+    }
+}
+function truncateForLog(s, n) {
+    if (s.length <= n)
+        return s;
+    return `${s.slice(0, n)}...(truncated, ${String(s.length)} chars)`;
+}

package/dist/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setRuntimeHttpClient = exports.setHttpClient = exports.resetHttpClient = exports.getRuntimeHttpClient = exports.getHttpClient = exports.log = exports.debug = exports.isJsonMode = exports.emitError = exports.emit = exports.getLogId = exports.generateLogId = exports.initConfigFromOpts = exports.resetConfig = exports.setConfig = exports.getConfig = exports.HttpError = exports.AppError = void 0;
+exports.pollUntilDone = exports.msToSec = exports.msToNs = exports.parseToSec = exports.parseToNs = exports.parseToMs = exports.parseTimeToMs = exports.getInnerApi = exports.postInnerApi = exports.setRuntimeHttpClient = exports.setHttpClient = exports.resetHttpClient = exports.getRuntimeHttpClient = exports.getHttpClient = exports.log = exports.debug = exports.fmt = exports.isJsonMode = exports.emitPaged = exports.emitOk = exports.emitError = exports.emit = exports.getLogId = exports.generateLogId = exports.initConfigFromOpts = exports.resetConfig = exports.setConfig = exports.getConfig = exports.HttpError = exports.AppError = void 0;
 var error_1 = require("./error");
 Object.defineProperty(exports, "AppError", { enumerable: true, get: function () { return error_1.AppError; } });
 Object.defineProperty(exports, "HttpError", { enumerable: true, get: function () { return error_1.HttpError; } });
@@ -15,7 +15,10 @@ Object.defineProperty(exports, "getLogId", { enumerable: true, get: function ()
 var output_1 = require("./output");
 Object.defineProperty(exports, "emit", { enumerable: true, get: function () { return output_1.emit; } });
 Object.defineProperty(exports, "emitError", { enumerable: true, get: function () { return output_1.emitError; } });
+Object.defineProperty(exports, "emitOk", { enumerable: true, get: function () { return output_1.emitOk; } });
+Object.defineProperty(exports, "emitPaged", { enumerable: true, get: function () { return output_1.emitPaged; } });
 Object.defineProperty(exports, "isJsonMode", { enumerable: true, get: function () { return output_1.isJsonMode; } });
+Object.defineProperty(exports, "fmt", { enumerable: true, get: function () { return output_1.fmt; } });
 var logger_1 = require("./logger");
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return logger_1.debug; } });
 Object.defineProperty(exports, "log", { enumerable: true, get: function () { return logger_1.log; } });
@@ -25,3 +28,14 @@ Object.defineProperty(exports, "getRuntimeHttpClient", { enumerable: true, get:
 Object.defineProperty(exports, "resetHttpClient", { enumerable: true, get: function () { return http_1.resetHttpClient; } });
 Object.defineProperty(exports, "setHttpClient", { enumerable: true, get: function () { return http_1.setHttpClient; } });
 Object.defineProperty(exports, "setRuntimeHttpClient", { enumerable: true, get: function () { return http_1.setRuntimeHttpClient; } });
+Object.defineProperty(exports, "postInnerApi", { enumerable: true, get: function () { return http_1.postInnerApi; } });
+Object.defineProperty(exports, "getInnerApi", { enumerable: true, get: function () { return http_1.getInnerApi; } });
+var time_1 = require("./time");
+Object.defineProperty(exports, "parseTimeToMs", { enumerable: true, get: function () { return time_1.parseTimeToMs; } });
+Object.defineProperty(exports, "parseToMs", { enumerable: true, get: function () { return time_1.parseToMs; } });
+Object.defineProperty(exports, "parseToNs", { enumerable: true, get: function () { return time_1.parseToNs; } });
+Object.defineProperty(exports, "parseToSec", { enumerable: true, get: function () { return time_1.parseToSec; } });
+Object.defineProperty(exports, "msToNs", { enumerable: true, get: function () { return time_1.msToNs; } });
+Object.defineProperty(exports, "msToSec", { enumerable: true, get: function () { return time_1.msToSec; } });
+var poll_1 = require("./poll");
+Object.defineProperty(exports, "pollUntilDone", { enumerable: true, get: function () { return poll_1.pollUntilDone; } });