JS: Recognize Workflow SDK 'use workflow' and 'use step' directives - #22713
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The exact-match implementation satisfies the issue and is covered by positive and negative tests.
Review effort: Balanced
Findings: None
What changed in this PR
Recognizes Workflow SDK directives to prevent false positives from js/unknown-directive.
Changes:
- Adds exact-match known directive classes for
use workflowanduse step. - Adds positive, negative, and regression test coverage.
- Adds a JavaScript library change note.
| File | Description |
|---|---|
javascript/ql/lib/semmle/javascript/Stmt.qll |
Defines both known directives. |
javascript/ql/test/library-tests/Directives/tst.js |
Adds directive fixtures. |
javascript/ql/test/library-tests/Directives/KnownDirective.expected |
Updates expected recognized directives. |
javascript/ql/test/query-tests/Expressions/UnknownDirective/UnknownDirective.js |
Tests valid directives and misspellings. |
javascript/ql/test/query-tests/Expressions/UnknownDirective/UnknownDirective.expected |
Records expected typo alerts. |
javascript/ql/lib/change-notes/2026-09-30-workflow-sdk-directives.md |
Documents the analysis improvement. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Fixes #22701 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jketema
force-pushed
the
js/workflow-sdk-directives
branch
from
September 30, 2026 13:32
8087646 to
f49ebeb
Compare
jketema
marked this pull request as ready for review
September 30, 2026 13:34
asgerf
approved these changes
Sep 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #22701.
The
js/unknown-directivequery flagged the Workflow SDK function directives'use workflow'and'use step'as unknown, suggesting their removal (which would change durable workflow/step behavior).This adds
UseWorkflowDirectiveandUseStepDirectiveasKnownDirectives, alongside the existinguse server/use client/use cachedirectives, with test coverage in theDirectiveslibrary test and theUnknownDirectivequery test.