[BUG]: ConsoleLogger overwrites local log file for each line write #5232

BenHenning · 2023-11-16T23:08:05Z

Describe the bug

ConsoleLogger has support for logging output lines to a local log (rather than just logcat). However, it seems that this is currently configured such that each line will completely overwrite the original log file.

Steps To Reproduce

Build & install a developer version of Oppia Android.
Play around in the app for a bit to generate logs.
Pull logs from logcat (e.g. either in Android Studio or via adb logcat | grep org.oppia.android).
Pull the logs file: $ANDROID_HOME/platform-tools/adb pull /data/data/org.oppia.android/files/oppia_app.log ~/opensource/oppia_app.log
Compare these logs. Notice that the last entry in oppia_app.log is just the last log written in the logcat log.

Expected Behavior

All lines should be kept, not just the most recent.

Screenshots/Videos

No response

What device/emulator are you using?

Pixel 6a emulator

Which Android version is your device/emulator running?

SDK 33

Which version of the Oppia Android app are you using?

0.11-dev-80a9a09723

Additional Context

From the logic in ConsoleLogger:

oppia-android/utility/src/main/java/org/oppia/android/util/logging/ConsoleLogger.kt

Line 108 in 6006277

    
           blockingScope.launch { logDirectory.printWriter().use { out -> out.println(text) } }

I suspect this is caused by the open FileWriter just always, by default, overwriting the file. We should, instead, open the writer in append mode & add tests to verify that this functionality now works.

Also, it's probably a good idea to keep a long-lived PrintStream open for the log file rather than reopening it for each line (which is going to be less performant). We should overwrite the file in this case (to avoid indefinitely using more disk space for debug logs). This includes adding tests for verifying that multiple ConsoleLogger instances do overwrite the file from the previous logger.

The text was updated successfully, but these errors were encountered:

BenHenning · 2023-11-16T23:08:28Z

Suggest that this is a good potential starter issue since it should be straightforward to investigate, fix, and add tests for it.

kmanikanta335 · 2023-12-01T18:54:00Z

can i work on this issue @adhiamboperes

adhiamboperes · 2023-12-01T19:21:48Z

Hi @kmanikanta335. Could you please share an overview of your proposed solution?

kmanikanta335 · 2023-12-02T09:00:07Z

@adhiamboperes
proposed solution

Open ConsoleLogger.kt:
Locate the file ConsoleLogger.kt in the Oppia Android project.
Modify File Opening Mode:
Change the file opening mode to append. Replace the existing line:
blockingScope.launch { logDirectory.printWriter().use { out -> out.println(text) } }
with:
blockingScope.launch { logDirectory.appendText("$text\n") }
Use Long-Lived PrintStream:
Maintain a long-lived PrintStream for the log file. You can create it during the initialization of the ConsoleLogger or at an
appropriate point where it won't be repeatedly opened. For example:

private val logPrintStream: PrintStream = logDirectory.appendText().bufferedWriter().use { it }

// ...

blockingScope.launch { logPrintStream.println(text) }

adhiamboperes · 2023-12-04T15:03:22Z

@kmanikanta335, you can put up a draft PR with these changes that you have proposed.

Saifuddin53 · 2023-12-10T04:46:19Z

Can I work on this issue as @kmanikanta335 has not posted any PR till now?

… write

manas-yu · 2024-10-07T14:06:06Z

Hi @adhiamboperes can i work on this issue?
The issue seems to stem from how PrintWriter is used in the logToFileInBackground() method within the ConsoleLogger class.
we can modify the logToFileInBackground function to use appendText() to add content to the log file instead of overwriting it. and it seems to resolve the issue

private fun logToFileInBackground(text: String) {
    blockingScope.launch {
      if (printWriter == null) {
        printWriter = PrintWriter(FileWriter(logDirectory, true)) // Open in append mode
      }
      printWriter?.println(text)
      printWriter?.flush()
    }
  }

  /** Close the log file when logging is finished. */
  fun closeLogFile() {
    printWriter?.close()
    printWriter = null
  }
}

