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

Fix #4405: Rename EventLogger to AnalyticsEventLogger #4694

Merged
merged 23 commits into from
Nov 12, 2022

Conversation

adhiamboperes
Copy link
Collaborator

@adhiamboperes adhiamboperes commented Nov 4, 2022

Explanation

Fixes #4405:
Refactoring EventLogger to AnalyticsEventLogger to make it more specific, in line with refactoring other event loggers.

Changes to:

  • Application files: all implementations and usages
  • Dagger files
  • Rename associated test files, imports and variables
  • EventLogger Fakes and the DebugEventLogger

Did not make changes to the following, given they are already pretty specific:

  • PerformanceMetricsEventLogger

Refactored scripts/assets/test_file_exemptions.textproto to update the new path of DebugAnalyticsEventLogger, FirebaseAnalyticsEventLogger and AnalyticsEventLogger to exempt them from corresponding file checks.
Refactored file_content_validation_checks.textproto to exempt FirebaseAnalyticsEventLogger from prohibited Locale use check.

Essential Checklist

  • The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
  • Any changes to scripts/assets files have their rationale included in the PR explanation.
  • The PR follows the style guide.
  • The PR does not contain any unnecessary code changes from Android Studio (reference).
  • The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
  • The PR is assigned to the appropriate reviewers (reference).

Refactoring this to make it more specific.
Also refactore4d some lines to meet ktlint lexicological import order and max line length rules
@adhiamboperes adhiamboperes self-assigned this Nov 4, 2022
adhiamboperes and others added 11 commits November 7, 2022 11:47
Update EventLogger.kt to AnalyticsEventLogger.kt following rename.
Update FakeEventLogger.kt to FakeAnalyticsEventLogger.kt
Update DebugEventLogger.kt to DebugAnalyticsEventLogger.kt
Wrap code to next line
Updating parameters and fields to capture context
AnalyticsEventLogger is an interface so it does not have tests. This change is needed due to the rename of the EventLogger file.
This change is needed due to the rename of the FirebaseEventLogger file.
This change is needed due to the rename of the FirebaseEventLogger file.
@adhiamboperes adhiamboperes marked this pull request as ready for review November 8, 2022 19:37
@adhiamboperes
Copy link
Collaborator Author

PTAL @BenHenning, the PR is ready

Copy link
Sponsor Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

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

Thanks @adhiamboperes! This is well done. I just had two comments--PTAL.

@adhiamboperes
Copy link
Collaborator Author

PTAL @BenHenning, I have removed the format-only changes in LogUploadWorkerTest.

@adhiamboperes adhiamboperes removed their assignment Nov 9, 2022
Copy link
Sponsor Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

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

Thanks @adhiamboperes. Had just one follow-up--PTAL.

Ryggs and others added 5 commits November 10, 2022 15:23
…a#4656)

<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation
Fixes  [oppia#3746](oppia#3746)

This PR bans all usage of the <include...> tag in XML layout files that
reference it. It does so by adding a check block inside the
file_content_validation_checks text proto script file.

This pr also removes the toolbar.xml file, since its no longer being
used.
<!--
- Explain what your PR does. If this PR fixes an existing bug, please
include
- "Fixes #bugnum:" in the explanation so that GitHub can auto-close the
issue
  - when this PR is merged.
  -->

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them. -->
- [x] The PR title and explanation each start with "Fix #bugnum: " (If
this PR fixes part of an issue, prefix the title with "Fix part of
#bugnum: ...".)
- [x] Any changes to
[scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets)
files have their rationale included in the PR explanation.
- [x] The PR follows the [style
guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide).
- [x] The PR does not contain any unnecessary code changes from Android
Studio
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)).
- [x] The PR is made from a branch that's **not** called "develop" and
is up-to-date with "develop".
- [x] The PR is **assigned** to the appropriate reviewers
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).

