Skip to content

Commit

Permalink
chore: Added new analytics parameter for git auto commit (#29538)
Browse files Browse the repository at this point in the history
## Description
A refactor in the analytics events for Git. Also adds
isSystemGenerated=false for regular commits.

#### PR fixes following issue(s)
Fixes #26769

#### Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
>
>
#### Type of change
> Please delete options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Chore (housekeeping or task changes that don't impact user perception)
- This change requires a documentation update
>
>
>
## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [ ] Manual
- [ ] JUnit
- [ ] Jest
- [ ] Cypress
>
>
#### Test Plan
> Add Testsmith test cases links that relate to this PR
>
>
#### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)
>
>
>
## Checklist:
#### Dev activity
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced Git integration with the inclusion of repository URLs in
auto-commit events.
- Improved analytics tracking by utilizing repository URLs for version
information.

- **Refactor**
- Standardized event naming by replacing string literals with enum
constants in Git-related operations.

- **Bug Fixes**
- Fixed an issue in the analytics service by correcting the method
signature for user ID hashing.

- **Documentation**
- Updated internal documentation to reflect changes in analytics and Git
service logic.

- **Tests**
- Expanded test coverage to account for new repository URL handling in
auto-commit events.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
Nayan authored Dec 13, 2023
1 parent e2d1ff7 commit d83f4e2
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ public class AutoCommitEvent {
private String repoName;
private String authorName;
private String authorEmail;
private String repoUrl;
}
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ public Mono<Boolean> autoCommitApplication(String defaultApplicationId, String b
autoCommitEvent.setWorkspaceId(application.getWorkspaceId());
autoCommitEvent.setAuthorName(gitProfile.getAuthorName());
autoCommitEvent.setAuthorEmail(gitProfile.getAuthorEmail());
autoCommitEvent.setRepoUrl(gitApplicationMetadata.getRemoteUrl());
// it's a synchronous call, no need to return anything
autoCommitEventHandler.publish(autoCommitEvent);
return Boolean.TRUE;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,10 @@ public List<AnalyticsEvents> getNonResourceEvents() {
/**
* Tells whether to hash userId or not for events
*
* @param String event
* @param String userId
* @param Boolean hashUserId
* @param event String
* @param userId String
* @param hashUserId Boolean
* @param isCloudHosting Boolean
* @return Boolean
*/
public static Boolean shouldHashUserId(String event, String userId, boolean hashUserId, boolean isCloudHosting) {
Expand Down
Loading

0 comments on commit d83f4e2

Please sign in to comment.