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

chore: json file error #366

Merged
merged 3 commits into from
Jan 12, 2025
Merged

Conversation

VanWeapon
Copy link
Contributor

@VanWeapon VanWeapon commented Jan 1, 2025

Description of changes

  • adds a popup error if a malform json file is attempted to be read but can't, e.g. someone edits their chapter save and its no longer valid json.

Reasons for changes

  • Provides instant feedback to players that they made a mistake, can be screenshotted for discord bug reports where a tech priest can inform them how to fix

Related links

Summary by Sourcery

Bug Fixes:

  • Detect and report malformed JSON files encountered when loading chapter save data.

Copy link
Contributor

sourcery-ai bot commented Jan 1, 2025

Reviewer's Guide by Sourcery

This PR implements error handling for JSON file parsing. When a malformed JSON file is encountered, a popup error message is displayed to the user. This provides immediate feedback and facilitates bug reporting.

File-Level Changes

Change Details Files
Added error handling for malformed JSON files.
  • Logs a debug message with the parsing error.
  • Displays a popup error message to the player with details about the parsing failure, including the file path and the full error message. Also, it instructs the player to check the file for typos or formatting errors.
  • Returns an empty object instead of incomplete or invalid data to prevent further issues.
scripts/JsonFileListLoader/JsonFileListLoader.gml
No changes in this file. This file is likely included due to project settings or build dependencies. ChapterMaster.yyp

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the PR: Chore Does something that does't fit other labels label Jan 1, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 1, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @VanWeapon - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296
Copy link
Collaborator

OH296 commented Jan 1, 2025

Seems to me like for some reason this has fucked up the diplomacy icon images, their numbers should all relate to their faction enum id's but instead i see the ork icon is 13 when it should be 7 and the inquis is instead 7 amongst other issues

@VanWeapon
Copy link
Contributor Author

Seems to me like for some reason this has fucked up the diplomacy icon images, their numbers should all relate to their faction enum id's but instead i see the ork icon is 13 when it should be 7 and the inquis is instead 7 amongst other issues

@OH296 From testing #363 it seems to work? I didn't reorder the icon indexes, if you look at diplomacy_icons.png which is what i split from, and count boxes from the left starting at 1, then you get the same ids. There's a light and dark version of each small icon which is why the indexes are off

@OH296
Copy link
Collaborator

OH296 commented Jan 1, 2025

Seems to me like for some reason this has fucked up the diplomacy icon images, their numbers should all relate to their faction enum id's but instead i see the ork icon is 13 when it should be 7 and the inquis is instead 7 amongst other issues

@OH296 From testing #363 it seems to work? I didn't reorder the icon indexes, if you look at diplomacy_icons.png which is what i split from, and count boxes from the left starting at 1, then you get the same ids. There's a light and dark version of each small icon which is why the indexes are off

Yep, sorry see that now, all is good.

@OH296 OH296 changed the base branch from release/0.10.0.0 to main January 12, 2025 21:25
@OH296 OH296 enabled auto-merge (squash) January 12, 2025 21:25
@OH296
Copy link
Collaborator

OH296 commented Jan 12, 2025

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @VanWeapon - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using 'fix:' instead of 'chore:' in the commit title since this change improves error handling for invalid user input. See the conventional commit types guide linked in the PR template.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296 OH296 merged commit ad38d53 into Adeptus-Dominus:main Jan 12, 2025
2 checks passed
OH296 pushed a commit that referenced this pull request Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Chore Does something that does't fit other labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants