Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs around package scanning and notify user of infected package upload. #13235

Merged
merged 3 commits into from
Aug 23, 2022

Conversation

zeusongit
Copy link
Contributor

Purpose

https://jira.autodesk.com/browse/DYN-4691
https://jira.autodesk.com/browse/DYN-4695

This PR adds documentation around package scanning, and now users with infected packages upload will see dismissible toast notifications when loading package manager search window.

Documentation:
devenv_eYuSnKSoX8

Infected package toast notification with package download:-
Revit_w9lfRphlwW

SS of notification:
Screen Shot 2022-08-22 at 5 37 24 PM

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

Release Notes

Add documentation around package scanning
Add notifications for users with infected package uploads

Reviewers

@DynamoDS/dynamo

var latestPkgs = Model.GetUsersLatestPackages();
if (latestPkgs != null && latestPkgs.maintains.Count > 0)
{
foreach (var infectedVer in latestPkgs.maintains)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you remind me why do we need to look at each version here? I thought we only need to check the latest version of each package

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API will return all packages with last uploaded version, so 1 version per package only.

@@ -543,17 +549,28 @@ public void ClearSearchTextBox(object obj)
/// one of these toast notifications.
/// </summary>
/// <param name="obj"></param>
public void ClearDownloadToastNotification(object obj)
public void ClearToastNotification(object obj)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is API breaking but I guess you decided to break it intentionally?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes to make this function a bit more generic


<!-- Version -->
<TextBlock
Name="version"
Name="iversion"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does iversion mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

infected version just a name for the text block, no relation to apple 😛

Copy link
Contributor

@QilongTang QilongTang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with some comments

@QilongTang QilongTang merged commit 77f6073 into DynamoDS:master Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants