DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 13:28:33 +00:00
Code Issues Releases Wiki Activity

Workshop - Refactor InstalledEntry to not implement IEntryDetails

Browse Source 
This turned out to be a hassle
This commit is contained in:
Robert 2024-07-22 14:42:17 +02:00
parent a45d98c171
commit 9001a12625
3 changed files with 192 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Artemis.UI/Services/Updating/WorkshopUpdateService.cs
View File

@ -54,14 +54,16 @@ public class WorkshopUpdateService : IWorkshopUpdateService
_updateNotificationProvider.Value.ShowWorkshopNotification(updatedEntries);
}
public async Task<bool> AutoUpdateEntry(InstalledEntry entry)
public async Task<bool> AutoUpdateEntry(InstalledEntry installedEntry)
{
// Query the latest version
IOperationResult<IGetEntryLatestReleaseByIdResult> latestReleaseResult = await _client.GetEntryLatestReleaseById.ExecuteAsync(entry.Id);
IOperationResult<IGetEntryLatestReleaseByIdResult> latestReleaseResult = await _client.GetEntryLatestReleaseById.ExecuteAsync(installedEntry.Id);
IGetEntryById_Entry_LatestRelease_Entry? entry = latestReleaseResult.Data?.Entry?.LatestRelease?.Entry;
if (entry == null)
return false;
if (latestReleaseResult.Data?.Entry?.LatestRelease is not IRelease latestRelease)
return false;
if (latestRelease.Id == entry.ReleaseId)
if (latestRelease.Id == installedEntry.ReleaseId)
return false;
_logger.Information("Auto-updating entry {Entry} to version {Version}", entry, latestRelease.Version);
@ -72,7 +74,7 @@ public class WorkshopUpdateService : IWorkshopUpdateService
// This happens during installation too but not on our reference of the entry
if (updateResult.IsSuccess)
entry.ApplyRelease(latestRelease);
installedEntry.ApplyRelease(latestRelease);
if (updateResult.IsSuccess)
_logger.Information("Auto-update successful for entry {Entry}", entry);

349
src/Artemis.WebClient.Workshop/Models/InstalledEntry.cs
View File

@ -6,22 +6,22 @@ using Artemis.Storage.Entities.Workshop;
namespace Artemis.WebClient.Workshop.Models;
public class InstalledEntry : CorePropertyChanged, IEntrySummary
public class InstalledEntry : CorePropertyChanged
{
private Dictionary<string, JsonNode> _metadata = new();
private long _id;
private string _author;
private bool _isOfficial;
private string _name;
private string _summary;
private EntryType _entryType;
private long _downloads;
private bool _autoUpdate;
private IReadOnlyList<InstalledEntryCategory> _categories;
private DateTimeOffset _createdAt;
private long _downloads;
private EntryType _entryType;
private long _id;
private bool _isOfficial;
private long? _latestReleaseId;
private IReadOnlyList<IGetDependantEntries_Entries_Items_Categories> _categories;
private Dictionary<string, JsonNode> _metadata = new();
private string _name;
private long _releaseId;
private string _releaseVersion = string.Empty;
private bool _autoUpdate;
private string _summary;
internal InstalledEntry(EntryEntity entity)
{
@ -40,7 +40,6 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
AutoUpdate = true;
}
internal EntryEntity Entity { get; }
public DateTimeOffset InstalledAt { get; set; }
public long ReleaseId
@ -61,6 +60,164 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
set => SetAndNotify(ref _autoUpdate, value);
}
public long Id
{
get => _id;
private set => SetAndNotify(ref _id, value);
}
public string Author
{
get => _author;
private set => SetAndNotify(ref _author, value);
}
public bool IsOfficial
{
get => _isOfficial;
private set => SetAndNotify(ref _isOfficial, value);
}
public string Name
{
get => _name;
private set => SetAndNotify(ref _name, value);
}
public string Summary
{
get => _summary;
private set => SetAndNotify(ref _summary, value);
}
public EntryType EntryType
{
get => _entryType;
private set => SetAndNotify(ref _entryType, value);
}
public long Downloads
{
get => _downloads;
private set => SetAndNotify(ref _downloads, value);
}
public DateTimeOffset CreatedAt
{
get => _createdAt;
private set => SetAndNotify(ref _createdAt, value);
}
public long? LatestReleaseId
{
get => _latestReleaseId;
private set => SetAndNotify(ref _latestReleaseId, value);
}
public IReadOnlyList<InstalledEntryCategory> Categories
{
get => _categories;
private set => SetAndNotify(ref _categories, value);
}
internal EntryEntity Entity { get; }
/// <summary>
/// Gets the metadata value associated with the specified key.
/// </summary>
/// <param name="key">The key of the value to get.</param>
/// <param name="value">
/// When this method returns, contains the value associated with the specified key, if the key is found and of type
/// <typeparamref name="T" />;
/// otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
/// </param>
/// <typeparam name="T">The type of the value.</typeparam>
/// <returns>
/// <see langword="true" /> if the metadata contains an element with the specified key; otherwise,
/// <see langword="false" />.
/// </returns>
public bool TryGetMetadata<T>(string key, [NotNullWhen(true)] out T? value)
{
if (!_metadata.TryGetValue(key, out JsonNode? element))
{
value = default;
return false;
}
value = element.GetValue<T>();
return value != null;
}
/// <summary>
/// Sets metadata with the provided key to the provided value.
/// </summary>
/// <param name="key">The key of the value to set</param>
/// <param name="value">The value to set.</param>
public void SetMetadata(string key, object value)
{
_metadata[key] = JsonSerializer.SerializeToNode(value) ?? throw new InvalidOperationException();
}
/// <summary>
/// Removes metadata with the provided key.
/// </summary>
/// <param name="key">The key of the metadata to remove</param>
/// <returns><see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
public bool RemoveMetadata(string key)
{
return _metadata.Remove(key);
}
/// <summary>
/// Returns the directory info of the entry, where any files would be stored if applicable.
/// </summary>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetDirectory()
{
return new DirectoryInfo(Path.Combine(Constants.WorkshopFolder, $"{Id}-{StringUtilities.UrlFriendly(Name)}"));
}
/// <summary>
/// Returns the directory info of a release of this entry, where any files would be stored if applicable.
/// </summary>
/// <param name="release">The release to use, if none provided the current release is used.</param>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetReleaseDirectory(IRelease? release = null)
{
return new DirectoryInfo(Path.Combine(GetDirectory().FullName, StringUtilities.UrlFriendly(release?.Version ?? ReleaseVersion)));
}
/// <summary>
/// Applies the provided release to the installed entry.
/// </summary>
/// <param name="release">The release to apply.</param>
public void ApplyRelease(IRelease release)
{
ReleaseId = release.Id;
ReleaseVersion = release.Version;
InstalledAt = DateTimeOffset.UtcNow;
}
public void ApplyEntrySummary(IEntrySummary entry)
{
Id = entry.Id;
Author = entry.Author;
IsOfficial = entry.IsOfficial;
Name = entry.Name;
Summary = entry.Summary;
EntryType = entry.EntryType;
Downloads = entry.Downloads;
CreatedAt = entry.CreatedAt;
LatestReleaseId = entry.LatestReleaseId;
Categories = entry.Categories.Select(c => new InstalledEntryCategory(c.Name, c.Icon)).ToList();
}
public override string ToString()
{
return $"[{EntryType}] {Id} - {Name}";
}
internal void Load()
{
Id = Entity.EntryId;
@ -72,8 +229,8 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
Downloads = Entity.Downloads;
CreatedAt = Entity.CreatedAt;
LatestReleaseId = Entity.LatestReleaseId;
Categories = Entity.Categories?.Select(c => new GetDependantEntries_Entries_Items_Categories_Category(c.Name, c.Icon)).ToList() ?? [];
Categories = Entity.Categories?.Select(c => new InstalledEntryCategory(c.Name, c.Icon)).ToList() ?? [];
ReleaseId = Entity.ReleaseId;
ReleaseVersion = Entity.ReleaseVersion;
InstalledAt = Entity.InstalledAt;
@ -100,171 +257,7 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
Entity.ReleaseVersion = ReleaseVersion;
Entity.InstalledAt = InstalledAt;
Entity.AutoUpdate = AutoUpdate;
Entity.Metadata = new Dictionary<string, JsonNode>(_metadata);
}
/// <summary>
/// Gets the metadata value associated with the specified key.
/// </summary>
/// <param name="key">The key of the value to get.</param>
/// <param name="value">When this method returns, contains the value associated with the specified key, if the key is found and of type <typeparamref name="T"/>;
/// otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.</param>
/// <typeparam name="T">The type of the value.</typeparam>
/// <returns><see langword="true"/> if the metadata contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
public bool TryGetMetadata<T>(string key, [NotNullWhen(true)] out T? value)
{
if (!_metadata.TryGetValue(key, out JsonNode? element))
{
value = default;
return false;
}
value = element.GetValue<T>();
return value != null;
}
/// <summary>
/// Sets metadata with the provided key to the provided value.
/// </summary>
/// <param name="key">The key of the value to set</param>
/// <param name="value">The value to set.</param>
public void SetMetadata(string key, object value)
{
_metadata[key] = JsonSerializer.SerializeToNode(value) ?? throw new InvalidOperationException();
}
/// <summary>
/// Removes metadata with the provided key.
/// </summary>
/// <param name="key">The key of the metadata to remove</param>
/// <returns><see langword="true"/> if the element is successfully found and removed; otherwise, <see langword="false"/>.</returns>
public bool RemoveMetadata(string key)
{
return _metadata.Remove(key);
}
/// <summary>
/// Returns the directory info of the entry, where any files would be stored if applicable.
/// </summary>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetDirectory()
{
return new DirectoryInfo(Path.Combine(Constants.WorkshopFolder, $"{Id}-{StringUtilities.UrlFriendly(Name)}"));
}
/// <summary>
/// Returns the directory info of a release of this entry, where any files would be stored if applicable.
/// </summary>
/// <param name="release">The release to use, if none provided the current release is used.</param>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetReleaseDirectory(IRelease? release = null)
{
return new DirectoryInfo(Path.Combine(GetDirectory().FullName, StringUtilities.UrlFriendly(release?.Version ?? ReleaseVersion)));
}
/// <summary>
/// Applies the provided release to the installed entry.
/// </summary>
/// <param name="release">The release to apply.</param>
public void ApplyRelease(IRelease release)
{
ReleaseId = release.Id;
ReleaseVersion = release.Version;
InstalledAt = DateTimeOffset.UtcNow;
}
public void ApplyEntrySummary(IEntrySummary entry)
{
Id = entry.Id;
Author = entry.Author;
IsOfficial = entry.IsOfficial;
Name = entry.Name;
Summary = entry.Summary;
EntryType = entry.EntryType;
Downloads = entry.Downloads;
CreatedAt = entry.CreatedAt;
LatestReleaseId = entry.LatestReleaseId;
Categories = entry.Categories;
}
#region Implementation of IEntrySummary
/// <inheritdoc />
public long Id
{
get => _id;
private set => SetAndNotify(ref _id, value);
}
/// <inheritdoc />
public string Author
{
get => _author;
private set => SetAndNotify(ref _author, value);
}
/// <inheritdoc />
public bool IsOfficial
{
get => _isOfficial;
private set => SetAndNotify(ref _isOfficial, value);
}
/// <inheritdoc />
public string Name
{
get => _name;
private set => SetAndNotify(ref _name, value);
}
/// <inheritdoc />
public string Summary
{
get => _summary;
private set => SetAndNotify(ref _summary, value);
}
/// <inheritdoc />
public EntryType EntryType
{
get => _entryType;
private set => SetAndNotify(ref _entryType, value);
}
/// <inheritdoc />
public long Downloads
{
get => _downloads;
private set => SetAndNotify(ref _downloads, value);
}
/// <inheritdoc />
public DateTimeOffset CreatedAt
{
get => _createdAt;
private set => SetAndNotify(ref _createdAt, value);
}
/// <inheritdoc />
public long? LatestReleaseId
{
get => _latestReleaseId;
private set => SetAndNotify(ref _latestReleaseId, value);
}
/// <inheritdoc />
public IReadOnlyList<IGetDependantEntries_Entries_Items_Categories> Categories
{
get => _categories;
private set => SetAndNotify(ref _categories, value);
}
#endregion
/// <inheritdoc />
public override string ToString()
{
return $"[{EntryType}] {Id} - {Name}";
}
}

14
src/Artemis.WebClient.Workshop/Models/InstalledEntryCategory.cs Normal file
View File

@ -0,0 +1,14 @@
namespace Artemis.WebClient.Workshop.Models;
public class InstalledEntryCategory
{
public InstalledEntryCategory(string name, string icon)
{
Name = name;
Icon = icon;
}
public string Name { get; }
public string Icon { get; }
}