Ensure json files are read and writen in utf-8

[nvdaes]

Summary of the issue

After normalization of add-on metadata files in addon-datastore repo, the transform action fails, as reported in nvaccess/addon-datastore#4325

Development approach

Use encoding="utf-8" to read and write json files in the transform module.

Testing performed

• Check that the transform action fails locally before this change.
• Also locally, confirm that it can be run successfully after changes.

Summary by CodeRabbit

• Bug Fixes
  • Improved file handling by ensuring JSON files are read with UTF-8 encoding, enhancing compatibility and preventing potential issues with special characters.

[coderabbitai]

Walkthrough

The changes involve modifications to the writeAddons and readAddons functions within the src/transform/transform.py file. The file opening method has been updated to include an explicit encoding="utf-8" parameter for reading JSON files. This adjustment ensures that the files are processed using UTF-8 encoding, improving the handling of file encoding without altering the existing logic or control flow of the functions.

Changes

File	Change Summary
src/transform/transform.py	Added encoding="utf-8" parameter to file opening in writeAddons and readAddons functions.

Poem

In a world of bytes and bits,
A rabbit hops where logic sits.
With UTF-8, the files now sing,
Encoding joy, a happy thing!
Let’s celebrate this little feat,
With every line, our code’s more sweet! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dc1034b and 6448300.

Files selected for processing (1)

• src/transform/transform.py (2 hunks)

Additional comments not posted (2)

src/transform/transform.py (2)

107-107: LGTM!

Adding the encoding="utf-8" parameter when opening the addon file for reading is a good practice. It ensures that the file is read using the correct encoding, preventing potential issues related to non-ASCII characters.

---

166-166: Looks good!

Adding the encoding="utf-8" parameter when opening the addon file for reading in the readAddons function is consistent with the change made in the writeAddons function. It ensures that the file is read using the correct encoding, preventing potential issues related to non-ASCII characters.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[nvdaes]

Transformation failure using nvaccess addon-datastore-transform repo

[nvdaes]

Success checking out transformation repo with fix

[seanbudd]

Thanks @nvdaes