Skip to content

refactor: update flow architecture improvements #454

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
JusterZhu merged 3 commits into from
May 27, 2026
Merged

refactor: update flow architecture improvements #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e047800
refactor: update flow architecture improvements
JusterZhu May 27, 2026
35717a2
fix: update tests for changed defaults and simplified logic
JusterZhu May 27, 2026
bb61051
fix: address Copilot review suggestions
JusterZhu May 27, 2026
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
8 changes: 4 additions & 4 deletions src/c#/DifferentialTest/Pipeline/DiffPipelineOptionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace DifferentialTest.Pipeline
{
/// <summary>
/// 分支覆盖点：
/// 1. MaxDegreeOfParallelism — 默认 = Environment.ProcessorCount
/// 1. MaxDegreeOfParallelism — 默认 = 2
/// 2. StopOnFirstError — 默认 = false
/// 3. DeletePatchAfterApply — 默认 = true
/// 4. 属性 set/get — 修改后正确返回
Expand All @@ -15,12 +15,12 @@ namespace DifferentialTest.Pipeline
/// </summary>
public class DiffPipelineOptionsTests
{
[Fact(DisplayName = "默认构造_MaxDegreeOfParallelism为Environment.ProcessorCount")]
public void DefaultConstructor_MaxDegreeOfParallelism_EqualsProcessorCount()
[Fact(DisplayName = "默认构造_MaxDegreeOfParallelism为2")]
public void DefaultConstructor_MaxDegreeOfParallelism_Equals2()
{
var options = new DiffPipelineOptions();

Assert.Equal(Environment.ProcessorCount, options.MaxDegreeOfParallelism);
Assert.Equal(2, options.MaxDegreeOfParallelism);
}

[Fact(DisplayName = "默认构造_StopOnFirstError为false")]
Expand Down
135 changes: 57 additions & 78 deletions src/c#/GeneralUpdate.Core/Bootstrap/GeneralUpdateBootstrap.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ public void Cancel()
public override async Task<GeneralUpdateBootstrap> LaunchAsync()
{
var appType = GetOption(UpdateOptions.AppType);
_configInfo.AppType = appType;

// Silent mode: start background poll and return immediately
if (appType == AppType.Client && GetOption(UpdateOptions.Silent))
Expand All @@ -75,9 +76,9 @@ public override async Task<GeneralUpdateBootstrap> LaunchAsync()

return appType switch
{
AppType.Client => await LaunchWithStrategy(new ClientUpdateStrategy()),
AppType.Client => await LaunchWithStrategy(new ClientUpdateStrategy()),
AppType.Upgrade => await LaunchWithStrategy(new UpgradeUpdateStrategy()),
AppType.OSSClient => await LaunchWithStrategy(new OSSUpdateStrategy(AppType.OSSClient)),
AppType.OSSClient => await LaunchWithStrategy(new OSSUpdateStrategy(AppType.OSSClient)),
AppType.OSSUpgrade => await LaunchWithStrategy(new OSSUpdateStrategy(AppType.OSSUpgrade)),
_ => await LaunchWithStrategy(new ClientUpdateStrategy())
};
Expand All @@ -94,68 +95,40 @@ private async Task<GeneralUpdateBootstrap> LaunchWithStrategy(IStrategy roleStra

// Resolve hooks and reporter from extensions
var hooks = ResolveExtension<Hooks.IUpdateHooks>() ?? new Hooks.NoOpUpdateHooks();
var reporter = ResolveExtension<Download.Reporting.IUpdateReporter>() ?? new Download.Reporting.NoOpUpdateReporter();
var reporter = ResolveExtension<Download.Reporting.IUpdateReporter>() ??
new Download.Reporting.NoOpUpdateReporter();

// Configure client-specific callbacks
if (roleStrategy is ClientUpdateStrategy clientStrat)
{
clientStrat.Hooks = hooks;
clientStrat.Reporter = reporter;
// Resolve DownloadSource from extension registry (Hub, custom, etc.)
var resolvedSource = ResolveExtension<Download.Abstractions.IDownloadSource>();

// Inject SignalR Hub download source if configured
if (resolvedSource == null)
{
var hubConfig = GetOption(UpdateOptions.Hub);
if (hubConfig != null && !string.IsNullOrEmpty(hubConfig.Url))
{
var hubSource = new Download.Sources.HubDownloadSource(
hubConfig.Url, _configInfo.Token, _configInfo.AppSecretKey);
await hubSource.StartAsync().ConfigureAwait(false);
resolvedSource = hubSource;
GeneralTracer.Info("GeneralUpdateBootstrap: HubDownloadSource started from HubConfig.");
}
}
clientStrat.DownloadSource = resolvedSource;
if (_updatePrecheck != null)
clientStrat.UseUpdatePrecheck(_updatePrecheck);
await CallSmallBowlHomeAsync(_configInfo.Bowl).ConfigureAwait(false);
}
else if (roleStrategy is UpgradeUpdateStrategy upgradeStrat)
{
upgradeStrat.Hooks = hooks;
upgradeStrat.Reporter = reporter;
}
else if (roleStrategy is OSSUpdateStrategy ossStrat)
{
ossStrat.Hooks = hooks;
ossStrat.Reporter = reporter;
}
// ── Phase 1: inject all dependencies before Create ──
roleStrategy.Hooks = hooks;
roleStrategy.Reporter = reporter;

roleStrategy.Create(_configInfo);

var binaryDiffer = ResolveExtension<IBinaryDiffer>();
var dirtyStrategy = ResolveExtension<IDirtyStrategy>();
var diffPipeline = BuildDiffPipeline();

if (roleStrategy is ClientUpdateStrategy cs2)
{
if (binaryDiffer != null) cs2.SetBinaryDiffer(binaryDiffer);
if (dirtyStrategy != null) cs2.SetDirtyStrategy(dirtyStrategy);
}
else if (roleStrategy is UpgradeUpdateStrategy us2)
switch (roleStrategy)
{
if (binaryDiffer != null) us2.SetBinaryDiffer(binaryDiffer);
if (dirtyStrategy != null) us2.SetDirtyStrategy(dirtyStrategy);
case ClientUpdateStrategy cs:
cs.DownloadSource = ResolveExtension<Download.Abstractions.IDownloadSource>();

if (_updatePrecheck != null)
cs.UseUpdatePrecheck(_updatePrecheck);

await CallSmallBowlHomeAsync(_configInfo.Bowl).ConfigureAwait(false);

if (binaryDiffer != null) cs.SetBinaryDiffer(binaryDiffer);
if (dirtyStrategy != null) cs.SetDirtyStrategy(dirtyStrategy);
cs.SetDiffPipeline(diffPipeline);
break;

case UpgradeUpdateStrategy us:
if (binaryDiffer != null) us.SetBinaryDiffer(binaryDiffer);
if (dirtyStrategy != null) us.SetDirtyStrategy(dirtyStrategy);
us.SetDiffPipeline(diffPipeline);
break;
}

// Build DiffPipeline — user‑configured or default with BsdiffDiffer,
// parallelism=2, and progress reporter wired to AddListenerProgress.
var diffPipeline = BuildDiffPipeline();
if (roleStrategy is ClientUpdateStrategy cs3)
cs3.SetDiffPipeline(diffPipeline);
else if (roleStrategy is UpgradeUpdateStrategy us3)
us3.SetDiffPipeline(diffPipeline);
roleStrategy.Create(_configInfo);

// Check custom skip condition before executing update
if (_customSkipOption?.Invoke() == true)
Expand All @@ -173,24 +146,21 @@ private async Task<GeneralUpdateBootstrap> LaunchWithStrategy(IStrategy roleStra
}
finally
{
// Dispose HubDownloadSource if it was started
if (roleStrategy is ClientUpdateStrategy cs && cs.DownloadSource is IAsyncDisposable ad)
await ad.DisposeAsync();
_cts?.Dispose();
_cts = null;
}

return this;
}



// ════════════════════════════════════════════════════════════════
// Configuration
// ════════════════════════════════════════════════════════════════

public GeneralUpdateBootstrap SetConfig(Configinfo configInfo)
{
configInfo.Validate();
_configInfo = ConfigurationMapper.MapToGlobalConfigInfo(configInfo);
{
configInfo.Validate();
_configInfo = ConfigurationMapper.MapToGlobalConfigInfo(configInfo);

var appType = GetOption(UpdateOptions.AppType);
if (appType != AppType.Upgrade)
Expand Down Expand Up @@ -223,7 +193,7 @@ public GeneralUpdateBootstrap SetConfig(string filePath)

// Resolve filename-only paths to current directory
var hasPathChar = filePath.Contains(Path.DirectorySeparatorChar)
|| filePath.Contains(Path.AltDirectorySeparatorChar);
|| filePath.Contains(Path.AltDirectorySeparatorChar);
var fullPath = hasPathChar
? Path.GetFullPath(filePath)
: Path.Combine(AppDomain.CurrentDomain.BaseDirectory, filePath);
Expand Down Expand Up @@ -277,16 +247,18 @@ private void InitializeFromEnvironment()
LastVersion = processInfo.LastVersion,
UpdateLogUrl = processInfo.UpdateLogUrl,
Encoding = Encoding.GetEncoding(processInfo.CompressEncoding),
Format = processInfo.CompressFormat,
Format = ParseFormat(processInfo.CompressFormat),
DownloadTimeOut = processInfo.DownloadTimeOut,
AppSecretKey = processInfo.AppSecretKey,
UpdateVersions = processInfo.UpdateVersions,
TempPath = StorageManager.GetTempDirectory("upgrade_temp"),
TempPath = processInfo.TempPath,
ReportUrl = processInfo.ReportUrl,
BackupDirectory = processInfo.BackupDirectory,
Scheme = processInfo.Scheme,
Token = processInfo.Token,
DriverDirectory = processInfo.DriverDirectory,
UpdatePath = processInfo.UpdatePath,
LaunchClientAfterUpdate = processInfo.LaunchClientAfterUpdate,
BlackFiles = processInfo.BlackFiles ?? BlackListDefaults.DefaultBlackFiles,
BlackFormats = processInfo.BlackFileFormats ?? BlackListDefaults.DefaultBlackFormats,
SkipDirectorys = processInfo.SkipDirectorys ?? BlackListDefaults.DefaultSkipDirectories
Expand All @@ -306,11 +278,7 @@ private void ApplyRuntimeOptions()
{
// Preserve Upgrade path values set by InitializeFromEnvironment()
_configInfo.Encoding ??= GetOption(UpdateOptions.Encoding);
_configInfo.Format ??= GetOption(UpdateOptions.Format);
// Normalize legacy "ZIP" default (UpdateOptions) to Format.ZIP (".zip")
// so the pipeline constructs correct paths and CompressProvider matches its switch.
if (_configInfo.Format == "ZIP")
_configInfo.Format = Format.ZIP;
_configInfo.Format = GetOption(UpdateOptions.Format);
if (_configInfo.DownloadTimeOut <= 0)
_configInfo.DownloadTimeOut = GetOption(UpdateOptions.DownloadTimeout) ?? 60;

Expand Down Expand Up @@ -338,16 +306,15 @@ private async Task LaunchSilentAsync()
GeneralTracer.Info("GeneralUpdateBootstrap: starting silent update mode.");

var pollMinutes = GetOption(UpdateOptions.SilentPollIntervalMinutes);
var autoInstall = GetOption(UpdateOptions.SilentAutoInstall);

var silentOptions = new Silent.SilentOptions
{
PollInterval = TimeSpan.FromMinutes(pollMinutes),
AutoInstall = autoInstall
PollInterval = TimeSpan.FromMinutes(pollMinutes)
};

var hooks = ResolveExtension<Hooks.IUpdateHooks>() ?? new Hooks.NoOpUpdateHooks();
var reporter = ResolveExtension<Download.Reporting.IUpdateReporter>() ?? new Download.Reporting.NoOpUpdateReporter();
var reporter = ResolveExtension<Download.Reporting.IUpdateReporter>() ??
new Download.Reporting.NoOpUpdateReporter();

var orchestrator = new Silent.SilentPollOrchestrator(_configInfo, silentOptions)
.WithHooks(hooks)
Expand All @@ -371,14 +338,26 @@ private DiffPipeline BuildDiffPipeline()
.Build();
}

private static Format ParseFormat(string? compressFormat)
{
if (string.IsNullOrWhiteSpace(compressFormat)) return Format.Zip;
return compressFormat switch
{
".zip" => Format.Zip,
_ => Format.Zip
};
}

private void InitBlackList()
{
// Build blacklist matcher from GlobalConfigInfo and set on StorageManager.
// The matcher combines user config with system defaults.
var effectiveConfig = new BlackListConfig(
_configInfo.BlackFiles?.Count > 0 ? _configInfo.BlackFiles : BlackListDefaults.DefaultBlackFiles,
_configInfo.BlackFormats?.Count > 0 ? _configInfo.BlackFormats : BlackListDefaults.DefaultBlackFormats,
_configInfo.SkipDirectorys?.Count > 0 ? _configInfo.SkipDirectorys : BlackListDefaults.DefaultSkipDirectories
_configInfo.SkipDirectorys?.Count > 0
? _configInfo.SkipDirectorys
: BlackListDefaults.DefaultSkipDirectories
);
StorageManager.BlackListMatcher = new DefaultBlackListMatcher(effectiveConfig);
}
Expand Down Expand Up @@ -449,4 +428,4 @@ public GeneralUpdateBootstrap AddListenerProgress(
AddListener<ProgressEventArgs>((s, e) => listener.OnProgress(e));
return this;
}
}
}
8 changes: 4 additions & 4 deletions src/c#/GeneralUpdate.Core/Compress/CompressProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ public class CompressProvider
{
private CompressProvider() { }

public static void Compress(string compressType, string sourcePath, string destinationPath, bool includeRootDirectory, Encoding encoding)
public static void Compress(Format compressType, string sourcePath, string destinationPath, bool includeRootDirectory, Encoding encoding)
{
var strategy = GetCompressionStrategy(compressType);
strategy.Compress(sourcePath, destinationPath, includeRootDirectory, encoding);
}

public static void Decompress(string compressType, string archivePath, string destinationPath, Encoding encoding)
public static void Decompress(Format compressType, string archivePath, string destinationPath, Encoding encoding)
{
var strategy = GetCompressionStrategy(compressType);
strategy.Decompress(archivePath, destinationPath, encoding);
}

private static ICompressionStrategy GetCompressionStrategy(string compressType) => compressType switch
private static ICompressionStrategy GetCompressionStrategy(Format compressType) => compressType switch
{
Format.ZIP => new ZipCompressionStrategy(),
Format.Zip => new ZipCompressionStrategy(),
_ => throw new ArgumentException("Compression format is not supported!")
};
}
Loading
Loading