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

Ensure all file handlers use utf-8 encoding. #9401

Merged

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented May 3, 2022

Summary

  • Sets explicit utf-8 encoding on logging file handlers
  • Encodes messages to utf-8 before writing them as bytes to the stream for logging to terminal

References

Attempts to fix #6298

Reviewer guidance

Try running kolibri manage listchannels on a Windows machine with a non-Latin alphabet entitled channel.
Check the logs from Kolibri running and see if it is full of lots of errors from logging.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@rtibbles rtibbles added the TODO: needs review Waiting for review label May 3, 2022
@rtibbles rtibbles requested a review from radinamatic May 3, 2022 21:47
@pcenov
Copy link
Member

pcenov commented May 4, 2022

Looks good to me @radinamatic - no encoding errors observed in the console and the logs after running kolibri manage listchannels:
2022-05-04_14-20-43

Logs: logs.zip

Copy link
Member

@radinamatic radinamatic left a comment

Choose a reason for hiding this comment

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

Manual QA by @pcenov passed! 💯

@rtibbles rtibbles requested a review from jredrejo May 4, 2022 15:13
@rtibbles rtibbles merged commit 83d2311 into learningequality:release-v0.15.x May 12, 2022
@rtibbles rtibbles deleted the windows_unicode_logging branch May 12, 2022 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TODO: needs review Waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants