"Failed to compare two elements in the array." in combination with Pwsh 7.5.0

[bijlm]

I have a Git repo in Azure DevOps where we develop our own Powershell Module.

Since this week our build agents are updated with Pwsh 7.5.0 and now our tests are failing on the code coverage part.

The building and testing is relying on the Sampler Project which on its part is relying on the Convert-LineNumber.

ERROR: Exception calling "BinarySearch" with "2" argument(s): "Failed to compare two elements in the array."
At C:\Users\xxxxx\Git\MyModule\output\RequiredModules\Sampler\0.118.2\tasks\JaCoCo.coverage.build.ps1:385 char:23
+ … edCommands | Convert-LineNumber -ErrorAction 'Stop' -PassThru | Out-N …                                             
+                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                                       
At C:\Users\xxxxx\Git\MyModule\output\RequiredModules\Sampler\0.118.2\tasks\JaCoCo.coverage.build.ps1:246 char:1
+ task Convert_Pester_Coverage {                                                                                        
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                                                                        
Build FAILED. 16 tasks, 1 errors, 0 warnings 00:02:55.2719609
ConvertTo-SourceLineNumber: C:\Users\xxxxx\Git\MyModule\output\RequiredModules\Sampler\0.118.2\tasks\JaCoCo.coverage.build.ps1:385:23
Line |                                                                                                                  
 385 |  … edCommands | Convert-LineNumber -ErrorAction 'Stop' -PassThru | Out-N …                                       
     |                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                                 
     | Exception calling "BinarySearch" with "2" argument(s): "Failed to compare two elements in the array."

There are 2 things I can do to prevent the Sample build not to fail (I can test/reproduce it locally):

1. Disable CodeCoverage by setting the threshold to '0'
2. Change my Pwsh version back from 7.5.0 to an older version like 7.4.x or earlier.

If someone could have a look at this? That would be great. I didn't see anything that triggered me.

[johlju]

This seems to happen on this line:

https://github.com/PoshCode/ModuleBuilder/blob/0ade8f4a8c3bf4dfdb2364bdc38051c7418d52d4/Source/Public/ConvertTo-SourceLineNumber.ps1#L75C13-L75C89

And it seems to be because BinarySearch() does not allow different types anymore.

[DBG]>> $hit.StartLineNumber
1                       
11

[DBG]>> $hit.StartLineNumber[0].GetType();$hit.StartLineNumber[1].GetType()           

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     UInt64                                   System.ValueType
True     True     UInt64                                   System.ValueType

[DBG]>> $SourceLineNumber
3                                        
[DBG]>> $SourceLineNumber.GetType()                                                   

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     Int32                                    System.ValueType

[DBG]>> [Array]::BinarySearch(@([system.uint64] 1,[system.uint64] 11), [system.int32] 3) 
ParentContainsErrorRecordException: Exception calling "BinarySearch" with "2" argument(s): "Failed to compare two elements in the array."

But changing to the same type for all the values, then the line works:

[DBG]>> [Array]::BinarySearch(@([system.uint64] 1,[system.uint64] 11), [system.uint64] 3)
-2

So maybe it is this line that has the wrong type, [int] should probably be changed to [System.UInt64]:

ModuleBuilder/Source/Public/ConvertTo-SourceLineNumber.ps1

Line 25 in 0ade8f4

[int]$SourceLineNumber,

This is probably a change in .NET 9 which PowerShell 7.5 uses 🤔 BeforeBinarySearch() probably converted values. My guess.

[johlju]

Can confirm that changing line:

ModuleBuilder/Source/Public/ConvertTo-SourceLineNumber.ps1

Line 25 in 0ade8f4

[int]$SourceLineNumber,

to

[System.UInt64]$SourceLineNumber,

made it work on the repository I was testing on, but not sure it is as easy as that. To support different Pester version, maybe we need to check what type the first item in the array has and then cast the $SourceLineNumber to the same type. 🤔

[bijlm]

@johlju I changed it locally as suggested and it works like a charm. 🙌
Quick find... BTW

I tested it in the context:
Windows 11 x64
Pwsh 7.5.0 (.Net 9)
Pester v5.7.1

I also tested it with then it seems to fail with the proposed change:
Windows 11 x64
Pwsh 7.3.7 (.Net 7)
Pester v5.7.1

So now, I'm testing both contexts with an additional check on .Net version just above line 25

If ([environment]::Version.Major -ge 9) {
     # .Net 9 doesn't accept differences in types
     $SourceLineNumber = [System.UInt64]$SourceLineNumber
}

Not sure if there is a more elegant way?

[bijlm]

The test above is failing... Now testing the following instead:

If ([environment]::Version.Major -ge 9) {
    # .Net 9 doesn't accept differences in types
    $index = -2 - [Array]::BinarySearch($hit.StartLineNumber, [System.UInt64]$SourceLineNumber)
}
else {
    $index = -2 - [Array]::BinarySearch($hit.StartLineNumber, $SourceLineNumber)
}

If that doesn't work.... anyway let you know it a few.

[bijlm]

@johlju
I can confirm the last approach is working with both pwsh version 7.3.7 and 7.5.0.

I'm not fully aware on the way forward, can you pick something up or can I? Is there anything to say in the ETA on a permanent fix on this function?

[johlju]

Maybe we can convert to the "expected" type by something like this:

PS> $a = [System.UInt64] 3   
PS> $a.GetType().FullName 
System.UInt64
PS> $b = [System.Int32] 5                                                                                    
System.Int32
PS> $b = $b -as $a.GetType()
PS> $b.GetType().FullName   
System.UInt64

So maybe this works for all scenarios?

$SourceLineNumber = $SourceLineNumber -as $hit.StartLineNumber[0].GetType()
$index = -2 - [Array]::BinarySearch($hit.StartLineNumber, $SourceLineNumber)

I'm not fully aware on the way forward, can you pick something up or can I?

Suggest sending in a PR with your best working approach of solving the issue and then ask @Jaykul to review. 🙂

[dan-hughes]

I do wonder if this is a .NET bug. The type on $SourceLineNumber is correct as this can be negative docs.

On [Array]::BinarySearch() the second parameter is of type Object which implies this is acceptable and work.

For the time being casting $hit.StartLineNumber to Int32 to match $SourceLineNumber I think would be better.

[johlju]

$hit.StartLineNumber is an array of numbers, so maybe we should cast each value to Int32 here:

ModuleBuilder/Source/Public/ConvertTo-SourceLineNumber.ps1

Line 61 in 0ade8f4

StartLineNumber = $_.LineNumber

It must be there it is made UInt64? 🤔 I haven't debugged it so not sure.

[dan-hughes]

$hit.StartLineNumber is an array of numbers, so maybe we should cast each value to Int32 here:

ModuleBuilder/Source/Public/ConvertTo-SourceLineNumber.ps1

Line 61 in 0ade8f4

StartLineNumber = $_.LineNumber
It must be there it is made UInt64? 🤔 I haven't debugged it so not sure.

Casting here does fix this. I've just tested locally.

[bijlm]

I do wonder if this is a .NET bug. The type on $SourceLineNumber is correct as this can be negative docs.

I just gave some feedback on this page, since this page is applying to:

PowerShell SDK : 7.2.0, 7.3.0, 7.4.0

I guess the 7.5.0 might bring new additions to it. So hopefully an update on this page will come soon.

BTW also testing locally, but your solution to type casting is not working for me... still looking into why?

[mikebijl]

I tested it locally and your approach works on the terminal, however if I implement this in the module, it still fails.

Maybe we can convert to the "expected" type by something like this:

PS> $a = [System.UInt64] 3
PS> $a.GetType().FullName
System.UInt64
PS> $b = [System.Int32] 5
System.Int32
PS> $b = $b -as $a.GetType()
PS> $b.GetType().FullName
System.UInt64
So maybe this works for all scenarios?

$SourceLineNumber = $SourceLineNumber -as $hit.StartLineNumber[0].GetType()
$index = -2 - [Array]::BinarySearch($hit.StartLineNumber, $SourceLineNumber)

I'm not fully aware on the way forward, can you pick something up or can I?

Suggest sending in a PR with your best working approach of solving the issue and then ask @Jaykul to review. 🙂

When I changed your lines a bit, it does work...

$index = -2 - [Array]::BinarySearch($hit.StartLineNumber, $($SourceLineNumber -as $hit.StartLineNumber[0].GetType()))

Start preparing a PR right away...

Note: switched to personal github account, my company account will be decommed soon 😜

[dan-hughes]

Changing line 61 to

 StartLineNumber = [System.Int32] $_.LineNumber 

Fixed the issue locally. $SourceLineNumber which is from InvocationInfo is an Int and can be -1.