7.4 KiB
| kind | id | version | title | description | inputs | outputs | bc-version | technologies | countries | application-area | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| action-skill | al-performance-review | 1 | AL performance review | Reviews AL source changes against performance guidance from BCQuality. |
|
|
|
|
|
|
AL performance review
Reviews AL source changes against the performance knowledge domain in BCQuality and emits a findings report. This is a leaf action skill: it invokes no sub-skills. It is one of the skills composed by al-code-review.
An orchestrator invokes this skill with either a pr-diff (the standard PR-review entry point) or a file-path (single-file review). The skill produces a single JSON document conforming to the DO output contract.
Source
Collect all knowledge files under */knowledge/performance/**/*.md, across every enabled layer (/microsoft/, /community/, /custom/). Relevance trims the result to the subset that applies.
Relevance
Apply the frontmatter matching rules defined in READ (Frontmatter matching semantics) against the task context:
bc-version— the target BC version from the PR branch'sapp.jsonor the orchestrator-supplied version. If unavailable, the dimension isunknown.technologies—[al].countries— the countries declared in the consuming app'sapp.json. Default to the orchestrator's configured context; if absent,unknown.application-area— the union of application areas declared by the changed objects. Pass the actual set; do not substitute[all]. If the area cannot be determined from the changes, the dimension isunknown.
Discard files that are not applicable. Retain conditionally applicable files (any dimension unknown) only when the orchestrator's configuration permits them; findings derived from those files MUST have confidence no higher than medium, AND the finding's message MUST name the dimension or dimensions that were unknown.
Worklist
Narrow the relevant files to the subset that applies to the changes under review. For each relevant file, compute overlap against:
- The changed AL object names and types — especially tables, pages with SourceTable bindings, reports, queries, and codeunits performing record iteration.
- The changed procedures and triggers, weighted toward those that perform loops, Find/FindSet/FindFirst calls, CalcFields, CalcSums, FlowField access, or cross-table navigation.
- Tokens extracted from the diff that relate to data access and hot-path costs (
SetRange,SetFilter,SetLoadFields,SetCurrentKey,FindSet,ReadIsolation,LockTable,ModifyAll,DeleteAll,TextBuilder,Dictionary,temporary,repeat,until,CalcFields,CalcSums).
A file enters the candidate worklist when its keywords intersect the extracted tokens or its topic (derived from filename and Description) matches a changed object type.
Once the candidate worklist is known, resolve layer-precedence conflicts per READ. Drop lower-precedence files whose normative guidance (## Best Practice or ## Anti Pattern) directly contradicts a higher-precedence candidate, and record each dropped file in suppressed with reason: "layer-precedence". Files that would have been candidates but are hidden because their layer is disabled in consumer configuration are recorded with reason: "configuration". Files that never became candidates are NOT recorded in suppressed.
When the post-conflict worklist is empty because no applicable performance knowledge exists, or because configuration suppressed every candidate, emit outcome: "no-knowledge". When the worklist is empty because no applicable performance knowledge matched the changes, emit outcome: "completed" with an empty findings array.
Action
For each worklist entry, evaluate the diff against the file's ## Best Practice and ## Anti Pattern sections. Emit findings as follows:
- When the diff contains a clear match for an Anti Pattern, emit a finding with severity
majororblocker, a message summarizing the anti-pattern,locationpointing to the offending line or range, and areferencesentry pointing to the knowledge file. Useblockeronly when the knowledge file states the anti-pattern violates a platform-level guarantee (for example, documented query timeouts or transaction size limits). When the file does not make such a claim, the ceiling ismajor. - When the diff contains code that contradicts a Best Practice without being a full anti-pattern, emit
minorwith the same reference shape. - When the skill cannot detect a violation but the file is clearly applicable to the change, emit
infociting the file. Repository-wide observations MAY omitlocation.
Set confidence to:
highwhen the detection is based on an unambiguous pattern match (identifier, syntax, object type).mediumwhen detection relies on heuristics or when any frontmatter dimension wasunknown.lowwhen the finding is an advisory derived only from applicability.
Outcome selection:
completed— the skill evaluated every worklist item; default when the skill finishes normally, including when the resultingfindingsarray is empty.no-knowledge— no applicable performance knowledge survived Source, Relevance, configuration filtering, and conflict resolution.findingsis empty.not-applicable— the task context lacks an AL dimension (no AL changes in the diff, ortechnologiesfilter rejected the task).partial— a time or token budget was hit before the worklist was exhausted.summary.coveragereflects the evaluated subset;outcome-reasonexplains the cause.failed— an unrecoverable error occurred.outcome-reasonis required.
Output
Output conforms to the DO output contract. A populated example:
{
"skill": { "id": "al-performance-review", "version": 1 },
"outcome": "completed",
"summary": {
"counts": { "blocker": 0, "major": 1, "minor": 1, "info": 0 },
"coverage": { "worklist-size": 2, "items-evaluated": 2 }
},
"findings": [
{
"id": "microsoft/knowledge/performance/filter-before-find.md",
"severity": "major",
"message": "FindSet is called on a record variable without any prior SetRange/SetFilter. This forces a full-table scan.",
"location": {
"file": "src/Sales/PostingRoutines.Codeunit.al",
"line": 140,
"range": { "start-line": 140, "end-line": 144 }
},
"references": [
{ "path": "microsoft/knowledge/performance/filter-before-find.md" }
],
"confidence": "high"
},
{
"id": "community/knowledge/performance/call-setloadfields-before-filters.md",
"severity": "minor",
"message": "SetLoadFields is called after SetRange. Per the referenced guidance the call must come before filters to be folded into the query plan.",
"location": {
"file": "src/Sales/PostingRoutines.Codeunit.al",
"line": 152
},
"references": [
{ "path": "community/knowledge/performance/call-setloadfields-before-filters.md" }
],
"confidence": "high"
}
],
"suppressed": []
}
The empty-corpus case — BCQuality's state until performance knowledge files land — produces:
{
"skill": { "id": "al-performance-review", "version": 1 },
"outcome": "no-knowledge",
"summary": {
"counts": { "blocker": 0, "major": 0, "minor": 0, "info": 0 },
"coverage": { "worklist-size": 0, "items-evaluated": 0 }
},
"findings": [],
"suppressed": []
}