Bound member invocation logging argument strings#27513
Open
KirtiRamchandani wants to merge 2 commits into
Open
Bound member invocation logging argument strings#27513KirtiRamchandani wants to merge 2 commits into
KirtiRamchandani wants to merge 2 commits into
Conversation
8 tasks
Author
|
@microsoft-github-policy-service agree |
Comment on lines
+3670
to
+3674
| return string.Concat( | ||
| value.AsSpan(0, MaxLoggedArgumentStringLength), | ||
| "...<truncated; original length: ".AsSpan(), | ||
| originalLength.AsSpan(), | ||
| ">".AsSpan()); |
| ); | ||
| #endif | ||
|
|
||
| private const int MaxLoggedArgumentStringLength = 4096; |
Comment on lines
+12
to
+26
| It 'Keeps short string arguments unchanged' { | ||
| $value = 'short argument' | ||
|
|
||
| $argumentToString.Invoke($null, [object[]]@($value)) | Should -BeExactly $value | ||
| } | ||
|
|
||
| It 'Limits long string arguments' { | ||
| $value = 'a' * 5000 | ||
|
|
||
| $result = $argumentToString.Invoke($null, [object[]]@($value)) | ||
|
|
||
| $result.Length | Should -BeLessThan $value.Length | ||
| $result.StartsWith(('a' * 4096), [System.StringComparison]::Ordinal) | Should -BeTrue | ||
| $result | Should -Match '<truncated; original length: 5000>' | ||
| } |
Comment on lines
+19
to
+25
| $value = 'a' * 5000 | ||
|
|
||
| $result = $argumentToString.Invoke($null, [object[]]@($value)) | ||
|
|
||
| $result.Length | Should -BeLessThan $value.Length | ||
| $result.StartsWith(('a' * 4096), [System.StringComparison]::Ordinal) | Should -BeTrue | ||
| $result | Should -Match '<truncated; original length: 5000>' |
Comment on lines
+19
to
+25
| $value = 'a' * 5000 | ||
|
|
||
| $result = $argumentToString.Invoke($null, [object[]]@($value)) | ||
|
|
||
| $result.Length | Should -BeLessThan $value.Length | ||
| $result.StartsWith(('a' * 4096), [System.StringComparison]::Ordinal) | Should -BeTrue | ||
| $result | Should -Match '<truncated; original length: 5000>' |
| $value = 'a' * $originalLength | ||
|
|
||
| $result = $argumentToString.Invoke($null, [object[]]@($value)) | ||
| $truncationMarker = "...<truncated; original length: $originalLength>" |
|
|
||
| $result.Length | Should -Be $maxLoggedArgumentStringLength | ||
| $result.StartsWith(('a' * $expectedPrefixLength), [System.StringComparison]::Ordinal) | Should -BeTrue | ||
| $result | Should -Match $truncationMarker |
|
|
||
| $result.Length | Should -Be $maxLoggedArgumentStringLength | ||
| $result.Length | Should -BeLessThan $value.Length | ||
| $result | Should -Match "<truncated; original length: $originalLength>" |
| || baseType == typeof(decimal)) | ||
| { | ||
| return baseObj.ToString(); | ||
| return LimitLoggedArgumentString(baseObj.ToString()); |
| $type = [psobject].Assembly.GetType('System.Management.Automation.MemberInvocationLoggingOps') | ||
| $argumentToString = $type.GetMethod( | ||
| 'ArgumentToString', | ||
| [System.Reflection.BindingFlags]'NonPublic, Static') |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Bounds long string values included in member invocation logging while preserving the method invocation and recording the original string length.
PR Context
Addresses #21473.
MemberInvocationLoggingOps.ArgumentToString()currently returns full string arguments, soLogMemberInvocation()can build very large AMSI report content for calls such asFromBase64Stringwith large strings. This change keeps strings at or below the limit unchanged, caps longer logged string values to 4096 characters total, and appends a marker with the original length. It also applies the same bound to special primitive-likeToString()results, such as very largeBigIntegervalues.PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerValidation
Start-PSBuild -PSModuleRestore -UseNuGetOrgbuiltpwsh.exe. The Windows PowerShell 5.1 build wrapper emitted post-buildConvertFrom-Json -Depthcompatibility warnings after build output was produced.Start-PSPester -Path test/powershell/engine/Logging/MemberInvocationLogging.Tests.ps1 -UseNuGetOrg -ThrowOnFailure -Terse -SkipTestToolBuildpassed: 4 passed, 0 failed.