DYN-7337 Make TuneUp an Built-In package, part II

.gitignore

@@ -2,12 +2,15 @@
 ###################
 *.com
 *.class
-*.dll
+
 *.exe
 *.msi
 *.o
 *.so
-bin/
+AnyCPU/
+Debug/
+Release/
+originalBinaries/
 obj/
 int/
 packages/
@@ -96,6 +99,7 @@ src/AssemblySharedInfoGenerator/AssemblySharedInfo.cs
 /src/Libraries/PythonNodeModelsWpf/*.resources
 /src/Libraries/PythonNodeModels/*.resources
 /test/core/dsevaluation/DSFiles/test.ds
+/test/test_dependencies
 GregStandaloneAuth.dll
 /src/Libraries/Watch3DNodeModels/*.resources
 *.resources

extern/TuneUp/TuneUp_ViewExtensionDefinition.xml → extern/TuneUp/extra/TuneUp_ViewExtensionDefinition.xml

@@ -1,4 +1,4 @@
 <ViewExtensionDefinition>
-  <AssemblyPath>..\Built-In Packages\TuneUp.dll</AssemblyPath>
+  <AssemblyPath>..\bin\TuneUp.dll</AssemblyPath>
   <TypeName>TuneUp.TuneUpViewExtension</TypeName>
 </ViewExtensionDefinition>

extern/TuneUp/pkg.json

@@ -0,0 +1,24 @@
+{
+    "license": "MIT",
+    "file_hash": null,
+    "name": "TuneUp",
+    "version": "1.0.12",
+    "description": "*** THE TUNEUP EXTENSION USES NEW API FEATURES THAT ARE ONLY AVAILABLE IN DYNAMO VERSION 2.5 OR ABOVE ***\r\n\r\nTuneUp is in beta and is a view extension for analyzing the performance of Dynamo graphs. TuneUp allows you to see overall graph execution time, per-node execution time, and other helpful information about what\u0027s happening under the hood, e.g. nodes run in the current execution v.s. nodes run in the previous execution (which are skipped this run for optimization/ caching). Read more here: https://dynamobim.org/tuneup-extension-explore-your-node-and-graph-execution-times/ \r\n\r\nKnown issues:\r\n1. TuneUp does not work with .dyfs (custom nodes) yet.\r\n2.TuneUp binaries are not semantically versioned and are not intended to be built on top of as an API. Do not treat these binaries like DynamoCore.\r\n3. TuneUp requires Dynamo 3.0 or higher for access to new extension APIs.\r\n4. When user have TuneUp open, after switching workspace in Dynamo, the first graph run does not give execution time and nodes order.",
+    "group": "",
+    "keywords": [
+        "profiler",
+        "tuneup"
+    ],
+    "dependencies": [],
+    "host_dependencies": [],
+    "contents": "",
+    "engine_version": "3.0.0.7186",
+    "engine": "dynamo",
+    "engine_metadata": "",
+    "site_url": "https://dynamobim.org/",
+    "repository_url": "https://github.com/DynamoDS/TuneUp",
+    "contains_binaries": true,
+    "node_libraries": [],
+    "copyright_holder": "DynamoTeam",
+    "copyright_year": "2024"
+}

src/DynamoCore/Models/DynamoModel.cs

@@ -930,6 +930,7 @@ protected DynamoModel(IStartConfiguration config)
 
             if (extensions.Any())
             {
+                Logger.Log("\nLoading Dynamo extensions:");
                 var startupParams = new StartupParams(this);
 
                 foreach (var ext in extensions)

src/DynamoCoreWpf/DynamoCoreWpf.csproj

@@ -1857,11 +1857,9 @@
   </ItemGroup>
  <Target Name="AfterBuildOps" AfterTargets="Build">
     <ItemGroup>
-      <ExternTuneUpDll Include="$(SolutionDir)..\extern\TuneUp\TuneUp.dll" />
-      <ExternTuneUpManifest Include="$(SolutionDir)..\extern\TuneUp\TuneUp_ViewExtensionDefinition.xml" />
+      <ExternTuneUpPkg Include="$(SolutionDir)..\extern\TuneUp\**\*.*" />
     </ItemGroup>
     <MakeDir Directories="$(OutputPath)\viewExtensions\" />
-    <Copy SourceFiles="@(ExternTuneUpDll)" DestinationFolder="$(OutputPath)\Built-In Packages" />
-    <Copy SourceFiles="@(ExternTuneUpManifest)" DestinationFolder="$(OutputPath)\viewExtensions" />
+    <Copy SourceFiles="@(ExternTuneUpPkg)" DestinationFolder="$(OutputPath)\Built-In Packages\packages\TuneUp\%(RecursiveDir)" />
   </Target>
 </Project>

src/DynamoPackages/PackageLoader.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -247,7 +248,8 @@ private void TryLoadPackageIntoLibrary(Package package)
 
                 // load custom nodes
                 var packageInfo = new Graph.Workspaces.PackageInfo(package.Name, new Version(package.VersionName));
-                var customNodes = OnRequestLoadCustomNodeDirectory(package.CustomNodeDirectory, packageInfo);
+                // skip loding if the CustomNodeDirectory does not exist
+                var customNodes = Directory.Exists(package.CustomNodeDirectory)? OnRequestLoadCustomNodeDirectory(package.CustomNodeDirectory, packageInfo) : [];
                 package.LoadedCustomNodes.AddRange(customNodes);
 
                 package.EnumerateAdditionalFiles();
@@ -643,16 +645,8 @@ private Version CheckAndGetPackageVersion(string version, string name, string di
         /// </summary>
         /// <param name="packageDirectoryPath">path to package location</param>
         /// <param name="discoveredPkg">package object to check</param>
-        private void CheckPackageNodeLibraryCertificates(string packageDirectoryPath, Package discoveredPkg)
+        private static void CheckPackageNodeLibraryCertificates(string packageDirectoryPath, Package discoveredPkg)
         {
-            var dllfiles = new System.IO.DirectoryInfo(discoveredPkg.BinaryDirectory).EnumerateFiles("*.dll");
-            if (discoveredPkg.Header.node_libraries.Count() == 0 && dllfiles.Count() != 0)
-            {
-                Log(String.Format(
-                    String.Format(Resources.InvalidPackageNoNodeLibrariesDefinedInPackageJson,
-                    discoveredPkg.Name, discoveredPkg.RootDirectory)));
-            }
-
             foreach (var nodeLibraryAssembly in discoveredPkg.Header.node_libraries)
             {
 

src/DynamoPackages/Properties/Resources.en-US.resx

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -136,12 +136,8 @@
     <value>"A package called {0} found at {1} could not be verified to have signed dll files.  {2}  Ignoring it."</value>
     <comment>This warning message is shown when the node libraries defined for the package in the pkg.json manifest are invalid or do not have a verified certificate file</comment>
   </data>
-  <data name="InvalidPackageNoNodeLibrariesDefinedInPackageJson" xml:space="preserve">
-    <value>A package called {0} found at {1} includes dll files but none are defined in node libraries in the package manifest.  Ignoring it.</value>
-    <comment>This warning message is shown when packages are loaded and require verification of their certificate.  Having Dll's and no defined node libararies in the pkg json manifest stops the validation process</comment>
-  </data>
   <data name="PackagesDirectorySkipped" xml:space="preserve">
     <value>{0} was not scanned for packages because a preference setting disabled loading from that location."</value>
     <comment>This warning message is shown when a package directory is skipped due to a preference setting disabling loads from that location type.</comment>
   </data>
-</root>
+</root>

src/DynamoPackages/Properties/Resources.resx

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -136,12 +136,8 @@
     <value>"A package called {0} found at {1} could not be verified to have signed dll files.  {2}  Ignoring it."</value>
     <comment>This warning message is shown when the node libraries defined for the package in the pkg.json manifest are invalid or do not have a verified certificate file</comment>
   </data>
-  <data name="InvalidPackageNoNodeLibrariesDefinedInPackageJson" xml:space="preserve">
-    <value>A package called {0} found at {1} includes dll files but none are defined in node libraries in the package manifest.  Ignoring it.</value>
-    <comment>This warning message is shown when packages are loaded and require verification of their certificate.  Having Dll's and no defined node libararies in the pkg json manifest stops the validation process</comment>
-  </data>
   <data name="PackagesDirectorySkipped" xml:space="preserve">
     <value>{0} was not scanned for packages because a preference setting disabled loading from that location."</value>
     <comment>This warning message is shown when a package directory is skipped due to a preference setting disabling loads from that location type.</comment>
   </data>
-</root>
+</root>

src/Tools/DynamoFeatureFlags/FeatureFlagsClient.cs

@@ -81,8 +81,7 @@ internal FeatureFlagsClient(string userkey, string mobileKey = null, bool testMo
             if (testMode)
             {
                 MessageLogged?.Invoke($"LD startup: testmode true, no LD connection. ");
-                MessageLogged?.Invoke($"LD startup time: {sw.ElapsedMilliseconds} ");
-                MessageLogged?.Invoke("<<<<<InitDone>>>>>");
+                MessageLogged?.Invoke($"LD startup time: {sw.ElapsedMilliseconds} ms ");
                 AllFlags = LdValue.ObjectFrom(new Dictionary<string,LdValue> { { "TestFlag1",LdValue.Of(true) },
                     { "TestFlag2", LdValue.Of("I am a string") },
                     //in tests we want instancing on so we can test it.
@@ -95,8 +94,7 @@ internal FeatureFlagsClient(string userkey, string mobileKey = null, bool testMo
 
             Init(mobileKey);
             sw.Stop();
-            MessageLogged?.Invoke($"LD startup time: {sw.ElapsedMilliseconds} ");
-            MessageLogged?.Invoke("<<<<<InitDone>>>>>");
+            MessageLogged?.Invoke($"Launch Darkly startup time: {sw.ElapsedMilliseconds} ms");
             //gather all the user's flags and create a top level ldvalue object containing all of them.
             if (ldClient.Initialized)
             {
@@ -110,11 +108,11 @@ internal void Init(string mobileKey)
             ldClient =  LaunchDarkly.Sdk.Client.LdClient.Init(mobileKey, LaunchDarkly.Sdk.Client.ConfigurationBuilder.AutoEnvAttributes.Disabled, user, TimeSpan.FromSeconds(5));
             if (ldClient.Initialized)
             {
-                MessageLogged?.Invoke($"launch darkly initalized");
+                MessageLogged?.Invoke($"Launch Darkly initalized");
             }
             else
             {
-                MessageLogged?.Invoke($"launch darkly failed to initalize");
+                MessageLogged?.Invoke($"Launch Darkly failed to initalize");
             }
         }
 

test/DynamoCoreTests/Logging/FeatureFlagTests.cs

@@ -72,7 +72,7 @@ public void FeatureFlagsShouldMessageLoggedShouldContainAllLogs()
             testflagsManager.MessageLogged -= TestflagsManager_MessageLogged;
             //json ordering cannot be controlled between .net target versions.
             StringAssert.StartsWith("LD startup: testmode true, no LD connection. LD startup time:" , log);
-            StringAssert.Contains("<<<<<InitDone>>>>>feature flag exe starting<<<<<Sod>>>>>",log);
+            StringAssert.Contains("feature flag exe starting<<<<<Sod>>>>>",log);
             StringAssert.Contains("\"TestFlag1\":true", log);
             StringAssert.Contains("\"TestFlag2\":\"I am a string\"", log);
             StringAssert.Contains("\"graphics-primitive-instancing\":true", log);

test/DynamoCoreWpfTests/CrashReportingTests.cs

@@ -151,7 +151,8 @@ public void NoLoadedPackages()
             //Gets package loader
             var packageLoader = CurrentDynamoModel.GetPackageManagerExtension()?.PackageLoader;
             Assert.IsNotNull(packageLoader);
-            Assert.IsEmpty(packageLoader.LocalPackages, string.Join(", ", packageLoader.LocalPackages.Select(x => x.Name)));
+            Assert.IsTrue(packageLoader.LocalPackages.Count() == 1);
+            Assert.IsNotEmpty(packageLoader.LocalPackages, string.Join(", ", packageLoader.LocalPackages.Select(x => x.Name)));
 
             //Get packages data from null package loader
             var packagesData = Wpf.Utilities.CrashUtilities.PackagesToMakrdown(packageLoader);
@@ -170,7 +171,8 @@ public void NoLoadedPackages()
             var body = url.Substring(startIndex);
             var decoded = Uri.UnescapeDataString(body);
 
-            var expectedString = "No loaded packages were found.";
+            // At least one built-in package is always loaded
+            var expectedString = "- TuneUp";
 
             // Verify request contains the packages information
             Assert.True(decoded.Contains(expectedString));

test/DynamoCoreWpfTests/PackageManager/PackageManagerUITests.cs

@@ -950,7 +950,7 @@ public void PackageManagerUninstallCommand()
 
             // This function is called upon addition of new package paths in the UI.
             loader.LoadAll(loadPackageParams);
-            Assert.AreEqual(1, loader.LocalPackages.Count());
+            Assert.AreEqual(2, loader.LocalPackages.Count());
 
             var dlgMock = new Mock<MessageBoxService.IMessageBox>();
             dlgMock.Setup(m => m.Show(It.IsAny<Window>(), It.IsAny<string>(), It.IsAny<string>(), It.Is<MessageBoxButton>(x => x == MessageBoxButton.OKCancel || x == MessageBoxButton.OK), It.IsAny<MessageBoxImage>()))
@@ -1010,7 +1010,7 @@ public void PackageManagerLoadManuallyUnloadedBuiltIn()
             var loader = currentDynamoModel.GetPackageManagerExtension().PackageLoader;
 
             loader.LoadAll(loadPackageParams);
-            Assert.AreEqual(1, loader.LocalPackages.Count());
+            Assert.AreEqual(2, loader.LocalPackages.Count());
             Assert.IsTrue(loader.LocalPackages.Count(x => x.Name == "SignedPackage") == 1);
 
             var dlgMock = new Mock<MessageBoxService.IMessageBox>();
@@ -1025,9 +1025,11 @@ public void PackageManagerLoadManuallyUnloadedBuiltIn()
 
             ViewModel.PreferencesViewModel.InitPackageListFilters();
             var filters = ViewModel.PreferencesViewModel.Filters;
-            Assert.AreEqual(2, filters.Count);
+            Assert.AreEqual(3, filters.Count);
             Assert.AreEqual(@"All", filters[0].Name);
-            Assert.AreEqual(@"Unloaded", filters[1].Name);
+            Assert.AreEqual(@"Loaded", filters[1].Name);
+            Assert.AreEqual(@"Unloaded", filters[2].Name);
+
 
             builtInPkgViewModel.LoadCommand.Execute();
 
@@ -1061,7 +1063,7 @@ public void PackageManagerNoDuplicatesOnPathIsRemovedThenAdded()
             var loader = currentDynamoModel.GetPackageManagerExtension().PackageLoader;
 
             loader.LoadAll(loadPackageParams);
-            Assert.AreEqual(0, loader.LocalPackages.Count());
+            Assert.AreEqual(1, loader.LocalPackages.Count());
             var vm = new PackagePathViewModel(loader, loadPackageParams, Model.CustomNodeManager);
 
             vm.RequestShowFileDialog += (sender, args) => { args.Path = BuiltinPackagesTestDir; };

test/DynamoCoreWpfTests/PackageManager/PackageManagerViewExtensionTests.cs

@@ -159,7 +159,7 @@ public void PackageManagerLoadsRuntimeGeneratedExtension()
         public void PackageManagerViewExtensionHasCorrectNumberOfRequestedExtensions()
         {
             var pkgViewExtension = View.viewExtensionManager.ViewExtensions.OfType<PackageManagerViewExtension>().FirstOrDefault();
-            Assert.AreEqual(pkgViewExtension.RequestedExtensions.Count(), 1);
+            Assert.AreEqual(pkgViewExtension.RequestedExtensions.Count(), 2);
         }
 
         [Test]
@@ -208,7 +208,7 @@ public void LateLoadedViewExtensionsHaveMethodsCalled()
                 var pkg = loader.ScanPackageDirectory(pkgDir);
                 loader.LoadPackages(new List<Package> { pkg });
                 Assert.AreEqual(0, loader.RequestedExtensions.Count());
-                Assert.AreEqual(2, View.viewExtensionManager.ViewExtensions.OfType<PackageManagerViewExtension>().FirstOrDefault().RequestedExtensions.Count());
+                Assert.AreEqual(3, View.viewExtensionManager.ViewExtensions.OfType<PackageManagerViewExtension>().FirstOrDefault().RequestedExtensions.Count());
                 Assert.IsTrue(viewExtensionLoadStart);
                 Assert.IsTrue(viewExtensionAdd);
                 Assert.IsTrue(viewExtensionLoaded);

tools/DynamoPackagesAnalyzer/DynamoPackagesAnalyzer.csproj

@@ -10,7 +10,7 @@
   <ItemGroup>
     <PackageReference Include="CommandLineParser" Version="2.8.0" />
     <PackageReference Include="CsvHelper" Version="30.0.1" />
-    <PackageReference Include="Greg" Version="3.0.1.4707" />
+    <PackageReference Include="Greg" Version="3.0.2.6284" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="6.0.0" />
     <PackageReference Include="RestSharp.Serializers.NewtonsoftJson" Version="106.12.0" />
   </ItemGroup>