JS: Mass promotion of queries to quality status
#19776
Conversation
Napalys
force-pushed
the
js/mass_quality_promotion
branch
from
7686f1f to
69734a8
Compare
Napalys
force-pushed
the
js/mass_quality_promotion
branch
from
69734a8 to
0c31838
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR promotes various JavaScript CodeQL queries to quality status by adding the @tags quality annotation and updating related tags, and updates the integration-tests suite to include all newly promoted queries.
- Bulk update: Added
@tags qualityand refined tag lists in Declarations, DOM, AngularJS, and other query modules. - Test suite update: Extended
javascript-code-quality.qls.expectedto cover all newly promoted queries.
Reviewed Changes
Copilot reviewed 96 out of 96 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| javascript/ql/src/Declarations/* | Added @tags quality and adjusted tags on declaration queries |
| javascript/ql/src/DOM/* | Added @tags quality and refined tags on DOM queries |
| javascript/ql/src/AngularJS/* | Added @tags quality and refined tags on AngularJS queries |
| javascript/ql/integration-tests/query-suite/javascript-code-quality.qls.expected | Updated expected suite list to include all promoted queries |
Comments suppressed due to low confidence (1)
javascript/ql/src/DOM/PseudoEval.ql:11
- The CWE identifier was changed from
cwe-676tocwe-67, which appears incorrect. Please restore the correct identifier (e.g.,external/cwe/cwe-676).
* external/cwe/cwe-67
| * maintainability | ||
| * readability |
There was a problem hiding this comment.
This seems more like correctness to me, like the tags originally said. (And copilot agreed, fwiw.)
| * correctness | ||
| * @tags quality | ||
| * maintainability | ||
| * readability |
There was a problem hiding this comment.
I think this should be correctness, because in the majority of cases it indicates a copy-paste error/typo, and the user will adjust the condition rather than deleting that branch. That's how we've tagged this query in go, which has the same query. And it matches how this query was tagged before this PR.
There was a problem hiding this comment.
It feels like a bit of a gray area. When you look at the top-level categories, you could make a case for either. Sometimes, duplicate conditions hint at a copy-paste mistake (which could affect correctness), but not always. To me, it felt more like this falls under for queries that detect patterns that make it harder for developers to make changes to the code rather than for queries that detect issues that affect whether the code will perform as expected during execution.
That’s why I ended up leaning more towards @tags maintainability and specifically @tags readability.
I actually debated between @tags useless-code and @tags readability, and I thought I’d get more comments here. 😄
But I really don’t mind changing it to correctness and reliability, we’ll probably change these tags quite a bit over time anyway, depending on feedback. :)
| @@ -7,10 +7,9 @@ | |||
| * @id js/useless-expression | |||
| * @tags quality | |||
| * maintainability | |||
| * correctness | |||
| * useless-code | |||
There was a problem hiding this comment.
I went for correctness for go. I think that is the more interesting case, that the quality result makes the user realise that they meant to write something different. The examples in the javascript qhelp show me that there are situations in javascript where a seemingly useless expression actually has side effects, so perhaps the situation is different for javascript.
There was a problem hiding this comment.
Again, it really feels like a gray area, and I could easily justify using correctness, useless-code, or readability.
This PR promotes multiple JavaScript queries by adding quality-related tags, clearly indicating their promotion to quality status.
Notes for reviewers:
js/loop-iteration-skipped-due-to-shiftingbecause it is currently being promoted in another pr JS: Promotejs/loop-iteration-skipped-due-to-shiftingto the Code Quality suite #19743