fix(report): fix error with unmarshal of ExperimentalModifiedFindings

[DmitriyLewen]

Description

Fix error with unmarshal of ExperimentalModifiedFindings (e.g. in convert mode)

➜ trivy -d convert --show-suppressed  --exit-code 0 reports/trivyFull.json 
...
2024-09-09T10:22:22+06:00	FATAL	Fatal error
  - json decode error:
    github.com/aquasecurity/trivy/pkg/commands/convert.Run
        github.com/aquasecurity/trivy/pkg/commands/convert/run.go:32
  - json: cannot unmarshal object into Go struct field ModifiedFinding.Results.ExperimentalModifiedFindings.Finding of type types.finding

Related issues

• Close bug(convert): unable to decode ModifiedFinding.Results.ExperimentalModifiedFindings.Finding field #7461

Checklist

• I've read the guidelines for contributing to this repository.
• I've followed the conventions in the PR title.
• I've added tests that prove my fix is effective or that my feature works.
• I've updated the documentation with the relevant information (if needed).
• I've added usage information (if the PR introduces new options)
• I've included a "before" and "after" example to the description (if the PR is a user interface change).

[knqyf263]

We don't run MarshalJSON functions for ExperimentalModifiedFindings.Finding. e.g.:

This problem will be solved after aquasecurity/trivy-db#436.

[knqyf263]

I'll also open another PR to fix this line.

trivy/pkg/fanal/types/package.go

Line 81 in 5c37361

func (id *PkgIdentifier) MarshalJSON() ([]byte, error) {

[knqyf263]

Can we refactor as below?

    type Alias ModifiedFinding
    aux := &struct {
        Finding json.RawMessage `json:"Finding"`
        *Alias
    }{
        Alias: (*Alias)(m),
    }

cf.

trivy/pkg/fanal/types/package.go

Lines 97 to 121 in 5c37361

	// UnmarshalJSON customizes the JSON decoding of PkgIdentifier.
	func (id *PkgIdentifier) UnmarshalJSON(data []byte) error {
	type Alias PkgIdentifier
	aux := &struct {
	PURL string `json:",omitempty"`
	*Alias
	}{
	Alias: (*Alias)(id),
	}
	if err := json.Unmarshal(data, &aux); err != nil {
	return err
	}
	if aux.PURL != "" {
	p, err := packageurl.FromString(aux.PURL)
	if err != nil {
	return err
	} else if len(p.Qualifiers) == 0 {
	p.Qualifiers = nil
	}
	id.PURL = &p
	}
	return nil
	}

[DmitriyLewen]

Updated in 38b0d2b

[DmitriyLewen]

@knqyf263 I merged #7483. So this PR is ready for review.

[knqyf263]

@DmitriyLewen Do you think we want to backport this fix? I'm not sure this is a critical issue because this problem happens only when --show-suppressed is passed.

[DmitriyLewen]

hmm... I'm not sure about that
To reproduce this bug you need to use json with ExperimentalModifiedFindings into convert mode.

This is really quite rare case
We can just wait for feedback from users.
if many people encounter this - we will release a patch

[DmitriyLewen]

@aqua-bot backport release/v0.55

[aqua-bot]

Backport PR created: #7492