Use --experiment-run-id instead of --query argument

Author: erichaagdev

build.gradle.kts

@@ -54,14 +54,13 @@ repositories {
         }
     }
     mavenCentral()
-
 }
 
 val isDevelopmentRelease = !hasProperty("finalRelease")
 val releaseVersion = releaseVersion()
 val releaseNotes = releaseNotes()
 val distributionVersion = distributionVersion()
-val buildScanSummaryVersion = "1.0.4-2024.1" // todo update to 1.0.5-2024.1 once released
+val buildScanSummaryVersion = "1.0.5-2024.1"
 
 allprojects {
     version = releaseVersion.get()

components/scripts/gradle/01-validate-incremental-building.sh

@@ -140,7 +140,7 @@ print_gradle_command() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_run_id)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID"
 }
 
 # Overrides summary.sh#print_performance_characteristics

components/scripts/gradle/02-validate-local-build-caching-same-location.sh

@@ -145,7 +145,7 @@ print_gradle_command() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_run_id)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID"
 }
 
 print_introduction() {

components/scripts/gradle/03-validate-local-build-caching-different-locations.sh

@@ -150,7 +150,7 @@ print_gradle_command() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_run_id)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID"
 }
 
 print_introduction() {

components/scripts/gradle/04-validate-remote-build-caching-ci-ci.sh

@@ -117,7 +117,7 @@ validate_required_args() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_VERBOSE" "$(query_none)"
+  process_build_scan_data_online "$LOGGING_VERBOSE" "$RUN_ID_NONE"
 }
 
 # Overrides summary.sh#print_experiment_specific_summary_info

components/scripts/gradle/05-validate-remote-build-caching-ci-local.sh

@@ -225,7 +225,7 @@ execute_build() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_none)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID_NONE"
 }
 
 # Overrides summary.sh#print_experiment_specific_summary_info

components/scripts/lib/build-scan-online.sh

@@ -2,38 +2,32 @@
 
 readonly LOGGING_BRIEF='brief_logging'
 readonly LOGGING_VERBOSE='verbose_logging'
+readonly RUN_ID_NONE=''
 
 # Main entrypoint for processing data online using the Build Scan summary tool.
 # All scripts should call this function to fetch Build Scan data used in the
 # experiment summary.
 #
-# USAGE: fetch_build_scans_and_build_time_metrics <logging_level> <query>
+# USAGE:   fetch_build_scans_and_build_time_metrics <logging_level> <run_id>
+# EXAMPLE: fetch_build_scans_and_build_time_metrics "$LOGGING_BRIEF" "$RUN_ID"
 #
-# <logging_level> should be set using either LOGGING_BRIEF or LOGGING_VERBOSE
-#                 constant, e.g., "$LOGGING_BRIEF"
-# <query>         should be set using either query_none or query_run_id
-#                 function, e.g., "$(query_none)"
+# <logging_level> should be set to the constant LOGGING_BRIEF or LOGGING_VERBOSE
+# <run_id>        should be set to the constant RUN_ID or RUN_ID_NONE depending
+#                 on whether the builds being queried for have a common run id,
+#                 which will only be the case when both builds were produced
+#                 during script execution
 process_build_scan_data_online() {
   local logging_level="$1"
-  local query="$2"
+  local run_id="$2"
 
   # Always call since it will only read if the metadata file exists
   read_build_scan_metadata
 
   local build_scan_data
-  build_scan_data="$(fetch_build_scan_data "${@}")"
+  build_scan_data="$(fetch_build_scan_data "$logging_level" "$run_id")"
   parse_build_scans_and_build_time_metrics "${build_scan_data}"
 }
 
-query_none() {
-  # Intentionally no-op so query definitions can appear consistent
-  true
-}
-
-query_run_id() {
-  echo "value:\"Experiment run id=$RUN_ID\""
-}
-
 read_build_scan_metadata() {
   # This isn't the most robust way to read a CSV,
   # but we control the CSV so we don't have to worry about various CSV edge cases
@@ -77,7 +71,7 @@ fetch_single_build_scan() {
   local build_scan_url="$1"
 
   local build_scan_data
-  build_scan_data="$(fetch_build_scan_data "$LOGGING_VERBOSE" "$(query_none)")"
+  build_scan_data="$(fetch_build_scan_data "$LOGGING_VERBOSE" "$RUN_ID_NONE")"
 
   parse_single_build_scan "${build_scan_data}"
 }
@@ -90,7 +84,7 @@ fetch_single_build_scan() {
 #          be done inside this function.
 fetch_build_scan_data() {
   local logging_level="$1"
-  local query="$2"
+  local run_id="$2"
 
   if [[ "${debug_mode}" == "on" ]]; then
     args+=("--debug")
@@ -112,8 +106,8 @@ fetch_build_scan_data() {
     args+=("--build-scan-availability-wait-timeout" "60")
   fi
 
-  if [[ -n "${query}" ]]; then
-    args+=("--query" "$query")
+  if [[ -n "${run_id}" ]]; then
+    args+=("--experiment-run-id" "$run_id")
   fi
 
   for run_num in "${!build_scan_urls[@]}"; do

components/scripts/maven/01-validate-local-build-caching-same-location.sh

@@ -150,7 +150,7 @@ print_maven_command() {
  }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_run_id)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID"
 }
 
 print_introduction() {

components/scripts/maven/02-validate-local-build-caching-different-locations.sh

@@ -154,7 +154,7 @@ print_maven_command() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_run_id)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID"
 }
 
 print_introduction() {

components/scripts/maven/03-validate-remote-build-caching-ci-ci.sh

@@ -115,7 +115,7 @@ validate_required_args() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_VERBOSE" "$(query_none)"
+  process_build_scan_data_online "$LOGGING_VERBOSE" "$RUN_ID_NONE"
 }
 
 # Overrides summary.sh#print_experiment_specific_summary_info

components/scripts/maven/04-validate-remote-build-caching-ci-local.sh

@@ -220,7 +220,7 @@ execute_build() {
 }
 
 process_build_scan_data() {
-  process_build_scan_data_online "$LOGGING_BRIEF" "$(query_none)"
+  process_build_scan_data_online "$LOGGING_BRIEF" "$RUN_ID_NONE"
 }
 
 # Overrides summary.sh#print_experiment_specific_summary_info