microsoft / microsoft/sarif-sdk

SARIF2004.OptimizeFileSize: Don't complain about location-only artifacts if any artifact has other info

Open
#2,000 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-validation bug
Dominant language
C#
Stars
226
Forks
108
Avg merge
3d 8h
Merged PRs (30d)
6

Description

This rule fires if the first artifact in run.artifacts is location-only. But in the SARIF file produced by the SarifSdkSample, there are three artifacts and only the second one has non-location content.

There are two issues:

  1. Should we refrain from firing the rule unless all artifacts are location-only?
  2. If the answer to #1 is "no" -- that is, if we do want to fire the rule if any artifact is location-only, then at the very least the message is wrong ("The 'artifacts' array contains no information beyond the locations of the artifacts"). But in that case, we should fire on the individual location-only artifacts, not on the artifacts array as a whole.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SARIF2004.OptimizeFileSize rule and reproduce the behavior using the SARIF file produced by SarifSdkSample. Determine whether the rule should consider all artifacts or report individual location-only artifacts, then verify that its diagnostic message matches the selected behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.