Re-enable the retain folder structure toggle in package manager publish workflow and bug fixes #14880

zeusongit · 2024-01-23T20:18:07Z

Purpose

https://jira.autodesk.com/browse/DYN-6589

The PR addresses multiple issues in the package publishing workflow and re-enables the retain folder structure option when publishing a package using package manager.
The work done in an extension of @dnenov and @mjkkirschner's branches, and includes their contribution as well.

The following use cases were updated:

The retain folder structure option is now enabled by default when a user is publishing a new version.
The user can view Node Library checkbox when navigating away from the publishing workflow and then returning to it later in the same session. (the assemblies were not loaded correctly)
The user can assign newly added files to be node libraries. (the checkbox was missing before)
The package version is not updated if publish fails due to any reason.
Handled access exception thrown when publishing a new version of a package by disposing temporary load context.
Make directory tree view scrollable when previewing package contents
Code refactor
Handle use case when a user removes some assemblies when publishing a new version and the workflow fails, since it tries to delete the files already loaded.(will track in a separate issue to limit this PRs scope)
Show a meaningful exception message when trying to update a loaded package (same message is used when adding assemblies):

Declarations

Check these if you believe they are true

The codebase 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.
This PR modifies some build requirements and the readme is updated
This PR contains no files larger than 50 MB

Release Notes

improve package manager publish workflow with retain folder structure option

Reviewers

@DynamoDS/dynamo

- now retains the exact number of files when retaining folder structure

- publish and publish version using retained folders now working better than before

…n-fix-pub

- added two new options to publish package allowing the retain folder structure from the get-go

…nov/Dynamo into deyan-fix-pub

make treeview scrollable retain nodelibraries values refactor publish version code

github-actions · 2024-01-23T20:37:03Z

UI Smoke Tests

Test: success. 2 passed, 0 failed.
TestComplete Test Result
Workflow Run: UI Smoke Tests
Check: UI Smoke Tests - net8.0

- added MaxHeight to trigger the scrollbar - enabled the custombrowsercontrol - the Tag property of the custombrowsercontrol now controls the visibility of the remove icons as well, allowing to hide them in this page

…fix-pub

QilongTang · 2024-01-29T21:37:31Z

@zeusongit Please also check if the PR validation contains real failure and address the merge conflicts. Once you address all the comments, we can merge and cherry-pick to RC3.0.3 branch

…fix-pub

src/DynamoCoreWpf/ViewModels/PackageManager/PublishPackageViewModel.cs

aparajit-pratap · 2024-01-30T01:04:06Z

@zeusongit can we add a new test to verify that publishing a new package version works with the new version already loaded into Dynamo?

It may not be possible with the current implementation to have a unit test that can cover the complete version upload, we may need a UI test for that, the issue that user will not be able to upload a new package version with any change in the current version that includes removing assemblies will still not work though.

Yes, I'm aware that the issue of not being able to publish a new version involving removing assemblies from the current version is not fixed yet. I was referring to publishing the new version with the same version installed.

aparajit-pratap · 2024-01-30T01:12:46Z

src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html

@@ -269,7 +268,6 @@ <h4>Adding package files</h4>
            When in doubt, toggle the setting off to allow Dynamo to set up the folder structure.
        </p>
    </p>
-    -->


The description says it's an advanced setting. Is it still an advanced setting now that it's the default?

@hwahlstrom @QilongTang should we remove the advanced tag?

@zeusongit make sense

src/DynamoCoreWpf/ViewModels/PackageManager/PublishPackageViewModel.cs

src/DynamoPackages/PackageDirectoryBuilder.cs

aparajit-pratap · 2024-01-30T01:34:53Z

src/DynamoPackages/PackageDirectoryBuilder.cs

