Skip to content

Commit

Permalink
ready for PR
Browse files Browse the repository at this point in the history 
- TuneUp active only when MenuItem.IsChecked
- switches to manual model when activated
- ViewModel.IsTuneUpChecked tracks MenuItem.IsChecked
  • Loading branch information
@ivaylo-matov
ivaylo-matov committed Jun 28, 2024
1 parent a0137d5 commit a325950
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 67 deletions.
7 changes: 4 additions & 3 deletions TuneUp/TuneUpViewExtension.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ public override void Loaded(ViewLoadedParams p)
if (TuneUpMenuItem.IsChecked)
{
p.AddToExtensionsSideBar(this, TuneUpView);
ViewModel.EnableProfiling();
ViewModel.SwitchToManualMode();
ViewModel.EnableProfiling();
}
else
{
Expand All @@ -53,8 +54,8 @@ public override void Loaded(ViewLoadedParams p)
};

// Bind the IsChecked property to the IsTuneUpActive property
TuneUpMenuItem.Checked += (sender, args) => ViewModel.IsTuneUpActive = true;
TuneUpMenuItem.Unchecked += (sender, args) => ViewModel.IsTuneUpActive = false;
TuneUpMenuItem.Checked += (sender, args) => ViewModel.IsTuneUpChecked = true;
TuneUpMenuItem.Unchecked += (sender, args) => ViewModel.IsTuneUpChecked = false;

// Add this view extension's menu item to the Extensions tab or View tab accordingly.
var dynamoMenuItems = p.dynamoMenu.Items.OfType<MenuItem>();
Expand Down
149 changes: 85 additions & 64 deletions TuneUp/TuneUpWindowViewModel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public enum ProfiledNodeState
public class TuneUpWindowViewModel : NotificationObject, IDisposable
{
#region Internal Properties

private ViewLoadedParams viewLoadedParams;
private IProfilingExecutionTimeData executionTimeData;
private int executedNodesNum;
Expand All @@ -48,7 +49,7 @@ public class TuneUpWindowViewModel : NotificationObject, IDisposable
private HomeWorkspaceModel currentWorkspace;
private Dictionary<Guid, ProfiledNodeViewModel> nodeDictionary = new Dictionary<Guid, ProfiledNodeViewModel>();
private SynchronizationContext uiContext;
private bool isTuneUpActive = false;
private bool isTuneUpChecked = false;

/// <summary>
/// Name of the row to display current execution time
Expand All @@ -72,49 +73,31 @@ public class TuneUpWindowViewModel : NotificationObject, IDisposable

private HomeWorkspaceModel CurrentWorkspace
{
get
{
return currentWorkspace;
}
get => currentWorkspace;
set
{
// Unsubscribe from old workspace
if (currentWorkspace != null && isTuneUpActive)
if (currentWorkspace != null && isTuneUpChecked)
{
UnsubscribeWorkspaceEvents(currentWorkspace);
ManageWorkspaceEvents(currentWorkspace, false);
}

// Subscribe to new workspace
if (value != null)
{
// Set new workspace
currentWorkspace = value;
if (isTuneUpActive)
if (isTuneUpChecked)
{
SubscribeWorkspaceEvents(currentWorkspace);
ManageWorkspaceEvents(currentWorkspace, true);
}
}
}
}
#endregion

#region Public Properties
public bool IsTuneUpActive
{
get => isTuneUpActive;
set
{
if (isTuneUpActive != value)
{
isTuneUpActive = value;
RaisePropertyChanged(nameof(IsTuneUpActive));

if (value == true) SubscribeWorkspaceEvents(currentWorkspace);
else UnsubscribeWorkspaceEvents(currentWorkspace);
}
}
}


/// <summary>
/// Is the recomputeAll button enabled in the UI. Users should not be able to force a
/// reset of the engine and re-execution of the graph if one is still ongoing. This causes...trouble.
Expand All @@ -131,6 +114,31 @@ private set
}
}
}

/// <summary>
/// Gets or sets a value indicating whether the TuneUp extension is active.
/// When activated, it subscribes to workspace events to enable profiling.
/// When deactivated, it unsubscribes from those events.
/// </summary>
public bool IsTuneUpChecked
{
get => isTuneUpChecked;
set
{
if (isTuneUpChecked != value)
{
isTuneUpChecked = value;
RaisePropertyChanged(nameof(IsTuneUpChecked));

// Subscribe if activated, unsubscribe if deactivated
if (currentWorkspace != null)
{
ManageWorkspaceEvents(currentWorkspace, isTuneUpChecked);
}
}
}
}

/// <summary>
/// Collection of profiling data for nodes in the current workspace
/// </summary>
Expand Down Expand Up @@ -173,11 +181,14 @@ public TuneUpWindowViewModel(ViewLoadedParams p)
CurrentWorkspace = p.CurrentWorkspaceModel as HomeWorkspaceModel;
}
}

#endregion

#region ProfilingMethods

/// <summary>
/// Resets the profiling data for all nodes in the current workspace. Clears the existing
/// profiling data and re-initializes it based on the nodes present in the current workspace.
/// </summary>
internal void ResetProfiledNodes()
{
if (CurrentWorkspace == null)
Expand Down Expand Up @@ -206,13 +217,13 @@ internal void ResetProfiledNodes()
}

