source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.step;
  21
  22 import java.util.ArrayList;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.function.Function;
  26 import java.util.stream.Collectors;
  27 import org.sonar.api.utils.System2;
  28 import org.sonar.ce.task.projectanalysis.issue.ProtoIssueCache;
  29 import org.sonar.ce.task.projectanalysis.issue.RuleRepository;
  30 import org.sonar.ce.task.projectanalysis.issue.UpdateConflictResolver;
  31 import org.sonar.ce.task.projectanalysis.period.PeriodHolder;
  32 import org.sonar.ce.task.step.ComputationStep;
  33 import org.sonar.core.issue.DefaultIssue;
  34 import org.sonar.core.util.CloseableIterator;
  35 import org.sonar.core.util.UuidFactory;
  36 import org.sonar.db.BatchSession;
  37 import org.sonar.db.DbClient;
  38 import org.sonar.db.DbSession;
  39 import org.sonar.db.issue.AnticipatedTransitionMapper;
  40 import org.sonar.db.issue.IssueChangeMapper;
  41 import org.sonar.db.issue.IssueDao;
  42 import org.sonar.db.issue.IssueDto;
  43 import org.sonar.db.issue.IssueMapper;
  44 import org.sonar.db.issue.NewCodeReferenceIssueDto;
  45 import org.sonar.db.newcodeperiod.NewCodePeriodType;
  46 import org.sonar.server.issue.IssueStorage;
  47
  48 import static org.sonar.core.util.FileUtils.humanReadableByteCountSI;
  49
  50 public class PersistIssuesStep implements ComputationStep {
  51   // holding up to 1000 DefaultIssue (max size of addedIssues and updatedIssues at any given time) in memory should not
  52   // be a problem while making sure we leverage extensively the batch feature to speed up persistence
  53   private static final int ISSUE_BATCHING_SIZE = BatchSession.MAX_BATCH_SIZE * 2;
  54
  55   private final DbClient dbClient;
  56   private final System2 system2;
  57   private final UpdateConflictResolver conflictResolver;
  58   private final RuleRepository ruleRepository;
  59   private final PeriodHolder periodHolder;
  60   private final ProtoIssueCache protoIssueCache;
  61   private final IssueStorage issueStorage;
  62   private final UuidFactory uuidFactory;
  63
  64   public PersistIssuesStep(DbClient dbClient, System2 system2, UpdateConflictResolver conflictResolver,
  65     RuleRepository ruleRepository, PeriodHolder periodHolder, ProtoIssueCache protoIssueCache, IssueStorage issueStorage,
  66     UuidFactory uuidFactory) {
  67     this.dbClient = dbClient;
  68     this.system2 = system2;
  69     this.conflictResolver = conflictResolver;
  70     this.ruleRepository = ruleRepository;
  71     this.periodHolder = periodHolder;
  72     this.protoIssueCache = protoIssueCache;
  73     this.issueStorage = issueStorage;
  74     this.uuidFactory = uuidFactory;
  75   }
  76
  77   @Override
  78   public void execute(ComputationStep.Context context) {
  79     context.getStatistics().add("cacheSize", humanReadableByteCountSI(protoIssueCache.fileSize()));
  80     IssueStatistics statistics = new IssueStatistics();
  81     try (DbSession dbSession = dbClient.openSession(true);
  82          CloseableIterator<DefaultIssue> issues = protoIssueCache.traverse()) {
  83       List<DefaultIssue> addedIssues = new ArrayList<>(ISSUE_BATCHING_SIZE);
  84       List<DefaultIssue> updatedIssues = new ArrayList<>(ISSUE_BATCHING_SIZE);
  85       List<DefaultIssue> noLongerNewIssues = new ArrayList<>(ISSUE_BATCHING_SIZE);
  86       List<DefaultIssue> newCodeIssuesToMigrate = new ArrayList<>(ISSUE_BATCHING_SIZE);
  87       IssueDao issueDao = dbClient.issueDao();
  88       IssueChangeMapper changeMapper = dbSession.getMapper(IssueChangeMapper.class);
  89       AnticipatedTransitionMapper anticipatedTransitionMapper = dbSession.getMapper(AnticipatedTransitionMapper.class);
  90       while (issues.hasNext()) {
  91         DefaultIssue issue = issues.next();
  92         if (issue.isNew() || issue.isCopied()) {
  93           addedIssues.add(issue);
  94           if (addedIssues.size() >= ISSUE_BATCHING_SIZE) {
  95             persistNewIssues(statistics, addedIssues, issueDao, changeMapper, anticipatedTransitionMapper, dbSession);
  96             addedIssues.clear();
  97           }
  98         } else if (issue.isChanged()) {
  99           updatedIssues.add(issue);
 100           if (updatedIssues.size() >= ISSUE_BATCHING_SIZE) {
 101             persistUpdatedIssues(statistics, updatedIssues, issueDao, changeMapper, dbSession);
 102             updatedIssues.clear();
 103           }
 104         } else if (isOnBranchUsingReferenceBranch() && issue.isNoLongerNewCodeReferenceIssue()) {
 105           noLongerNewIssues.add(issue);
 106           if (noLongerNewIssues.size() >= ISSUE_BATCHING_SIZE) {
 107             persistNoLongerNewIssues(statistics, noLongerNewIssues, issueDao, dbSession);
 108             noLongerNewIssues.clear();
 109           }
 110         } else if (isOnBranchUsingReferenceBranch() && issue.isToBeMigratedAsNewCodeReferenceIssue()) {
 111           newCodeIssuesToMigrate.add(issue);
 112           if (newCodeIssuesToMigrate.size() >= ISSUE_BATCHING_SIZE) {
 113             persistNewCodeIssuesToMigrate(statistics, newCodeIssuesToMigrate, issueDao, dbSession);
 114             newCodeIssuesToMigrate.clear();
 115           }
 116         }
 117       }
 118
 119       persistNewIssues(statistics, addedIssues, issueDao, changeMapper, anticipatedTransitionMapper, dbSession);
 120       persistUpdatedIssues(statistics, updatedIssues, issueDao, changeMapper, dbSession);
 121       persistNoLongerNewIssues(statistics, noLongerNewIssues, issueDao, dbSession);
 122       persistNewCodeIssuesToMigrate(statistics, newCodeIssuesToMigrate, issueDao, dbSession);
 123       flushSession(dbSession);
 124     } finally {
 125       statistics.dumpTo(context);
 126     }
 127   }
 128
 129   private void persistNewIssues(IssueStatistics statistics, List<DefaultIssue> addedIssues,
 130     IssueDao issueDao, IssueChangeMapper changeMapper, AnticipatedTransitionMapper anticipatedTransitionMapper, DbSession dbSession) {
 131
 132     final long now = system2.now();
 133
 134     addedIssues.forEach(addedIssue -> {
 135       String ruleUuid = ruleRepository.getByKey(addedIssue.ruleKey()).getUuid();
 136       IssueDto dto = IssueDto.toDtoForComputationInsert(addedIssue, ruleUuid, now);
 137       issueDao.insert(dbSession, dto);
 138       if (isOnBranchUsingReferenceBranch() && addedIssue.isOnChangedLine()) {
 139         issueDao.insertAsNewCodeOnReferenceBranch(dbSession, NewCodeReferenceIssueDto.fromIssueDto(dto, now, uuidFactory));
 140       }
 141       statistics.inserts++;
 142       issueStorage.insertChanges(changeMapper, addedIssue, uuidFactory);
 143       addedIssue.getAnticipatedTransitionUuid().ifPresent(anticipatedTransitionMapper::delete);
 144     });
 145   }
 146
 147   private void persistUpdatedIssues(IssueStatistics statistics, List<DefaultIssue> updatedIssues, IssueDao
 148     issueDao, IssueChangeMapper changeMapper, DbSession dbSession) {
 149     if (updatedIssues.isEmpty()) {
 150       return;
 151     }
 152
 153     long now = system2.now();
 154     updatedIssues.forEach(i -> {
 155       IssueDto dto = IssueDto.toDtoForUpdate(i, now);
 156       issueDao.updateIfBeforeSelectedDate(dbSession, dto);
 157       statistics.updates++;
 158     });
 159
 160     // retrieve those of the updatedIssues which have not been updated and apply conflictResolver on them
 161     List<String> updatedIssueKeys = updatedIssues.stream().map(DefaultIssue::key).toList();
 162     List<IssueDto> conflictIssueKeys = issueDao.selectByKeysIfNotUpdatedAt(dbSession, updatedIssueKeys, now);
 163     if (!conflictIssueKeys.isEmpty()) {
 164       Map<String, DefaultIssue> issuesByKeys = updatedIssues.stream().collect(Collectors.toMap(DefaultIssue::key, Function.identity()));
 165       conflictIssueKeys
 166         .forEach(dbIssue -> {
 167           DefaultIssue updatedIssue = issuesByKeys.get(dbIssue.getKey());
 168           conflictResolver.resolve(updatedIssue, dbIssue, issueDao, dbSession);
 169           statistics.merged++;
 170         });
 171     }
 172
 173     updatedIssues.forEach(i -> issueStorage.insertChanges(changeMapper, i, uuidFactory));
 174   }
 175
 176   private static void persistNoLongerNewIssues(IssueStatistics
 177     statistics, List<DefaultIssue> noLongerNewIssues, IssueDao issueDao, DbSession dbSession) {
 178     if (noLongerNewIssues.isEmpty()) {
 179       return;
 180     }
 181
 182     noLongerNewIssues.forEach(i -> {
 183       issueDao.deleteAsNewCodeOnReferenceBranch(dbSession, i.key());
 184       statistics.updates++;
 185     });
 186
 187   }
 188
 189   private void persistNewCodeIssuesToMigrate(IssueStatistics
 190     statistics, List<DefaultIssue> newCodeIssuesToMigrate, IssueDao issueDao, DbSession dbSession) {
 191     if (newCodeIssuesToMigrate.isEmpty()) {
 192       return;
 193     }
 194
 195     long now = system2.now();
 196     newCodeIssuesToMigrate.forEach(i -> {
 197       issueDao.insertAsNewCodeOnReferenceBranch(dbSession, NewCodeReferenceIssueDto.fromIssueKey(i.key(), now, uuidFactory));
 198       statistics.updates++;
 199     });
 200   }
 201
 202   private static void flushSession(DbSession dbSession) {
 203     dbSession.flushStatements();
 204     dbSession.commit();
 205   }
 206
 207   private boolean isOnBranchUsingReferenceBranch() {
 208     if (periodHolder.hasPeriod()) {
 209       return periodHolder.getPeriod().getMode().equals(NewCodePeriodType.REFERENCE_BRANCH.name());
 210     }
 211     return false;
 212   }
 213
 214   @Override
 215   public String getDescription() {
 216     return "Persist issues";
 217   }
 218
 219   private static class IssueStatistics {
 220     private int inserts = 0;
 221     private int updates = 0;
 222     private int merged = 0;
 223
 224     private void dumpTo(ComputationStep.Context context) {
 225       context.getStatistics()
 226         .add("inserts", String.valueOf(inserts))
 227         .add("updates", String.valueOf(updates))
 228         .add("merged", String.valueOf(merged));
 229     }
 230   }
 231 }