DYN-8766 - Add local node help lookup as fallback for DNA by johnpierson · Pull Request #16299 · DynamoDS/Dynamo

johnpierson · 2025-06-13T17:41:03Z

Purpose

This PR adds a fallback to local help files when ML-based node autocomplete suggestions are unavailable and refactors internal access to support the extension.

Introduce a new LocalAutoCompleteService to query package and built-in help files.
Update NodeAutoCompleteBarViewModel to use local fallback and expose internals.
Add a new constructor in SingleResultItem to support port-based instantiation.

Declarations

Check these if you believe they are true

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
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning and are documented in the API Changes document.
This PR modifies some build requirements and the readme is updated
This PR contains no files larger than 50 MB
This PR introduces new feature code involve network connecting and is tested with no-network mode.

Release Notes

N/A

Reviewers

@DynamoDS/synapse

FYIs

@DynamoDS/eidos

github-actions

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-8766

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs

BogdanZavu · 2025-06-26T20:59:53Z

For the candidate help file we are looking for
AppData\Roaming\Dynamo\Dynamo Core\3.6\packages\Clockwork for Dynamo 3.x\doc\a9ad1519-73f2-4015-97e3-03c6b9a484eb.dyn
That is indeed the creation name but perhaps we should look for category as help - which in this case is more human readable e.g Clockwork.Display.Create.

BogdanZavu · 2025-06-26T21:07:22Z

@johnpierson can you recommend some packages that worth installing while testing this ?
We are doing all this in an worker thread but still I'm wondering if this could be problematic performance wise if it happens to target a big package with lots of custom nodes and help files and/or a lot of packages are installed. We are narrowing down on every step so we should probably be fine.

This is a very nice enhancement overall! LGTM!

johnpierson · 2025-06-27T03:18:42Z

@johnpierson can you recommend some packages that worth installing while testing this ? We are doing all this in an worker thread but still I'm wondering if this could be problematic performance wise if it happens to target a big package with lots of custom nodes and help files and/or a lot of packages are installed. We are narrowing down on every step so we should probably be fine.

