From d22cccdc4d7c105f4ff8a4ddbf89b05ecf8847d6 Mon Sep 17 00:00:00 2001
From: "nataliya.valtman" <nataliya.valtman@jetbrains.com>
Date: Mon, 29 Aug 2022 15:22:19 +0200
Subject: [PATCH] Add property to protect sensitive data in http reports

#KT-53773 Fixed
---
 .../gradle/plugin/PropertiesProvider.kt       |  3 +++
 .../statistics/CompileStatisticsData.kt       | 15 ++++++------
 .../gradle/report/BuildReportsService.kt      | 24 ++++++++++++++++---
 .../kotlin/gradle/report/ReportingSettings.kt |  5 ++--
 .../kotlin/gradle/report/configureReporing.kt |  2 +-
 5 files changed, 36 insertions(+), 13 deletions(-)

diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/PropertiesProvider.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/PropertiesProvider.kt
index 0db34334a90..36a9da54b7d 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/PropertiesProvider.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/PropertiesProvider.kt
@@ -97,6 +97,9 @@ internal class PropertiesProvider private constructor(private val project: Proje
     val buildReportHttpPassword: String?
         get() = this.property("kotlin.build.report.http.password")
 
+    val buildReportHttpVerboseEnvironment: Boolean
+        get() = property("kotlin.build.report.http.verbose_environment")?.toBoolean() ?: false
+
     val buildReportBuildScanCustomValuesLimit: Int
         get() = property("kotlin.build.report.build_scan.custom_values_limit")?.toInt() ?: 1000
 
diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/statistics/CompileStatisticsData.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/statistics/CompileStatisticsData.kt
index 54d7fcc3afd..192e1fe7145 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/statistics/CompileStatisticsData.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/statistics/CompileStatisticsData.kt
@@ -12,6 +12,7 @@ import java.text.SimpleDateFormat
 import java.util.*
 
 //Sensitive data. This object is used directly for statistic via http
+private val formatter = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss").also { it.timeZone = TimeZone.getTimeZone("UTC")}
 data class CompileStatisticsData(
     val version: Int = 2,
     val projectName: String?,
@@ -32,11 +33,8 @@ data class CompileStatisticsData(
     val buildTimesMetrics: Map<BuildTime, Long>,
     val performanceMetrics: Map<BuildPerformanceMetric, Long>,
     val type: String = BuildDataType.TASK_DATA.name
-) {
-    companion object {
-        private val formatter = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss").also { it.timeZone = TimeZone.getTimeZone("UTC")}
-    }
-}
+)
+
 
 enum class StatTag {
     ABI_SNAPSHOT,
@@ -58,7 +56,7 @@ enum class BuildDataType {
 data class GradleBuildStartParameters(
     val tasks: List<String>,
     val excludedTasks: Set<String>,
-    val currentDir: String,
+    val currentDir: String?,
     val projectProperties: List<String>,
     val systemProperties: List<String>,
 ) : java.io.Serializable
@@ -70,7 +68,10 @@ data class BuildFinishStatisticsData(
     val buildUuid: String = "Unset",
     val label: String?,
     val totalTime: Long,
-    val type: String = BuildDataType.BUILD_DATA.name
+    val type: String = BuildDataType.BUILD_DATA.name,
+    val finishTime: Long,
+    val timestamp: String = formatter.format(finishTime),
+    val hostName: String? = "Unset",
 )
 
 
diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/BuildReportsService.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/BuildReportsService.kt
index f30b63fd293..b9877e2dc86 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/BuildReportsService.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/BuildReportsService.kt
@@ -93,7 +93,7 @@ abstract class BuildReportsService : BuildService<BuildReportsService.Parameters
         }
 
         //It's expected that bad internet connection can cause a significant delay for big project
-        executorService.shutdownNow()
+        executorService.shutdown()
     }
 
     override fun onFinish(event: FinishEvent?) {
@@ -111,16 +111,34 @@ abstract class BuildReportsService : BuildService<BuildReportsService.Parameters
     }
 
     private fun reportBuildFinish() {
+        val finishTime = System.nanoTime()
         val buildFinishData = BuildFinishStatisticsData(
             projectName = parameters.projectName.get(),
-            startParameters = parameters.startParameters.get(),
+            startParameters = parameters.startParameters.get()
+                .includeVerboseEnvironment(parameters.reportingSettings.get().httpReportSettings?.verboseEnvironment ?: false),
             buildUuid = buildUuid,
             label = parameters.label.orNull,
-            totalTime = (System.nanoTime() - startTime) / 1_000_000
+            totalTime = (finishTime - startTime) / 1_000_000,
+            finishTime = finishTime,
+            hostName = hostName
         )
         sendDataViaHttp(buildFinishData)
     }
 
+    private fun GradleBuildStartParameters.includeVerboseEnvironment(verboseEnvironment: Boolean): GradleBuildStartParameters {
+        return if (verboseEnvironment) {
+            this
+        } else {
+            GradleBuildStartParameters(
+                tasks = this.tasks,
+                excludedTasks = this.excludedTasks,
+                currentDir = null,
+                projectProperties = emptyList(),
+                systemProperties = emptyList()
+            )
+        }
+    }
+
     private fun addHttpReport(event: FinishEvent?) {
         if (parameters.reportingSettings.get().httpReportSettings != null) {
             if (event is TaskFinishEvent) {
diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/ReportingSettings.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/ReportingSettings.kt
index 50db59f2057..0dc857b28ea 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/ReportingSettings.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/ReportingSettings.kt
@@ -34,7 +34,8 @@ data class FileReportSettings(
 data class HttpReportSettings(
     val url: String,
     val password: String?,
-    val user: String?
+    val user: String?,
+    val verboseEnvironment: Boolean
 ) : Serializable {
     companion object {
         const val serialVersionUID: Long = 0
@@ -42,7 +43,7 @@ data class HttpReportSettings(
 }
 
 data class BuildScanSettings(
-    val customValueLimit: Int
+    val customValueLimit: Int,
 ): Serializable {
     companion object {
         const val serialVersionUID: Long = 0
diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/configureReporing.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/configureReporing.kt
index 477eb8fd76d..271c449f855 100644
--- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/configureReporing.kt
+++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/report/configureReporing.kt
@@ -32,7 +32,7 @@ internal fun reportingSettings(rootProject: Project): ReportingSettings {
             ?: throw IllegalStateException("Can't configure http report: '${properties.buildReportHttpUrlProperty}' property is mandatory")
         val password = properties.buildReportHttpPassword
         val user = properties.buildReportHttpUser
-        HttpReportSettings(url, password, user)
+        HttpReportSettings(url, password, user, properties.buildReportHttpVerboseEnvironment)
     } else {
         null
     }