Documentation does not mention sonar.plugins.download.timeout

anon40266202 · October 15, 2024, 4:46pm

I’m currently updating to Sonarqube Enterprise latest 10.7.1 and we still have those problems i mentioned here once

This is fixed with [SONAR-19994] - Jira, but the documentation has nothing about the scanner property sonar.plugins.download.timeout.

see

github.com

SonarSource/sonarqube/blob/909d7ce602d9f3f5cbe8a98ebda1843e263abee9/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/PluginFiles.java#L50


      
          import org.sonarqube.ws.client.HttpException;
          import org.sonarqube.ws.client.WsResponse;
          
          import static java.lang.String.format;
          
          public class PluginFiles {
          
            private static final Logger LOGGER = LoggerFactory.getLogger(PluginFiles.class);
            private static final String MD5_HEADER = "Sonar-MD5";
            @VisibleForTesting
            static final String PLUGINS_DOWNLOAD_TIMEOUT_PROPERTY = "sonar.plugins.download.timeout";
            private static final int PLUGINS_DOWNLOAD_TIMEOUT_DEFAULT = 300;
          
            private final DefaultScannerWsClient wsClient;
            private final Configuration configuration;
            private final Path cacheDir;
            private final Path tempDir;
          
            public PluginFiles(DefaultScannerWsClient wsClient, Configuration configuration, SonarUserHome sonarUserHome) {
              this.wsClient = wsClient;
              this.configuration = configuration;

github.com

SonarSource/sonarqube/blob/909d7ce602d9f3f5cbe8a98ebda1843e263abee9/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/PluginFiles.java#L95


      
            Path jarInCache = jarInCache(plugin.key, plugin.hash);
            if (Files.isRegularFile(jarInCache)) {
              return Optional.of(jarInCache.toFile());
            }
            return download(plugin).map(Path::toFile);
          }
          
          private Optional<Path> download(InstalledPlugin plugin) {
            GetRequest request = new GetRequest("api/plugins/download")
              .setParam("plugin", plugin.key)
              .setTimeOutInMs(configuration.getInt(PLUGINS_DOWNLOAD_TIMEOUT_PROPERTY).orElse(PLUGINS_DOWNLOAD_TIMEOUT_DEFAULT) * 1000);
          
            Path downloadedFile = newTempFile();
            LOGGER.debug("Download plugin '{}' to '{}'", plugin.key, downloadedFile);
          
            try (WsResponse response = wsClient.call(request)) {
              Optional<String> expectedMd5 = response.header(MD5_HEADER);
              if (expectedMd5.isEmpty()) {
                throw new IllegalStateException(format(
                  "Fail to download plugin [%s]. Request to %s did not return header %s", plugin.key, response.requestUrl(), MD5_HEADER));
              }

cyn.bethea · October 16, 2024, 2:54pm

Thank you for pointing out this oversight.

I created a ticket in the docs backlog to add this information to the documentation.