🐛 Modules with Trailing Zeroes do not install correctly (#100)

Fixes #98 Co-authored-by: Justin Grote <[email protected]> Co-authored-by: Raimund Andree <[email protected]>
JustinGrote · Dec 7, 2024 · d2e0185 · d2e0185
1 parent 8457844
commit d2e0185
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/ModuleFast.psm1 b/ModuleFast.psm1
@@ -1011,6 +1011,47 @@ function Install-ModuleFastHelper {
               $zip = [IO.Compression.ZipArchive]::new($stream, 'Read')
               [IO.Compression.ZipFileExtensions]::ExtractToDirectory($zip, $installPath)
 
+              $manifestPath = Join-Path $installPath "$($context.Module.Name).psd1"
+
+              # Try to read the manifest with a streamreader just to ModuleVersion.
+              # This makes a glaring but reasonable assumption that the moduleVersion is not dynamic and has no newlines.
+              # Much more performant than a full parse, as it will stop as soon as it hits moduleversion, perhaps at the
+              # expense of more iops due to the readline vs reading the entire file at once
+              $reader = [IO.StreamReader]::new($manifestPath)
+              [Version]$moduleManifestVersion = $null
+              try {
+                while ($null -ne ($line = $reader.ReadLine())) {
+                  if ($line -match '\s*ModuleVersion\s*=\s*[''"](?<version>.+?)[''"]') {
+                    $moduleManifestVersion = $matches['version']
+                    break
+                  }
+                }
+              } finally {
+                $reader.Close()
+              }
+
+              # Resolves an edge case where nuget packages are normalized in some package manages from 3.2.1.0 to 3.2.1
+              if (-not $moduleManifestVersion) {
+                Write-Warning "$($context.Module): Could not detect the module manifest version. This module may not install properly if it has trailing zeros in the version"
+              } else {
+                $installPathRoot = Split-Path $installPath
+                $originalModuleVersion = Split-Path $installPath -Leaf
+                if ($originalModuleVersion -ne $moduleManifestVersion)
+                {
+                    Write-Debug "$($context.Module): Module Manifest Version $moduleManifestVersion differs from package version $originalModuleVersion, moving..."
+
+                    $newInstallPath = Join-Path $installPathRoot $moduleManifestVersion
+                    [System.IO.Directory]::Move($installPath, $newInstallPath)
+
+                    $installPath = $newInstallPath
+                    $context.InstallPath = $installPath
+                    $originalModuleVersion > (Join-Path $installPath '.originalModuleVersion')
+                    $installIndicatorPath = Join-Path $installPath '.incomplete'
+                } else {
+                  Write-Debug "$($context.Module): Module Manifest version matches the expected version"
+                }
+              }
+
               if ($context.Module.Guid -and $context.Module.Guid -ne [Guid]::Empty) {
                 Write-Debug "$($context.Module): GUID was specified in Module. Verifying manifest"
                 $manifestPath = Join-Path $installPath "$($context.Module.Name).psd1"

diff --git a/ModuleFast.tests.ps1 b/ModuleFast.tests.ps1
@@ -461,6 +461,12 @@ Describe 'Install-ModuleFast' -Tag 'E2E' {
 		| Limit-ModulePath $installTempPath
 		| Should -HaveCount 1
   }
+  It '4 section version numbers with single trailing zero' {
+    $actual = Install-ModuleFast @imfParams 'ConnectWiseManageApi=0.4.15.0' -PassThru
+    # Path should exist in the new location
+    $resolvedPath = $actual.Location.LocalPath
+    Split-Path $resolvedPath -Leaf | Should -Be '0.4.15.0'
+  }
   It 'lots of dependencies (Az)' {
     Install-ModuleFast @imfParams 'Az'
 		(Get-Module Az* -ListAvailable).count | Should -BeGreaterThan 10