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

FEA-2796: Occurrence Diagnostics #94

Merged
merged 6 commits into from
Oct 23, 2023
Merged

Conversation

matthewnitschke-wk
Copy link
Contributor

@matthewnitschke-wk matthewnitschke-wk commented Sep 10, 2023

FEA-2796

Issue Status

Populates the diagnostics field on Occurrences: https://github.com/sourcegraph/scip/blob/main/scip.proto#L579 with data from the dart analyzer

Now that sourcegraph has fixed their gql provider for retrieving this diagnostic data: https://github.com/sourcegraph/sourcegraph/issues/56904, this data has become more helpful, and we should start populating it

@aviary2-wf
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

@matthewnitschke-wk matthewnitschke-wk changed the title populate diagnostics Occurrence Diagnostics Oct 21, 2023
@bender-wk bender-wk changed the title Occurrence Diagnostics FEA-2796: Occurrence Diagnostics Oct 21, 2023
@matthewnitschke-wk matthewnitschke-wk marked this pull request as ready for review October 21, 2023 15:45
@evanweible-wf
Copy link

Should/could we update the snapshots to test the population of these diagnostics?

@matthewnitschke-wk
Copy link
Contributor Author

matthewnitschke-wk commented Oct 23, 2023

@evanweible-wf

Should/could we update the snapshots to test the population of these diagnostics?

Unfortunately the snapshot command doesn't include diagnostics in what it writes

I considered writing my own (could even just be a json output thing), but its a bit more of a lift than I wanted to do for this PR. Happy to reconsider if you think that would be valuable

@evanweible-wf
Copy link

Nope that's fine with me - diagnostics are just extra, so as long as they don't break the generation in the first place, I'm fine not including them in the tests if it's a bigger lift

@matthewnitschke-wk
Copy link
Contributor Author

Nope that's fine with me - diagnostics are just extra, so as long as they don't break the generation in the first place, I'm fine not including them in the tests if it's a bigger lift

👍 The existing snapshot tests, and my integration tests should cover that breakage case: https://github.com/Workiva/scip-dart/actions/runs/6598256582/job/17926049013?pr=94

I would like to get some tests to cover that though, I'll create a ticket for it so I dont forget

@matthewnitschke-wk
Copy link
Contributor Author

Ticketed #98

@matthewnitschke-wk
Copy link
Contributor Author

QA +1

  • CI passes, and diagnostic data is additional, doesn't effect existing scip data

🚀 @Workiva/release-management-p 🚢

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 from RM

@rmconsole5-wk rmconsole5-wk merged commit 2d1ae23 into master Oct 23, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants