Skip to content

Fix --string non-string error reporting - #1039

Closed
He-Pin wants to merge 1 commit into
databricks:masterfrom
He-Pin:fix/cli-string-non-string-error
Closed

Fix --string non-string error reporting#1039
He-Pin wants to merge 1 commit into
databricks:masterfrom
He-Pin:fix/cli-string-non-string-error

Conversation

@He-Pin

@He-Pin He-Pin commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Motivation

--string mode leaked Internal error: upickle.core.Abort when the Jsonnet program produced a non-string result (object, array, number, boolean, null). Other implementations report a clean type error. The error path also lost the source position, making debugging harder.

Implementation --string on {}
C++ jsonnet 0.22.0 ERROR: expected string result, got: object
go-jsonnet 0.22.0 expected string result, got: object
sjsonnet master Internal error: upickle.core.Abort
this PR expected string result, got: object

Modification

  • Replace the generic SimpleVisitor that threw upickle.core.Abort with a typed visitor that overrides every non-string visitor method to throw sjsonnet.Error with a clear message including the Jsonnet type name (object, array, number, boolean, null).
  • Remove unnecessary return keyword in ManifestModule.scala match expression for idiomatic Scala.
  • Add a golden test for each non-string type and tighten existing --exec --string tests.

Result

  • Non-string results produce a clean sjsonnet.Error with position and Jsonnet type name.
  • String happy path is unchanged — zero overhead on the common case.
  • Error-path only: fillInStackTrace override prevents wasted JVM stack capture.

@He-Pin
He-Pin force-pushed the fix/cli-string-non-string-error branch from 2dd17d0 to cedccb2 Compare June 25, 2026 04:48
Motivation: --string rendering of non-string values leaked internal or upickle errors, including multi and yaml-stream paths.

Modification: Reject all non-string renderer visitor paths with sjsonnet.Error, wrap direct transforms, and add CLI regressions.

Result: --string now fails cleanly for non-string output without internal stack traces.
@He-Pin

He-Pin commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

Superseded by combined CLI PR #1032

@He-Pin He-Pin closed this Jun 28, 2026
stephenamar-db pushed a commit that referenced this pull request Jun 28, 2026
…y bindings (#1032)

## Motivation

Several CLI error paths leaked Java exception names
(`NoSuchFileException`, `InvalidPathException`, `upickle.core.Abort`) or
stack traces to end users. The `-V` short flag was ambiguously bound to
`--ext-str`, `--ext-code`, and `--tla-code`. The `--string` flag
produced internal errors for non-string results instead of a clean type
mismatch message. Binding file paths with invalid characters (e.g. null
bytes) were silently accepted. Reference implementations (C++ jsonnet,
go-jsonnet, jrsonnet) reserve `-V` exclusively for `--ext-str`.

This PR combines the following fixes into a single cohesive CLI
hardening change:

| Original PR | Fix |
| --- | --- |
| #1032 | Reserve `-V` exclusively for `--ext-str` |
| #1034 | Report undefined CLI binding env vars with clean error |
| #1035 | Make `--ext-str-file`/`--ext-code-file` lazy via
importstr/import |
| #1036 | Report missing input files without stack traces |
| #1038 | Report output file write failures cleanly |
| #1039 | Fix `--string` non-string error reporting |

## Modification

### Config / CLI parsing
- Remove `short = 'V'` from `--ext-code` and `--tla-code` `@arg`
annotations in `Config.scala`
- Keep `short = 'V'` on `--ext-str` only
- Update README help snapshot

### Error handling (`SjsonnetMainBase.scala`)
- Add `CliError` class with no stack trace for clean CLI error messages
- Add `handleRenderError` to wrap Jsonnet evaluation errors
- Add `handleWriteFile` to wrap file I/O errors with
C++/go-jsonnet-style messages
- Rewrite `parseBindings` to use `HashMap` with eager
`InvalidPathException` validation
- Make `--ext-str-file` and `--ext-code-file` lazy
(`importstr`/`import`) while still validating path syntax eagerly
- Add clean type error for `--string` with non-string results (matching
C++/go-jsonnet format)
- Wrap output file write and multi/yaml-stream render paths with error
handling

### Tests
- 18 new CLI integration tests covering all error paths
- `ConfigTests` verifies `-V` binds only to `--ext-str`
- 24 new test resource files (jsonnet inputs + golden outputs)

## Result

- All CLI errors produce clean messages matching C++/go-jsonnet
conventions
- `-V` binds only to `--ext-str`, matching reference implementations
- `--string` rejects non-string types with clear `expected string
result, got: <type>` error
- Malformed binding file paths fail eagerly with clean error
- Unused `--ext-str-file` bindings are lazy (file not read unless
referenced)
- 45/45 MainTests pass, 0 regressions in full test suite

## CLI Superset Status

sjsonnet is now a superset of go-jsonnet and C++ jsonnet CLI features,
with these extras:
- `--yaml-out`, `--yaml-debug`, `--debug-importer`, `--debug-stats`
- `--profile`, `--strict`, `--preserve-order`, `--indent`
- `--fatal-warnings`, `--throw-error-for-invalid-sets`
- `--max-stack`, `--max-parser-recursion-depth`
- `--reverse-jpaths-priority`, `--no-trailing-newline`
- `--broken-assertion-logic` (backwards compat)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant