private static object GetInstruction(InstallInstructions installModel, InstallTrackingItem item,
InstallSetupStep step)
{
installModel.Instructions.TryGetValue(item.Name, out var instruction); // else null
if (instruction is JObject jObject)
{
instruction = jObject?.ToObject(step.StepType);
}
return(instruction);
}
/// <summary>
/// We'll peek ahead and check if it's RequiresExecution is returning true. If it
/// is not, we'll dequeue that step and peek ahead again (recurse)
/// </summary>
/// <param name="current"></param>
/// <param name="queue"></param>
/// <param name="installId"></param>
/// <param name="installModel"></param>
/// <returns></returns>
private string IterateSteps(InstallSetupStep current, Queue <InstallTrackingItem> queue, Guid installId,
InstallInstructions installModel)
{
while (queue.Count > 0)
{
var item = queue.Peek();
// if the current step restarts the app pool then we must simply return the next one in the queue,
// we cannot peek ahead as the next step might rely on the app restart and therefore RequiresExecution
// will rely on that too.
if (current.PerformsAppRestart)
{
return(item.Name);
}
var step = _installSteps.GetAllSteps().Single(x => x.Name == item.Name);
// if this step has any instructions then extract them
var instruction = GetInstruction(installModel, item, step);
// if the step requires execution then return its name
if (StepRequiresExecution(step, instruction))
{
return(step.Name);
}
// no longer requires execution, could be due to a new config change during installation
// dequeue
queue.Dequeue();
// complete
_installStatusTracker.SetComplete(installId, step.Name);
// and continue
current = step;
}
return(string.Empty);
}
/// <summary>
/// We'll peek ahead and check if it's RequiresExecution is returning true. If it
/// is not, we'll dequeue that step and peek ahead again (recurse)
/// </summary>
/// <param name="current"></param>
/// <param name="queue"></param>
/// <param name="installId"></param>
/// <param name="installModel"></param>
/// <returns></returns>
private string IterateNextRequiredStep(InstallSetupStep current, Queue <InstallTrackingItem> queue, Guid installId, InstallInstructions installModel)
{
if (queue.Count > 0)
{
var next = queue.Peek();
var step = InstallHelper.GetAllSteps().Single(x => x.Name == next.Name);
//If the current step restarts the app pool then we must simply return the next one in the queue,
// we cannot peek ahead as the next step might rely on the app restart and therefore RequiresExecution
// will rely on that too.
if (current.PerformsAppRestart)
{
return(step.Name);
}
JToken instruction = null;
//If this step has any instructions then extract them
if (installModel.Instructions.Any(x => x.Key == step.Name))
{
instruction = installModel.Instructions[step.Name];
}
//if the step requires execution then return it's name
if (StepRequiresExecution(step, instruction))
{
return(step.Name);
}
//this step no longer requires execution, this could be due to a new config change during installation,
// so we'll dequeue this one from the queue and recurse
queue.Dequeue();
//set this as complete
InstallStatusTracker.SetComplete(installId, step.Name, null);
//recurse
return(IterateNextRequiredStep(step, queue, installId, installModel));
}
//there is no more steps
return(string.Empty);
}
/// <summary>
/// Installs.
/// </summary>
public async Task <ActionResult <InstallProgressResultModel> > PostPerformInstall(InstallInstructions installModel)
{
if (installModel == null)
{
throw new ArgumentNullException(nameof(installModel));
}
var status = InstallStatusTracker.GetStatus().ToArray();
//there won't be any statuses returned if the app pool has restarted so we need to re-read from file.
if (status.Any() == false)
{
status = _installStatusTracker.InitializeFromFile(installModel.InstallId).ToArray();
}
//create a new queue of the non-finished ones
var queue = new Queue <InstallTrackingItem>(status.Where(x => x.IsComplete == false));
while (queue.Count > 0)
{
var item = queue.Dequeue();
var step = _installSteps.GetAllSteps().Single(x => x.Name == item.Name);
// if this step has any instructions then extract them
var instruction = GetInstruction(installModel, item, step);
// if this step doesn't require execution then continue to the next one, this is just a fail-safe check.
if (StepRequiresExecution(step, instruction) == false)
{
// set this as complete and continue
_installStatusTracker.SetComplete(installModel.InstallId, item.Name);
continue;
}
try
{
var setupData = await ExecuteStepAsync(step, instruction);
// update the status
_installStatusTracker.SetComplete(installModel.InstallId, step.Name, setupData?.SavedStepData);
// determine's the next step in the queue and dequeue's any items that don't need to execute
var nextStep = IterateSteps(step, queue, installModel.InstallId, installModel);
// check if there's a custom view to return for this step
if (setupData != null && setupData.View.IsNullOrWhiteSpace() == false)
{
return(new InstallProgressResultModel(false, step.Name, nextStep, setupData.View,
setupData.ViewModel));
}
return(new InstallProgressResultModel(false, step.Name, nextStep));
}
catch (Exception ex)
{
_logger.LogError(ex, "An error occurred during installation step {Step}",
step.Name);
if (ex is TargetInvocationException && ex.InnerException != null)
{
ex = ex.InnerException;
}
var installException = ex as InstallException;
if (installException != null)
{
return(new ValidationErrorResult(new
{
view = installException.View,
model = installException.ViewModel,
message = installException.Message
}));
}
return(new ValidationErrorResult(new
{
step = step.Name,
view = "error",
message = ex.Message
}));
}
}
_installStatusTracker.Reset();
return(new InstallProgressResultModel(true, "", ""));
}
/// <summary>
/// Does the install
/// </summary>
/// <returns></returns>
public InstallProgressResultModel PostPerformInstall(InstallInstructions installModel)
{
if (installModel == null)
{
throw new ArgumentNullException("installModel");
}
var status = InstallStatusTracker.GetStatus().ToArray();
//there won't be any statuses returned if the app pool has restarted so we need to re-read from file.
if (status.Any() == false)
{
status = InstallStatusTracker.InitializeFromFile(installModel.InstallId).ToArray();
}
//create a new queue of the non-finished ones
var queue = new Queue <InstallTrackingItem>(status.Where(x => x.IsComplete == false));
while (queue.Count > 0)
{
var stepStatus = queue.Dequeue();
var step = InstallHelper.GetAllSteps().Single(x => x.Name == stepStatus.Name);
JToken instruction = null;
//If this step has any instructions then extract them
if (installModel.Instructions.Any(x => x.Key == step.Name))
{
instruction = installModel.Instructions[step.Name];
}
//If this step doesn't require execution then continue to the next one, this is just a fail-safe check.
if (StepRequiresExecution(step, instruction) == false)
{
//set this as complete and continue
InstallStatusTracker.SetComplete(installModel.InstallId, stepStatus.Name, null);
continue;
}
try
{
var setupData = ExecuteStep(step, instruction);
//update the status
InstallStatusTracker.SetComplete(installModel.InstallId, step.Name, setupData != null ? setupData.SavedStepData : null);
//Determine's the next step in the queue and dequeue's any items that don't need to execute
var nextStep = IterateNextRequiredStep(step, queue, installModel.InstallId, installModel);
//check if there's a custom view to return for this step
if (setupData != null && setupData.View.IsNullOrWhiteSpace() == false)
{
return(new InstallProgressResultModel(false, step.Name, nextStep, setupData.View, setupData.ViewModel));
}
return(new InstallProgressResultModel(false, step.Name, nextStep));
}
catch (Exception ex)
{
LogHelper.Error <InstallApiController>("An error occurred during installation step " + step.Name, ex);
if (ex is TargetInvocationException && ex.InnerException != null)
{
ex = ex.InnerException;
}
var installException = ex as InstallException;
if (installException != null)
{
throw new HttpResponseException(Request.CreateValidationErrorResponse(new
{
view = installException.View,
model = installException.ViewModel,
message = installException.Message
}));
}
throw new HttpResponseException(Request.CreateValidationErrorResponse(new
{
step = step.Name,
view = "error",
message = ex.Message
}));
}
}
InstallStatusTracker.Reset();
return(new InstallProgressResultModel(true, "", ""));
}
