Skip to content

Improved installer progress messages and no longer timeout when setup/upgrade taking a long time to complete #4835

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
andreasohlund merged 4 commits into from
Feb 25, 2025
Merged

Improved installer progress messages and no longer timeout when setup/upgrade taking a long time to complete #4835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4309376
Use correct name for the instance setup phase
andreasohlund Feb 24, 2025
36b7e38
Cleanup
andreasohlund Feb 24, 2025
340f688
Added 'can take a very long time'
ramonsmits Feb 25, 2025
59702e9
Apply suggestions from code review
andreasohlund Feb 25, 2025
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
4 changes: 2 additions & 2 deletions src/ServiceControl.Config/Framework/Modules/InstallerModule.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ internal async Task<ReportCard> Add(ServiceControlInstallableBase details, IProg
{
progress.Report(5, 9, "Registering URL ACLs...");
instanceInstaller.RegisterUrlAcl();
progress.Report(6, 9, "Creating queues...");
progress.Report(6, 9, "Instance setup in progress, this could take several minutes...");
instanceInstaller.SetupInstance();
}
catch (Exception ex)
Expand Down Expand Up @@ -141,7 +141,7 @@ internal ReportCard Upgrade(ServiceControlBaseService instance, ServiceControlUp

UpgradeOptions(upgradeOptions, instance);

progress.Report(++currentStep, totalSteps, "Running Queue Creation...");
progress.Report(++currentStep, totalSteps, "Instance setup in progress, this could take several minutes...");
instance.SetupInstance();

instance.ReportCard.SetStatus();
Expand Down
18 changes: 5 additions & 13 deletions src/ServiceControlInstaller.Engine/Instances/MonitoringInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
using Configuration;
using Configuration.Monitoring;
using FileSystem;
using Queues;
using ReportCard;
using Services;
using Setup;
using UrlAcl;
using Validation;

Expand Down Expand Up @@ -188,13 +188,9 @@ public void ApplyConfigChange()
{
try
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}
catch (QueueCreationFailedException ex)
{
ReportCard.Errors.Add(ex.Message);
}
catch (QueueCreationTimeoutException ex)
catch (Exception ex)
{
ReportCard.Errors.Add(ex.Message);
}
Expand Down Expand Up @@ -278,13 +274,9 @@ public void SetupInstance()
{
try
{
QueueCreation.RunQueueCreation(this);
}
catch (QueueCreationFailedException ex)
{
ReportCard.Errors.Add(ex.Message);
InstanceSetup.Run(this);
}
catch (QueueCreationTimeoutException ex)
catch (Exception ex)
{
ReportCard.Errors.Add(ex.Message);
}
Expand Down
10 changes: 3 additions & 7 deletions src/ServiceControlInstaller.Engine/Instances/MonitoringNewInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
using Configuration.Monitoring;
using FileSystem;
using NuGet.Versioning;
using Queues;
using Setup;
using ReportCard;
using Services;
using UrlAcl;
Expand Down Expand Up @@ -148,13 +148,9 @@ public void SetupInstance()
{
try
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}
catch (QueueCreationFailedException ex)
{
ReportCard.Errors.Add(ex.Message);
}
catch (QueueCreationTimeoutException ex)
catch (Exception ex)
{
ReportCard.Errors.Add(ex.Message);
}
Expand Down
10 changes: 5 additions & 5 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlAuditInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ namespace ServiceControlInstaller.Engine.Instances
using Configuration;
using Configuration.ServiceControl;
using FileSystem;
using Queues;
using ServiceControlInstaller.Engine.Validation;
using Setup;
using Validation;
using Services;

public class ServiceControlAuditInstance : ServiceControlBaseService, IServiceControlAuditInstance
Expand Down Expand Up @@ -57,7 +57,7 @@ protected override AppConfig CreateAppConfig()
protected override TransportInfo DetermineTransportPackage()
{
var transportAppSetting = (AppConfig.Read<string>(AuditInstanceSettingsList.TransportType, null)?.Trim())
?? throw new Exception($"{AuditInstanceSettingsList.TransportType.Name} setting not found in app.config.");
?? throw new Exception($"{AuditInstanceSettingsList.TransportType.Name} setting not found in app.config.");

var transport = ServiceControlCoreTransports.Find(transportAppSetting);

Expand Down Expand Up @@ -102,9 +102,9 @@ public override void Reload()
EnableFullTextSearchOnBodies = AppConfig.Read(AuditInstanceSettingsList.EnableFullTextSearchOnBodies, true);
}

public override void RunQueueCreation()
public override void RunSetup()
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}

protected override void Prepare(string zipResourceName, string destDir)
Expand Down
7 changes: 3 additions & 4 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlAuditNewInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
{
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using Configuration.ServiceControl;
using Queues;
using Setup;
using Services;
using Validation;

Expand Down Expand Up @@ -58,9 +57,9 @@ internal override WindowsServiceDetails GetWindowsServiceDetails()
};
}

protected override void RunQueueCreation()
protected override void RunSetup()
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}

