Skip to content

[Config] add config to disable write error to file system #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 11, 2023
Merged

[Config] add config to disable write error to file system #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e8ea8df
disable error records persistence
VeryEarly Aug 8, 2023
6193676
split RecordDebugMessage and FlushDebugMessages
VeryEarly Aug 8, 2023
f861f14
invoke RecordDebugMessages only when write error and throw terminatin…
VeryEarly Aug 8, 2023
d5364cd
combine if condition in a bool function
VeryEarly Aug 10, 2023
c596c7d
Uppercase first letter for method name
VeryEarly Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Authentication.Abstractions/Models/ConfigKeysForCommon.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,8 @@ public static class ConfigKeysForCommon
public const string EnableDataCollection = "EnableDataCollection";
public const string EnableTestCoverage = "EnableTestCoverage";
public const string CheckForUpgrade = "CheckForUpgrade";
//Use DisableErrorRecordsPersistence as opt-out for now, will replace it with EnableErrorRecordsPersistence as opt-in at next major release (November 2023)
public const string DisableErrorRecordsPersistence = "DisableErrorRecordsPersistence";
public const string EnableErrorRecordsPersistence = "EnableErrorRecordsPersistence";
}
}
27 changes: 19 additions & 8 deletions src/Common/AzurePSCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,11 @@ protected void WriteSurvey()
}
protected new void WriteError(ErrorRecord errorRecord)
{
FlushDebugMessages(IsDataCollectionAllowed());
FlushDebugMessages();
if (ShouldRecordDebugMessages())
{
RecordDebugMessages();
}
if (_qosEvent != null && errorRecord != null)
{
_qosEvent.Exception = errorRecord.Exception;
Expand All @@ -515,7 +519,11 @@ protected void WriteSurvey()

protected new void ThrowTerminatingError(ErrorRecord errorRecord)
{
FlushDebugMessages(IsDataCollectionAllowed());
FlushDebugMessages();
if (ShouldRecordDebugMessages())
{
RecordDebugMessages();
}
base.ThrowTerminatingError(errorRecord);
}

Expand Down Expand Up @@ -634,13 +642,8 @@ protected void SafeWriteOutputPSObject(string typeName, params object[] args)
WriteObject(customObject);
}

private void FlushDebugMessages(bool record = false)
private void FlushDebugMessages()
{
if (record)
{
RecordDebugMessages();
}

string message;
while (DebugMessages.TryDequeue(out message))
{
Expand Down Expand Up @@ -777,6 +780,14 @@ private void RecordDebugMessages()
}
}

//Use DisableErrorRecordsPersistence as opt-out for now, will replace it with EnableErrorRecordsPersistence as opt-in at next major release (November 2023)
private bool ShouldRecordDebugMessages()
{
return (!AzureSession.Instance.TryGetComponent<IConfigManager>(nameof(IConfigManager), out var configManager)
|| !configManager.GetConfigValue<bool>(ConfigKeysForCommon.DisableErrorRecordsPersistence))
&& IsDataCollectionAllowed();
}

/// <summary>
/// Invoke this method when the cmdlet is completed or terminated.
/// </summary>
Expand Down