Enable package node migration for Dynamo Core 2.0+ graphs #9306

alfarok · 2018-12-11T16:15:33Z

Purpose

This PR restores the previous (1.3 and older) behavior for package node migration for JSON graphs (2.0+). For example, you can now migrate a packaged node that was built against Core 2.0 but was later renamed. We previously handled 1.3 (XML) to 2.0 (JSON) but never 2.0 to 2.0+.

Package Migration Strategies:
ZeroTouch nodes => Use a Migrations.XML file located in the packages bin folder
NodeModel derived nodes => Use the AlsoKnownAs attribute on the class

Examples:

MyZeroTouchLib.MyNodes.SayHello to MyZeroTouchLib.MyNodes.SayHelloRENAMED

<?xml version="1.0"?>
<migrations>
  <priorNameHint>
    <oldName>MyZeroTouchLib.MyNodes.SayHello</oldName>
    <newName>MyZeroTouchLib.MyNodes.SayHelloRENAMED</newName>
  </priorNameHint>
</migrations>

SampleLibraryUI.Examples.DropDownExample to SampleLibraryUI.Examples.DropDownExampleRENAMED

namespace SampleLibraryUI.Examples
{
    [NodeName("Drop Down Example")]
    [NodeDescription("An example drop down node.")]
    [IsDesignScriptCompatible]
    [AlsoKnownAs("SampleLibraryUI.Examples.DropDownExample")]
    public class DropDownExampleRENAMED : DSDropDownBase
    {
        ...
    }
{

Testing

Created a test package with several node types (not committed)
Created a legacy graph including these nodes (committed)
Renamed the classes of all included nodes
Included migrations.xml for ZeroTouch nodes
Added [AlsoKnownAs] attribute for the NodeModel node
Rebuilt package (committed)
Assert all nodes migrate to the appropriate types and no dummy nodes are found

Test Cases:

ZeroTouch single input (overload)
ZeroTouch multi input (overload)
ZeroTouch no input multi output
NodeModel dropdown

Declarations

Check these if you believe they are true

The code base is in a better state after this PR
Is documented according to the standards
The level of testing this PR includes is appropriate
User facing strings, if any, are extracted into *.resx files
All tests pass using the self-service CI.
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning, and are documented in the API Changes document.

Reviewers

@mjkkirschner @aparajit-pratap @QilongTang

FYIs

@johnpierson

…d with packages for 2.0+ graphs

mjkkirschner · 2018-12-11T16:38:42Z

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

+                var priorNames = libraryServices.GetPriorNames();
+                FunctionDescriptor functionDescriptor;
+
+                // Attempt to located a newer migrated version of the node


sic(locate)?

aparajit-pratap · 2018-12-11T17:53:10Z

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

+                FunctionDescriptor functionDescriptor;
+
+                // Attempt to located a newer migrated version of the node
+                if (priorNames.ContainsKey(mangledName))


Just use TryGetValue . You can check for the key and get the value at the key at the same time.

… JSON 2.0+ graphs

mjkkirschner · 2018-12-14T02:23:53Z

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

        public ElementResolver ElementResolver { get; set; }
        //map of all loaded assemblies including LoadFrom context assemblies
        private Dictionary<string, List<Assembly>> loadedAssemblies;

+        [Obsolete("This function will be removed in Dynamo 3.0, please use new NodeReadConverter method with additional parameters to support node migration.")]


constructor

…odes

alfarok · 2018-12-14T19:27:28Z

@mjkkirschner @aparajit-pratap Hey guys, I think this one is ready for a final look when you get a free moment.

QilongTang · 2018-12-14T19:34:49Z

@alfarok Question on nodeModel nodes renaming, instead of dong what you put as example, can I rename the node in the opposite way below?

namespace SampleLibraryUI.Examples
{
    [NodeName("Drop Down Example")]
    [NodeDescription("An example drop down node.")]
    [IsDesignScriptCompatible]
    [AlsoKnownAs("SampleLibraryUI.Examples.DropDownExampleRENAMED ")]
    public class DropDownExample : DSDropDownBase
    {
        ...
    }
{

mjkkirschner · 2018-12-14T19:36:28Z

@alfarok did you ever investigate if you could get rid of this

          else if (type == typeof(DSVarArgFunction))
            {
                var functionId = Guid.Parse(obj["FunctionSignature"].Value<string>());
                node = manager.CreateCustomNodeInstance(functionId);
            }

?

mjkkirschner · 2018-12-14T19:38:24Z

I think some tests will break as they count the number of packages loaded from the test/pkgs folder.

alfarok · 2018-12-14T19:43:08Z

@QilongTang I haven't tried that but my assumption is that it could be used to migrate the node in the opposite direction? I think it makes more sense for the classes to be renamed so nodes can more clearly be traced back to their origin and keeps the 2 in sync. The library basically does the opposite when it was reorganized and now none of the locations truly represent the code locations/classes.

alfarok · 2018-12-14T19:45:14Z

@mjkkirschner I don't think it is required but am also a bit nervous about removing it thinking it may have been added for some strange edge case? What do you think?

Also the self-serve is running one last time so I will update any tests that rely of the package count if required.

QilongTang · 2018-12-14T19:46:19Z

@alfarok Good to know! I think people need to be aware of this is the preferred way

aparajit-pratap · 2018-12-14T20:49:35Z

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

+            this.manager = manager;
+            this.libraryServices = libraryServices;
+            this.nodeFactory = nodeFactory;
+            this.isTestMode = isTestMode;


Minor but I think we avoid using this as per existing coding conventions (which may have been forgotten along the way). Also if you use Resharper you'll see that a lot of these things are highlighted by the tool.

This is the old code and this file in particular is filled with this. Removing it in certain areas creates ambiguity between constructor parameters and class properties, such as above

aparajit-pratap · 2018-12-14T20:54:19Z

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

+                nodeFactory.ResolveType(unresolvedName, out newType);
+
+                if (newType != null) // If resolved update the type
+                { type = newType; }


Here it is preferred to have a single curly brace on a line (don't know what happened to coding conventions once followed by the team):

// If resolved update the type if (newType != null) { type = newType; }

https://github.com/DynamoDS/Dynamo/wiki/Coding-Standards

oh wow, if we would like to get this topic up, please fix all the comments in this PR so they are in the same format 😉
//[space][Comment]

Sorry comments without a space were copied from the constructor I made obsolete, I would never commit such a crime 😂

aparajit-pratap · 2018-12-14T20:57:38Z

@alfarok other than the harping about coding conventions this looks good to me. Thanks!

…e added

alfarok · 2018-12-14T21:17:33Z

@aparajit-pratap 🚨 🚓 guilty as charged, I don't think I've ever seen that doc before though

mjkkirschner · 2018-12-17T16:39:04Z

LGTM

…onal test package

…t package (#9323)

alfarok added 3 commits December 11, 2018 10:24

enable node migration using the Migrations.xml file sometimes include…

17588a4

…d with packages for 2.0+ graphs

cleanup logic

5704464

add additional comments

ce79a73

mjkkirschner reviewed Dec 11, 2018

View reviewed changes

aparajit-pratap reviewed Dec 11, 2018

View reviewed changes

alfarok added 7 commits December 12, 2018 09:32

more logic cleanup

5f7cd98

enable nodeModel node migration using the AlsoKnownAs attribute for…

0638108

… JSON 2.0+ graphs

cleanup

6ce664e

update comment

14199b3

replace ContainsKey with TryGetValue

0deb09a

mark previously used method as [Obsolete] to prevent breaking API

98a05b6

more logic cleanup

4f819e5

alfarok changed the title ~~Enable package node migration using a migrations.xml for core 2.0+ graphs~~ Enable package node migration for Dynamo Core 2.0+ graphs Dec 13, 2018

mjkkirschner reviewed Dec 14, 2018

View reviewed changes

alfarok added 4 commits December 14, 2018 14:01

testing coverage on JSON node migration for ZeroTouch and NodeModel n…

9cc5039

…odes

update [Obsolete] message

6a5d1f8

remove unnecessary pkg files

e17b80a

remove more unnecessary pkg files

2007a35

alfarok added the PTAL Please Take A Look 👀 label Dec 14, 2018

aparajit-pratap reviewed Dec 14, 2018

View reviewed changes

remove package count test as it could easily change when new tests ar…

672b698

…e added

alfarok added 2 commits December 14, 2018 16:39

address coding standard comments

bfa3302

accidental commit

e51d511

mjkkirschner added LGTM Looks good to me and removed PTAL Please Take A Look 👀 labels Dec 17, 2018

alfarok merged commit 58a4361 into DynamoDS:master Dec 17, 2018

alfarok added a commit to alfarok/Dynamo that referenced this pull request Dec 17, 2018

increment package count in test as DynamoDS#9306 introduced an additi…

86124a5

…onal test package

alfarok mentioned this pull request Dec 17, 2018

increment package count in test #9323

Merged

7 tasks

alfarok added a commit that referenced this pull request Dec 17, 2018

increment package count in test as #9306 introduced an additional tes…

a42cc1e

…t package (#9323)

mjkkirschner mentioned this pull request Feb 1, 2019

Migrations.XML is not working #9076

Closed

erfajo mentioned this pull request Feb 6, 2019

Nodes are showing error even when loading the new and updated Orchid file from Github erfajo/OrchidForDynamo#23

Closed

mjkkirschner mentioned this pull request Jan 5, 2021

use existing library function to lookup previous name hints #11379

Merged

10 tasks

mjkkirschner mentioned this pull request Apr 23, 2021

localized packages tests #11643

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable package node migration for Dynamo Core 2.0+ graphs #9306

Enable package node migration for Dynamo Core 2.0+ graphs #9306

alfarok commented Dec 11, 2018 •

edited

Loading

mjkkirschner Dec 11, 2018

aparajit-pratap Dec 11, 2018

mjkkirschner Dec 14, 2018

alfarok commented Dec 14, 2018

QilongTang commented Dec 14, 2018

mjkkirschner commented Dec 14, 2018 •

edited

Loading

mjkkirschner commented Dec 14, 2018

alfarok commented Dec 14, 2018 •

edited

Loading

alfarok commented Dec 14, 2018

QilongTang commented Dec 14, 2018

aparajit-pratap Dec 14, 2018

alfarok Dec 14, 2018

aparajit-pratap Dec 14, 2018

mjkkirschner Dec 14, 2018

QilongTang Dec 14, 2018

alfarok Dec 14, 2018

aparajit-pratap commented Dec 14, 2018

alfarok commented Dec 14, 2018 •

edited

Loading

mjkkirschner commented Dec 17, 2018

Enable package node migration for Dynamo Core 2.0+ graphs #9306

Enable package node migration for Dynamo Core 2.0+ graphs #9306

Conversation

alfarok commented Dec 11, 2018 • edited Loading

Purpose

Testing

Declarations

Reviewers

FYIs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alfarok commented Dec 14, 2018

QilongTang commented Dec 14, 2018

mjkkirschner commented Dec 14, 2018 • edited Loading

mjkkirschner commented Dec 14, 2018

alfarok commented Dec 14, 2018 • edited Loading

alfarok commented Dec 14, 2018

QilongTang commented Dec 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aparajit-pratap commented Dec 14, 2018

alfarok commented Dec 14, 2018 • edited Loading

mjkkirschner commented Dec 17, 2018

alfarok commented Dec 11, 2018 •

edited

Loading

mjkkirschner commented Dec 14, 2018 •

edited

Loading

alfarok commented Dec 14, 2018 •

edited

Loading

alfarok commented Dec 14, 2018 •

edited

Loading