[eng/common] Make helper function "Install-ModuleIfNotInstalled" threadsafe (#6521)

- Fixes #6514

Author: mikeharder

eng/common-tests/psmodule-helpers/Install-Module-Parallel.ps1

@@ -0,0 +1,31 @@
+# Manual test to verify the threadsafety of "Install-ModuleIfNotInstalled"
+# If test runs several iterations with no errors, the function is likely threadsafe
+# If test throws any errors related to installing or loading the module, the function likely has a race condition
+
+$command = {
+    . $PWD/../../common/scripts/Helpers/PSModule-Helpers.ps1
+    Write-Host 'Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module'
+    Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
+    Write-Host
+}
+
+while ($true) {
+    Write-Host 'Uninstall-Module "powershell-yaml"'
+    Uninstall-Module "powershell-yaml"
+
+    $job1 = Start-Job -ScriptBlock $command
+    $job2 = Start-Job -ScriptBlock $command
+    $job3 = Start-Job -ScriptBlock $command
+    Wait-Job -Job $job1, $job2, $job3 | Out-Null
+    Receive-Job -Job $job1, $job2, $job3
+
+    Write-Host
+
+    $job1 = Start-Job -ScriptBlock $command
+    $job2 = Start-Job -ScriptBlock $command
+    $job3 = Start-Job -ScriptBlock $command
+    Wait-Job -Job $job1, $job2, $job3 | Out-Null
+    Receive-Job -Job $job1, $job2, $job3
+
+    Write-Host
+}

eng/common/scripts/Helpers/PSModule-Helpers.ps1

@@ -47,6 +47,7 @@ function Update-PSModulePathForCI()
   }
 }
 
+# Manual test at eng/common-tests/psmodule-helpers/Install-Module-Parallel.ps1
 # If we want to use another default repository other then PSGallery we can update the default parameters
 function Install-ModuleIfNotInstalled()
 {
@@ -65,35 +66,53 @@ function Install-ModuleIfNotInstalled()
 
   if ($modules.Count -eq 0)
   {
-    $repositories = (Get-PSRepository).Where({ $_.SourceLocation -eq $repositoryUrl })
-    if ($repositories.Count -eq 0)
-    {
-      Register-PSRepository -Name $repositoryUrl -SourceLocation $repositoryUrl -InstallationPolicy Trusted
-      $repositories = (Get-PSRepository).Where({ $_.SourceLocation -eq $repositoryUrl })
-      if ($repositories.Count -eq 0) {
-        Write-Error "Failed to registory package repository $repositoryUrl."
-        return
+    # Use double-checked locking to avoid locking when module is already installed
+    $mutex = New-Object System.Threading.Mutex($false, "Install-ModuleIfNotInstalled")
+    $null = $mutex.WaitOne()
+
+    try {
+      # Check installed modules again after acquiring lock
+      $modules = (Get-Module -ListAvailable $moduleName)
+      if ($version -as [Version]) {
+        $modules = $modules.Where({ [Version]$_.Version -ge [Version]$version })
       }
-    }
-    $repository = $repositories[0]
-
-    if ($repository.InstallationPolicy -ne "Trusted") {
-      Set-PSRepository -Name $repository.Name -InstallationPolicy "Trusted"
-    }
 
-    Write-Host "Installing module $moduleName with min version $version from $repositoryUrl"
-    # Install under CurrentUser scope so that the end up under $CurrentUserModulePath for caching
-    Install-Module $moduleName -MinimumVersion $version -Repository $repository.Name -Scope CurrentUser -Force
-
-    # Ensure module installed
-    $modules = (Get-Module -ListAvailable $moduleName)
-    if ($version -as [Version]) {
-      $modules = $modules.Where({ [Version]$_.Version -ge [Version]$version })
+      if ($modules.Count -eq 0)
+      {
+        $repositories = (Get-PSRepository).Where({ $_.SourceLocation -eq $repositoryUrl })
+        if ($repositories.Count -eq 0)
+        {
+          Register-PSRepository -Name $repositoryUrl -SourceLocation $repositoryUrl -InstallationPolicy Trusted
+          $repositories = (Get-PSRepository).Where({ $_.SourceLocation -eq $repositoryUrl })
+          if ($repositories.Count -eq 0) {
+            Write-Error "Failed to register package repository $repositoryUrl."
+            return
+          }
+        }
+        $repository = $repositories[0]
+
+        if ($repository.InstallationPolicy -ne "Trusted") {
+          Set-PSRepository -Name $repository.Name -InstallationPolicy "Trusted"
+        }
+
+        Write-Host "Installing module $moduleName with min version $version from $repositoryUrl"
+        # Install under CurrentUser scope so that the end up under $CurrentUserModulePath for caching
+        Install-Module $moduleName -MinimumVersion $version -Repository $repository.Name -Scope CurrentUser -Force
+
+        # Ensure module installed
+        $modules = (Get-Module -ListAvailable $moduleName)
+        if ($version -as [Version]) {
+          $modules = $modules.Where({ [Version]$_.Version -ge [Version]$version })
+        }
+
+        if ($modules.Count -eq 0) {
+          Write-Error "Failed to install module $moduleName with version $version"
+          return
+        }
+      }
     }
-
-    if ($modules.Count -eq 0) {
-      Write-Error "Failed to install module $moduleName with version $version"
-      return
+    finally {
+      $mutex.ReleaseMutex()
     }
   }