SONAR-8857 clean-up opening of DbSession

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/QProfileBackuper.java

@@ -61,17 +61,6 @@ public QProfileBackuper(QProfileReset reset, DbClient db) {
     this.db = db;
   }
 
-  /**
-   * @deprecated use {@link #backup(DbSession, QualityProfileDto, Writer)} instead
-   */
-  @Deprecated
-  public void backup(String key, Writer writer) {
-    try (DbSession dbSession = db.openSession(false)) {
-      QualityProfileDto profile = db.qualityProfileDao().selectOrFailByKey(dbSession, key);
-      backup(dbSession, profile, writer);
-    }
-  }
-
   public void backup(DbSession dbSession, QualityProfileDto profileDto, Writer writer) {
     List<ActiveRuleDto> activeRules = db.activeRuleDao().selectByProfileKey(dbSession, profileDto.getKey());
     activeRules.sort(BackupActiveRuleComparator.INSTANCE);
@@ -109,7 +98,7 @@ private void writeXml(DbSession dbSession, Writer writer, QualityProfileDto prof
    * @param toProfileName the target profile. If <code>null</code>, then use the
    *                   lang and name declared in the backup
    */
-  public BulkChangeResult restore(Reader reader, @Nullable QProfileName toProfileName) {
+  public BulkChangeResult restore(DbSession dbSession, Reader reader, @Nullable QProfileName toProfileName) {
     try {
       String profileLang = null;
       String profileName = null;
@@ -136,7 +125,7 @@ public BulkChangeResult restore(Reader reader, @Nullable QProfileName toProfileN
       }
 
       QProfileName target = (QProfileName) ObjectUtils.defaultIfNull(toProfileName, new QProfileName(profileLang, profileName));
-      return reset.reset(target, ruleActivations);
+      return reset.reset(dbSession, target, ruleActivations);
     } catch (XMLStreamException e) {
       throw new IllegalStateException("Fail to restore Quality profile backup", e);
     }

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/QProfileCopier.java

@@ -25,9 +25,7 @@
 import java.io.OutputStreamWriter;
 import java.io.Reader;
 import java.io.Writer;
-import java.nio.charset.StandardCharsets;
 import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang.StringUtils;
 import org.sonar.api.server.ServerSide;
 import org.sonar.api.utils.TempFolder;
@@ -36,6 +34,8 @@
 import org.sonar.db.qualityprofile.QualityProfileDto;
 import org.sonar.server.qualityprofile.ws.QProfileWsSupport;
 
+import static java.nio.charset.StandardCharsets.UTF_8;
+
 @ServerSide
 public class QProfileCopier {
 
@@ -53,38 +53,32 @@ public QProfileCopier(DbClient db, QProfileFactory factory, QProfileBackuper bac
     this.qProfileWsSupport = qProfileWsSupport;
   }
 
-  public QualityProfileDto copyToName(String fromProfileKey, String toName) {
-    QualityProfileDto to = prepareTarget(fromProfileKey, toName);
+  public QualityProfileDto copyToName(DbSession dbSession, String fromProfileKey, String toName) {
+    QualityProfileDto from = db.qualityProfileDao().selectOrFailByKey(dbSession, fromProfileKey);
+    QualityProfileDto to = prepareTarget(dbSession, from, toName);
     File backupFile = temp.newFile();
     try {
-      backup(fromProfileKey, backupFile);
-      restore(backupFile, QProfileName.createFor(to.getLanguage(), to.getName()));
+      backup(dbSession, from, backupFile);
+      restore(dbSession, backupFile, QProfileName.createFor(to.getLanguage(), to.getName()));
       return to;
     } finally {
       org.sonar.core.util.FileUtils.deleteQuietly(backupFile);
     }
   }
 
-  private QualityProfileDto prepareTarget(String fromProfileKey, String toName) {
-    DbSession dbSession = db.openSession(false);
-    try {
-      QualityProfileDto fromProfile = db.qualityProfileDao().selectOrFailByKey(dbSession, fromProfileKey);
-      QProfileName toProfileName = new QProfileName(fromProfile.getLanguage(), toName);
-      verify(fromProfile, toProfileName);
-      QualityProfileDto toProfile = db.qualityProfileDao().selectByNameAndLanguage(toProfileName.getName(), toProfileName.getLanguage(), dbSession);
-      if (toProfile == null) {
-        // Do not delegate creation to QProfileBackuper because we need to keep
-        // the parent-child association, if exists.
-        toProfile = factory.create(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), toProfileName);
-        toProfile.setParentKee(fromProfile.getParentKee());
-        db.qualityProfileDao().update(dbSession, toProfile);
-        dbSession.commit();
-      }
-      return toProfile;
-
-    } finally {
-      dbSession.close();
+  private QualityProfileDto prepareTarget(DbSession dbSession, QualityProfileDto from, String toName) {
+    QProfileName toProfileName = new QProfileName(from.getLanguage(), toName);
+    verify(from, toProfileName);
+    QualityProfileDto toProfile = db.qualityProfileDao().selectByNameAndLanguage(toProfileName.getName(), toProfileName.getLanguage(), dbSession);
+    if (toProfile == null) {
+      // Do not delegate creation to QProfileBackuper because we need to keep
+      // the parent-child association, if exists.
+      toProfile = factory.create(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), toProfileName);
+      toProfile.setParentKee(from.getParentKee());
+      db.qualityProfileDao().update(dbSession, toProfile);
+      dbSession.commit();
     }
+    return toProfile;
   }
 
   private void verify(QualityProfileDto fromProfile, QProfileName toProfileName) {
@@ -99,27 +93,19 @@ private void verify(QualityProfileDto fromProfile, QProfileName toProfileName) {
     }
   }
 
-  private void backup(String profileKey, File backupFile) {
-    Writer writer = null;
-    try {
-      writer = new OutputStreamWriter(FileUtils.openOutputStream(backupFile), StandardCharsets.UTF_8);
-      backuper.backup(profileKey, writer);
+  private void backup(DbSession dbSession, QualityProfileDto profile, File backupFile) {
+    try (Writer writer = new OutputStreamWriter(FileUtils.openOutputStream(backupFile), UTF_8)) {
+      backuper.backup(dbSession, profile, writer);
     } catch (IOException e) {
       throw new IllegalStateException("Fail to open temporary backup file: " + backupFile, e);
-    } finally {
-      IOUtils.closeQuietly(writer);
     }
   }
 
-  private void restore(File backupFile, QProfileName profileName) {
-    Reader reader = null;
-    try {
-      reader = new InputStreamReader(FileUtils.openInputStream(backupFile), StandardCharsets.UTF_8);
-      backuper.restore(reader, profileName);
+  private void restore(DbSession dbSession, File backupFile, QProfileName profileName) {
+    try (Reader reader = new InputStreamReader(FileUtils.openInputStream(backupFile), UTF_8)) {
+      backuper.restore(dbSession, reader, profileName);
     } catch (IOException e) {
       throw new IllegalStateException("Fail to create temporary backup file: " + backupFile, e);
-    } finally {
-      IOUtils.closeQuietly(reader);
     }
   }
 }

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/QProfileReset.java

@@ -77,48 +77,38 @@ public QProfileReset(DbClient db, RuleActivator activator, ActiveRuleIndexer act
    * Reset built-in profiles for the given language. Missing profiles are created and
    * existing ones are updated.
    */
-  public void resetLanguage(String language) {
-    DbSession dbSession = db.openSession(false);
-    try {
-      ListMultimap<QProfileName, RulesProfile> profilesByName = loadDefinitionsGroupedByName(language);
-      for (Map.Entry<QProfileName, Collection<RulesProfile>> entry : profilesByName.asMap().entrySet()) {
-        QProfileName profileName = entry.getKey();
-        QualityProfileDto profile = factory.getOrCreate(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), profileName);
-        List<RuleActivation> activations = Lists.newArrayList();
-        for (RulesProfile def : entry.getValue()) {
-          for (ActiveRule activeRule : def.getActiveRules()) {
-            RuleActivation activation = new RuleActivation(RuleKey.of(activeRule.getRepositoryKey(), activeRule.getRuleKey()));
-            activation.setSeverity(activeRule.getSeverity().name());
-            if (!activeRule.getActiveRuleParams().isEmpty()) {
-              for (ActiveRuleParam param : activeRule.getActiveRuleParams()) {
-                activation.setParameter(param.getParamKey(), param.getValue());
-              }
-            } else {
-              for (RuleParamDto param : db.ruleDao().selectRuleParamsByRuleKey(dbSession, activeRule.getRule().ruleKey())) {
-                activation.setParameter(param.getName(), param.getDefaultValue());
-              }
+  public void resetLanguage(DbSession dbSession, String language) {
+    ListMultimap<QProfileName, RulesProfile> profilesByName = loadDefinitionsGroupedByName(language);
+    for (Map.Entry<QProfileName, Collection<RulesProfile>> entry : profilesByName.asMap().entrySet()) {
+      QProfileName profileName = entry.getKey();
+      QualityProfileDto profile = factory.getOrCreate(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), profileName);
+      List<RuleActivation> activations = Lists.newArrayList();
+      for (RulesProfile def : entry.getValue()) {
+        for (ActiveRule activeRule : def.getActiveRules()) {
+          RuleActivation activation = new RuleActivation(RuleKey.of(activeRule.getRepositoryKey(), activeRule.getRuleKey()));
+          activation.setSeverity(activeRule.getSeverity().name());
+          if (!activeRule.getActiveRuleParams().isEmpty()) {
+            for (ActiveRuleParam param : activeRule.getActiveRuleParams()) {
+              activation.setParameter(param.getParamKey(), param.getValue());
+            }
+          } else {
+            for (RuleParamDto param : db.ruleDao().selectRuleParamsByRuleKey(dbSession, activeRule.getRule().ruleKey())) {
+              activation.setParameter(param.getName(), param.getDefaultValue());
             }
-            activations.add(activation);
           }
+          activations.add(activation);
         }
-        doReset(dbSession, profile, activations);
       }
-    } finally {
-      dbSession.close();
+      doReset(dbSession, profile, activations);
     }
   }
 
   /**
    * Reset the profile, which is created if it does not exist
    */
-  BulkChangeResult reset(QProfileName profileName, Collection<RuleActivation> activations) {
-    DbSession dbSession = db.openSession(false);
-    try {
-      QualityProfileDto profile = factory.getOrCreate(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), profileName);
-      return doReset(dbSession, profile, activations);
-    } finally {
-      dbSession.close();
-    }
+  BulkChangeResult reset(DbSession dbSession, QProfileName profileName, Collection<RuleActivation> activations) {
+    QualityProfileDto profile = factory.getOrCreate(dbSession, qProfileWsSupport.getDefaultOrganization(dbSession), profileName);
+    return doReset(dbSession, profile, activations);
   }
 
   /**

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/CopyAction.java

@@ -25,6 +25,8 @@
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
 import org.sonar.api.server.ws.WebService.NewAction;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
 import org.sonar.db.qualityprofile.QualityProfileDto;
 import org.sonar.server.qualityprofile.QProfileCopier;
 
@@ -33,11 +35,13 @@ public class CopyAction implements QProfileWsAction {
   private static final String PARAM_PROFILE_NAME = "toName";
   private static final String PARAM_PROFILE_KEY = "fromKey";
 
+  private final DbClient dbClient;
   private final QProfileCopier profileCopier;
   private final Languages languages;
   private final QProfileWsSupport qProfileWsSupport;
 
-  public CopyAction(QProfileCopier profileCopier, Languages languages, QProfileWsSupport qProfileWsSupport) {
+  public CopyAction(DbClient dbClient, QProfileCopier profileCopier, Languages languages, QProfileWsSupport qProfileWsSupport) {
+    this.dbClient = dbClient;
     this.profileCopier = profileCopier;
     this.languages = languages;
     this.qProfileWsSupport = qProfileWsSupport;
@@ -69,20 +73,22 @@ public void handle(Request request, Response response) throws Exception {
     String newName = request.mandatoryParam(PARAM_PROFILE_NAME);
     String profileKey = request.mandatoryParam(PARAM_PROFILE_KEY);
 
-    QualityProfileDto copiedProfile = profileCopier.copyToName(profileKey, newName);
+    try (DbSession dbSession = dbClient.openSession(false)) {
+      QualityProfileDto copiedProfile = profileCopier.copyToName(dbSession, profileKey, newName);
 
-    String languageKey = copiedProfile.getLanguage();
-    Language language = languages.get(copiedProfile.getLanguage());
-    String parentKey = copiedProfile.getParentKee();
-    response.newJsonWriter()
-      .beginObject()
-      .prop("key", copiedProfile.getKey())
-      .prop("name", copiedProfile.getName())
-      .prop("language", languageKey)
-      .prop("languageName", language == null ? null : language.getName())
-      .prop("isDefault", copiedProfile.isDefault())
-      .prop("isInherited", parentKey != null)
-      .prop("parentKey", parentKey)
-      .endObject().close();
+      String languageKey = copiedProfile.getLanguage();
+      Language language = languages.get(copiedProfile.getLanguage());
+      String parentKey = copiedProfile.getParentKee();
+      response.newJsonWriter()
+        .beginObject()
+        .prop("key", copiedProfile.getKey())
+        .prop("name", copiedProfile.getName())
+        .prop("language", languageKey)
+        .prop("languageName", language == null ? null : language.getName())
+        .prop("isDefault", copiedProfile.isDefault())
+        .prop("isInherited", parentKey != null)
+        .prop("parentKey", parentKey)
+        .endObject().close();
+    }
   }
 }

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/OldRestoreAction.java

@@ -29,6 +29,8 @@
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
 import org.sonar.api.utils.text.JsonWriter;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
 import org.sonar.db.qualityprofile.QualityProfileDto;
 import org.sonar.server.qualityprofile.BulkChangeResult;
 import org.sonar.server.qualityprofile.QProfileBackuper;
@@ -44,11 +46,14 @@
 public class OldRestoreAction implements WsAction {
 
   private static final String PARAM_BACKUP = "backup";
+
+  private final DbClient dbClient;
   private final QProfileBackuper backuper;
   private final Languages languages;
   private final QProfileWsSupport qProfileWsSupport;
 
-  public OldRestoreAction(QProfileBackuper backuper, Languages languages, QProfileWsSupport qProfileWsSupport) {
+  public OldRestoreAction(DbClient dbClient, QProfileBackuper backuper, Languages languages, QProfileWsSupport qProfileWsSupport) {
+    this.dbClient = dbClient;
     this.backuper = backuper;
     this.languages = languages;
     this.qProfileWsSupport = qProfileWsSupport;
@@ -77,10 +82,10 @@ public void handle(Request request, Response response) throws Exception {
     InputStream backup = request.paramAsInputStream(PARAM_BACKUP);
     InputStreamReader reader = null;
 
-    try {
+    try (DbSession dbSession = dbClient.openSession(false)) {
       checkArgument(backup != null, "A backup file must be provided");
       reader = new InputStreamReader(backup, StandardCharsets.UTF_8);
-      BulkChangeResult result = backuper.restore(reader, null);
+      BulkChangeResult result = backuper.restore(dbSession, reader, null);
       writeResponse(response.newJsonWriter(), result);
     } finally {
       IOUtils.closeQuietly(reader);

server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RestoreAction.java

@@ -21,26 +21,33 @@
 
 import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.nio.charset.StandardCharsets;
+import org.apache.commons.io.IOUtils;
 import org.sonar.api.resources.Language;
 import org.sonar.api.resources.Languages;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
 import org.sonar.api.utils.text.JsonWriter;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
 import org.sonar.db.qualityprofile.QualityProfileDto;
 import org.sonar.server.qualityprofile.BulkChangeResult;
 import org.sonar.server.qualityprofile.QProfileBackuper;
 
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.nio.charset.StandardCharsets.UTF_8;
+
 public class RestoreAction implements QProfileWsAction {
 
   private static final String PARAM_BACKUP = "backup";
 
+  private final DbClient dbClient;
   private final QProfileBackuper backuper;
   private final Languages languages;
   private final QProfileWsSupport wsSupport;
 
-  public RestoreAction(QProfileBackuper backuper, Languages languages, QProfileWsSupport wsSupport) {
+  public RestoreAction(DbClient dbClient, QProfileBackuper backuper, Languages languages, QProfileWsSupport wsSupport) {
+    this.dbClient = dbClient;
     this.backuper = backuper;
     this.languages = languages;
     this.wsSupport = wsSupport;
@@ -66,10 +73,17 @@ public void define(WebService.NewController controller) {
   public void handle(Request request, Response response) throws Exception {
     wsSupport.checkQProfileAdminPermission();
 
-    try (InputStream backup = request.paramAsInputStream(PARAM_BACKUP);
-      InputStreamReader reader = new InputStreamReader(backup, StandardCharsets.UTF_8)) {
-      BulkChangeResult result = backuper.restore(reader, null);
+    InputStream backup = request.paramAsInputStream(PARAM_BACKUP);
+    InputStreamReader reader = null;
+
+    try (DbSession dbSession = dbClient.openSession(false)) {
+      checkArgument(backup != null, "A backup file must be provided");
+      reader = new InputStreamReader(backup, UTF_8);
+      BulkChangeResult result = backuper.restore(dbSession, reader, null);
       writeResponse(response.newJsonWriter(), result);
+    } finally {
+      IOUtils.closeQuietly(reader);
+      IOUtils.closeQuietly(backup);
     }
   }