adhiamboperes · 2024-10-07T19:46:57Z

Hi @manas-yu, I have assigned the issue to you. Please feel free to put up a PR!

… write (oppia#5550) ## Explanation Fix oppia#5232 This PR updates the `ConsoleLogger` class to improve logging functionality. The key changes include: - **Append Mode for Logs**: The `FileWriter` is now opened in append mode, ensuring that new log entries are added to the existing log file instead of overwriting it. - **Long-lived PrintWriter**: A long-lived `PrintWriter` instance has been implemented to enhance performance by reducing the overhead of opening and closing the log file multiple times. - **Close Log File**: A `closeLogFile()` method has been added to properly close the `PrintWriter`, preventing resource leaks after logging is complete. These changes address the issue of logs being overwritten and enhance performance while ensuring proper resource management. ## Essential Checklist - [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)). --------- Co-authored-by: Adhiambo Peres <59600948+adhiamboperes@users.noreply.github.com>

BenHenning added bug End user-perceivable behaviors which are not desirable. triage needed labels Nov 16, 2023

seanlip removed the triage needed label Nov 20, 2023

seanlip added this to [Team] Developer Workflow & Infrastructure - Android Nov 20, 2023

github-project-automation bot moved this to Todo in [Team] Developer Workflow & Infrastructure - Android Nov 20, 2023

adhiamboperes added Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Low Solution is clear and broken into good-first-issue-sized chunks. good first issue This item is good for new contributors to make their pull request. labels Nov 27, 2023

adhiamboperes assigned kmanikanta335 Dec 4, 2023

kmanikanta335 mentioned this issue Dec 18, 2023

Fix #5232: ConsoleLogger overwrites local log file for each line write~ #5275

Closed

6 tasks

kmanikanta335 added a commit to kmanikanta335/oppia-android that referenced this issue Dec 19, 2023

Fix oppia#5232: ConsoleLogger overwrites local log file for each line…

3ffe3cb

… write

adhiamboperes unassigned kmanikanta335 Aug 22, 2024

adhiamboperes assigned manas-yu Oct 7, 2024

manas-yu mentioned this issue Oct 7, 2024

Fix #5232: ConsoleLogger overwrites local log file for each line write #5550

Merged

6 tasks

adhiamboperes closed this as completed in #5550 Nov 11, 2024

adhiamboperes closed this as completed in 96f5289 Nov 11, 2024

github-project-automation bot moved this from Todo to Done in [Team] Developer Workflow & Infrastructure - Android Nov 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG]: ConsoleLogger overwrites local log file for each line write #5232

[BUG]: ConsoleLogger overwrites local log file for each line write #5232

BenHenning commented Nov 16, 2023 •

edited

Loading

BenHenning commented Nov 16, 2023

kmanikanta335 commented Dec 1, 2023

adhiamboperes commented Dec 1, 2023

kmanikanta335 commented Dec 2, 2023

adhiamboperes commented Dec 4, 2023

Saifuddin53 commented Dec 10, 2023

manas-yu commented Oct 7, 2024 •

edited

Loading

adhiamboperes commented Oct 7, 2024

[BUG]: ConsoleLogger overwrites local log file for each line write #5232

[BUG]: ConsoleLogger overwrites local log file for each line write #5232

Comments

BenHenning commented Nov 16, 2023 • edited Loading

Describe the bug

Steps To Reproduce

Expected Behavior

Screenshots/Videos

What device/emulator are you using?

Which Android version is your device/emulator running?

Which version of the Oppia Android app are you using?

Additional Context

BenHenning commented Nov 16, 2023

kmanikanta335 commented Dec 1, 2023

adhiamboperes commented Dec 1, 2023

kmanikanta335 commented Dec 2, 2023

adhiamboperes commented Dec 4, 2023

Saifuddin53 commented Dec 10, 2023

manas-yu commented Oct 7, 2024 • edited Loading

adhiamboperes commented Oct 7, 2024

BenHenning commented Nov 16, 2023 •

edited

Loading

manas-yu commented Oct 7, 2024 •

edited

Loading