@@ -222,7 +220,7 @@ internal void CopyFilesIntoRetainedPackageDirectory(IEnumerable<IEnumerable<stri
            {
                // We expect that files are bundled in root folders
                // For single files, just get its folder
-                var commonPath = files.Count() > 1 ? GetLongestCommonPrefix(files.ToArray()) : Path.GetDirectoryName(files.First());
+                var commonPath = files.Count() > 1 ? GetLongestCommonPrefix(files.ToArray()) : Path.GetDirectoryName(files.FirstOrDefault());


files.Any()

files.Any() won't work here since we need to know if there is only 1 item vs more than 1

QilongTang

LGTM with comments addressed

aparajit-pratap

LGTM once comments are addressed.

One thing about testing - as we don't have unit tests for all package publishing scenarios, I wonder if we can or have already tested them manually.

zeusongit · 2024-01-30T05:08:26Z

LGTM once comments are addressed.

One thing about testing - as we don't have unit tests for all package publishing scenarios, I wonder if we can or have already tested them manually.

Added a test

zeusongit · 2024-01-30T05:14:40Z

test/DynamoCoreWpfTests/DynamoCoreWpfTests.csproj

@@ -192,6 +192,7 @@
      <Name>DynamoUtilities</Name>
      <Private>False</Private>
    </ProjectReference>
+    <ProjectReference Include="..\Libraries\PackageManagerTests\PackageManagerTests.csproj" />


Added a test for loading a package and then publishing the same package with a new version.

zeusongit · 2024-01-30T06:47:53Z

Build passed here: https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/14235/

…sh workflow and bug fixes (DynamoDS#14880) * retain exact number of files - now retains the exact number of files when retaining folder structure - publish and publish version using retained folders now working better than before * publish retain added - added two new options to publish package allowing the retain folder structure from the get-go * fix issue with files with same substring in name in same subfolder * make treeview scrollable * retain nodelibraries values * refactor publish version code * scrollable custombrowsercontrol in preview page - added MaxHeight to trigger the scrollbar - enabled the custombrowsercontrol - the Tag property of the custombrowsercontrol now controls the visibility of the remove icons as well, allowing to hide them in this page * dispose mlc at publish * comments * revert docs change to add retain feature * test fix * add test --------- Co-authored-by: Deyan Nenov <dnenov@archilizer.com> Co-authored-by: mjk.kirschner <mjk.kirschner@gmail.com>

…sh workflow and bug fixes (#14880) (#14910) * retain exact number of files - now retains the exact number of files when retaining folder structure - publish and publish version using retained folders now working better than before * publish retain added - added two new options to publish package allowing the retain folder structure from the get-go * fix issue with files with same substring in name in same subfolder * make treeview scrollable * retain nodelibraries values * refactor publish version code * scrollable custombrowsercontrol in preview page - added MaxHeight to trigger the scrollbar - enabled the custombrowsercontrol - the Tag property of the custombrowsercontrol now controls the visibility of the remove icons as well, allowing to hide them in this page * dispose mlc at publish * comments * revert docs change to add retain feature * test fix * add test --------- Co-authored-by: Deyan Nenov <dnenov@archilizer.com> Co-authored-by: mjk.kirschner <mjk.kirschner@gmail.com>

dnenov and others added 8 commits December 19, 2023 19:35

retain exact number of files

d784293

- now retains the exact number of files when retaining folder structure

publish version

55b1177

- publish and publish version using retained folders now working better than before

Merge branch 'master' of https://github.com/DynamoDS/Dynamo into deya…

083cbb8

…n-fix-pub

publish retain added

5e24b55

- added two new options to publish package allowing the retain folder structure from the get-go

Merge branch 'pm-publish-experience-rework' of https://github.com/dne…

414d17c

…nov/Dynamo into deyan-fix-pub

fix issue with files with same substring in name in same subfolder

c75e4c9

init

b5be11b

make treeview scrollable retain nodelibraries values refactor publish version code

cleanup

64dfe5c

zeusongit requested review from dnenov and mjkkirschner January 23, 2024 20:18

zeusongit added 3 commits January 23, 2024 15:20

Update DynamoCoreWpf.csproj

a3da084

Update DynamoCoreWpf.csproj

d520aa3

Update DynamoCoreWpf.csproj

4fe5b1e

zeusongit changed the title ~~Amd fix pub~~ Re-enable the retain folder structure toggle in package manager publish workflow Jan 23, 2024

zeusongit and others added 7 commits January 23, 2024 18:09

remove retain explicit menu resources

a6943fe

Update PackageViewModel.cs

8669aaa

update

3dbb890

Update PackageViewModel.cs

03a5de9

comments

bf0cd4c

scrollable custombrowsercontrol in preview page

cf3431d

- added MaxHeight to trigger the scrollbar - enabled the custombrowsercontrol - the Tag property of the custombrowsercontrol now controls the visibility of the remove icons as well, allowing to hide them in this page

dispose mlc at publish

409cb75

dnenov mentioned this pull request Jan 26, 2024

Pm publish experience rework #14791

Closed

9 tasks

zeusongit added 2 commits January 26, 2024 15:10

Update PackageDirectoryBuilder.cs

6e221cc

Update PackageDirectoryBuilder.cs

5030868

zeusongit changed the title ~~Re-enable the retain folder structure toggle in package manager publish workflow~~ Re-enable the retain folder structure toggle in package manager publish workflow and bug fixes Jan 26, 2024

zeusongit requested a review from QilongTang January 26, 2024 23:57

zeusongit added 2 commits January 26, 2024 19:15

Merge branch 'master' of https://github.com/DynamoDS/Dynamo into amd-…

ed9f905

…fix-pub

cleanup

f5eb8fb

zeusongit marked this pull request as ready for review January 27, 2024 01:36

zeusongit added 8 commits January 29, 2024 16:41

comments

e5e7f86

Merge branch 'master' into amd-fix-pub

95c7ee5

revert docs change to add retain feature

5d9eb81

Update PublishPackageViewModel.cs

2d81231

Update PackageManagerClient.cs

186573b

Update PackageManagerClient.cs

1d8bd04

Merge branch 'master' of https://github.com/DynamoDS/Dynamo into amd-…

0f92b69

…fix-pub

Update PackageManagerUITests.cs

7aca1b6