-
Notifications
You must be signed in to change notification settings - Fork 58
SLCORE-1762 Migrate Xodus known findings store to h2 db #1552
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
Merged
kirill-knize-sonarsource
merged 3 commits into
master
from
task/kk/SLCORE-1762-Migrate-XodusKnownFindingsStore-to-H2-DB
Nov 5, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
backend/commons/src/main/java/org/sonarsource/sonarlint/core/commons/KnownFindingType.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * SonarLint Core - Commons | ||
| * Copyright (C) 2016-2025 SonarSource SA | ||
| * mailto:info AT sonarsource DOT com | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with this program; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
| package org.sonarsource.sonarlint.core.commons; | ||
|
|
||
| public enum KnownFindingType { | ||
| ISSUE, | ||
| HOTSPOT | ||
| } |
149 changes: 149 additions & 0 deletions
149
...va/org/sonarsource/sonarlint/core/commons/storage/repository/KnownFindingsRepository.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * SonarLint Core - Commons | ||
| * Copyright (C) 2016-2025 SonarSource SA | ||
| * mailto:info AT sonarsource DOT com | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with this program; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
| package org.sonarsource.sonarlint.core.commons.storage.repository; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.time.LocalDateTime; | ||
| import java.time.ZoneId; | ||
| import java.util.List; | ||
| import org.jooq.Configuration; | ||
| import org.jooq.Record; | ||
| import org.sonarsource.sonarlint.core.commons.KnownFinding; | ||
| import org.sonarsource.sonarlint.core.commons.KnownFindingType; | ||
| import org.sonarsource.sonarlint.core.commons.LineWithHash; | ||
| import org.sonarsource.sonarlint.core.commons.api.TextRangeWithHash; | ||
| import org.sonarsource.sonarlint.core.commons.storage.SonarLintDatabase; | ||
|
|
||
| import static org.sonarsource.sonarlint.core.commons.storage.model.Tables.KNOWN_FINDINGS; | ||
|
|
||
| public class KnownFindingsRepository { | ||
|
|
||
| private final SonarLintDatabase database; | ||
|
|
||
| public KnownFindingsRepository(SonarLintDatabase database) { | ||
| this.database = database; | ||
| } | ||
|
|
||
| public void storeKnownIssues(String configurationScopeId, Path clientRelativePath, List<KnownFinding> newKnownIssues) { | ||
| storeKnownFindings(configurationScopeId, clientRelativePath, newKnownIssues, KnownFindingType.ISSUE); | ||
| } | ||
|
|
||
| public void storeKnownSecurityHotspots(String configurationScopeId, Path clientRelativePath, List<KnownFinding> newKnownSecurityHotspots) { | ||
| storeKnownFindings(configurationScopeId, clientRelativePath, newKnownSecurityHotspots, KnownFindingType.HOTSPOT); | ||
| } | ||
|
|
||
| public List<KnownFinding> loadSecurityHotspotsForFile(String configurationScopeId, Path filePath) { | ||
| return getKnownFindingsForFile(configurationScopeId, filePath, KnownFindingType.HOTSPOT); | ||
| } | ||
|
|
||
| public List<KnownFinding> loadIssuesForFile(String configurationScopeId, Path filePath) { | ||
| return getKnownFindingsForFile(configurationScopeId, filePath, KnownFindingType.ISSUE); | ||
| } | ||
|
|
||
| private void storeKnownFindings(String configurationScopeId, Path clientRelativePath, List<KnownFinding> newKnownFindings, KnownFindingType type) { | ||
| database.dsl().transaction((Configuration trx) -> newKnownFindings.forEach(finding -> { | ||
| var textRangeWithHash = finding.getTextRangeWithHash(); | ||
| var startLine = textRangeWithHash == null ? null : textRangeWithHash.getStartLine(); | ||
| var startLineOffset = textRangeWithHash == null ? null : textRangeWithHash.getStartLineOffset(); | ||
| var endLine = textRangeWithHash == null ? null : textRangeWithHash.getEndLine(); | ||
| var endLineOffset = textRangeWithHash == null ? null : textRangeWithHash.getEndLineOffset(); | ||
| var textRangeHash = textRangeWithHash == null ? null : textRangeWithHash.getHash(); | ||
|
|
||
| var lineWithHash = finding.getLineWithHash(); | ||
| var line = lineWithHash == null ? null : lineWithHash.getNumber(); | ||
| var lineHash = lineWithHash == null ? null : lineWithHash.getHash(); | ||
| var introDate = LocalDateTime.ofInstant(finding.getIntroductionDate(), ZoneId.systemDefault()); | ||
| trx.dsl().mergeInto(KNOWN_FINDINGS) | ||
| .using(trx.dsl().selectOne()) | ||
| .on(KNOWN_FINDINGS.ID.eq(finding.getId())) | ||
| .whenMatchedThenUpdate() | ||
| .set(KNOWN_FINDINGS.CONFIGURATION_SCOPE_ID, configurationScopeId) | ||
| .set(KNOWN_FINDINGS.IDE_RELATIVE_FILE_PATH, clientRelativePath.toString()) | ||
| .set(KNOWN_FINDINGS.SERVER_KEY, finding.getServerKey()) | ||
| .set(KNOWN_FINDINGS.RULE_KEY, finding.getRuleKey()) | ||
| .set(KNOWN_FINDINGS.MESSAGE, finding.getMessage()) | ||
| .set(KNOWN_FINDINGS.INTRODUCTION_DATE, introDate) | ||
| .set(KNOWN_FINDINGS.FINDING_TYPE, type.name()) | ||
| .set(KNOWN_FINDINGS.START_LINE, startLine) | ||
| .set(KNOWN_FINDINGS.START_LINE_OFFSET, startLineOffset) | ||
| .set(KNOWN_FINDINGS.END_LINE, endLine) | ||
| .set(KNOWN_FINDINGS.END_LINE_OFFSET, endLineOffset) | ||
| .set(KNOWN_FINDINGS.TEXT_RANGE_HASH, textRangeHash) | ||
| .set(KNOWN_FINDINGS.LINE, line) | ||
| .set(KNOWN_FINDINGS.LINE_HASH, lineHash) | ||
| .whenNotMatchedThenInsert(KNOWN_FINDINGS.ID, KNOWN_FINDINGS.CONFIGURATION_SCOPE_ID, KNOWN_FINDINGS.IDE_RELATIVE_FILE_PATH, KNOWN_FINDINGS.SERVER_KEY, | ||
| KNOWN_FINDINGS.RULE_KEY, KNOWN_FINDINGS.MESSAGE, KNOWN_FINDINGS.INTRODUCTION_DATE, KNOWN_FINDINGS.FINDING_TYPE, | ||
| KNOWN_FINDINGS.START_LINE, KNOWN_FINDINGS.START_LINE_OFFSET, KNOWN_FINDINGS.END_LINE, KNOWN_FINDINGS.END_LINE_OFFSET, KNOWN_FINDINGS.TEXT_RANGE_HASH, | ||
| KNOWN_FINDINGS.LINE, KNOWN_FINDINGS.LINE_HASH) | ||
| .values(finding.getId(), configurationScopeId, clientRelativePath.toString(), finding.getServerKey(), finding.getRuleKey(), | ||
| finding.getMessage(), introDate, type.name(), | ||
| startLine, startLineOffset, endLine, endLineOffset, textRangeHash, | ||
| line, lineHash | ||
| ) | ||
| .execute(); | ||
| })); | ||
| } | ||
|
|
||
| private List<KnownFinding> getKnownFindingsForFile(String configurationScopeId, Path filePath, KnownFindingType type) { | ||
| var issuesInFile = database.dsl() | ||
| .selectFrom(KNOWN_FINDINGS) | ||
| .where(KNOWN_FINDINGS.CONFIGURATION_SCOPE_ID.eq(configurationScopeId) | ||
| .and(KNOWN_FINDINGS.IDE_RELATIVE_FILE_PATH.eq(filePath.toString())) | ||
| .and(KNOWN_FINDINGS.FINDING_TYPE.eq(type.name())) | ||
| ) | ||
| .fetch(); | ||
| return issuesInFile.stream() | ||
| .map(KnownFindingsRepository::recordToKnownFinding) | ||
| .toList(); | ||
| } | ||
|
|
||
| private static KnownFinding recordToKnownFinding(Record rec) { | ||
| var id = rec.get(KNOWN_FINDINGS.ID); | ||
| var introductionDate = rec.get(KNOWN_FINDINGS.INTRODUCTION_DATE).atZone(ZoneId.systemDefault()).toInstant(); | ||
| var textRangeWithHash = getTextRangeWithHash(rec); | ||
| var lineWithHash = getLineWithHash(rec); | ||
| return new KnownFinding( | ||
| id, | ||
| rec.get(KNOWN_FINDINGS.SERVER_KEY), | ||
| textRangeWithHash, lineWithHash, | ||
| rec.get(KNOWN_FINDINGS.RULE_KEY), | ||
| rec.get(KNOWN_FINDINGS.MESSAGE), | ||
| introductionDate | ||
| ); | ||
| } | ||
|
|
||
| private static LineWithHash getLineWithHash(Record rec) { | ||
| if (rec.get(KNOWN_FINDINGS.LINE) == null) return null; | ||
| var line = rec.get(KNOWN_FINDINGS.LINE); | ||
| var hash = rec.get(KNOWN_FINDINGS.LINE_HASH); | ||
| return new LineWithHash(line, hash); | ||
| } | ||
|
|
||
| private static TextRangeWithHash getTextRangeWithHash(Record rec) { | ||
| if (rec.get(KNOWN_FINDINGS.START_LINE) == null) return null; | ||
| var startLine = rec.get(KNOWN_FINDINGS.START_LINE); | ||
| var endLine = rec.get(KNOWN_FINDINGS.END_LINE); | ||
| var startLineOffset = rec.get(KNOWN_FINDINGS.START_LINE_OFFSET); | ||
| var endLineOffset = rec.get(KNOWN_FINDINGS.END_LINE_OFFSET); | ||
| var hash = rec.get(KNOWN_FINDINGS.TEXT_RANGE_HASH); | ||
| return new TextRangeWithHash(startLine, startLineOffset, endLine, endLineOffset, hash); | ||
| } | ||
|
|
||
| } |
12 changes: 0 additions & 12 deletions
12
backend/commons/src/main/resources/db/migration/V1__create_ai_codefix_settings_table.sql
This file was deleted.
Oops, something went wrong.
32 changes: 32 additions & 0 deletions
32
backend/commons/src/main/resources/db/migration/V1__init_database.sql
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| -- Flyway migration: create AI_CODEFIX_SETTINGS table for H2 | ||
| -- Initial schema includes per-connection scoping via connection_id | ||
| CREATE TABLE IF NOT EXISTS AI_CODEFIX_SETTINGS ( | ||
| connection_id VARCHAR(255) NOT NULL PRIMARY KEY, | ||
| supported_rules VARCHAR(200) ARRAY, | ||
| organization_eligible BOOLEAN, | ||
| enablement VARCHAR(64), | ||
| enabled_project_keys VARCHAR(400) ARRAY, | ||
| CONSTRAINT pk_ai_codefix_settings PRIMARY KEY (connection_id) | ||
| ); | ||
|
|
||
| CREATE TABLE IF NOT EXISTS KNOWN_FINDINGS ( | ||
| -- UUID | ||
| id UUID NOT NULL PRIMARY KEY, | ||
| configuration_scope_id VARCHAR(255) NOT NULL, | ||
| ide_relative_file_path VARCHAR(255) NOT NULL, | ||
| server_key VARCHAR(255), | ||
| rule_key VARCHAR(255) NOT NULL, | ||
| message VARCHAR(255) NOT NULL, | ||
| introduction_date TIMESTAMP NOT NULL, | ||
| finding_type VARCHAR(255) NOT NULL, | ||
| -- TextRangeWithHash | ||
| start_line INT, | ||
| start_line_offset INT, | ||
| end_line INT, | ||
| end_line_offset INT, | ||
| text_range_hash VARCHAR(255), | ||
| -- LineWithHash | ||
| line INT, | ||
| line_hash VARCHAR(255) | ||
| ); | ||
|
|
||
85 changes: 85 additions & 0 deletions
85
...a/org/sonarsource/sonarlint/core/commons/storage/repository/AiCodeFixRepositoryTests.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * SonarLint Core - Commons | ||
| * Copyright (C) 2016-2025 SonarSource SA | ||
| * mailto:info AT sonarsource DOT com | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with this program; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
| package org.sonarsource.sonarlint.core.commons.storage.repository; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.Set; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.sonarsource.sonarlint.core.commons.log.SonarLintLogTester; | ||
| import org.sonarsource.sonarlint.core.commons.storage.SonarLintDatabaseMode; | ||
| import org.sonarsource.sonarlint.core.commons.storage.SonarLintDatabase; | ||
| import org.sonarsource.sonarlint.core.commons.storage.SonarLintDatabaseInitParams; | ||
| import org.sonarsource.sonarlint.core.commons.storage.model.AiCodeFix; | ||
|
|
||
| class AiCodeFixRepositoryTests { | ||
|
|
||
| @RegisterExtension | ||
| static SonarLintLogTester logTester = new SonarLintLogTester(); | ||
|
|
||
| @TempDir | ||
| Path temp; | ||
|
|
||
| @Test | ||
| void upsert_and_get_should_persist_to_h2_file_database() { | ||
| // Given a file-based H2 database under a temporary storage root | ||
| var storageRoot = temp.resolve("storage"); | ||
|
|
||
| var db = new SonarLintDatabase(new SonarLintDatabaseInitParams(storageRoot, SonarLintDatabaseMode.FILE)); | ||
| var aiCodeFixRepo = new AiCodeFixRepository(db); | ||
|
|
||
| var entityToStore = new AiCodeFix( | ||
| "test-connection", | ||
| Set.of("java:S100", "js:S200"), | ||
| true, | ||
| AiCodeFix.Enablement.ENABLED_FOR_SOME_PROJECTS, | ||
| Set.of("project-a", "project-b") | ||
| ); | ||
|
|
||
| // When we upsert the entity | ||
| aiCodeFixRepo.upsert(entityToStore); | ||
|
|
||
| // And shutdown the first DB to force closing connections | ||
| db.shutdown(); | ||
|
|
||
| // Create a new repository with a fresh DB instance pointing to the same storage root | ||
| var db2 = new SonarLintDatabase(new SonarLintDatabaseInitParams(storageRoot, SonarLintDatabaseMode.FILE)); | ||
| var repo2 = new AiCodeFixRepository(db2); | ||
| // With a different connection id, no settings should be visible | ||
| var loadedOptDifferent = repo2.get("test-connection-2"); | ||
| assertThat(loadedOptDifferent).isEmpty(); | ||
|
|
||
| // With the same connection id, we should read back exactly what we stored | ||
| var repoSame = new AiCodeFixRepository(db2); | ||
| var loadedOpt = repoSame.get("test-connection"); | ||
| assertThat(loadedOpt).isPresent(); | ||
| var loaded = loadedOpt.get(); | ||
|
|
||
| assertThat(loaded.supportedRules()).containsExactlyInAnyOrder("java:S100", "js:S200"); | ||
| assertThat(loaded.organizationEligible()).isTrue(); | ||
| assertThat(loaded.enablement()).isEqualTo(AiCodeFix.Enablement.ENABLED_FOR_SOME_PROJECTS); | ||
| assertThat(loaded.enabledProjectKeys()).containsExactlyInAnyOrder("project-a", "project-b"); | ||
|
|
||
| db2.shutdown(); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.