## For UI-specific PRs only
<!-- Delete these section if this PR does not include UI-related
changes. -->
If your PR includes UI-related changes, then:
- Add screenshots for portrait/landscape for both a tablet & phone of
the before & after UI changes
- For the screenshots above, include both English and pseudo-localized
(RTL) screenshots (see [RTL
guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines))
- Add a video showing the full UX flow with a screen reader enabled (see
[accessibility
guide](https://github.com/oppia/oppia-android/wiki/Accessibility-(A11y)-Guide))
- Add a screenshot demonstrating that you ran affected Espresso tests
locally & that they're passing

## SCREENSHOT FOR THE REGEX PATTERN CHECKS FAILED 


![checksfailed](https://user-images.githubusercontent.com/31986629/196036816-ddb6e065-d4bc-4f96-95e7-f5228ae3e23d.PNG)

## SCREENSHOT FOR THE REGEX PATTERN CHECKS PASSED


![passed](https://user-images.githubusercontent.com/31986629/196038476-e54e2319-6567-4b96-934d-c040b36360c5.PNG)

## A LIST OF THE FILES THAT HAVE THE <INCLUDE.../> TAG
- app/src/main/res/layout/add_profile_activity.xml
- addprofileactivity
- app/src/main/res/layout/administrator_controls_activity.xml:15: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
- app/src/main/res/layout/help_without_drawer_activity.xml:11: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
- app/src/main/res/layout/option_activity.xml:13: Remove <include .../>
tag from layout and use the appropriate widget, e.g like AppBarLayout
widget instead
- app/src/main/res/layout/options_without_drawer_activity.xml:11: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
- app/src/main/res/layout/developer_options_activity.xml:15: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
- app/src/main/res/layout/home_activity.xml:14: Remove <include .../>
tag from layout and use the appropriate widget, e.g like AppBarLayout
widget instead
- app/src/main/res/layout/help_activity.xml:13: Remove <include .../>
tag from layout and use the appropriate widget, e.g like AppBarLayout
widget instead
- app/src/main/res/layout/profile_progress_activity.xml:9: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
-
app/src/main/res/layout-sw600dp/administrator_controls_activity.xml:15:
Remove <include .../> tag from layout and use the appropriate widget,
e.g like AppBarLayout widget instead
- app/src/main/res/layout-sw600dp/option_activity.xml:13: Remove
<include .../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead
-
app/src/main/res/layout-sw600dp/options_without_drawer_activity.xml:12:
Remove <include .../> tag from layout and use the appropriate widget,
e.g like AppBarLayout widget instead
- app/src/main/res/layout-sw600dp/help_activity.xml:13: Remove <include
.../> tag from layout and use the appropriate widget, e.g like
AppBarLayout widget instead

Co-authored-by: MAZAKPE <makpalyy@gmail.com>
Co-authored-by: Ben Henning <ben@oppia.org>
## Explanation
Fixes oppia#4701: Improved accessibility for congratulations text by changing
height to wrap_content and improved contrast ratio by changing color in
color pallet.

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them. -->
- [x] The PR title and explanation each start with "Fix #bugnum: " (If
this PR fixes part of an issue, prefix the title with "Fix part of
#bugnum: ...".)
- [x] Any changes to
[scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets)
files have their rationale included in the PR explanation.
- [x] The PR follows the [style
guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide).
- [x] The PR does not contain any unnecessary code changes from Android
Studio
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)).
- [x] The PR is made from a branch that's **not** called "develop" and
is up-to-date with "develop".
- [x] The PR is **assigned** to the appropriate reviewers
([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).


## Screenshot 

Before         |  After
:-------------------------:|:-------------------------:

![image](https://user-images.githubusercontent.com/43074241/200644040-416efbc0-cced-457d-91b3-da8b2c5d877e.png)
|
![image](https://user-images.githubusercontent.com/43074241/200643995-580d2b9c-2742-483c-81dd-18948b4e66f8.png)
Translation updates

Co-authored-by: Ben Henning <ben@oppia.org>
Copy link
Collaborator Author

@adhiamboperes adhiamboperes left a comment

Choose a reason for hiding this comment

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

Thanks for clarifying @BenHenning! I hadn't noticed this before. PTAL again.

@adhiamboperes
Copy link
Collaborator Author

adhiamboperes commented Nov 10, 2022

Thanks for clarifying @BenHenning! I hadn't noticed this before. PTAL again.

Actually I have noticed that there are some unrelated commits on this branch, not sure how I got them mixed up. Is there a provision for me to rebase-drop these?

Alternatively I may have to create a new branch and cherry-pick the relevant commits😟

Screen Shot 2022-11-10 at 3 40 18 PM

@oppiabot oppiabot bot assigned BenHenning and unassigned adhiamboperes Nov 10, 2022
@oppiabot
Copy link

oppiabot bot commented Nov 10, 2022

Unassigning @adhiamboperes since a re-review was requested. @adhiamboperes, please make sure you have addressed all review comments. Thanks!

Copy link
Sponsor Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

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

Thanks @adhiamboperes! This LGTM.

@BenHenning BenHenning enabled auto-merge (squash) November 12, 2022 00:48
@oppiabot
Copy link

oppiabot bot commented Nov 12, 2022

Unassigning @BenHenning since they have already approved the PR.

@oppiabot
Copy link

oppiabot bot commented Nov 12, 2022

Assigning @rt4914 for code owner reviews. Thanks!

@BenHenning BenHenning merged commit 6683c6d into oppia:develop Nov 12, 2022
@adhiamboperes adhiamboperes deleted the rename-event-logger branch November 14, 2022 10:22
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.

Renaming EventLogger to AnalyticsEventLogger
6 participants