mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-07 03:36:44 +02:00
[PTRun]Don't clear config data on upgrade (#30187)
* [PTRun] Implemented a new JSON storage method for PTRun settings files. * [PTRun] Removed uncessary parts. * [PTRun] Spell checks. * [PTRun] New JsonSerializerOptions added for information files. * [PTRun] Unnecessary null check is removed. * [PT Run] - ExtractFields function removed. - Creating instance is used instead of deserializing. * [PTRun] Build fix * [PTRun] Removed unncessary parts * [PTRun] CheckWithInformationFileToClear reversed. * [PTRun] Build fix. * [PTRun] Deserialization is used instead of key by key comparison. * [PTRun] Removed unncessary parts. * [PTRun] Removed unncessary parts. * [PTRun] Remove entry if query is null or empty.
This commit is contained in:
@@ -3,9 +3,11 @@
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using System.IO;
|
||||
using System.IO.Abstractions;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using Wox.Plugin.Logger;
|
||||
|
||||
@@ -20,6 +22,8 @@ namespace Wox.Infrastructure.Storage
|
||||
private static readonly IPath Path = FileSystem.Path;
|
||||
private static readonly IFile File = FileSystem.File;
|
||||
|
||||
private readonly object _saveLock = new object();
|
||||
|
||||
// use property initialization instead of DefaultValueAttribute
|
||||
// easier and flexible for default value of object
|
||||
private static readonly JsonSerializerOptions _serializerOptions = new JsonSerializerOptions
|
||||
@@ -28,6 +32,15 @@ namespace Wox.Infrastructure.Storage
|
||||
IncludeFields = true,
|
||||
PropertyNameCaseInsensitive = true,
|
||||
WriteIndented = true,
|
||||
UnmappedMemberHandling = System.Text.Json.Serialization.JsonUnmappedMemberHandling.Disallow,
|
||||
};
|
||||
|
||||
private static readonly JsonSerializerOptions _deserializerOptions = new JsonSerializerOptions
|
||||
{
|
||||
DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.Never,
|
||||
IncludeFields = true,
|
||||
PropertyNameCaseInsensitive = true,
|
||||
WriteIndented = true,
|
||||
};
|
||||
|
||||
private T _data;
|
||||
@@ -44,20 +57,10 @@ namespace Wox.Infrastructure.Storage
|
||||
private const int _jsonStorage = 1;
|
||||
private StoragePowerToysVersionInfo _storageHelper;
|
||||
|
||||
public T Load()
|
||||
public virtual T Load()
|
||||
{
|
||||
_storageHelper = new StoragePowerToysVersionInfo(FilePath, _jsonStorage);
|
||||
|
||||
// Depending on the version number of the previously installed PT Run, delete the cache if it is found to be incompatible
|
||||
if (_storageHelper.ClearCache)
|
||||
{
|
||||
if (File.Exists(FilePath))
|
||||
{
|
||||
File.Delete(FilePath);
|
||||
Log.Info($"Deleting cached data at <{FilePath}>", GetType());
|
||||
}
|
||||
}
|
||||
|
||||
if (File.Exists(FilePath))
|
||||
{
|
||||
var serialized = File.ReadAllText(FilePath);
|
||||
@@ -82,7 +85,7 @@ namespace Wox.Infrastructure.Storage
|
||||
{
|
||||
try
|
||||
{
|
||||
_data = JsonSerializer.Deserialize<T>(serialized, _serializerOptions);
|
||||
_data = JsonSerializer.Deserialize<T>(serialized, _deserializerOptions);
|
||||
}
|
||||
catch (JsonException e)
|
||||
{
|
||||
@@ -121,18 +124,59 @@ namespace Wox.Infrastructure.Storage
|
||||
}
|
||||
|
||||
public void Save()
|
||||
{
|
||||
lock (_saveLock)
|
||||
{
|
||||
try
|
||||
{
|
||||
string serialized = JsonSerializer.Serialize(_data, _serializerOptions);
|
||||
File.WriteAllText(FilePath, serialized);
|
||||
_storageHelper.Close();
|
||||
|
||||
Log.Info($"Saving cached data at <{FilePath}>", GetType());
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
Log.Exception($"Error in saving data at <{FilePath}>", e, GetType());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public void Clear()
|
||||
{
|
||||
if (File.Exists(FilePath))
|
||||
{
|
||||
File.Delete(FilePath);
|
||||
LoadDefault();
|
||||
Log.Info($"Deleting cached data at <{FilePath}>", GetType());
|
||||
}
|
||||
}
|
||||
|
||||
public bool CheckVersionMismatch()
|
||||
{
|
||||
// Skip the fields check if the version hasn't changed.
|
||||
// This optimization prevents unnecessary fields processing when the cache
|
||||
// is already up to date, enhancing performance and reducing IO operations
|
||||
if (!_storageHelper.ClearCache)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
_storageHelper.ClearCache = false;
|
||||
return true;
|
||||
}
|
||||
|
||||
public bool TryLoadData()
|
||||
{
|
||||
try
|
||||
{
|
||||
string serialized = JsonSerializer.Serialize(_data, _serializerOptions);
|
||||
File.WriteAllText(FilePath, serialized);
|
||||
_storageHelper.Close();
|
||||
|
||||
Log.Info($"Saving cached data at <{FilePath}>", GetType());
|
||||
JsonSerializer.Deserialize<T>(File.ReadAllText(FilePath), _serializerOptions);
|
||||
return true;
|
||||
}
|
||||
catch (IOException e)
|
||||
catch (JsonException e)
|
||||
{
|
||||
Log.Exception($"Error in saving data at <{FilePath}>", e, GetType());
|
||||
Log.Exception($"Error in TryLoadData at <{FilePath}>", e, GetType());
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
// See the LICENSE file in the project root for more information.
|
||||
|
||||
using System.IO.Abstractions;
|
||||
using System.Text.Json;
|
||||
using Wox.Plugin;
|
||||
using Wox.Plugin.Logger;
|
||||
|
||||
namespace Wox.Infrastructure.Storage
|
||||
{
|
||||
@@ -23,5 +25,28 @@ namespace Wox.Infrastructure.Storage
|
||||
|
||||
FilePath = Path.Combine(DirectoryPath, $"{dataType.Name}{FileSuffix}");
|
||||
}
|
||||
|
||||
public override T Load()
|
||||
{
|
||||
var data = base.Load();
|
||||
|
||||
// Check information file for version mismatch
|
||||
try
|
||||
{
|
||||
if (CheckVersionMismatch())
|
||||
{
|
||||
if (!TryLoadData())
|
||||
{
|
||||
Clear();
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (JsonException e)
|
||||
{
|
||||
Log.Exception($"Error in Load of PluginJsonStorage: {e.Message}", e, GetType());
|
||||
}
|
||||
|
||||
return data.NonNull();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user