Skip to content

Commit

Permalink
[DYN-7833] Run All should be disabled in Custom Nodes (#86)
Browse files Browse the repository at this point in the history 
* RunAll disabled in CustomNodes

* Update TuneUpWindowViewModel.cs

* Update TuneUpWindowViewModel.cs

* Update TuneUpWindowViewModel.cs

* Update TuneUpWindowViewModel.cs
  • Loading branch information
@ivaylo-matov
ivaylo-matov authored Nov 26, 2024
1 parent 53d58b7 commit 2892897
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 9 deletions.
9 changes: 9 additions & 0 deletions TuneUp/Properties/Resources.Designer.cs
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions TuneUp/Properties/Resources.en-US.resx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,9 @@
<data name="ToolTip_RunAll" xml:space="preserve">
<value>Execute entire graph, including nodes with no change since the latest run.</value>
</data>
<data name="ToolTip_RunAllDisabled" xml:space="preserve">
<value>Custom Node mode does not support Run All.</value>
</data>
<data name="ToolTip_TotalExecutionTime" xml:space="preserve">
<value>Combined execution time of latest and previous run.</value>
</data>
Expand Down
3 changes: 3 additions & 0 deletions TuneUp/Properties/Resources.resx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,9 @@
<data name="ToolTip_RunAll" xml:space="preserve">
<value>Execute entire graph, including nodes with no change since the latest run.</value>
</data>
<data name="ToolTip_RunAllDisabled" xml:space="preserve">
<value>Custom Node mode does not support Run All.</value>
</data>
<data name="ToolTip_TotalExecutionTime" xml:space="preserve">
<value>Combined execution time of latest and previous run.</value>
</data>
Expand Down
8 changes: 6 additions & 2 deletions TuneUp/TuneUpWindow.xaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,9 @@
</BeginStoryboard>
</Trigger.EnterActions>
</Trigger>
<Trigger Property="IsEnabled" Value="False">
<Setter Property="Foreground" Value="{StaticResource DisabledForegroundBrush}" />
</Trigger>
</Style.Triggers>
</Style>
<!-- Context Menu style for Export button * -->
Expand Down Expand Up @@ -483,10 +486,11 @@
Content="{x:Static resx:Resources.Button_RunAll}"
Cursor="Hand"
IsEnabled="{Binding Path=IsRecomputeEnabled}"
Style="{StaticResource ButtonStyleTuneUp}" >
Style="{StaticResource ButtonStyleTuneUp}"
ToolTipService.ShowOnDisabled="True" >
<Button.ToolTip>
<ToolTip Style="{StaticResource ToolTipPointerTopRight}">
<TextBlock Text="{x:Static resx:Resources.ToolTip_RunAll}" Style="{StaticResource ToolTipContent}"/>
<TextBlock Style="{StaticResource ToolTipContent}" Text="{Binding RunAllTooltipMessage}" />
</ToolTip>
</Button.ToolTip>
</Button>
Expand Down
171 changes: 164 additions & 7 deletions TuneUp/TuneUpWindowViewModel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ public class TuneUpWindowViewModel : NotificationObject, IDisposable
private HashSet<ProfiledNodeViewModel> tempProfiledNodesLatestRun = new HashSet<ProfiledNodeViewModel>();
private HashSet<ProfiledNodeViewModel> tempProfiledNodesPreviousRun = new HashSet<ProfiledNodeViewModel>();
private HashSet<ProfiledNodeViewModel> tempProfiledNodesNotExecuted = new HashSet<ProfiledNodeViewModel>();
private bool suppressNodeReset = false;
private IWorkspaceModel previousWorkspace;
private readonly WorkspaceProfilingData cachedData = new WorkspaceProfilingData();

private HomeWorkspaceModel CurrentWorkspace
{
Expand Down Expand Up @@ -121,6 +124,7 @@ private set
{
isRecomputeEnabled = value;
RaisePropertyChanged(nameof(IsRecomputeEnabled));
RaisePropertyChanged(nameof(RunAllTooltipMessage));
}
}
}
Expand Down Expand Up @@ -281,6 +285,7 @@ public string SortingOrder
public const string SortByName = "name";
public const string SortByNumber = "number";
public const string SortByTime = "time";
public string RunAllTooltipMessage => IsRecomputeEnabled ? Resources.ToolTip_RunAll : Resources.ToolTip_RunAllDisabled;

#endregion

