chore: Added new analytics parameter for git auto commit #29538
Conversation
nayan-rafiq
changed the title
github-actions
bot
added
Git Platform Pod
WalkthroughWalkthroughThe recent updates to the codebase involve enhancements to Git-related functionalities, including the tracking of repository URLs in auto-commit events and analytics. Changes also include the introduction of an enum for analytics events and a modification in the user ID hashing logic for analytics. These alterations aim to refine the application's Git integration and analytics reporting, ensuring more precise data capture and streamlined operations. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ? TipsChat with CodeRabbit Bot (
|
github-actions
bot
added
the
skip-changelog
|
/ok-to-test |
|
Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7177896482. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| private String repoName; | ||
| private String authorName; | ||
| private String authorEmail; | ||
| private String repoUrl; |
There was a problem hiding this comment.
💡 NOTE
Codebase verification is a beta feature.
The review of the codebase has revealed the following:
- The
repoUrlfield is accessed and used inAutoCommitEventHandlerCEImpl.java, which aligns with the intended changes. - The test files
AutoCommitEventHandlerImplTest.javaandGitAutoCommitHelperImplTest.javainstantiateAutoCommitEventwithout setting therepoUrl. This may need to be updated to reflect the new field and ensure that tests cover the new functionality. - The main file
GitAutoCommitHelperImpl.javaalso instantiatesAutoCommitEventwithout setting therepoUrl, which is likely an oversight and should be corrected.
Based on these findings, the following actions are recommended:
-
Verify and update the test files to include the
repoUrlfield in their instantiation ofAutoCommitEvent. -
Update the instantiation of
AutoCommitEventinGitAutoCommitHelperImpl.javato set therepoUrlfield. -
The test files
AutoCommitEventHandlerImplTest.javaandGitAutoCommitHelperImplTest.javashould be verified and potentially updated to set therepoUrlwhen instantiatingAutoCommitEvent. -
The
GitAutoCommitHelperImpl.javafile should be updated to set therepoUrlfield when instantiatingAutoCommitEvent.
Analysis chain
The addition of the repoUrl field to the AutoCommitEvent class is consistent with the PR objectives and the AI-generated summaries. Ensure that all parts of the codebase that instantiate or use the AutoCommitEvent class are updated to handle the new repoUrl field appropriately.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for instances where `AutoCommitEvent` is instantiated to ensure `repoUrl` is being set.
rg 'new AutoCommitEvent' --files-with-matches
# Search for instances where `AutoCommitEvent` is used to ensure `repoUrl` is being handled.
rg 'AutoCommitEvent' --files-with-matches
Length of output: 1218
Script:
#!/bin/bash
# Check the instantiation of `AutoCommitEvent` in the test files to ensure `repoUrl` is being set.
rg 'new AutoCommitEvent' app/server/appsmith-server/src/test/java/com/appsmith/server/solutions/AutoCommitEventHandlerImplTest.java
rg 'new AutoCommitEvent' app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/ce/GitAutoCommitHelperImplTest.java
# Check the instantiation of `AutoCommitEvent` in the main file to ensure `repoUrl` is being set.
rg 'new AutoCommitEvent' app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/ce/GitAutoCommitHelperImpl.java
# Check the usage of `AutoCommitEvent` in the main files to ensure `repoUrl` is being handled.
rg 'AutoCommitEvent' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/AutoCommitEventHandlerCEImpl.java
rg 'AutoCommitEvent' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/AutoCommitEventHandlerCE.java
rg 'AutoCommitEvent' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/AutoCommitEventHandler.java
rg 'AutoCommitEvent' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/AutoCommitEventHandlerImpl.java
Length of output: 2737
Script:
#!/bin/bash
# Check for the access or modification of the `repoUrl` field in the files where `AutoCommitEvent` is used.
rg 'repoUrl' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/AutoCommitEventHandlerCEImpl.java
rg 'repoUrl' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/AutoCommitEventHandlerCE.java
rg 'repoUrl' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/AutoCommitEventHandler.java
rg 'repoUrl' app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/AutoCommitEventHandlerImpl.java
Length of output: 538
|
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/7177896482. |
@AnaghHegde Primary reason was to add some extra parameters for specific git events. In this case, we need to add a new parameter |
Description
A refactor in the analytics events for Git. Also adds isSystemGenerated=false for regular commits.
PR fixes following issue(s)
Fixes #26769
Media
Type of change
Testing
How Has This Been Tested?
Test Plan
Issues raised during DP testing
Checklist:
Dev activity
QA activity:
Test Plan Approvedlabel after Cypress tests were reviewedTest Plan Approvedlabel after JUnit tests were reviewedSummary by CodeRabbit
New Features
Refactor
Bug Fixes
Documentation
Tests