protected override void ValidateMaintenancePort()
Expand Down
11 changes: 3 additions & 8 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlBaseService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ namespace ServiceControlInstaller.Engine.Instances
using Configuration;
using FileSystem;
using NuGet.Versioning;
using Queues;
using ReportCard;
using Services;
using UrlAcl;
Expand Down Expand Up @@ -383,19 +382,15 @@ public void RestoreAppConfig(string sourcePath)
AppConfig.Save();
}

public abstract void RunQueueCreation();
public abstract void RunSetup();

public void SetupInstance()
{
try
{
RunQueueCreation();
RunSetup();
}
catch (QueueCreationFailedException ex)
{
ReportCard.Errors.Add(ex.Message);
}
catch (QueueCreationTimeoutException ex)
catch (Exception ex)
{
ReportCard.Errors.Add(ex.Message);
}
Expand Down
11 changes: 3 additions & 8 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlInstallableBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
using Accounts;
using FileSystem;
using NuGet.Versioning;
using Queues;
using ReportCard;
using Services;
using UrlAcl;
Expand Down Expand Up @@ -197,7 +196,7 @@ protected List<string> GetServiceDependencies()

internal abstract WindowsServiceDetails GetWindowsServiceDetails();

protected abstract void RunQueueCreation();
protected abstract void RunSetup();

public void RegisterUrlAcl()
{
Expand All @@ -221,13 +220,9 @@ public void SetupInstance()
{
try
{
RunQueueCreation();
RunSetup();
}
catch (QueueCreationFailedException ex)
{
ReportCard.Errors.Add(ex.Message);
}
catch (QueueCreationTimeoutException ex)
catch (Exception ex)
{
ReportCard.Errors.Add(ex.Message);
}
Expand Down
6 changes: 3 additions & 3 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ namespace ServiceControlInstaller.Engine.Instances
using Configuration;
using Configuration.ServiceControl;
using FileSystem;
using Queues;
using Services;
using Setup;
using Validation;

using AppConfig = Configuration.ServiceControl.AppConfig;
Expand Down Expand Up @@ -56,9 +56,9 @@ protected override AppConfig CreateAppConfig()
return new ServiceControlAppConfig(this);
}

public override void RunQueueCreation()
public override void RunSetup()
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}

protected override void ValidateQueueNames()
Expand Down
6 changes: 3 additions & 3 deletions src/ServiceControlInstaller.Engine/Instances/ServiceControlNewInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ namespace ServiceControlInstaller.Engine.Instances
using System.Xml;
using System.Xml.Serialization;
using Configuration.ServiceControl;
using Queues;
using Services;
using Setup;
using Validation;

public class ServiceControlNewInstance : ServiceControlInstallableBase, IServiceControlInstance
Expand Down Expand Up @@ -85,9 +85,9 @@ internal override WindowsServiceDetails GetWindowsServiceDetails()
};
}

protected override void RunQueueCreation()
protected override void RunSetup()
{
QueueCreation.RunQueueCreation(this);
InstanceSetup.Run(this);
}

protected override void ValidateMaintenancePort()
Expand Down
77 changes: 0 additions & 77 deletions src/ServiceControlInstaller.Engine/Queues/QueueCreation.cs
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions src/ServiceControlInstaller.Engine/Queues/QueueCreationException.cs
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions src/ServiceControlInstaller.Engine/Queues/QueueCreationTimeoutException.cs
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions src/ServiceControlInstaller.Engine/Queues/ServiceControlQueueCreationTimeoutException.cs
View file
Open in desktop

This file was deleted.

Loading