SLVS-1853 Refactor the RoslynSettingsFileSynchronizer to not use ServerIssueStore #6029
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The ServerIssuesStore will be dropped, so instead an event should be raised.
When an issue is resolved on the server, it means it is suppressed. And when isResolved=false, it means the issue is reopened (a.k.a. suppression has to be removed)
… easier to identify when they are resolved. When an issue is resolved, we receive from the server a list of issueKeys, which makes it difficult to retrieve the corresponding SonarQubeIssue in the RoslynSuppressionUpdater due to the fact that the GetSuppressedIssuesAsync will not return the issue if it is not suppressed (it is resolved) Additionally there is no need to perform yet another server request if we already have the information about the issue Key so we could simply cache it.
gabriela-trutan-sonarsource
requested a review
from georgii-borovinskikh-sonarsource
georgii-borovinskikh-sonarsource
requested changes
Feb 14, 2025
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
Base automatically changed from
gt/suppressions-updater
to
feature/sloop-mute-issue
February 14, 2025 15:33
…urce/sonarlint-visualstudio into gt/roslyn-settings-file-sync
…sFileStorage" This reverts commit f9c2467.
gabriela-trutan-sonarsource
requested a review
from georgii-borovinskikh-sonarsource
…erface and use factory for instantiating corresponding type.
georgii-borovinskikh-sonarsource
approved these changes
Feb 17, 2025
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
| IEnumerable<SuppressedIssue> GetSuppressedIssuesOrNull(string roslynSettingsKey); | ||
| } | ||
|
|
||
| internal interface ISuppressedIssuesCalculatorFactory |
There was a problem hiding this comment.
You don't need to change this now, it's good enough, but I thought of a cleaner (IMO) alternative:
interface ISuppressedIssuesCalculator<T>
{
IEnumerable<SuppressedIssue> GetSuppressedIssuesOrNull(string roslynSettingsKey, T payload);
}
class ConcreteCalculator1<EventType1>
The slight problem with this is the fact that All and New calculators have essentially the same payload type, so there would be a need to have a way to differentiate between them somehow
src/Roslyn.Suppressions/Roslyn.Suppressions/InProcess/RoslynSettingsFileSynchronizer.cs
Outdated
Show resolved
Hide resolved
...slyn.Suppressions/Roslyn.Suppressions.UnitTests/InProcess/SuppressedIssuesCalculatorTests.cs
Outdated
Show resolved
Hide resolved
- Extract method - Move class into its own file -Split tests into multiple test classes
|
gabriela-trutan-sonarsource
merged commit 58de500
into
feature/sloop-mute-issue
3 checks passed
gabriela-trutan-sonarsource
added a commit
that referenced
this pull request
Mar 4, 2025
gabriela-trutan-sonarsource
added a commit
that referenced
this pull request
Mar 4, 2025
gabriela-trutan-sonarsource
added a commit
that referenced
this pull request
Mar 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SLVS-1853
The ServerIssuesStore will be dropped, so the RoslynSettingsFileSynchronizer should listen to the events from SuppressionIssueStoreUpdater and should update the file accordingly.
As part of this PR, I have stored the server key of the issue in the file as well, so that the issues can be easier to identify when they are resolved.
This targets the PR in which the SuppressionIssueStoreUpdater has been refactored to use events.