Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/microsoft/knowledge/performance/guard-event-subscribers-before-db-call.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.7 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
all
performance
event-subscriber
guard
db-call
frequently-fired
validate
al
w1
all

Guard event subscribers with cheap checks before any database call

Description

Event subscribers fire on every event matching their signature — for OnAfterValidateEvent on a hot field like Sales Line.Quantity, that is every quantity edit by every user. Per the upstream guidance, "Keep event subscriber code lightweight" and "Avoid database operations in frequently-fired events — guard with cheap checks first." A Get or FindFirst at the top of such a subscriber pays a database round-trip on every fire, including the calls for which the subscriber's work was not needed.

Best Practice

Open the subscriber with an in-memory predicate that filters out the calls the subscriber does not handle — record type, document type, status, parameter-passed flags. Only after the cheap guard passes should the body issue a database call, and only with SetLoadFields for the columns the body actually reads.

See sample: guard-event-subscribers-before-db-call.good.al.

Anti Pattern

[EventSubscriber(...'OnAfterValidateEvent', 'Quantity', ...)] local procedure ... var Item: Record Item; begin Item.Get(Rec."No."); if Item.HasCustomPricing() then ...; — Item.Get runs on every quantity change, including changes to lines whose Type is not Item. A pre-check if Rec.Type <> Rec.Type::Item then exit; ahead of the Get removes most of the calls.

See sample: guard-event-subscribers-before-db-call.bad.al.