Expand Down Expand Up @@ -315,6 +320,14 @@ internal void ResetProfiledNodes()
Task.Run(() =>
{
uiContext.Post(_ => {
if (suppressNodeReset)
{
// Skip resetting nodes and directly refresh the UI
isProfilingEnabled = true;
RefreshUIAfterReset();
return;
}
// Initialize collections and dictionaries
InitializeCollectionsAndDictionaries();
Expand Down Expand Up @@ -1013,20 +1026,164 @@ private void CurrentWorkspaceModel_GroupRemoved(AnnotationModel group)

private void OnCurrentWorkspaceChanged(IWorkspaceModel workspace)
{
// Profiling needs to be enabled per workspace so mark it false after switching
// Reset suppression flag
suppressNodeReset = false;

// Handle transitions based on the types of the current and previous workspaces
if (workspace is CustomNodeWorkspaceModel)
{
if (previousWorkspace is HomeWorkspaceModel)
{
// Cache data when moving from HomeWorkspace to CustomNodeWorkspace
CacheWorkspaceData();
}
}
else if (workspace is HomeWorkspaceModel)
{
if (previousWorkspace is CustomNodeWorkspaceModel)
{
// Restore data when moving from CustomNodeWorkspace to HomeWorkspace
suppressNodeReset = true;
RestoreWorkspaceData();
}
}

// Profiling needs to be enabled per workspace, so mark it false after switching
isProfilingEnabled = false;

// Disable IsRecomputeEnabled if the workspace is a CustomNodeWorkspaceModel
IsRecomputeEnabled = !(workspace is CustomNodeWorkspaceModel);

// Update the previous and current workspace references
previousWorkspace = workspace;
CurrentWorkspace = workspace as HomeWorkspaceModel;
}

private void OnCurrentWorkspaceCleared(IWorkspaceModel workspace)
{
// Profiling needs to be enabled per workspace so mark it false after closing
isProfilingEnabled = false;
suppressNodeReset = false;
ClearCacheWorkspaceData();
CurrentWorkspace = viewLoadedParams.CurrentWorkspaceModel as HomeWorkspaceModel;
}

#endregion

#region Cache

/// <summary>
/// Represents cached profiling data for a workspace. Includes node collections and execution times.
/// </summary>
private class WorkspaceProfilingData
{
/// <summary>
/// Guid to map graphs with cached data
/// </summary>
public Guid GraphGuid { get; set; }
/// <summary>
/// Collection to cache nodes executed in the latest run of the graph.
/// </summary>
public ObservableCollection<ProfiledNodeViewModel> LatestRunNodes { get; set; } = new();
/// <summary>
/// Collection to cache nodes executed in the previous run of the graph.
/// </summary>
public ObservableCollection<ProfiledNodeViewModel> PreviousRunNodes { get; set; } = new();
// <summary>
/// Collection to cache nodes that were not executed in the graph.
/// </summary>
public ObservableCollection<ProfiledNodeViewModel> NotExecutedNodes { get; set; } = new();
/// <summary>
/// String to cache the Total execution time for the graph across all runs.
/// </summary>
public string TotalGraphExecutionTime { get; set; }
/// <summary>
/// String to cache the Execution time for the latest graph run.
/// </summary>
public string LatestGraphExecutionTime { get; set; }
/// <summary>
/// String to cache the Execution time for the previous graph run.
/// </summary>
public string PreviousGraphExecutionTime { get; set; }
}

/// <summary>
/// Caches the current workspace data, including nodes, execution times, and clears old collections.
/// </summary>
private void CacheWorkspaceData()
{
// Ensure collections are initialized
if (ProfiledNodesLatestRun == null)
ProfiledNodesLatestRun = new ObservableCollection<ProfiledNodeViewModel>();
if (ProfiledNodesPreviousRun == null)
ProfiledNodesPreviousRun = new ObservableCollection<ProfiledNodeViewModel>();
if (ProfiledNodesNotExecuted == null)
ProfiledNodesNotExecuted = new ObservableCollection<ProfiledNodeViewModel>();

// Save the current data into the cache
cachedData.GraphGuid = CurrentWorkspace?.Guid ?? Guid.Empty;
cachedData.LatestRunNodes = new ObservableCollection<ProfiledNodeViewModel>(ProfiledNodesLatestRun);
cachedData.PreviousRunNodes = new ObservableCollection<ProfiledNodeViewModel>(ProfiledNodesPreviousRun);
cachedData.NotExecutedNodes = new ObservableCollection<ProfiledNodeViewModel>(ProfiledNodesNotExecuted);
cachedData.LatestGraphExecutionTime = LatestGraphExecutionTime ?? Resources.Label_DefaultExecutionTime;
cachedData.PreviousGraphExecutionTime = PreviousGraphExecutionTime ?? Resources.Label_DefaultExecutionTime;
cachedData.TotalGraphExecutionTime = TotalGraphExecutionTime ?? Resources.Label_DefaultExecutionTime;

// Clear the old collections
ProfiledNodesLatestRun.Clear();
ProfiledNodesPreviousRun.Clear();
ProfiledNodesNotExecuted.Clear();
LatestGraphExecutionTime = PreviousGraphExecutionTime = TotalGraphExecutionTime = defaultExecutionTime;

// Refresh the UI
RefreshAllCollectionViews();
UpdateTableVisibility();
}

/// <summary>
/// Restores cached workspace data to the current workspace and updates the UI.
/// </summary>
private void RestoreWorkspaceData()
{
// Safety check: Ensure cached data is not null
cachedData.LatestRunNodes ??= new ObservableCollection<ProfiledNodeViewModel>();
cachedData.PreviousRunNodes ??= new ObservableCollection<ProfiledNodeViewModel>();
cachedData.NotExecutedNodes ??= new ObservableCollection<ProfiledNodeViewModel>();
cachedData.LatestGraphExecutionTime ??= Resources.Label_DefaultExecutionTime;
cachedData.PreviousGraphExecutionTime ??= Resources.Label_DefaultExecutionTime;
cachedData.TotalGraphExecutionTime ??= Resources.Label_DefaultExecutionTime;

// Restore cached data
ProfiledNodesLatestRun = new ObservableCollection<ProfiledNodeViewModel>(cachedData.LatestRunNodes);
ProfiledNodesPreviousRun = new ObservableCollection<ProfiledNodeViewModel>(cachedData.PreviousRunNodes);
ProfiledNodesNotExecuted = new ObservableCollection<ProfiledNodeViewModel>(cachedData.NotExecutedNodes);
LatestGraphExecutionTime = cachedData.LatestGraphExecutionTime;
PreviousGraphExecutionTime = cachedData.PreviousGraphExecutionTime;
TotalGraphExecutionTime = cachedData.TotalGraphExecutionTime;

ClearCacheWorkspaceData();

// Refresh the UI
RefreshAllCollectionViews();
UpdateTableVisibility();
}

/// <summary>
/// Clears the cached workspace data, resetting all collections and execution times to default values.
/// </summary>
private void ClearCacheWorkspaceData()
{
cachedData.GraphGuid = Guid.Empty;
cachedData.LatestRunNodes = new ObservableCollection<ProfiledNodeViewModel>();
cachedData.PreviousRunNodes = new ObservableCollection<ProfiledNodeViewModel>();
cachedData.NotExecutedNodes = new ObservableCollection<ProfiledNodeViewModel>();
cachedData.LatestGraphExecutionTime = defaultExecutionTime;
cachedData.PreviousGraphExecutionTime = defaultExecutionTime;
cachedData.TotalGraphExecutionTime = defaultExecutionTime;
}

#endregion

#region Helpers

/// <summary>
Expand Down Expand Up @@ -1214,11 +1371,7 @@ public void ApplyCustomSortingToAllCollections()
{
ApplyCustomSorting(ProfiledNodesCollectionLatestRun);
ApplyCustomSorting(ProfiledNodesCollectionPreviousRun);
// Apply custom sorting to NotExecuted collection only if sortingOrder is "name"
if (defaultSortingOrder == SortByName)
{
ApplyCustomSorting(ProfiledNodesCollectionNotExecuted);
}
ApplyCustomSorting(ProfiledNodesCollectionNotExecuted, SortByName);
}

/// <summary>
Expand Down Expand Up @@ -1377,8 +1530,12 @@ private void RefreshUIAfterReset()
ProfiledNodesCollectionNotExecuted = new CollectionViewSource { Source = ProfiledNodesNotExecuted };

// Refresh UI by raising property changes and applying sorting/filtering
RaisePropertyChanged(nameof(ProfiledNodesCollectionLatestRun));
RaisePropertyChanged(nameof(ProfiledNodesCollectionPreviousRun));
RaisePropertyChanged(nameof(ProfiledNodesCollectionNotExecuted));
ApplyCustomSorting(ProfiledNodesCollectionNotExecuted, SortByName);

ApplyCustomSortingToAllCollections();

ApplyGroupNodeFilter();
UpdateTableVisibility();
}
Expand Down

0 comments on commit 2892897

Please sign in to comment.