mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-06-06 00:23:00 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Adding Telemetry Events for svg and markdown enable/disable (#2814)

Browse Source 
* Raising Telemetry events when svg and markdown preview pane is turned off

* Properly serializing Bool property.  This allows us to be backwards compatible with .17 settings but interact with the properties as boolean elements, and fire events on property changed notification
This commit is contained in:
ryanbodrug-microsoft 2020-05-08 16:12:37 -07:00 committed by GitHub
parent e654999fdf
commit d329406eb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 79 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/core/Microsoft.PowerToys.Settings.UI.Lib/BoolPropertyJsonConverter.cs Normal file
View File

@ -0,0 +1,23 @@
using System;
using System.Collections.Generic;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
namespace Microsoft.PowerToys.Settings.UI.Lib
{
public class BoolPropertyJsonConverter : JsonConverter<bool>
{
public override bool Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var boolProperty = JsonSerializer.Deserialize<BoolProperty>(ref reader, options);
return boolProperty.Value;
}
public override void Write(Utf8JsonWriter writer, bool value, JsonSerializerOptions options)
{
var boolProperty = new BoolProperty(value);
JsonSerializer.Serialize(writer, boolProperty, options);
}
}
}

4
src/core/Microsoft.PowerToys.Settings.UI.Lib/EnabledModules.cs
View File

@ -133,10 +133,10 @@ namespace Microsoft.PowerToys.Settings.UI.Lib
private void LogTelemetryEvent(bool value, [CallerMemberName] string moduleName = null )
{
var dataEvent = new SettingsEnabledModuleEvent()
var dataEvent = new SettingsEnabledEvent()
{
Value = value,
ModuleName = moduleName,
Name = moduleName,
};
PowerToysTelemetry.Log.WriteEvent(dataEvent);
}

52
src/core/Microsoft.PowerToys.Settings.UI.Lib/PowerPreviewProperties.cs
View File

@ -2,28 +2,68 @@
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Runtime.CompilerServices;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.PowerToys.Settings.Telemetry;
using Microsoft.PowerToys.Telemetry;
namespace Microsoft.PowerToys.Settings.UI.Lib
{
public class PowerPreviewProperties
{
[JsonPropertyName("svg-previewer-toggle-setting")]
public BoolProperty EnableSvg { get; set; }
{
private bool enableSvg = true;
[JsonPropertyName("svg-previewer-toggle-setting")]
[JsonConverter(typeof(BoolPropertyJsonConverter))]
public bool EnableSvg
{
get => this.enableSvg;
set
{
if (value != this.enableSvg)
{
LogTelemetryEvent(value);
this.enableSvg = value;
}
}
}
private bool enableMd = true;
[JsonPropertyName("md-previewer-toggle-setting")]
public BoolProperty EnableMd { get; set; }
[JsonConverter(typeof(BoolPropertyJsonConverter))]
public bool EnableMd
{
get => this.enableMd;
set
{
if (value != this.enableMd)
{
LogTelemetryEvent(value);
this.enableMd = value;
}
}
}
public PowerPreviewProperties()
{
EnableSvg = new BoolProperty();
EnableMd = new BoolProperty();
}
public override string ToString()
{
return JsonSerializer.Serialize(this);
}
private void LogTelemetryEvent(bool value, [CallerMemberName] string propertyName = null)
{
var dataEvent = new SettingsEnabledEvent()
{
Value = value,
Name = propertyName,
};
PowerToysTelemetry.Log.WriteEvent(dataEvent);
}
}
}

4
src/core/Microsoft.PowerToys.Settings.UI.Lib/Telemetry/Events/SettingsEnabledModuleEvent.cs → src/core/Microsoft.PowerToys.Settings.UI.Lib/Telemetry/Events/SettingsEnabledEvent.cs
View File

@ -3,9 +3,9 @@
namespace Microsoft.PowerToys.Settings.Telemetry
{
[EventData]
public class SettingsEnabledModuleEvent
public class SettingsEnabledEvent
{
public string ModuleName { get; set; }
public string Name { get; set; }
public bool Value { get; set; }
}

8
src/core/Microsoft.PowerToys.Settings.UI/ViewModels/PowerPreviewViewModel.cs
View File

@ -27,8 +27,8 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
SettingsUtils.SaveSettings(Settings.ToJsonString(), ModuleName);
}
this._svgRenderIsEnabled = Settings.properties.EnableSvg.Value;
this._mdRenderIsEnabled = Settings.properties.EnableMd.Value;
this._svgRenderIsEnabled = Settings.properties.EnableSvg;
this._mdRenderIsEnabled = Settings.properties.EnableMd;
}
private bool _svgRenderIsEnabled = false;
@ -46,7 +46,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
if (value != _svgRenderIsEnabled)
{
_svgRenderIsEnabled = value;
Settings.properties.EnableSvg.Value = value;
Settings.properties.EnableSvg = value;
RaisePropertyChanged();
}
}
@ -64,7 +64,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
if (value != _mdRenderIsEnabled)
{
_mdRenderIsEnabled = value;
Settings.properties.EnableMd.Value = value;
Settings.properties.EnableMd = value;
RaisePropertyChanged();
}
}

4
src/core/Microsoft.PowerToys.Settings.UnitTest/ViewModelTests/PowerPreview.cs
View File

@ -59,7 +59,7 @@ namespace ViewModelTests
ShellPage.DefaultSndMSGCallback = msg =>
{
SndModuleSettings<SndPowerPreviewSettings> snd = JsonSerializer.Deserialize<SndModuleSettings<SndPowerPreviewSettings>>(msg);
Assert.IsTrue(snd.powertoys.FileExplorerPreviewSettings.properties.EnableSvg.Value);
Assert.IsTrue(snd.powertoys.FileExplorerPreviewSettings.properties.EnableSvg);
};
// act
@ -76,7 +76,7 @@ namespace ViewModelTests
ShellPage.DefaultSndMSGCallback = msg =>
{
SndModuleSettings<SndPowerPreviewSettings> snd = JsonSerializer.Deserialize<SndModuleSettings<SndPowerPreviewSettings>>(msg);
Assert.IsTrue(snd.powertoys.FileExplorerPreviewSettings.properties.EnableMd.Value);
Assert.IsTrue(snd.powertoys.FileExplorerPreviewSettings.properties.EnableMd);
};
// act