/// <summary>
/// The hanlder for force-recompute the graph
/// The handler for force-recompute the graph
/// </summary>
internal void ResetProfiling()
{
// Put the graph into manual mode as there is no guarantee that nodes will be marked
// dirty in topologically sorted oreder during a reset.
CurrentWorkspace.RunSettings.RunType = Dynamo.Models.RunType.Manual;
// dirty in topologically sorted order during a reset.
SwitchToManualMode();
// TODO: need a way to do this from an extension and not cause a run.
// DynamoModel interface or a more specific reset command.
(viewLoadedParams.DynamoWindow.DataContext as DynamoViewModel).Model.ResetEngine(true);
Expand All @@ -225,6 +236,15 @@ internal void ResetProfiling()
executionTimeData = CurrentWorkspace.EngineController.ExecutionTimeData;
}

/// <summary>
/// Switches the current workspace's run mode to manual. Prevents the workspace from
/// running automatically and allows for manual control of execution.
/// </summary>
internal void SwitchToManualMode()
{
CurrentWorkspace.RunSettings.RunType = Dynamo.Models.RunType.Manual;
}

/// <summary>
/// Enable profiling when it is disabled temporarily.
/// </summary>
Expand Down Expand Up @@ -369,50 +389,51 @@ private void OnCurrentWorkspaceCleared(IWorkspaceModel workspace)
// Profiling needs to be enabled per workspace so mark it false after closing
isProfilingEnabled = false;
CurrentWorkspace = viewLoadedParams.CurrentWorkspaceModel as HomeWorkspaceModel;
}

#endregion

#region Dispose or setup
}

/// <summary>
/// When switching workspaces or closing TuneUp extension,
/// unsubscribe workspace events for profiling
/// </summary>
/// <param name="workspace">target workspace</param>
private void UnsubscribeWorkspaceEvents(HomeWorkspaceModel workspace)
{
workspace.NodeAdded -= CurrentWorkspaceModel_NodeAdded;
workspace.NodeRemoved -= CurrentWorkspaceModel_NodeRemoved;
workspace.EvaluationStarted -= CurrentWorkspaceModel_EvaluationStarted;
workspace.EvaluationCompleted -= CurrentWorkspaceModel_EvaluationCompleted;
#endregion

foreach (var node in workspace.Nodes)
{
node.NodeExecutionBegin -= OnNodeExecutionBegin;
node.NodeExecutionEnd -= OnNodeExecutionEnd;
}
executedNodesNum = 0;
}
#region Dispose or setup

/// <summary>
/// When switching workspaces or closing TuneUp extension,
/// subscribe workspace events for profiling
/// subscribe (true)/unsubscribe (false) workspace events for profiling
/// </summary>
/// <param name="workspace">target workspace</param>
private void SubscribeWorkspaceEvents(HomeWorkspaceModel workspace)
/// <param name="workspace"></param>
/// <param name="subscribe"></param>
private void ManageWorkspaceEvents(HomeWorkspaceModel workspace, bool subscribe)
{
workspace.NodeAdded += CurrentWorkspaceModel_NodeAdded;
workspace.NodeRemoved += CurrentWorkspaceModel_NodeRemoved;
workspace.EvaluationStarted += CurrentWorkspaceModel_EvaluationStarted;
workspace.EvaluationCompleted += CurrentWorkspaceModel_EvaluationCompleted;
if (workspace == null) return;

foreach (var node in workspace.Nodes)
// Subscribe from workspace events
if (subscribe)
{
node.NodeExecutionBegin += OnNodeExecutionBegin;
node.NodeExecutionEnd += OnNodeExecutionEnd;
workspace.NodeAdded += CurrentWorkspaceModel_NodeAdded;
workspace.NodeRemoved += CurrentWorkspaceModel_NodeRemoved;
workspace.EvaluationStarted += CurrentWorkspaceModel_EvaluationStarted;
workspace.EvaluationCompleted += CurrentWorkspaceModel_EvaluationCompleted;

foreach (var node in workspace.Nodes)
{
node.NodeExecutionBegin += OnNodeExecutionBegin;
node.NodeExecutionEnd += OnNodeExecutionEnd;
}
ResetProfiledNodes();
}
ResetProfiledNodes();
// Unsubscribe to workspace events
else
{
workspace.NodeAdded -= CurrentWorkspaceModel_NodeAdded;
workspace.NodeRemoved -= CurrentWorkspaceModel_NodeRemoved;
workspace.EvaluationStarted -= CurrentWorkspaceModel_EvaluationStarted;
workspace.EvaluationCompleted -= CurrentWorkspaceModel_EvaluationCompleted;

foreach (var node in workspace.Nodes)
{
node.NodeExecutionBegin -= OnNodeExecutionBegin;
node.NodeExecutionEnd -= OnNodeExecutionEnd;
}
}
executedNodesNum = 0;
}

Expand All @@ -421,7 +442,7 @@ private void SubscribeWorkspaceEvents(HomeWorkspaceModel workspace)
/// </summary>
public void Dispose()
{
UnsubscribeWorkspaceEvents(CurrentWorkspace);
ManageWorkspaceEvents(CurrentWorkspace, false);
viewLoadedParams.CurrentWorkspaceChanged -= OnCurrentWorkspaceChanged;
viewLoadedParams.CurrentWorkspaceCleared -= OnCurrentWorkspaceCleared;
}
Expand Down

0 comments on commit a325950

Please sign in to comment.