Fix the issue that string is returned instead of object and add one more property in the telemetry #415
Conversation
…sage is added to accommodate this situation.
vidai-msft
force-pushed
the
vidai/sanitizer-handler
branch
from
3230152 to
940d279
Compare
| @@ -29,11 +31,17 @@ public class SanitizerTelemetry | |||
|
|
|||
| public TimeSpan SanitizeDuration { get; set; } | |||
|
|
|||
| public SanitizerTelemetry(bool showSecretsWarning) | |||
There was a problem hiding this comment.
This is technically a breaking change, because the default constructor (the one without parameters) will be hidden by this. Are we sure about the backward compatibility?
There was a problem hiding this comment.
The change was due to the value in the telemetry may be not consistent with the DisplaySecretsWarning option. Previously the ShowSecretsWarning in the telemetry relied on if the real detection method was invoked. If not, then the value would be the default (false). However, the real value of DisplaySecretsWarning may be true. The initialization of the SanitizerTelemetry just happens in Az.Accounts module (For SDK, Authentication proj; for AutoRest, AzModule). So it won't cause any real breaking change and build error.
This pull request primarily focuses on improving the handling of secret detection in the Azure PowerShell Cmdlet. The changes include a more nuanced approach to secret detection warnings, improved null safety, and adjustments to the
SanitizerTelemetryclass.The most important changes are:
Improved Secret Detection Warnings:
src/Common/AzurePSCmdlet.cs]: TheWriteSecretsWarningMessage()method now checks forsanitizerInfo.SecretsDetectedbefore showing a secrets warning. It also differentiates the warning message based on whether any properties were detected.src/Common/Properties/Resources.Designer.csandsrc/Common/Properties/Resources.resx: Added a new resource stringDisplaySecretsWarningMessageWithoutPropertyfor the case where no specific properties were detected.Null Safety Improvements:
src/Common/AzurePSCmdlet.cs]: Null safety has been improved in several places by using the null-conditional operator. This includes theOutputSanitizerproperty and theSanitizeOutput()andInitializeQosEvent()methods.Changes to
SanitizerTelemetry:src/Common/Sanitizer/SanitizerTelemetry.cs]: Added a new propertySecretsDetectedto track whether secrets were detected. Also added a new constructor that takes ashowSecretsWarningparameter.src/Common/MetricHelper.cs]: ThePopulateSanitizerPropertiesFromQos()method now uses the newSecretsDetectedproperty and adjusts thesecrets-detected-propertiesvalue based on whether any properties were detected.