STR30-C: use new DataFlow module by mbaluda · Pull Request #1203 · github/codeql-coding-standards · GitHub
Skip to content

STR30-C: use new DataFlow module - #1203

Open
mbaluda wants to merge 3 commits into
mainfrom
mbaluda/STR30-C-new-dataflow
Open

mbaluda wants to merge 3 commits into
mainfrom
mbaluda/STR30-C-new-dataflow

Conversation

@mbaluda

@mbaluda mbaluda commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Migrates STR30-C to semmle.code.cpp.dataflow.new.DataFlow.
The migration preserves the existing alert set while substantially simplifying the query.
Handles direct writes separately from global flow, preventing use-use flow from producing duplicate source/write combinations.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • STR30-C

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@mbaluda
mbaluda marked this pull request as ready for review September 24, 2026 11:20
Copilot AI balanced review requested due to automatic review settings September 24, 2026 11:20
@mbaluda

mbaluda commented Sep 24, 2026

Copy link
Copy Markdown
Collaborator Author

@github-actions

Copy link
Copy Markdown

🏁 Beep Boop! Performance testing for this PR has been initiated. Please check back later for results. Note that the query package generation step must complete before testing will start so it might be a minute.

💡 If you do not hear back from me please check my status! I will report even if I fail!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The dataflow migration requires a change note under repository policy.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Migrates STR30-C to the newer CodeQL dataflow API while retaining existing expected alerts.

Changes:

  • Refactors string-literal source, sink, and flow modeling.
  • Removes obsolete deprecation warnings from test expectations.
  • Missing the required change note for altered query evaluation.
File Description
DoNotAttemptToModifyStringLiterals.ql Migrates and simplifies dataflow logic.
DoNotAttemptToModifyStringLiterals.expected Removes deprecated-module warnings.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread c/cert/src/rules/STR30-C/DoNotAttemptToModifyStringLiterals.ql
@codeql-coding-standards-automation

Copy link
Copy Markdown

@mbaluda
mbaluda requested review from a team and MichaelRFairhurst September 24, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants