Automate filing issues for any external package dependency

eng/pipelines/weekly_automation.yml

@@ -29,3 +29,38 @@ jobs:
       PRTitle: "Automatic rush update --full"
       PRBody: "This is an automatic PR generated weekly with changes from running the command rush update --full"
       PushArgs: "-f"
+
+
+- job: 'CheckDependency'
+  displayName: 'Check Package Dependency'
+  variables:
+  - template: /eng/pipelines/templates/variables/globals.yml
+
+  pool:
+    name: azsdk-pool-mms-ubuntu-2004-general
+    vmImage: MMSUbuntu20.04
+
+  steps:
+  - template: /eng/pipelines/templates/steps/common.yml
+  - template: /eng/common/pipelines/templates/steps/set-default-branch.yml
+
+  - script: |
+      node common/scripts/install-run-rush.js install
+      node common/scripts/install-run-rush.js unlink
+      git clean -xdf
+    displayName: "Rush Unlink"
+
+  - task: PowerShell@2
+    displayName: 'Check Dependency Warnings and File GitHub Issues'
+    inputs:
+      targetType: filePath
+      filePath: $(Build.SourcesDirectory)/eng/scripts/check-external-dependency.ps1
+      arguments: >
+        -RepoName azure-sdk-for-js
+        -RepoOwner azure
+        -AuthToken "$(azuresdk-github-pat)"
+      pwsh: true
+
+  - script: |
+      git reset --hard
+    displayName: "Reset Changes"

eng/scripts/check-external-dependency.ps1

@@ -0,0 +1,103 @@
+[CmdletBinding(SupportsShouldProcess = $true)]
+param (
+  [Parameter(Mandatory = $true)]
+  [string]$AuthToken,
+
+  [Parameter(Mandatory = $true)]
+  [string]$RepoOwner,
+
+  [Parameter(Mandatory = $true)]
+  [string]$RepoName
+)
+
+# This script will reset the repo and any changes in tracked files will be lost.
+
+$dependencyUpgradeLabel = "dependency-upgrade-required"
+$dependencyRegex = "^\+\s(?<pkg>[\S]*)\s(?<version>[\S]*)\s\((?<newVersion>[0-9\.a-b]*).*\)\s?(?<deprecated>deprecated)?"
+$RepoRoot = Resolve-Path -Path "${PSScriptRoot}/../.."
+Write-Host "Repo root: $RepoRoot"
+$rushFile = join-Path -Path $RepoRoot "rush.json"
+Write-Host "Path to rush.json: $rushFile"
+$commonConfigFile = Join-path -Path $RepoRoot "common" "config" "rush" "common-versions.json"
+Write-Host "Path to common-versions.json: $commonConfigFile"
+
+$EngCommonScriptsPath = Join-Path (Resolve-Path "${PSScriptRoot}/..") "common" "scripts"
+. (Join-Path $EngCommonScriptsPath common.ps1)
+
+$ghIssues = Get-GitHubIssues -RepoOwner $RepoOwner -RepoName $RepoName -CreatedBy "azure-sdk" -Labels "dependency-upgrade-required" -AuthToken $AuthToken
+# Check and return if an isue already exists to upgrade the package 
+function Get-GithubIssue($IssueTitle) {
+  foreach ($issue in $ghIssues) {
+    if ($issue.title -eq $IssueTitle) {
+      return $issue
+    }
+  }
+  return $null
+}
+
+# Create new issue if none exists for the package. or update current one if an issue exists
+function Set-GitHubIssue($Package) {
+  $pkgName = $Package.Name
+  $issueTitle = "Dependency package $pkgName has a new version available"
+  $issueDesc = "We have identified a dependency on $pkgName ($($Package.OldVersion)). "
+
+  if ($Package.IsDeprecated) {
+    $issueDesc += "Version $($Package.OldVersion) of $pkgName has been deprecated.`n"
+  }
+  $issueDesc += "A new version ($($Package.NewVersion)) is available now."
+
+  $issue = Get-GithubIssue -IssueTitle $issueTitle
+  if ($issue) {
+    if ($issue.body -ne $issueDesc) {
+      $oldIssue = Update-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -IssueNumber $issue.number -Body $issueDesc
+      Write-Host "Updated existing issue $($oldIssue.number)"      
+    }
+    else {
+      Write-Host "Found existing issue for package $($Package.Name)"
+    }   
+  }
+  else {
+    write-Host "Creating issue for $pkgName"
+    $newIssue = New-GitHubIssue -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Title $issueTitle -Description $issueDesc  
+    if ($newIssue) {
+      $out = Add-GitHubIssueLabels -RepoOwner $RepoOwner -RepoName $RepoName -AuthToken $AuthToken -Labels $dependencyUpgradeLabel -IssueNumber $newIssue.number
+    }
+  }
+}
+
+
+# Update rush configuration files to alter settings
+if ((Test-Path $rushFile) -and (Test-Path $commonConfigFile)) {
+  $rushJson = Get-Content -Path $rushFile | ConvertFrom-Json
+  $rushJson.pnpmOptions.strictPeerDependencies = $false
+  Set-Content -Path $rushFile -Value (ConvertTo-Json -InputObject $rushJson)
+
+  $configJson = Get-Content -Path $commonConfigFile | ConvertFrom-Json
+  $configJson.implicitlyPreferredVersions = $true
+  Set-Content -Path $commonConfigFile -Value (ConvertTo-Json -InputObject $configJson)
+}
+else {
+  Write-Error "Failed to find $($rushFile) and/or $($commonConfigFile). Verify repo root parameter."
+  exit 1
+}
+
+# Run rush update --full
+Write-Host "Running rush update"
+$rushUpdateOutput = node common/scripts/install-run-rush.js update --full
+write-host $rushUpdateOutput
+foreach ($line in $rushUpdateOutput) {
+  if ($line -match $dependencyRegex -and !$matches['pkg'].StartsWith("@azure")) { 
+    $p = New-Object PSObject -Property @{
+      Name         = $matches['pkg']  
+      OldVersion   = [AzureEngSemanticVersion]::ParseVersionString($matches['version'])        
+      NewVersion   = [AzureEngSemanticVersion]::ParseVersionString($matches['newVersion'])
+      IsDeprecated = ($matches['deprecated'] -eq "deprecated")
+    }
+
+    if ($null -ne $p.OldVersion -and $null -ne $p.NewVersion) {
+      Set-GitHubIssue -Package $p
+      Start-Sleep -s 5
+    }    
+  }
+}
+Write-Host "Verified and filed issues"