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

fix: Possible over running of array length with ship weapons #337

Merged
merged 2 commits into from
Dec 27, 2024

Conversation

OH296
Copy link
Collaborator

@OH296 OH296 commented Dec 27, 2024

Summary by Sourcery

Bug Fixes:

  • Prevent crashes caused by mismatched array lengths when accessing ship weapons and their facing directions.

Copy link
Contributor

sourcery-ai bot commented Dec 27, 2024

Reviewer's Guide by Sourcery

This pull request fixes a potential array overrun error when accessing ship weapons. The change introduces a check for the lengths of ship_wep and ship_wep_facing arrays and uses the minimum of the two lengths and 5 to prevent accessing elements beyond the array bounds. A loop iterates up to this calculated maximum, ensuring that weapon and facing data are accessed safely.

File-Level Changes

Change Details Files
Prevent potential array overrun errors when accessing ship weapons.
  • Added array_length checks for both obj_ini.ship_wep_facing and obj_ini.ship_wep arrays.
  • Used min function to determine the maximum number of weapons to process, preventing potential out-of-bounds access.
  • Replaced direct array accesses with a loop that iterates up to the calculated maximum number of weapons.
  • The loop now dynamically assigns values to cn.temp based on the current weapon index, ensuring correct data population.
scripts/scr_fleet_advisor/scr_fleet_advisor.gml

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: Fix This is a fix for a bug label Dec 27, 2024
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 @OH296 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

scripts/scr_fleet_advisor/scr_fleet_advisor.gml Outdated Show resolved Hide resolved
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@OH296
Copy link
Collaborator Author

OH296 commented Dec 27, 2024

sourcery-ai review

@EttyKitty
Copy link
Contributor

@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 @OH296 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The original code handled 4 weapons (indices 1-4), but the new code uses 5 as the maximum in min(). Was this intentional? If not, consider changing max_weapons to 4 to maintain the same behavior.
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 79d0288 into Adeptus-Dominus:release/0.10.0.0 Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Fix This is a fix for a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants