feat: added recommendation acceptance tracking #158
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
xieshenzh
requested changes
May 10, 2024
| var telemetryMsg = TelemetryService.instance().action("component_analysis_recommendation_accepted"); | ||
| telemetryMsg.property("package", this.report.getRef().name()); | ||
| telemetryMsg.property("version", recommendedVersion); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.ECOSYSTEM.toString(), saUtils.determinePackageManagerName(file.getName())); |
There was a problem hiding this comment.
Suggested change
| telemetryMsg.property(ApiService.TelemetryKeys.ECOSYSTEM.toString(), saUtils.determinePackageManagerName(file.getName())); | |
| telemetryMsg.property(ApiService.TelemetryKeys.ECOSYSTEM.toString(), CAAnnotator.getPackageManager(file.getName())); |
Please use this method instead and change it to be static. Also delete line 63.
| telemetryMsg.property(ApiService.TelemetryKeys.PLATFORM.toString(), System.getProperty("os.name")); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.MANIFEST.toString(), file.getName()); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.RHDA_TOKEN.toString(), ApiSettingsState.getInstance().rhdaToken); | ||
| apiService.setRequestProperties(file.getName()); |
There was a problem hiding this comment.
Suggested change
| apiService.setRequestProperties(file.getName()); |
This method should not be called. It is only used when calling exhort-java-api. Also delete line 62.
Comment on lines
64
to
72
| var telemetryMsg = TelemetryService.instance().action("component_analysis_recommendation_accepted"); | ||
| telemetryMsg.property("package", this.report.getRef().name()); | ||
| telemetryMsg.property("version", recommendedVersion); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.ECOSYSTEM.toString(), saUtils.determinePackageManagerName(file.getName())); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.PLATFORM.toString(), System.getProperty("os.name")); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.MANIFEST.toString(), file.getName()); | ||
| telemetryMsg.property(ApiService.TelemetryKeys.RHDA_TOKEN.toString(), ApiSettingsState.getInstance().rhdaToken); | ||
| apiService.setRequestProperties(file.getName()); | ||
| telemetryMsg.send(); |
There was a problem hiding this comment.
Please move these lines of code for telemetry to a new method in the exhort package. Create the method in TelemetryService or ApiService.
| this.updateVersion(project, editor, file, recommendedVersion); | ||
| ApiService apiService = ServiceManager.getService(ApiService.class); | ||
| SaUtils saUtils = new SaUtils(); | ||
| var telemetryMsg = TelemetryService.instance().action("component_analysis_recommendation_accepted"); |
There was a problem hiding this comment.
Suggested change
| var telemetryMsg = TelemetryService.instance().action("component_analysis_recommendation_accepted"); | |
| var telemetryMsg = TelemetryService.instance().action("recommendation-accepted"); |
olavtar
force-pushed
the
track-recommendations
branch
from
41bfa63
to
7a72c2e
Compare
xieshenzh
requested changes
May 10, 2024
| @@ -21,4 +25,16 @@ public class TelemetryService { | |||
| public static TelemetryMessageBuilder instance() { | |||
| return INSTANCE.builder.get(); | |||
| } | |||
|
|
|||
| public static void sendTelemetryEvent(PsiFile file, String recommendedVersion, DependencyReport report, String actionName) { | |||
There was a problem hiding this comment.
Suggested change
| public static void sendTelemetryEvent(PsiFile file, String recommendedVersion, DependencyReport report, String actionName) { | |
| public static void sendPackageUpdateEvent(PsiFile file, String packageName, String packageVersion, String actionName) { |
I think the method name is too generic. This method only sends package and version that are changed.
Maybe, rename it to sendPackageUpdateEvent.
The third argument can be changed to String.
| this.updateVersion(project, editor, file, getRecommendedVersion(this.report)); | ||
| String recommendedVersion = getRecommendedVersion(this.report); | ||
| this.updateVersion(project, editor, file, recommendedVersion); | ||
| TelemetryService.sendTelemetryEvent(file, recommendedVersion, this.report, "recommendation_accepted"); |
There was a problem hiding this comment.
Suggested change
| TelemetryService.sendTelemetryEvent(file, recommendedVersion, this.report, "recommendation_accepted"); | |
| TelemetryService.sendTelemetryEvent(file, recommendedVersion, this.report, "recommendation-accepted"); |
The actionName used dash instead of underscore in other scenarios.
For example:
There was a problem hiding this comment.
Initially was using the same action name as Ilona did in the VS Code extension, not sure if they should match.
olavtar
force-pushed
the
track-recommendations
branch
from
7a72c2e
to
8e29e72
Compare
|
xieshenzh
approved these changes
May 10, 2024
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.
Added "component_analysis_recommendation_accepted" event to track recommendation acceptance for telemetry.
Jira: APPENG-2312