DYN-7728 Add Wild Card Syntax #15591

saintentropy · 2024-11-05T00:37:08Z

Purpose

This PR adds wildcard support for version compatibility calculation. Based on the current scheme explained here.

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

Asterisk(*) support
new WildCardParse method
test coverage

Reviewers

@zeusongit
@QilongTang

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

saintentropy · 2024-11-05T00:49:41Z

src/DynamoUtilities/VersionUtilities.cs

+
+            if (splitVersion.Length == 2)
+            {
+                var newVersion = splitVersion[0] + ".1000.0";


Maybe 1000 is not enough.... Could be more

I pulled that value into a separate const so that we can change this later more easily. I don't know if this should be '1000' or '9999' though - here is a screenshot of a few packages with minor versions outside that range, for reference:

With that said, this is what we expect (from the current wiki, link in the description above) "For year based versions like in revit, civil3d etc:
Major version should be a 4 digit number (<= 9999)
Minor version should be at most a 2 digit number (<= 99)
Patch version should be at most a 2 digit number (<=99)
For dynamo versions:
Major/Minor/Patch versions should be at most a 2 digit number (<= 99)"

Ahh we should probably bump this to a bit higher just to be really out of range. Maybe 99999?

@zeusongit maybe we need to adjust the rules on versions

Just to confirm here in writing and for posterity @saintentropy - the major/minor/patch maximum value for .Net is 2,147,483,647. The revision is 65,535.

We are validating Revit/Civil and other hosts versions, not the package versions itself, so this does not apply.

src/DynamoPackages/PackageManagerSearchElement.cs

- more tests added to cover edge cases - added the new wildcard static method to the API - extracted the '1000' max wildcard version value into a separate const variable to allow for ease of access later on (based on comment if value should be higher) - added small utility method to append wildcard version

dnenov

@saintentropy you have done everything! I only added a few minor edge-case tests, and a couple more things like:

dnenov · 2024-11-05T12:28:25Z

test/DynamoCoreWpfTests/PackageManager/PackageManagerSearchElementViewModelTests.cs

+            Assert.IsTrue(PackageManagerSearchElement.IsVersionCompatible(compatibility, compatibleVersion),
+                          "Expected compatibility to be true when version is within the min and max wildcard range.");
+
+            Assert.IsFalse(PackageManagerSearchElement.IsVersionCompatible(compatibility, incompatibleVersion),


I added this test to also highlight the fact that, differentiating between the minor and build wildcard values covers the respective 'domain' of that wildcard. Meaning .. well, meaning the above case is currently valid, I just wanted to make this explicit.

This should be updated when we start updating compatibility from client, it is fine for now.

github-actions · 2024-11-05T12:37:03Z

UI Smoke Tests

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

github-actions

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

zeusongit · 2024-11-05T15:42:05Z

src/DynamoUtilities/VersionUtilities.cs

+        /// <summary>
+        /// The maximum version we check against when substituting a wildcard
+        /// </summary>
+        private const string WILDCARD_MAX_VERSION = "99999";


This is different for major and minor versions. Also for Dynamo versions, this is too large.
Is this part of the defensive coding? @saintentropy
This makes 2.9999 valid, but it will be rejected by the server

The goal here is just to transform an asterisk into a Version object that obviously larger then the data in the system. This is only for the comparison syntax. The idea is we make a fake Max version that is just a really really big version vs coding the logic for actual infinity. We could actually push it to the theoretical max you pointed out -> 2,147,483,647 and then we would be good.

Got it, I think we are just displaying//comparing the data at this point so not a problem.

I did push it to the max.... Also had to fix the test. This way it's at the theoretical limit.

QilongTang · 2024-11-05T16:47:44Z

@saintentropy @dnenov Three regressions reported:
Dynamo.Tests.VersionUtilitiesTests.ParseWildCard_TwoAndThreePartVersionConsistency_ReturnsParsedVersions
Dynamo.Tests.VersionUtilitiesTests.ParseWildCard_ValidString1_ReturnsParsedVersion
Dynamo.Tests.VersionUtilitiesTests.ParseWildCard_ValidString2_ReturnsParsedVersion

zeusongit · 2024-11-05T17:48:30Z

src/DynamoUtilities/VersionUtilities.cs

+        /// <summary>
+        /// The maximum version we check against when substituting a wildcard
+        /// </summary>
+        private const string WILDCARD_MAX_VERSION = "2147483647";


use int.MaxValue.ToString() instead?

github-actions

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

zeusongit · 2024-11-05T18:11:24Z

Unrelated tests?
Dynamo.Tests.SerializationTests.SerializationInDifferentCultureTest("C:\Jenkins\workspace\Dynamo\DynamoSelfServe\pullRequestValidation\Dynamo\test\Temp Test Path\BasicAddition.dyn")
Dynamo.Tests.SerializationTests.SerializationNonGuidIdsTest("C:\Jenkins\workspace\Dynamo\DynamoSelfServe\pullRequestValidation\Dynamo\test\Temp Test Path\BasicAddition.dyn")
Dynamo.Tests.SerializationTests.SerializationTest("C:\Jenkins\workspace\Dynamo\DynamoSelfServe\pullRequestValidation\Dynamo\test\Temp Test Path\BasicAddition.dyn")

Co-authored-by: Deyan Nenov <dnenov@archilizer.com>

Quick try at wildcard

eb318f5

saintentropy commented Nov 5, 2024

View reviewed changes

dnenov reviewed Nov 5, 2024

View reviewed changes

src/DynamoPackages/PackageManagerSearchElement.cs Show resolved Hide resolved

dnenov approved these changes Nov 5, 2024

View reviewed changes

domain range test

3a0e930

dnenov reviewed Nov 5, 2024

View reviewed changes

saintentropy changed the title ~~WIP Quick try at wildcard~~ DYN-7341 Quick try at wildcard Nov 5, 2024

github-actions bot reviewed Nov 5, 2024

View reviewed changes

QilongTang added this to the 3.4 milestone Nov 5, 2024

QilongTang approved these changes Nov 5, 2024

View reviewed changes

saintentropy changed the title ~~DYN-7341 Quick try at wildcard~~ DYN-7341 Add Wild Card Syntax Nov 5, 2024

Bump up the max version

c7ebd5a

zeusongit reviewed Nov 5, 2024

View reviewed changes

Shift to theoretical max of Version

e54f678

zeusongit approved these changes Nov 5, 2024

View reviewed changes

Update to actual thoertical max

13681b4

zeusongit reviewed Nov 5, 2024

View reviewed changes

zeusongit changed the title ~~DYN-7341 Add Wild Card Syntax~~ DYN-7728 Add Wild Card Syntax Nov 5, 2024

github-actions bot reviewed Nov 5, 2024

View reviewed changes

zeusongit merged commit ccac495 into DynamoDS:master Nov 5, 2024
25 of 26 checks passed

zeusongit pushed a commit to zeusongit/Dynamo that referenced this pull request Nov 5, 2024

DYN-7728 Add Wild Card Syntax (DynamoDS#15591)

654e5e7

Co-authored-by: Deyan Nenov <dnenov@archilizer.com>

zeusongit mentioned this pull request Nov 5, 2024

Cherrypick compatibility wildcard support #15606

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DYN-7728 Add Wild Card Syntax #15591

DYN-7728 Add Wild Card Syntax #15591

saintentropy commented Nov 5, 2024 •

edited

Loading

saintentropy Nov 5, 2024

dnenov Nov 5, 2024

dnenov Nov 5, 2024

saintentropy Nov 5, 2024

saintentropy Nov 5, 2024

dnenov Nov 5, 2024

zeusongit Nov 5, 2024

dnenov left a comment

dnenov Nov 5, 2024

zeusongit Nov 5, 2024

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot left a comment

zeusongit Nov 5, 2024

saintentropy Nov 5, 2024 •

edited

Loading

zeusongit Nov 5, 2024

saintentropy Nov 5, 2024

QilongTang commented Nov 5, 2024

zeusongit Nov 5, 2024

github-actions bot left a comment

zeusongit commented Nov 5, 2024

DYN-7728 Add Wild Card Syntax #15591

DYN-7728 Add Wild Card Syntax #15591

Conversation

saintentropy commented Nov 5, 2024 • edited Loading

Purpose

Declarations

Release Notes

Reviewers

FYIs

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

Choose a reason for hiding this comment

dnenov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 5, 2024 • edited Loading

UI Smoke Tests

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saintentropy Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QilongTang commented Nov 5, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

zeusongit commented Nov 5, 2024

saintentropy commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

saintentropy Nov 5, 2024 •

edited

Loading