8000 Rust: Add Operation class by geoffw0 · Pull Request #19454 · github/codeql · GitHub
[go: up one dir, main page]

Skip to content

Rust: Add Operation class #19454

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

Merged
merged 10 commits into from
May 13, 2025
Merged

Rust: Add Operation class #19454

merged 10 commits into from
May 13, 2025

Conversation

geoffw0
Copy link
Contributor
@geoffw0 geoffw0 commented May 2, 2025

Unify various classes representing operations under a single Operation class, providing a single consistent interface (with getOperatorName() and getAnOperand()) for reasoning about them.

The idea is to get things in order before I follow up with another PR that will add new subclasses, allowing us to find things like the dereference expression (*) and comparison operations more easily.

@Copilot Copilot AI review requested due to automatic review settings May 2, 2025 15:54
@geoffw0 geoffw0 requested a review from a team as a code owner May 2, 2025 15:54
@geoffw0 geoffw0 added the Rust Pull requests that update Rust code label May 2, 2025
Copy link
Contributor
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a unified Operation class in the Rust QL library, letting all unary, binary, assignment, and logical expressions share a consistent interface with getOperatorName() and getAnOperand().

  • Defined OperationImpl::Operation and aliased it as Operation
  • Updated PrefixExpr and BinaryExpr implementations to mix in Operation
  • Added imports of Operation in query modules and extended tests to exercise the new API

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

File Description
rust/ql/lib/codeql/rust/elements/Operation.qll Added the abstract Operation class and alias
rust/ql/lib/codeql/rust/elements/internal/PrefixExprImpl.qll Extended PrefixExpr to implement Operation
rust/ql/lib/codeql/rust/elements/internal/BinaryExprImpl.qll Extended BinaryExpr to implement Operation
rust/ql/test/library-tests/operations/test.rs Expanded inline tests for various operators
Comments suppressed due to low confidence (1)

rust/ql/test/library-tests/operations/test.rs:54

  • No inline expectation is provided for the ? try operator. Consider adding an expectation comment, for example: // $ Operation Op=? Operands=1 PrefixExpr to validate its classification and operands.
res?;

@geoffw0
Copy link
Contributor Author
geoffw0 commented May 6, 2025

DCA shows nothing interesting, which is what we'd expect for a change like this.

@paldepind
Copy link
Contributor

I wonder if we should use the term "operator" instead of "operation"? I think that's a more precise term for this.

@geoffw0
Copy link
Contributor Author
geoffw0 commented May 12, 2025

I wonder if we should use the term "operator" instead of "operation"? I think that's a more precise term for this.

Perhaps.

I think of the "operator" as the + and the "operation" as the application of + to two particular expressions - in which case the expression we're labelling here seems closer to "operation". But I'm probably biased by years working with the CPP and Swift libraries which both use "operation". As does C#, and two classes (AssignmentOperation and LogicalOperation) in Rust. I'm not in a rush to change all of these!

Another naming issue is that we currently have AssignmentOperation and LogicalOperation but also BinaryExpr and PrefixExpr. I'm tempted to change the latter two to Operation as well (in a follow-up PR) but I'm unsure whether that's really a good change (and whether it will be a pain to do). I'd like to hear your opinion on that as well.

hvitved
hvitved previously approved these changes May 13, 2025
Co-authored-by: Simon Friis Vindum <paldepind@github.com>
@paldepind
Copy link
Contributor

I think of the "operator" as the + and the "operation" as the application of + to two particular expressions - in which case the expression we're labelling here seems closer to "operation". But I'm probably biased by years working with the CPP and Swift libraries which both use "operation". As does C#, and two classes (AssignmentOperation and LogicalOperation) in Rust. I'm not in a rush to change all of these!

If other languages uses "operation" then we should probably just stick to that yes. But as someone not familiar with these conventions I find "operator" much clearer than "operation". For the distinction between and operator and its application something like Operator and OperatorExpr would've made more sense to me.

Another naming issue is that we currently have AssignmentOperation and LogicalOperation but also BinaryExpr and PrefixExpr. I'm tempted to change the latter two to Operation as well (in a follow-up PR) but I'm unsure whether that's really a good change (and whether it will be a pain to do). I'd like to hear your opinion on that as well.

Something along those lines sounds like a good idea to me. Would renaming BinaryExpr to BinaryOperationExpr and vice versa for PrefixExpr on the extractor side be sufficient? That wouldn't be too hard (though we also need upgrade/downgrade scripts now).

@geoffw0
Copy link
Contributor Author
geoffw0 commented May 13, 2025

For the distinction between and operator and its application something like Operator and OperatorExpr would've made more sense to me.

I can see that.

Would renaming BinaryExpr to BinaryOperationExpr and vice versa for PrefixExpr on the extractor side be sufficient? That wouldn't be too hard (though we also need upgrade/downgrade scripts now).

Yes I think that will be the right way to do it.

@geoffw0 geoffw0 merged commit 20a012d into github:main May 13, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Rust Pull requests that update Rust code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0