FAForever / client

FAF Python Client
GNU General Public License v3.0
75 stars 88 forks source link

Fixes Inappropriate Logical Expression #1134

Closed fabihatasneem closed 6 months ago

fabihatasneem commented 11 months ago

Details

While triaging your project, our bug fixing tool generated the following message(s)-

In file: replayitem.py, method: permutations, a logical expression uses the identity operator. A new object is created inside the identity check operation and then used for matching identity. Since this is a distinct, new object, it will not match with anything else. As a result, the identity check will have a logical short circuit and the program may have unintended behavior. iCR suggested that the logical operation should be reviewed for correctness.

Notes

Replaced is with ==

For example, running the following code will give us false and true respectively:

a = []
print(a is [])                  # False
print(a == [])                  # True

CLA Requirements

This section is only relevant if your project requires contributors to sign a Contributor License Agreement (CLA) for external contributions.

All contributed commits are already automatically signed off.

The meaning of a signoff depends on the project, but it typically certifies that committer has the rights to submit this work under the same license and agrees to a Developer Certificate of Origin (see https://developercertificate.org/ for more information).

Git Commit SignOff documentation

Sponsorship and Support:

This work is done by the security researchers from OpenRefactory and is supported by the Open Source Security Foundation (OpenSSF): Project Alpha-Omega. Alpha-Omega is a project partnering with open source software project maintainers to systematically find new, as-yet-undiscovered vulnerabilities in open source code - and get them fixed – to improve global software supply chain security.

The bug is found by running the Intelligent Code Repair (iCR) tool by OpenRefactory and then manually triaging the results.

Gatsik commented 6 months ago

Nice catch!