DYN-6874 Logging Packages Tour (#15203)

RobertGlobant20 · web-flow · commit e32ec3175027 · 2024-05-13T15:19:52.000-04:00
Due that the Packages guide doesn't have a Welcome popup (like the other guides)  the Guide.Sequence starts at 1 (instead of 0) so I had to do a fix for calculating the number of steps correctly and modify the validation which is logging information when packages tour is completed.
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/Guide.cs b/src/DynamoCoreWpf/UI/GuidedTour/Guide.cs
@@ -143,7 +143,9 @@ internal void Play()
         /// </summary>
         internal void Initialize()
         {
-            TotalSteps = GuideSteps.Count;
+            //There are guided tours containing repeated Sequences due that we can have different Steps flow (conditional flows)
+            var differentSteps = GuideSteps.Select(step => step.Sequence).Distinct().ToList();
+            TotalSteps = differentSteps.Count;
 
             SetLibraryViewVisible(false);
 
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs b/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs
@@ -240,7 +240,11 @@ internal void ExitTour()
                 }
 
                 string guidName = Resources.ResourceManager.GetString(currentGuide.GuideNameResource, System.Globalization.CultureInfo.InvariantCulture).Replace("_", "");
-                if (currentGuide.TotalSteps - 1 == currentGuide.CurrentStep.Sequence)
+                int offSet = 1;
+                //Due that the Packages guide doesn't have a Welcome popup (like the other guides) then the Guide.Sequence starts at 1 (instead of 0) when we need to use a offSet = 0
+                if (currentGuide.Name == PackagesGuideName)
+                    offSet = 0;
+                if (currentGuide.TotalSteps - offSet == currentGuide.CurrentStep.Sequence)
                 {
                     Logging.Analytics.TrackEvent(Logging.Actions.Completed, Logging.Categories.GuidedTourOperations, guidName, currentGuide.CurrentStep.Sequence);
                 }

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,9 @@ internal void Play()`
`143`	`143`	`/// </summary>`
`144`	`144`	`internal void Initialize()`
`145`	`145`	`{`
`146`		`- TotalSteps = GuideSteps.Count;`
	`146`	`+ //There are guided tours containing repeated Sequences due that we can have different Steps flow (conditional flows)`
	`147`	`+ var differentSteps = GuideSteps.Select(step => step.Sequence).Distinct().ToList();`
	`148`	`+ TotalSteps = differentSteps.Count;`
`147`	`149`
`148`	`150`	`SetLibraryViewVisible(false);`
`149`	`151`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,11 @@ internal void ExitTour()`
`240`	`240`	`}`
`241`	`241`
`242`	`242`	`string guidName = Resources.ResourceManager.GetString(currentGuide.GuideNameResource, System.Globalization.CultureInfo.InvariantCulture).Replace("_", "");`
`243`		`- if (currentGuide.TotalSteps - 1 == currentGuide.CurrentStep.Sequence)`
	`243`	`+ int offSet = 1;`
	`244`	`+ //Due that the Packages guide doesn't have a Welcome popup (like the other guides) then the Guide.Sequence starts at 1 (instead of 0) when we need to use a offSet = 0`
	`245`	`+ if (currentGuide.Name == PackagesGuideName)`
	`246`	`+ offSet = 0;`
	`247`	`+ if (currentGuide.TotalSteps - offSet == currentGuide.CurrentStep.Sequence)`
`244`	`248`	`{`
`245`	`249`	`Logging.Analytics.TrackEvent(Logging.Actions.Completed, Logging.Categories.GuidedTourOperations, guidName, currentGuide.CurrentStep.Sequence);`
`246`	`250`	`}`