mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
sang-neo03
4c1a92caa6
* refactor: add output emitter contract and differential harness Introduce a leaf Emitter in internal/output that composes the existing output primitives (content-safety scan, envelope, jq, format rendering, notice) behind a single command-scoped port. The emitter is unwired: no production caller is migrated, so CLI output stays byte-for-byte unchanged. A differential test harness drives the real legacy entry points (RuntimeContext.Out/OutRaw/OutFormat/..., WriteSuccessEnvelope and the pagination formatter) and asserts byte-identical stdout/stderr plus typed errors, locking behavior before later slices migrate callers. * refactor: tighten emitter API and cover pagination with real tests - split Emitter.Success/PartialFailure and drop EmitOptions.OK so a missing ok flag can no longer silently emit ok:false - give StreamPage its own StreamOptions (format + pretty) instead of reusing EmitOptions, making "jq needs aggregation" a compile-time fact - pin the Emitter jq-error contract (returns error, writes no stderr); the caller adapter re-emits the legacy stderr line on migration - add in-package tests driving the real apiPaginate/servicePaginate over a mock transport: multi-page aggregation, empty-result fallback, MarkRaw handling, and the business-error raw-response red line * test: use standard TestFactory harness for pagination tests Replace the hand-rolled RoundTripper + APIClient construction in the apiPaginate/servicePaginate tests with cmdutil.TestFactory and its httpmock.Registry, and isolate LARKSUITE_CLI_CONFIG_DIR to t.TempDir(), matching the repo's standard HTTP-mocked test convention. Assertions and coverage (multi-page aggregation, empty-result fallback, MarkRaw, and the business-error raw-response red line) are unchanged. * refactor: route success output through the single Emitter port Migrate the success-output surfaces onto internal/output's Emitter, byte-for-byte identical (proven by frozen golden diffs and the real paginate/HandleResponse tests): - RuntimeContext.Out/OutRaw/OutFormat/OutFormatRaw/OutPartialFailure now build an Emitter and call Success/PartialFailure; emit and outFormat are removed. An adapter maps the returned error back to the legacy outputErrOnce / jq-error stderr / exit-code behavior. - WriteSuccessEnvelope degrades to a thin Emitter.Success delegate; its 8 callers are unchanged. - apiPaginate/servicePaginate stream pages via Emitter.StreamPage; the aggregate and business-error raw-response branches are untouched. - HandleResponse routes its non-JSON structured-response branch through Emitter.Success. Frozen golden fixtures replace the runtime legacy oracles so the differential harness cannot go self-referential after migration. * fix: keep _notice on struct payloads in Emitter's unknown-format fallback printLegacyDataJSON now normalizes via toGeneric first (matching FormatValue), so a struct / named-map payload retains its injected _notice on the unknown-format -> JSON fallback rather than dropping it silently. Add a regression test that fails against the pre-fix path. * refactor: make the Emitter own write failures and stop mutating inputs Route every Emitter stdout path through a render-to-buffer-then-copy helper so a marshal/render failure leaves stdout empty and surfaces a typed internal error (with cause), and a stdout write failure is propagated instead of silently swallowed. Leaf writers gain error-returning Write* cores; the legacy Print*/FormatValue wrappers keep their exact behavior for unmigrated callers. - handleEmitterError now captures every error, not only the jq/safety branches; flip OutRaw's write-error test to assert propagation. - Clone the map before injecting _notice so a caller's payload is never mutated and an existing _notice is never overwritten. - Preserve jq's own typed error (validation/api) on a bad expression or runtime failure; only wrap genuine stdout write failures. - Split tests: normative emitter_contract_test.go vs frozen emitter_legacy_compat_test.go (base SHA recorded, self-update env vars removed). * fix: satisfy license-header and forbidigo lint on the emitter changes - Move the base-SHA note below the copyright header in the renamed legacy-compat test so the license-header check sees a valid header at the top. - Route the leaf wrappers' marshal/format stderr messages through a single legacyStderrf helper (one //nolint:forbidigo) instead of bare os.Stderr, preserving exact legacy behavior for unmigrated direct callers while passing forbidigo; drop the now-unused os imports. * fix: stop legacy CSV wrappers reporting write failures to stderr Align FormatAsCSV/FormatAsCSVPaginated and FormatValue/FormatPage's CSV branch with the other leaf wrappers: report only marshal failures, swallow write failures. Previously they emitted a 'csv write error' for the (empty) line and the JSON-fallback write failures that the pre-refactor code ignored, and mislabeled a JSON write failure as a CSV one. Failure-path only; success output is unchanged (golden double-diff still byte-for-byte).
108 lines
3.7 KiB
JSON
108 lines
3.7 KiB
JSON
{
|
|
"cases": {
|
|
"csv": {
|
|
"stdout": "id,name\n1,Alice\n2,Bob\n",
|
|
"stderr": ""
|
|
},
|
|
"format_raw_json_preserves_html": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"html\": \"\u003cp\u003ea\u0026b\u003c/p\u003e\"\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"jq_invalid_expression": {
|
|
"stdout": "",
|
|
"stderr": "error: invalid jq expression: unexpected EOF\n",
|
|
"error": {
|
|
"go_type": "*errs.ValidationError",
|
|
"json": {
|
|
"type": "validation",
|
|
"subtype": "invalid_argument",
|
|
"message": "invalid jq expression: unexpected EOF"
|
|
},
|
|
"message": "invalid jq expression: unexpected EOF",
|
|
"exit_code": 2
|
|
}
|
|
},
|
|
"jq_safety_alert_without_stderr_warning": {
|
|
"stdout": "1\n",
|
|
"stderr": ""
|
|
},
|
|
"jq_scalar": {
|
|
"stdout": "Alice\n",
|
|
"stderr": ""
|
|
},
|
|
"json_object": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"enabled\": true,\n \"id\": \"1\"\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"metadata": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": [\n {\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"count\": 1,\n \"rollback\": \"lark-cli fixture rollback\"\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"ndjson": {
|
|
"stdout": "{\"id\":\"1\"}\n{\"id\":\"2\"}\n",
|
|
"stderr": ""
|
|
},
|
|
"notice": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"id\": \"1\"\n },\n \"_notice\": {\n \"update\": {\n \"latest\": \"9.9.9\"\n }\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"partial_failure_ok_false": {
|
|
"stdout": "{\n \"ok\": false,\n \"identity\": \"bot\",\n \"data\": {\n \"failed\": 1,\n \"succeeded\": 1\n }\n}\n",
|
|
"stderr": "",
|
|
"error": {
|
|
"go_type": "*output.PartialFailureError",
|
|
"json": {
|
|
"Code": 1
|
|
},
|
|
"message": "partial failure (exit 1)",
|
|
"exit_code": 1
|
|
}
|
|
},
|
|
"pretty": {
|
|
"stdout": "pretty:fixture\n",
|
|
"stderr": ""
|
|
},
|
|
"pretty_without_renderer": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"name\": \"Alice\"\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"raw_jq_complex": {
|
|
"stdout": "{\n \"html\": \"\u003cp\u003ea\u0026b\u003c/p\u003e\"\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"raw_json_preserves_html": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"html\": \"\u003cp\u003ea\u0026b\u003c/p\u003e\"\n }\n}\n",
|
|
"stderr": ""
|
|
},
|
|
"scanner_block": {
|
|
"stdout": "",
|
|
"stderr": "",
|
|
"error": {
|
|
"go_type": "*errs.ContentSafetyError",
|
|
"json": {
|
|
"type": "policy",
|
|
"subtype": "content_safety",
|
|
"message": "content safety violation detected (rules: fixture-rule)",
|
|
"rules": [
|
|
"fixture-rule"
|
|
]
|
|
},
|
|
"message": "content safety violation detected (rules: fixture-rule)",
|
|
"exit_code": 6
|
|
}
|
|
},
|
|
"scanner_error_fails_open": {
|
|
"stdout": "{\n \"ok\": true,\n \"identity\": \"bot\",\n \"data\": {\n \"id\": \"1\"\n }\n}\n",
|
|
"stderr": "warning: content safety scan error: scanner unavailable\n"
|
|
},
|
|
"table_with_safety_warning": {
|
|
"stdout": "id name \n── ─────\n1 Alice\n",
|
|
"stderr": "warning: content safety alert from emitter-oracle (rules: fixture-rule)\n"
|
|
},
|
|
"unknown_format_data_envelope_notice": {
|
|
"stdout": "{\n \"_notice\": {\n \"skills\": {\n \"current\": \"1.0.0\"\n }\n },\n \"ok\": true,\n \"value\": \"fixture\"\n}\n",
|
|
"stderr": "warning: unknown format \"yaml\", falling back to json\n"
|
|
}
|
|
}
|
|
}
|