From a836fde12ac67ee3faf4265eb805f1b0ef81723f Mon Sep 17 00:00:00 2001
From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Date: Thu, 27 Mar 2025 17:44:53 -0700
Subject: [PATCH] Sync eng/common directory with azure-sdk-tools for PR 10145
 (#6488)

* support accessing a different key for the value of the Package during batching in Create-PrJobMatrix

---------

Co-authored-by: Scott Beddall <scbedd@microsoft.com>
---
 .../templates/jobs/generate-job-matrix.yml    |  6 ++++
 .../scripts/job-matrix/Create-PrJobMatrix.ps1 | 30 ++++++++++---------
 2 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml
index 7cb3a785c..2833b1d9e 100644
--- a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml
+++ b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml
@@ -45,9 +45,14 @@ parameters:
 - name: EnablePRGeneration
   type: boolean
   default: false
+# name of the variable that will be added when creating batches for the PR Job Matrix
 - name: PRMatrixSetting
   type: string
   default: 'ArtifactPackageNames'
+# name of the key in PackageInfo that will be used to get the identifier when generating matrix batches
+- name: PRMatrixKey
+  type: string
+  default: 'ArtifactName'
 - name: PRJobBatchSize
   type: number
   default: 10
@@ -141,6 +146,7 @@ jobs:
               -PackagePropertiesFolder $(Build.ArtifactStagingDirectory)/PackageInfo `
               -PRMatrixFile matrix.json `
               -PRMatrixSetting ${{ parameters.PRMatrixSetting }} `
+              -PRMatrixKey ${{ parameters.PRMatrixKey }} `
               -DisplayNameFilter '$(displayNameFilter)' `
               -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' `
               -IndirectFilters '${{ join(''',''', parameters.PRMatrixIndirectFilters) }}' `
diff --git a/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1
index 81bd1c360..c541968ec 100644
--- a/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1
+++ b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1
@@ -40,12 +40,13 @@ param (
   [Parameter(Mandatory = $true)][string] $PackagePropertiesFolder,
   [Parameter(Mandatory = $true)][string] $PRMatrixFile,
   [Parameter(Mandatory = $true)][string] $PRMatrixSetting,
-  [Parameter(Mandatory = $False)][string] $DisplayNameFilter,
-  [Parameter(Mandatory = $False)][array] $Filters,
-  [Parameter(Mandatory = $False)][array] $IndirectFilters,
-  [Parameter(Mandatory = $False)][array] $Replace,
-  [Parameter(Mandatory = $False)][bool] $SparseIndirect = $true,
-  [Parameter(Mandatory = $False)][int] $PackagesPerPRJob = 10,
+  [Parameter(Mandatory = $false)][string] $DisplayNameFilter,
+  [Parameter(Mandatory = $false)][array] $Filters,
+  [Parameter(Mandatory = $false)][array] $IndirectFilters,
+  [Parameter(Mandatory = $false)][array] $Replace,
+  [Parameter(Mandatory = $false)][string] $PRMatrixKey = "ArtifactName",
+  [Parameter(Mandatory = $false)][bool] $SparseIndirect = $true,
+  [Parameter(Mandatory = $false)][int] $PackagesPerPRJob = 10,
   [Parameter()][switch] $CI = ($null -ne $env:SYSTEM_TEAMPROJECTID)
 )
 
@@ -74,6 +75,7 @@ function QueuePop([ref]$queue) {
 function GeneratePRMatrixForBatch {
   param (
     [Parameter(Mandatory = $true)][array] $Packages,
+    [Parameter(Mandatory = $true)][array] $MatrixKey,
     [Parameter(Mandatory = $false)][bool] $FullSparseMatrix = $false
   )
 
@@ -104,7 +106,7 @@ function GeneratePRMatrixForBatch {
     $matrixResults = @()
 
     if (!$matrixConfig) {
-      Write-Error "Unable to find matrix config for $matrixBatchKey. Check the package properties for the package $($matrixBatch[0].ArtifactName)."
+      Write-Error "Unable to find matrix config for $matrixBatchKey. Check the package properties for the package $($matrixBatch[0].($MatrixKey))."
       exit 1
     }
 
@@ -166,7 +168,7 @@ function GeneratePRMatrixForBatch {
       $batchCounter = 1
 
       foreach ($batch in $packageBatches) {
-        $namesForBatch = ($batch | ForEach-Object { $_.ArtifactName }) -join ","
+        $namesForBatch = ($batch | ForEach-Object { $_.($MatrixKey) }) -join ","
 
         foreach ($matrixOutputItem in $matrixResults) {
           # we need to clone this, as each item is an object with possible children
@@ -195,7 +197,7 @@ function GeneratePRMatrixForBatch {
       $batchSuffixNecessary = $packageBatches.Length -gt 0
       $batchCounter = 1
       foreach ($batch in $packageBatches) {
-        $namesForBatch = ($batch | ForEach-Object { $_.ArtifactName }) -join ","
+        $namesForBatch = ($batch | ForEach-Object { $_.($MatrixKey) }) -join ","
         $outputItem = QueuePop -queue ([ref]$matrixResults)
 
         $outputItem["parameters"]["$PRMatrixSetting"] = $namesForBatch
@@ -228,7 +230,7 @@ if (!(Test-Path $PRMatrixFile)) {
   exit 1
 }
 
-Write-Host "Generating PR job matrix for $PackagePropertiesFolder"
+Write-Host "Generating PR job matrix for $PackagePropertiesFolder using accesskey $PRMatrixKey to determine artifact batches."
 
 $configs = Get-Content -Raw $PRMatrixFile | ConvertFrom-Json
 
@@ -251,16 +253,16 @@ $OverallResult = @()
 if ($directPackages) {
   Write-Host "Discovered $($directPackages.Length) direct packages"
   foreach($artifact in $directPackages) {
-    Write-Host "-> $($artifact.ArtifactName)"
+    Write-Host "-> $($artifact.($PRMatrixKey))"
   }
-  $OverallResult += (GeneratePRMatrixForBatch -Packages $directPackages) ?? @()
+  $OverallResult += (GeneratePRMatrixForBatch -Packages $directPackages -MatrixKey $PRMatrixKey) ?? @()
 }
 if ($indirectPackages) {
   Write-Host "Discovered $($indirectPackages.Length) indirect packages"
   foreach($artifact in $indirectPackages) {
-    Write-Host "-> $($artifact.ArtifactName)"
+    Write-Host "-> $($artifact.($PRMatrixKey))"
   }
-  $OverallResult += (GeneratePRMatrixForBatch -Packages $indirectPackages -FullSparseMatrix (-not $SparseIndirect)) ?? @()
+  $OverallResult += (GeneratePRMatrixForBatch -Packages $indirectPackages -MatrixKey $PRMatrixKey -FullSparseMatrix (-not $SparseIndirect)) ?? @()
 }
 $serialized = SerializePipelineMatrix $OverallResult