Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider adding 'updated' baselineState #312

Closed
michaelcfanning opened this issue Jan 22, 2019 · 4 comments
Closed

Consider adding 'updated' baselineState #312

michaelcfanning opened this issue Jan 22, 2019 · 4 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement impact-breaks-consumers impact-breaks-producers p1 Priority 1 issue to close resolved-fixed

Comments

@michaelcfanning
Copy link
Contributor

michaelcfanning commented Jan 22, 2019

Feedback from an internal MS results matching effort. In some cases, a result is matched but details of it have been updated in some way that warrants refreshing the already filed work item. For this case, it would be helpful to have an 'updated' baseline state (which indicates the baseline result was effectively matched but something interesting changed about it). It is inefficient to consult the work item server for all 'existing' matches and comparing the filed result against current details. For 'existing' items, no server interaction s/be required. Here are all the possibilities for the work item filer:

  1. issue is 'absent': retrieve work item via correlation guid and close it
  2. issue is 'existing': no work. issue s/be filed, no refresh required
  3. issue is 'updated': retrieve work item and rewrite details or attach a new SARIF log file the reflects more current state
  4. issue is 'new': file a brand new work item

To provide a specific example, we have an analysis that analyzes a structural JSON file, looking for bad values in properties. The violation locations are denoted by a JSON path, for example, myObject.myProperty. In some cases, a work item may be filed already against the contents of myObject.myProperty. In a subsequent run, the literal contents of myProperty may have changed (but with the result that the scan tool still objects to them). For this case, we consider the result matched (because it is against the identical scan target, which is owned by a specific engineering team) but want to update the filed item to include new details of what changed.

@lgolding, FYI

@ghost
Copy link

ghost commented Jan 22, 2019

Makes sense to me.

@michaelcfanning michaelcfanning added the p1 Priority 1 issue to close label Jan 24, 2019
@michaelcfanning
Copy link
Contributor Author

TC suggestion to add 'reintroduced'. rename existing to 'unchanged', updated is approved.

@michaelcfanning michaelcfanning added the design-approved The TC approved the design and I can write the change draft label Jan 24, 2019
@michaelcfanning
Copy link
Contributor Author

Schema has been updated for this in SARIF SDK repo.

@ghost ghost self-assigned this Feb 11, 2019
ghost pushed a commit that referenced this issue Feb 11, 2019
ghost pushed a commit that referenced this issue Feb 20, 2019
@ghost
Copy link

ghost commented Feb 20, 2019

Changes merged to provisional draft.

@ghost ghost closed this as completed Feb 20, 2019
ghost pushed a commit that referenced this issue Feb 20, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement impact-breaks-consumers impact-breaks-producers p1 Priority 1 issue to close resolved-fixed
Projects
None yet
Development

No branches or pull requests

1 participant