Mirrored_Repos/wabbajack
1
0
Fork 0
mirror of https://github.com/wabbajack-tools/wabbajack.git synced 2024-08-30 18:42:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added StatusCategory to step logging.

Browse Source 
Gives us a little more information to work with for the design.
This commit is contained in:
Unnoen 2022-01-27 18:20:48 +11:00
parent d8e80bece0
commit 807eb96990
No known key found for this signature in database
GPG Key ID: 8F8E42252BA20553
4 changed files with 39 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Wabbajack.Compiler/ACompiler.cs
View File

@ -51,6 +51,7 @@ public abstract class ACompiler
public ConcurrentDictionary<Directive, RawSourceFile> _sourceFileLinks; public ConcurrentDictionary<Directive, RawSourceFile> _sourceFileLinks;
private string _statusText; private string _statusText;
private string _statusCategory;
public List<IndexedArchive> IndexedArchives = new(); public List<IndexedArchive> IndexedArchives = new();
public Dictionary<Hash, IEnumerable<VirtualFile>> IndexedFiles = new(); public Dictionary<Hash, IEnumerable<VirtualFile>> IndexedFiles = new();
@ -106,16 +107,17 @@ public abstract class ACompiler
public event EventHandler<StatusUpdate> OnStatusUpdate; public event EventHandler<StatusUpdate> OnStatusUpdate;
public void NextStep(string statusText, long maxStepProgress = 1) public void NextStep(string statusCategory, string statusText, long maxStepProgress = 1)
{ {
_updateStopWatch.Restart(); _updateStopWatch.Restart();
_maxStepProgress = maxStepProgress; _maxStepProgress = maxStepProgress;
_currentStep += 1; _currentStep += 1;
_statusText = statusText; _statusText = statusText;
_statusCategory = statusCategory;
_logger.LogInformation("Compiler Step: {Step}", statusText); _logger.LogInformation("Compiler Step: {Step}", statusText);
if (OnStatusUpdate != null) if (OnStatusUpdate != null)
OnStatusUpdate(this, new StatusUpdate($"[{_currentStep}/{MaxSteps}] " + statusText, OnStatusUpdate(this, new StatusUpdate(statusCategory, $"[{_currentStep}/{MaxSteps}] " + statusText,
Percent.FactoryPutInRange(_currentStep, MaxSteps), Percent.FactoryPutInRange(_currentStep, MaxSteps),
Percent.Zero)); Percent.Zero));
} }
@ -131,7 +133,7 @@ public abstract class ACompiler
} }
if (OnStatusUpdate != null) if (OnStatusUpdate != null)
OnStatusUpdate(this, new StatusUpdate(_statusText, Percent.FactoryPutInRange(_currentStep, MaxSteps), OnStatusUpdate(this, new StatusUpdate(_statusCategory, _statusText, Percent.FactoryPutInRange(_currentStep, MaxSteps),
Percent.FactoryPutInRange(_currentStepProgress, _maxStepProgress))); Percent.FactoryPutInRange(_currentStepProgress, _maxStepProgress)));
} }
@ -195,7 +197,7 @@ public abstract class ACompiler
public async Task<bool> GatherMetaData() public async Task<bool> GatherMetaData()
{ {
_logger.LogInformation("Getting meta data for {count} archives", SelectedArchives.Count); _logger.LogInformation("Getting meta data for {count} archives", SelectedArchives.Count);
NextStep("Gathering Metadata", SelectedArchives.Count); NextStep("Building", "Gathering Metadata", SelectedArchives.Count);
await SelectedArchives.PDoAll(CompilerLimiter, async a => await SelectedArchives.PDoAll(CompilerLimiter, async a =>
{ {
UpdateProgress(1); UpdateProgress(1);
@ -208,7 +210,7 @@ public abstract class ACompiler
protected async Task IndexGameFileHashes() protected async Task IndexGameFileHashes()
{ {
NextStep("Indexing Game Files"); NextStep("Compiling", "Indexing Game Files");
if (_settings.UseGamePaths) if (_settings.UseGamePaths)
{ {
//taking the games in Settings.IncludedGames + currently compiling game so you can eg //taking the games in Settings.IncludedGames + currently compiling game so you can eg
@ -258,7 +260,7 @@ public abstract class ACompiler
protected async Task CleanInvalidArchivesAndFillState() protected async Task CleanInvalidArchivesAndFillState()
{ {
NextStep("Cleaning Invalid Archives"); NextStep("Compiling", "Cleaning Invalid Archives");
var remove = await IndexedArchives.PMapAll(CompilerLimiter, async a => var remove = await IndexedArchives.PMapAll(CompilerLimiter, async a =>
{ {
try try
@ -313,7 +315,7 @@ public abstract class ACompiler
.Where(f => f.FileExists()) .Where(f => f.FileExists())
.ToList(); .ToList();
NextStep("InferMetas", toFind.Count); NextStep("Initializing", "InferMetas", toFind.Count);
if (toFind.Count == 0) return; if (toFind.Count == 0) return;
_logger.LogInformation("Attempting to infer {count} metas from the server.", toFind.Count); _logger.LogInformation("Attempting to infer {count} metas from the server.", toFind.Count);
@ -353,7 +355,7 @@ public abstract class ACompiler
protected async Task ExportModList(CancellationToken token) protected async Task ExportModList(CancellationToken token)
{ {
NextStep("Exporting Modlist"); NextStep("Finalizing", "Exporting Modlist");
_logger.LogInformation("Exporting ModList to {location}", _settings.OutputFile); _logger.LogInformation("Exporting ModList to {location}", _settings.OutputFile);
// Modify readme and ModList image to relative paths if they exist // Modify readme and ModList image to relative paths if they exist
@ -431,7 +433,7 @@ public abstract class ACompiler
})) }))
.ToArray(); .ToArray();
NextStep("Generating Patches", toBuild.Length); NextStep("Compiling","Generating Patches", toBuild.Length);
if (toBuild.Length == 0) return; if (toBuild.Length == 0) return;
// Extract all the source files // Extract all the source files
@ -512,7 +514,7 @@ public abstract class ACompiler
public async Task GenerateManifest() public async Task GenerateManifest()
{ {
NextStep("Generating Manifest"); NextStep("Finalizing", "Generating Manifest");
var manifest = new Manifest(ModList); var manifest = new Manifest(ModList);
await using var of = _settings.OutputFile.Open(FileMode.Create, FileAccess.Write); await using var of = _settings.OutputFile.Open(FileMode.Create, FileAccess.Write);
await _dtos.Serialize(manifest, of); await _dtos.Serialize(manifest, of);
@ -520,7 +522,7 @@ public abstract class ACompiler
public async Task GatherArchives() public async Task GatherArchives()
{ {
NextStep("Gathering Archives"); NextStep("Building", "Gathering Archives");
_logger.LogInformation("Building a list of archives based on the files required"); _logger.LogInformation("Building a list of archives based on the files required");
var hashes = InstallDirectives.OfType<FromArchive>() var hashes = InstallDirectives.OfType<FromArchive>()
@ -621,7 +623,7 @@ public abstract class ACompiler
.GroupBy(f => _sourceFileLinks[f].File) .GroupBy(f => _sourceFileLinks[f].File)
.ToDictionary(k => k.Key); .ToDictionary(k => k.Key);
NextStep("Inlining Files"); NextStep("Building", "Inlining Files");
if (grouped.Count == 0) return; if (grouped.Count == 0) return;
await _vfs.Extract(grouped.Keys.ToHashSet(), async (vf, sfn) => await _vfs.Extract(grouped.Keys.ToHashSet(), async (vf, sfn) =>
{ {

10
Wabbajack.Compiler/MO2Compiler.cs
View File

@ -59,12 +59,12 @@ public class MO2Compiler : ACompiler
var roots = new List<AbsolutePath> {Settings.Source, Settings.Downloads}; var roots = new List<AbsolutePath> {Settings.Source, Settings.Downloads};
roots.AddRange(Settings.OtherGames.Append(Settings.Game).Select(g => _locator.GameLocation(g))); roots.AddRange(Settings.OtherGames.Append(Settings.Game).Select(g => _locator.GameLocation(g)));
NextStep("Add Roots"); NextStep("Initializing", "Add Roots");
await _vfs.AddRoots(roots, token); // Step 1 await _vfs.AddRoots(roots, token); // Step 1
await InferMetas(token); // Step 2 await InferMetas(token); // Step 2
NextStep("Add Download Roots"); NextStep("Initializing", "Add Download Roots");
await _vfs.AddRoot(Settings.Downloads, token); // Step 3 await _vfs.AddRoot(Settings.Downloads, token); // Step 3
// Find all Downloads // Find all Downloads
@ -125,14 +125,14 @@ public class MO2Compiler : ACompiler
var stack = MakeStack(); var stack = MakeStack();
NextStep("Running Compilation Stack", AllFiles.Count); NextStep("Compiling", "Running Compilation Stack", AllFiles.Count);
var results = await AllFiles.PMapAll(CompilerLimiter, f => var results = await AllFiles.PMapAll(CompilerLimiter, f =>
{ {
UpdateProgress(1); UpdateProgress(1);
return RunStack(stack, f); return RunStack(stack, f);
}).ToList(); }).ToList();
NextStep("Updating Extra files"); NextStep("Compiling", "Updating Extra files");
// Add the extra files that were generated by the stack // Add the extra files that were generated by the stack
results = results.Concat(ExtraFiles).ToList(); results = results.Concat(ExtraFiles).ToList();
@ -184,7 +184,7 @@ public class MO2Compiler : ACompiler
private async Task RunValidation(ModList modList) private async Task RunValidation(ModList modList)
{ {
NextStep("Validating Archives", modList.Archives.Length); NextStep("Finalizing", "Validating Archives", modList.Archives.Length);
var allowList = await _wjClient.LoadDownloadAllowList(); var allowList = await _wjClient.LoadDownloadAllowList();
foreach (var archive in modList.Archives) foreach (var archive in modList.Archives)
{ {

33
Wabbajack.Installer/AInstaller.cs
View File

@ -26,7 +26,7 @@ using Wabbajack.VFS;
namespace Wabbajack.Installer; namespace Wabbajack.Installer;
public record StatusUpdate(string StatusText, Percent StepsProgress, Percent StepProgress) public record StatusUpdate(string StatusCategory, string StatusText, Percent StepsProgress, Percent StepProgress)
{ {
} }
@ -57,6 +57,7 @@ public abstract class AInstaller<T>
protected long MaxStepProgress { get; set; } protected long MaxStepProgress { get; set; }
private string _statusCategory;
private string _statusText; private string _statusText;
private readonly Stopwatch _updateStopWatch = new(); private readonly Stopwatch _updateStopWatch = new();
@ -92,15 +93,16 @@ public abstract class AInstaller<T>
public ModList ModList => _configuration.ModList; public ModList ModList => _configuration.ModList;
public void NextStep(string statusText, long maxStepProgress) public void NextStep(string statusCategory, string statusText, long maxStepProgress)
{ {
_updateStopWatch.Restart(); _updateStopWatch.Restart();
MaxStepProgress = maxStepProgress; MaxStepProgress = maxStepProgress;
_currentStep += 1; _currentStep += 1;
_statusText = statusText; _statusText = statusText;
_statusCategory = statusCategory;
_logger.LogInformation("Next Step: {Step}", statusText); _logger.LogInformation("Next Step: {Step}", statusText);
OnStatusUpdate?.Invoke(new StatusUpdate($"[{_currentStep}/{MaxSteps}] " + statusText, OnStatusUpdate?.Invoke(new StatusUpdate(statusCategory, statusText,
Percent.FactoryPutInRange(_currentStep, MaxSteps), Percent.Zero)); Percent.FactoryPutInRange(_currentStep, MaxSteps), Percent.Zero));
} }
@ -108,8 +110,7 @@ public abstract class AInstaller<T>
{ {
Interlocked.Add(ref _currentStepProgress, stepProgress); Interlocked.Add(ref _currentStepProgress, stepProgress);
OnStatusUpdate?.Invoke(new StatusUpdate($"[{_currentStep}/{MaxSteps}] " + _statusText, Percent.FactoryPutInRange(_currentStep, MaxSteps), OnStatusUpdate?.Invoke(new StatusUpdate(_statusCategory, _statusText, Percent.FactoryPutInRange(_currentStep, MaxSteps), Percent.FactoryPutInRange(_currentStepProgress, MaxStepProgress)));
Percent.FactoryPutInRange(_currentStepProgress, MaxStepProgress)));
} }
public abstract Task<bool> Begin(CancellationToken token); public abstract Task<bool> Begin(CancellationToken token);
@ -119,7 +120,7 @@ public abstract class AInstaller<T>
ExtractedModlistFolder = _manager.CreateFolder(); ExtractedModlistFolder = _manager.CreateFolder();
await using var stream = _configuration.ModlistArchive.Open(FileMode.Open, FileAccess.Read, FileShare.Read); await using var stream = _configuration.ModlistArchive.Open(FileMode.Open, FileAccess.Read, FileShare.Read);
using var archive = new ZipArchive(stream, ZipArchiveMode.Read); using var archive = new ZipArchive(stream, ZipArchiveMode.Read);
NextStep("Extracting Modlist", archive.Entries.Count); NextStep("Preparing","Extracting Modlist", archive.Entries.Count);
foreach (var entry in archive.Entries) foreach (var entry in archive.Entries)
{ {
var path = entry.FullName.ToRelativePath().RelativeTo(ExtractedModlistFolder); var path = entry.FullName.ToRelativePath().RelativeTo(ExtractedModlistFolder);
@ -181,7 +182,7 @@ public abstract class AInstaller<T>
/// </summary> /// </summary>
protected async Task PrimeVFS() protected async Task PrimeVFS()
{ {
NextStep("Priming VFS", 0); NextStep("Preparing","Priming VFS", 0);
_vfs.AddKnown(_configuration.ModList.Directives.OfType<FromArchive>().Select(d => d.ArchiveHashPath), _vfs.AddKnown(_configuration.ModList.Directives.OfType<FromArchive>().Select(d => d.ArchiveHashPath),
HashedArchives); HashedArchives);
await _vfs.BackfillMissing(); await _vfs.BackfillMissing();
@ -189,7 +190,7 @@ public abstract class AInstaller<T>
public async Task BuildFolderStructure() public async Task BuildFolderStructure()
{ {
NextStep("Building Folder Structure", 0); NextStep("Preparing", "Building Folder Structure", 0);
_logger.LogInformation("Building Folder Structure"); _logger.LogInformation("Building Folder Structure");
ModList.Directives ModList.Directives
.Where(d => d.To.Depth > 1) .Where(d => d.To.Depth > 1)
@ -200,7 +201,7 @@ public abstract class AInstaller<T>
public async Task InstallArchives(CancellationToken token) public async Task InstallArchives(CancellationToken token)
{ {
NextStep("Installing files", ModList.Directives.Sum(d => d.Size)); NextStep("Installing", "Installing files", ModList.Directives.Sum(d => d.Size));
var grouped = ModList.Directives var grouped = ModList.Directives
.OfType<FromArchive>() .OfType<FromArchive>()
.Select(a => new {VF = _vfs.Index.FileForArchiveHashPath(a.ArchiveHashPath), Directive = a}) .Select(a => new {VF = _vfs.Index.FileForArchiveHashPath(a.ArchiveHashPath), Directive = a})
@ -302,7 +303,7 @@ public abstract class AInstaller<T>
} }
_logger.LogInformation("Downloading {count} archives", missing.Count); _logger.LogInformation("Downloading {count} archives", missing.Count);
NextStep("Downloading files", missing.Count); NextStep("Downloading", "Downloading files", missing.Count);
await missing await missing
.OrderBy(a => a.Size) .OrderBy(a => a.Size)
@ -363,7 +364,7 @@ public abstract class AInstaller<T>
public async Task HashArchives(CancellationToken token) public async Task HashArchives(CancellationToken token)
{ {
NextStep("Hashing Archives", 0); NextStep("Hashing", "Hashing Archives", 0);
_logger.LogInformation("Looking for files to hash"); _logger.LogInformation("Looking for files to hash");
var allFiles = _configuration.Downloads.EnumerateFiles() var allFiles = _configuration.Downloads.EnumerateFiles()
@ -414,7 +415,7 @@ public abstract class AInstaller<T>
var savePath = (RelativePath) "saves"; var savePath = (RelativePath) "saves";
var existingFiles = _configuration.Install.EnumerateFiles().ToList(); var existingFiles = _configuration.Install.EnumerateFiles().ToList();
NextStep("Optimizing Modlist: Looking for files to delete", existingFiles.Count); NextStep("Preparing", "Looking for files to delete", existingFiles.Count);
await existingFiles await existingFiles
.PDoAll(async f => .PDoAll(async f =>
{ {
@ -428,12 +429,12 @@ public abstract class AInstaller<T>
if (NoDeleteRegex.IsMatch(f.ToString())) if (NoDeleteRegex.IsMatch(f.ToString()))
return; return;
_logger.LogInformation("Deleting {relativeTo} it's not part of this ModList", relativeTo); _logger.LogTrace("Deleting {relativeTo} it's not part of this ModList", relativeTo);
f.Delete(); f.Delete();
}); });
_logger.LogInformation("Cleaning empty folders"); _logger.LogInformation("Cleaning empty folders");
NextStep("Optimizing Modlist: Cleaning empty folders", indexed.Keys.Count); NextStep("Preparing", "Cleaning empty folders", indexed.Keys.Count);
var expectedFolders = (indexed.Keys var expectedFolders = (indexed.Keys
.Select(f => f.RelativeTo(_configuration.Install)) .Select(f => f.RelativeTo(_configuration.Install))
// We ignore the last part of the path, so we need a dummy file name // We ignore the last part of the path, so we need a dummy file name
@ -468,7 +469,7 @@ public abstract class AInstaller<T>
var existingfiles = _configuration.Install.EnumerateFiles().ToHashSet(); var existingfiles = _configuration.Install.EnumerateFiles().ToHashSet();
NextStep("Optimizing Modlist: Removing redundant directives", indexed.Count); NextStep("Preparing", "Removing redundant directives", indexed.Count);
await indexed.Values.PMapAll<Directive, Directive?>(async d => await indexed.Values.PMapAll<Directive, Directive?>(async d =>
{ {
// Bit backwards, but we want to return null for // Bit backwards, but we want to return null for
@ -487,7 +488,7 @@ public abstract class AInstaller<T>
_logger.LogInformation("Optimized {optimized} directives to {indexed} required", ModList.Directives.Length, _logger.LogInformation("Optimized {optimized} directives to {indexed} required", ModList.Directives.Length,
indexed.Count); indexed.Count);
NextStep("Finalizing modlist optimization", 0); NextStep("Preparing", "Finalizing modlist optimization", 0);
var requiredArchives = indexed.Values.OfType<FromArchive>() var requiredArchives = indexed.Values.OfType<FromArchive>()
.GroupBy(d => d.ArchiveHashPath.Hash) .GroupBy(d => d.ArchiveHashPath.Hash)
.Select(d => d.Key) .Select(d => d.Key)

6
Wabbajack.Installer/StandardInstaller.cs
View File

@ -61,7 +61,7 @@ public class StandardInstaller : AInstaller<StandardInstaller>
{ {
if (token.IsCancellationRequested) return false; if (token.IsCancellationRequested) return false;
await _wjClient.SendMetric(MetricNames.BeginInstall, ModList.Name); await _wjClient.SendMetric(MetricNames.BeginInstall, ModList.Name);
NextStep("Configuring Installer", 0); NextStep("Preparing", "Configuring Installer", 0);
_logger.LogInformation("Configuring Processor"); _logger.LogInformation("Configuring Processor");
if (_configuration.GameFolder == default) if (_configuration.GameFolder == default)
@ -145,7 +145,7 @@ public class StandardInstaller : AInstaller<StandardInstaller>
await ExtractedModlistFolder!.DisposeAsync(); await ExtractedModlistFolder!.DisposeAsync();
await _wjClient.SendMetric(MetricNames.FinishInstall, ModList.Name); await _wjClient.SendMetric(MetricNames.FinishInstall, ModList.Name);
NextStep("Finished", 1); NextStep("Finished", "Finished", 1);
_logger.LogInformation("Finished Installation"); _logger.LogInformation("Finished Installation");
return true; return true;
} }
@ -275,7 +275,7 @@ public class StandardInstaller : AInstaller<StandardInstaller>
private async Task InstallIncludedFiles(CancellationToken token) private async Task InstallIncludedFiles(CancellationToken token)
{ {
_logger.LogInformation("Writing inline files"); _logger.LogInformation("Writing inline files");
NextStep("Installing Included Files", ModList.Directives.OfType<InlineFile>().Count()); NextStep("Installing", "Installing Included Files", ModList.Directives.OfType<InlineFile>().Count());
await ModList.Directives await ModList.Directives
.OfType<InlineFile>() .OfType<InlineFile>()
.PDoAll(async directive => .PDoAll(async directive =>