Skip to content

Commit

Permalink
Fix #1433 Logging Exceptions to Both Console and Exception Loggers (#…
Browse files Browse the repository at this point in the history
…5396)

<!-- READ ME FIRST: Please fill in the explanation section below and
check off every point from the Essential Checklist! -->
## Explanation Fix #1433 
There are 3 TODO marks the place where we want to have both have log in
both Console and Exception Loggers
By checking 3 related TODOs, only TODO in ExceptionController needs to
add the exception logger for logging and I added it as the issue
required and removed the TODO comment.
The other 2 TODOs already meet the requirement of the issue, so I simply
deleted TODO comments.
<!--
- 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))
- For PRs introducing new UI elements or color changes, both light and
dark mode screenshots must be included
- Add a screenshot demonstrating that you ran affected Espresso tests
locally & that they're passing

---------

Co-authored-by: Adhiambo Peres <[email protected]>
  • Loading branch information
XichengSpencer and adhiamboperes authored May 20, 2024
1 parent 98257db commit 6f5f8fa
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ class AnalyticsController @Inject constructor(
.addEventLogsToUpload(eventLog)
.build()
} else {
// TODO(#1433): Refactoring for logging exceptions to both console and exception loggers.
val exception =
IllegalStateException("Least Recent Event index absent -- EventLogCacheStoreSize is 0")
consoleLogger.e("AnalyticsController", "Failure while caching event.", exception)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ class PerformanceMetricsController @Inject constructor(
.addOppiaMetricLog(oppiaMetricLog)
.build()
} else {
// TODO(#1433): Refactoring for logging exceptions to both console and exception loggers.
val exception =
IllegalStateException(
"Least Recent Event index absent -- MetricLogStorageCacheSize is 0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@ class ExceptionsController @Inject constructor(
.addExceptionLog(exceptionLog)
.build()
} else {
// TODO(#1433): Refactoring for logging exceptions to both console and exception loggers.
val exception =
NullPointerException(
"Least Recent Exception index absent -- ExceptionLogCacheStoreSize is 0"
)
consoleLogger.e(EXCEPTIONS_CONTROLLER, exception.toString())
exceptionLogger.logException(exception)
}
}
return@storeDataAsync oppiaExceptionLogs.toBuilder().addExceptionLog(exceptionLog).build()
Expand Down

0 comments on commit 6f5f8fa

Please sign in to comment.