mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
c100ca049e
* feat(cmdutil): support @file for --params/--data (issue #705) Inline JSON values for --params/--data are mangled by Windows PowerShell 5's CommandLineToArgvW. Stdin (-) was the only escape hatch but supports just one flag at a time. Extend ResolveInput to accept @<path> (read JSON from a file) and @@... (escape for a literal @-prefixed value), mirroring the shortcuts framework's resolveInputFlags semantics. With this, both --params and --data can be sourced from files in the same call, sidestepping shell quoting on every platform. - internal/cmdutil/resolve.go: add @path / @@ handling, trim file content like stdin does, error on empty path or empty file - internal/cmdutil/resolve_test.go: cover file read, whitespace trim, missing file, empty path, empty content, @@ escape, plus ParseJSONMap / ParseOptionalBody integration through @file - cmd/api/api.go, cmd/service/service.go: update --params/--data help text to mention @file Change-Id: I366aa0f5783fbec6f05403f7f542505098a98c82 * refactor(cmdutil): route @file through fileio.FileIO abstraction The first cut of @file support called os.ReadFile directly inside ResolveInput, bypassing the codebase's fileio.FileIO abstraction (SafeInputPath validation, pluggable provider). That diverged from how every other file-reading path works: BuildFormdata for --file uploads and the shortcuts framework's resolveInputFlags both go through fileio.FileIO.Open with explicit fileio.ErrPathValidation handling. Re-route @file through the same path: - ResolveInput, ParseJSONMap, ParseOptionalBody now take a fileio.FileIO; @path uses fileIO.Open which goes through SafeInputPath (control-char rejection, abs-path rejection, symlink-escape check) — same security posture as --file - cmd/api and cmd/service callsites pass Factory.ResolveFileIO(ctx); the upload path now reuses the resolved fileIO instead of resolving twice - Path-validation errors surface as `--params: invalid file path "...": ...` distinct from `--params: cannot read file "...": ...` for genuine I/O errors - Nil fileIO with an @path returns a clear "file input (@path) is not available" error - Tests use localfileio.LocalFileIO with TestChdir(t, dir), matching the existing fileupload_test.go pattern; absolute-path rejection and nil-fileIO are covered This makes the feature behave identically under any FileIO provider (including server mode) instead of being silently bound to the local filesystem. Change-Id: I878c4e8fb03f43f1f19afad75ec3af9cdab7a7f9 * refactor(cmdutil): share at-file input handling Change-Id: I92a6eb6ea8fd02054bf8f4925cd81807449d5e51
53 lines
1.6 KiB
Go
53 lines
1.6 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmdutil
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io"
|
|
|
|
"github.com/larksuite/cli/extension/fileio"
|
|
"github.com/larksuite/cli/internal/output"
|
|
)
|
|
|
|
// ParseOptionalBody parses --data JSON for methods that accept a request body.
|
|
// Supports stdin (-), @file, @@-escape, and single-quote stripping via ResolveInput.
|
|
// Returns (nil, nil) if the method has no body or data is empty.
|
|
func ParseOptionalBody(httpMethod, data string, stdin io.Reader, fileIO fileio.FileIO) (interface{}, error) {
|
|
switch httpMethod {
|
|
case "POST", "PUT", "PATCH", "DELETE":
|
|
default:
|
|
return nil, nil
|
|
}
|
|
resolved, err := ResolveInput(data, stdin, fileIO)
|
|
if err != nil {
|
|
return nil, output.ErrValidation("--data: %s", err)
|
|
}
|
|
if resolved == "" {
|
|
return nil, nil
|
|
}
|
|
var body interface{}
|
|
if err := json.Unmarshal([]byte(resolved), &body); err != nil {
|
|
return nil, output.ErrValidation("--data invalid JSON format")
|
|
}
|
|
return body, nil
|
|
}
|
|
|
|
// ParseJSONMap parses a JSON string into a map. Returns an empty map if input is empty.
|
|
// Supports stdin (-), @file, @@-escape, and single-quote stripping via ResolveInput.
|
|
func ParseJSONMap(input, label string, stdin io.Reader, fileIO fileio.FileIO) (map[string]any, error) {
|
|
resolved, err := ResolveInput(input, stdin, fileIO)
|
|
if err != nil {
|
|
return nil, output.ErrValidation("%s: %s", label, err)
|
|
}
|
|
if resolved == "" {
|
|
return map[string]any{}, nil
|
|
}
|
|
var result map[string]any
|
|
if err := json.Unmarshal([]byte(resolved), &result); err != nil {
|
|
return nil, output.ErrValidation("%s invalid format, expected JSON object", label)
|
|
}
|
|
return result, nil
|
|
}
|