Include the client version in BundleUploads #101
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfrankland
approved these changes
Sep 20, 2024
cli/src/main.rs
Outdated
Comment on lines
450
to
456
| } | ||
| } |
There was a problem hiding this comment.
I'm not sure why the Trunk Check runner isn't working, but it seems you need to run trunk check -y on this PR
cli/tests/upload.rs
Outdated
Comment on lines
75
to
91
| let request = requests_iter.next().unwrap(); | ||
| if let RequestPayload::CreateBundleUpload(upload_request) = request { | ||
| assert_eq!( | ||
| upload_request.repo, | ||
| Repo { | ||
| host: String::from("github.com"), | ||
| owner: String::from("trunk-io"), | ||
| name: String::from("analytics-cli"), | ||
| }, | ||
| org_url_slug: String::from("test-org"), | ||
| }) | ||
| ); | ||
| } | ||
| ); | ||
| assert_eq!(upload_request.org_url_slug, String::from("test-org")); | ||
| assert!(upload_request.client_version.starts_with("trunk-analytics-cli cargo=")); | ||
| assert!(upload_request.client_version.contains(" git=")); | ||
| assert!(upload_request.client_version.contains(" rustc=")); | ||
| } else { | ||
| panic!("Expected CreateBundleUpload request, got {:?}", request); | ||
| } |
There was a problem hiding this comment.
nit: You can use the fancy assert_matches macro to do the failure for when the pattern isn't matched here
Suggested change
| let request = requests_iter.next().unwrap(); | |
| if let RequestPayload::CreateBundleUpload(upload_request) = request { | |
| assert_eq!( | |
| upload_request.repo, | |
| Repo { | |
| host: String::from("github.com"), | |
| owner: String::from("trunk-io"), | |
| name: String::from("analytics-cli"), | |
| }, | |
| org_url_slug: String::from("test-org"), | |
| }) | |
| ); | |
| } | |
| ); | |
| assert_eq!(upload_request.org_url_slug, String::from("test-org")); | |
| assert!(upload_request.client_version.starts_with("trunk-analytics-cli cargo=")); | |
| assert!(upload_request.client_version.contains(" git=")); | |
| assert!(upload_request.client_version.contains(" rustc=")); | |
| } else { | |
| panic!("Expected CreateBundleUpload request, got {:?}", request); | |
| } | |
| let upload_request = | |
| assert_matches!(requests_iter.next().unwrap(), RequestPayload::CreateBundleUpload(ur) => ur); | |
| assert_eq!( | |
| upload_request.repo, | |
| Repo { | |
| host: String::from("github.com"), | |
| owner: String::from("trunk-io"), | |
| name: String::from("analytics-cli"), | |
| } | |
| ); | |
| assert_eq!(upload_request.org_url_slug, String::from("test-org")); | |
| assert!(upload_request.client_version.starts_with("trunk-analytics-cli cargo=")); | |
| assert!(upload_request.client_version.contains(" git=")); | |
| assert!(upload_request.client_version.contains(" rustc=")); |
|
354 tests were run on |
Summary: Adding client version information for upload bundles will allow us to help Flaky Test users who may be using outdated versions of the Analytics CLI. If a user is running into an old bug, we can direct them to update their tooling version. Should help with onboarding. Closes TRUNK-12763
dfrankland
approved these changes
Oct 8, 2024
cli/tests/upload.rs
Outdated
Comment on lines
11
to
12
| use test_utils::{ | ||
| mock_git_repo::setup_repo_with_commit, | ||
| mock_server::{spawn_mock_server, RequestPayload}, | ||
| }; | ||
| use test_utils::mock_git_repo::setup_repo_with_commit; | ||
| use test_utils::mock_server::{spawn_mock_server, RequestPayload}; |
There was a problem hiding this comment.
nit: no need to split these up
cli/tests/upload.rs
Outdated
| ); | ||
| assert_eq!(upload_request.org_url_slug, String::from("test-org")); |
There was a problem hiding this comment.
optional, nit: you shouldn't need String::from() here, the string literal is just fine
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Adding client version information for upload bundles will allow
us to help Flaky Test users who may be using outdated versions
of the Analytics CLI.
If a user is running into an old bug, we can direct them to update
their tooling version. Should help with onboarding.
Can't be merged until the corresponding API change (https://github.com/trunk-io/trunk/pull/16896) is in.
Closes TRUNK-12763
EDIT (10/8/24) - manually tested against prod, confirmed working https://api.trunk.io/metabase/question#eyJkYXRhc2V0X3F1ZXJ5Ijp7ImRhdGFiYXNlIjo1LCJ0eXBlIjoicXVlcnkiLCJxdWVyeSI6eyJzb3VyY2UtdGFibGUiOjE3ODgsImZpbHRlciI6WyJub3QtZW1wdHkiLFsiZmllbGQiLDg5MzIzLHsiYmFzZS10eXBlIjoidHlwZS9UZXh0In1dXX19LCJkaXNwbGF5IjoidGFibGUiLCJ2aXN1YWxpemF0aW9uX3NldHRpbmdzIjp7fX0=