I would say that the following are good (but not sure which ones actually have .md docs in the docs folder, Rhythm doesn't but can pretty quickly I think).

Clockwork
Rhythm
Orchid
GeniusLoci

johnpierson · 2025-06-27T03:39:56Z

For the candidate help file we are looking for AppData\Roaming\Dynamo\Dynamo Core\3.6\packages\Clockwork for Dynamo 3.x\doc\a9ad1519-73f2-4015-97e3-03c6b9a484eb.dyn That is indeed the creation name but perhaps we should look for category as help - which in this case is more human readable e.g Clockwork.Display.Create.

I fixed this to search based on category and node name. However, clockwork does not ship .dyn samples within the docs folder. Only .md. 🫠 His .md files instruct the user to download from Github. So the search won't find nodes for clockwork using this method. But it is fixed! 😃

Copilot

Pull Request Overview

This PR adds a fallback mechanism to use local help files when ML-based node autocomplete suggestions fail, and refactors several classes to support this extension.

Introduce LocalAutoCompleteService for querying local package and built-in help files.
Update NodeAutoCompleteBarViewModel to invoke the local fallback and expose internals.
Extend SingleResultItem with a new constructor for port-based instantiation and adjust assembly accessibility.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/NodeAutoCompleteViewExtension/ViewModels/SingleResultItem.cs	Added constructor to create items from a `NodeModel` and port
src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteBarViewModel.cs	Integrated `LocalAutoCompleteService` fallback in ML lookup and adjusted `AddCluster`
src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs	New service with methods for package and built-in help file search
src/DynamoUtilities/Properties/AssemblyInfo.cs	Granted `InternalsVisibleTo("NodeAutoCompleteViewExtension")`
src/DynamoCore/Models/DynamoModel.cs	Changed `OpenJsonFile` from private to internal

Comments suppressed due to low confidence (6)

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs:79

The local variable daName is assigned but never used. It can be removed to clean up the method GetNodeFullName.

                    var daName = $"{selectedNode.Category}.{selectedNode.GetOriginalName()}";

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs:46

Add unit tests for TryGetLocalAutoCompleteResult, covering package and built-in fallback paths to ensure this new functionality is validated.

        public List<SingleResultItem> TryGetLocalAutoCompleteResult(NodeModel selectedNode, PortModel selectedPortModel)

src/DynamoCore/Models/DynamoModel.cs:2434

Since OpenJsonFile is now internal, consider adding or updating its XML doc comment to explain why external callers need access.

        internal bool OpenJsonFile(

src/DynamoUtilities/Properties/AssemblyInfo.cs:34

[nitpick] Add a brief comment explaining why this internal exposure is needed to help future maintainers understand its purpose.

[assembly: InternalsVisibleTo("NodeAutoCompleteViewExtension")]

src/NodeAutoCompleteViewExtension/ViewModels/SingleResultItem.cs:21

This new constructor lacks an XML doc comment. Consider adding a <summary> that explains its parameters and intended use.

        public SingleResultItem(NodeModel nodeModel, int portToConnect, double score = 1.0)

src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteBarViewModel.cs:860

[nitpick] var is used elsewhere in this file for consistency. Consider reverting to var newNode = ... or updating other declarations to explicit types for a uniform style.

                    NodeModel newNode = dynamoModel.CreateNodeFromNameOrType(Guid.NewGuid(), typeInfo.FullName, true);

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs

src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteBarViewModel.cs

…rvice.cs Co-authored-by: Copilot <[email protected]>

…arViewModel.cs Co-authored-by: Copilot <[email protected]>

Fix for DYF nodes.

…arViewModel.cs Co-authored-by: Copilot <[email protected]>

github-actions bot reviewed Jun 13, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

johnpierson marked this pull request as ready for review June 13, 2025 18:52

johnpierson requested review from Copilot June 13, 2025 18:53

This comment was marked as outdated.

Sign in to view

johnpierson force-pushed the dyn8766_LocalDNA branch from eb9f287 to 21c6822 Compare June 23, 2025 17:00

johnpierson requested a review from Copilot June 23, 2025 20:42

This comment was marked as outdated.

Sign in to view

johnpierson requested a review from Copilot June 23, 2025 20:50

This comment was marked as outdated.

Sign in to view

johnpierson requested review from BogdanZavu, QilongTang and chubakueno June 23, 2025 20:55

BogdanZavu reviewed Jun 26, 2025

View reviewed changes

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs Outdated Show resolved Hide resolved

BogdanZavu approved these changes Jun 26, 2025

View reviewed changes

johnpierson requested a review from Copilot June 27, 2025 03:40

Copilot AI reviewed Jun 27, 2025

View reviewed changes

src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteService.cs Show resolved Hide resolved

src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteBarViewModel.cs Show resolved Hide resolved

johnpierson and others added 7 commits June 30, 2025 11:26

Add local node help lookup as fallback for DNA

6f979c5

Progress on Package Local AutoComplete

80d7936

Refactor to Move Local Autocomplete to its own Service

53fa04d

Update NodeAutoCompleteBarViewModel.cs

de47dda

Update src/NodeAutoCompleteViewExtension/Services/LocalAutoCompleteSe…

16142de

…rvice.cs Co-authored-by: Copilot <[email protected]>

Update src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteB…

ad5dd9d

…arViewModel.cs Co-authored-by: Copilot <[email protected]>

Update LocalAutoCompleteService.cs

d5c9b64

johnpierson and others added 3 commits June 30, 2025 11:26

Update LocalAutoCompleteService.cs

c1cc576

Fix for DYF nodes.

Update src/NodeAutoCompleteViewExtension/ViewModels/NodeAutoCompleteB…

22303d2

…arViewModel.cs Co-authored-by: Copilot <[email protected]>

Update LocalAutoCompleteService.cs

5284371

johnpierson force-pushed the dyn8766_LocalDNA branch from a8d4ae9 to 5284371 Compare June 30, 2025 17:27

johnpierson merged commit 59dd469 into DynamoDS:master Jun 30, 2025
24 of 25 checks passed

johnpierson deleted the dyn8766_LocalDNA branch June 30, 2025 17:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DYN-8766 - Add local node help lookup as fallback for DNA#16299

DYN-8766 - Add local node help lookup as fallback for DNA#16299
johnpierson merged 10 commits intoDynamoDS:masterfrom
johnpierson:dyn8766_LocalDNA

johnpierson commented Jun 13, 2025 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

BogdanZavu commented Jun 26, 2025

Uh oh!

BogdanZavu commented Jun 26, 2025

Uh oh!

johnpierson commented Jun 27, 2025 •

edited

Loading

Uh oh!

johnpierson commented Jun 27, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

johnpierson commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Declarations

Release Notes

Reviewers

FYIs

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

BogdanZavu commented Jun 26, 2025

Uh oh!

BogdanZavu commented Jun 26, 2025

Uh oh!

johnpierson commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnpierson commented Jun 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

johnpierson commented Jun 13, 2025 •

edited

Loading

johnpierson commented Jun 27, 2025 •

edited

Loading