updates from comments

Author: zeroshade

cmd/dbc/add.go

@@ -15,6 +15,7 @@
 package main
 
 import (
+	"bytes"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -34,14 +35,20 @@ import (
 var msgStyle = lipgloss.NewStyle().Faint(true)
 
 func marshalEnvelope(kind string, payload any) string {
-	payloadBytes, _ := json.Marshal(payload)
+	var b bytes.Buffer
+	enc := json.NewEncoder(&b)
+	enc.SetEscapeHTML(false) // don't escape <, >, & in JSON output
+	enc.Encode(payload)
+
 	env := jsonschema.Envelope{
 		SchemaVersion: jsonschema.SchemaVersion,
 		Kind:          kind,
-		Payload:       json.RawMessage(payloadBytes),
+		Payload:       json.RawMessage(b.Bytes()),
 	}
-	out, _ := json.Marshal(env)
-	return string(out)
+
+	b.Reset()
+	enc.Encode(env)
+	return b.String()
 }
 
 func driverListPath(path string) (string, error) {

cmd/dbc/add_test.go

@@ -454,6 +454,36 @@ func (suite *SubcommandTestSuite) TestAdd_JSON() {
 	suite.NotEmpty(resp.DriverListPath)
 }
 
+func (suite *SubcommandTestSuite) TestAdd_JSON_Constraint() {
+	m := InitCmd{Path: filepath.Join(suite.tempdir, "dbc.toml")}.GetModel()
+	suite.runCmd(m)
+
+	m = AddCmd{
+		Path:   filepath.Join(suite.tempdir, "dbc.toml"),
+		Driver: []string{"test-driver-1>=1.0.0"},
+		Json:   true,
+	}.GetModelCustom(
+		baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
+
+	out := suite.runCmd(m)
+
+	var env jsonschema.Envelope
+	suite.Require().NoError(json.Unmarshal([]byte(out), &env), "output must be valid JSON: %s", out)
+	suite.Equal(1, env.SchemaVersion)
+	suite.Equal("add.response", env.Kind)
+
+	// verify we aren't escaping the > character in the JSON output
+	suite.Equal(string(env.Payload), `{"driver_list_path":"`+filepath.Join(suite.tempdir, "dbc.toml")+
+		`","drivers":[{"name":"test-driver-1","version_constraint":">=1.0.0"}]}`)
+
+	var resp jsonschema.AddResponse
+	suite.Require().NoError(json.Unmarshal(env.Payload, &resp))
+	suite.Require().Len(resp.Drivers, 1)
+	suite.Equal("test-driver-1", resp.Drivers[0].Name)
+	suite.Equal(">=1.0.0", resp.Drivers[0].VersionConstraint)
+	suite.NotEmpty(resp.DriverListPath)
+}
+
 func (suite *SubcommandTestSuite) TestAddMultipleOutput() {
 	m := InitCmd{Path: filepath.Join(suite.tempdir, "dbc.toml")}.GetModel()
 	suite.runCmd(m)

cmd/dbc/completions/dbc.bash

@@ -69,7 +69,7 @@ _dbc_install_completions() {
     esac
 
     if [[ "$cur" == -* ]]; then
-        COMPREPLY=($(compgen -W "--json --no-verify --level -l --pre" -- "$cur"))
+        COMPREPLY=($(compgen -W "--json --json-stream-progress --no-verify --level -l --pre" -- "$cur"))
         return 0
     fi
 
@@ -162,7 +162,7 @@ _dbc_sync_completions() {
     esac
 
     if [[ "$cur" == -* ]]; then
-        COMPREPLY=($(compgen -W "-h --level -l --path -p --no-verify" -- "$cur"))
+        COMPREPLY=($(compgen -W "-h --level -l --path -p --no-verify --json --json-stream-progress" -- "$cur"))
         return 0
     fi
 

cmd/dbc/completions/dbc.fish

@@ -44,6 +44,7 @@ complete -f -c dbc -n '__fish_dbc_needs_command' -a 'auth' -d 'Authenticate with
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -s h -d 'Show Help'
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l help -d 'Show Help'
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l json -d 'Print output as JSON instead of plaintext'
+complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l json-stream-progress -d 'Stream progress events as JSON lines (implies --json)'
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l no-verify -d 'Do not verify the driver after installation'
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l pre -d 'Allow implicit installation of pre-release versions'
 complete -f -c dbc -n '__fish_dbc_using_subcommand install' -l level -s l -d 'Installation level' -xa 'user system'
@@ -69,6 +70,8 @@ complete -f -c dbc -n '__fish_dbc_using_subcommand sync' -l help -d 'Help'
 complete -f -c dbc -n '__fish_dbc_using_subcommand sync' -l level -s l -d 'Installation level' -xa 'user system'
 complete -c dbc -n '__fish_dbc_using_subcommand sync' -l path -s p -r -F -a '*.toml' -d 'Driver list to sync'
 complete -f -c dbc -n '__fish_dbc_using_subcommand sync' -l no-verify -d 'Do not verify the driver after installation'
+complete -f -c dbc -n '__fish_dbc_using_subcommand sync' -l json -d 'Print output as JSON instead of plaintext'
+complete -f -c dbc -n '__fish_dbc_using_subcommand sync' -l json-stream-progress -d 'Stream progress events as JSON lines (implies --json)'
 
 # search subcommand
 complete -f -c dbc -n '__fish_dbc_using_subcommand search' -s h -d 'Help'

cmd/dbc/completions/dbc.zsh

@@ -76,6 +76,7 @@ function _dbc_install_completions {
         '(-h)--help[Help]' \
         '--no-verify[do not verify the driver after installation]' \
         '--json[Print output as JSON instead of plaintext]' \
+        '--json-stream-progress[Stream progress events as JSON lines (implies --json)]' \
         '--pre[Allow implicit installation of pre-release versions]' \
         '(-l)--level[installation level]: :(user system)' \
         '(--level)-l[installation level]: :(user system)' \
@@ -117,7 +118,9 @@ function _dbc_sync_completions {
         '(--level)-l[installation level]: :(user system)' \
         '(-p)--path[driver list to add to]: :_files -g \*.toml' \
         '(--path)-p[driver list to add to]: :_files -g \*.toml' \
-        '--no-verify[do not verify the driver after installation]'
+        '--no-verify[do not verify the driver after installation]' \
+        '--json[Print output as JSON instead of plaintext]' \
+        '--json-stream-progress[Stream progress events as JSON lines (implies --json)]'
 }
 
 function _dbc_search_completions {

cmd/dbc/install.go

@@ -18,6 +18,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"io"
 	"io/fs"
 	"os"
 	"path/filepath"
@@ -67,6 +68,7 @@ type InstallCmd struct {
 	Driver             string             `arg:"positional,required" help:"Driver to install, optionally with a version constraint (for example: mysql, mysql=0.1.0, mysql>=1,<2)"`
 	Level              config.ConfigLevel `arg:"-l" help:"Config level to install to (user, system)"`
 	Json               bool               `arg:"--json" help:"Print output as JSON instead of plaintext"`
+	JsonStreamProgress bool               `arg:"--json-stream-progress" help:"Stream progress events as JSON lines (implies --json)"`
 	NoVerify           bool               `arg:"--no-verify" help:"Allow installation of drivers without a signature file"`
 	Pre                bool               `arg:"--pre" help:"Allow implicit installation of pre-release versions"`
 	InsecureNoChecksum bool               `arg:"--insecure-no-checksum" help:"Skip sha256 checksum recording (not recommended)"`
@@ -89,7 +91,8 @@ func (c InstallCmd) GetModelCustom(baseModel baseModel) tea.Model {
 	return progressiveInstallModel{
 		Driver:             c.Driver,
 		NoVerify:           c.NoVerify,
-		jsonOutput:         c.Json,
+		jsonOutput:         c.Json || c.JsonStreamProgress,
+		jsonStreamProgress: c.JsonStreamProgress,
 		Pre:                c.Pre,
 		insecureNoChecksum: c.InsecureNoChecksum,
 		spinner:            s,
@@ -181,8 +184,21 @@ func (progressiveInstallModel) NeedsRenderer() {}
 
 func (m progressiveInstallModel) IsJSONMode() bool { return m.jsonOutput }
 
+func (m progressiveInstallModel) WithJSONWriter(w io.Writer) tea.Model {
+	m.jsonOut = w
+	return m
+}
+
+func (m progressiveInstallModel) emitJSON(kind string, payload any) {
+	out := m.jsonOut
+	if out == nil {
+		out = os.Stdout
+	}
+	fmt.Fprintln(out, marshalEnvelope(kind, payload))
+}
+
 func (m progressiveInstallModel) addEvent(event string, extra ...func(*jsonschema.InstallProgressEvent)) progressiveInstallModel {
-	if !m.jsonOutput {
+	if !m.jsonStreamProgress {
 		return m
 	}
 	evt := jsonschema.InstallProgressEvent{
@@ -192,19 +208,20 @@ func (m progressiveInstallModel) addEvent(event string, extra ...func(*jsonschem
 	for _, fn := range extra {
 		fn(&evt)
 	}
-	m.jsonEvents = append(m.jsonEvents, marshalEnvelope("install.progress", evt))
+	m.emitJSON("install.progress", evt)
 	return m
 }
 
 type progressiveInstallModel struct {
 	baseModel
 
-	Driver       string
-	VersionInput *semver.Version
-	NoVerify     bool
-	jsonOutput   bool
-	Pre          bool
-	cfg          config.Config
+	Driver             string
+	VersionInput       *semver.Version
+	NoVerify           bool
+	jsonOutput         bool
+	jsonStreamProgress bool
+	Pre                bool
+	cfg                config.Config
 
 	insecureNoChecksum  bool
 	installedDriverInfo config.DriverInfo
@@ -222,8 +239,8 @@ type progressiveInstallModel struct {
 	localPackagePath string
 
 	registryErrors           error
-	jsonEvents               []string
 	alreadyInstalledChecksum string
+	jsonOut                  io.Writer
 	jsonErrorOutput          string // JSON error envelope to emit via FinalOutput
 }
 
@@ -353,31 +370,15 @@ func (m progressiveInstallModel) FinalOutput() string {
 
 		if m.jsonOutput {
 			if installStatus.Checksum != "" {
-				m = m.addEvent("verify.checksum.ok", func(e *jsonschema.InstallProgressEvent) {
+				m.addEvent("verify.checksum.ok", func(e *jsonschema.InstallProgressEvent) {
 					e.Checksum = installStatus.Checksum
 				})
 			}
-			payloadBytes, err := json.Marshal(installStatus)
-			if err != nil {
-				return fmt.Sprintf(`{"schema_version":1,"kind":"error","payload":{"code":"marshal_error","message":"%s"}}`, err.Error())
-			}
-			env := jsonschema.Envelope{
-				SchemaVersion: jsonschema.SchemaVersion,
-				Kind:          "install.status",
-				Payload:       json.RawMessage(payloadBytes),
-			}
-			jsonOutput, err := json.Marshal(env)
-			if err != nil {
-				return fmt.Sprintf(`{"schema_version":1,"kind":"error","payload":{"code":"marshal_error","message":"%s"}}`, err.Error())
-			}
-			completeLine := marshalEnvelope("install.progress", jsonschema.InstallProgressEvent{
+			m.emitJSON("install.progress", jsonschema.InstallProgressEvent{
 				Event:  "install.complete",
 				Driver: m.Driver,
 			})
-			allLines := make([]string, 0, len(m.jsonEvents)+2)
-			allLines = append(allLines, m.jsonEvents...)
-			allLines = append(allLines, completeLine, string(jsonOutput))
-			return strings.Join(allLines, "\n")
+			return marshalEnvelope("install.status", installStatus)
 		}
 
 		if installStatus.Conflict != "" {

cmd/dbc/install_test.go

@@ -530,7 +530,7 @@ func (suite *SubcommandTestSuite) TestInstall_InsecureNoChecksumFlag() {
 }
 
 func (suite *SubcommandTestSuite) TestInstall_JSONProgressStream() {
-	m := InstallCmd{Driver: "test-driver-1", Level: suite.configLevel, Json: true}.
+	m := InstallCmd{Driver: "test-driver-1", Level: suite.configLevel, JsonStreamProgress: true}.
 		GetModelCustom(baseModel{getDriverRegistry: getTestDriverRegistry, downloadPkg: downloadTestPkg})
 	out := suite.runCmd(m)
 

cmd/dbc/subcommand_test.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"io/fs"
 	"net/url"
 	"os"
@@ -145,11 +146,19 @@ func (suite *SubcommandTestSuite) Dir() string {
 	return suite.configLevel.ConfigLocation()
 }
 
+// HasJSONWriter is implemented by models that stream JSON events directly to an io.Writer.
+type HasJSONWriter interface {
+	WithJSONWriter(io.Writer) tea.Model
+}
+
 func (suite *SubcommandTestSuite) runCmdErr(m tea.Model) string {
 	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
 	defer cancel()
 
 	var out bytes.Buffer
+	if jw, ok := m.(HasJSONWriter); ok {
+		m = jw.WithJSONWriter(&out)
+	}
 	prog = tea.NewProgram(m, tea.WithInput(nil), tea.WithOutput(&out),
 		tea.WithoutRenderer(), tea.WithContext(ctx))
 	defer func() {
@@ -185,6 +194,9 @@ func (suite *SubcommandTestSuite) runCmd(m tea.Model) string {
 	defer cancel()
 
 	var out bytes.Buffer
+	if jw, ok := m.(HasJSONWriter); ok {
+		m = jw.WithJSONWriter(&out)
+	}
 	prog = tea.NewProgram(m, tea.WithInput(nil), tea.WithOutput(&out),
 		tea.WithoutRenderer(), tea.WithContext(ctx))
 	defer func() {