mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 14:46:55 +01:00
Fix ten focused correctness items plus sample links from Jesper's 2026-09-15 re-review
Six carried-over threads: - api-page-least-privilege-write-access fixtures: added the mandatory EntityName/EntitySetName properties (AL0485). - pages-must-not-contain-business-logic fixtures: Sales Line has no "Total Amount" field; replaced with the real "Line Amount" (field 103). - test-feature-scenario-tags.good.al and test-one-when-per-test.good.al: CreatePriceHeader leaves a price list in Draft status, which price calculation ignores. Added Validate(Status, Active) + Modify before the sales line that depends on it. Verified Status field/enum against PriceListHeader.Table.al and PriceStatus.Enum.al in the BCApps clone. - exposed-objects-must-be-in-a-permission-set.md: a published codeunit is a SOAP endpoint (SOAP is deprecated), not OData - Page/Query are the OData object types. Corrected and pointed new integrations at API pages/queries instead. - al-error-handling-review.md: the log-writes-must-survive-rollback cue selected on Session.StartSession, which only appears in the compliant fix, never in the anti-pattern - the bad fixture could never be worklisted. Recued on the actual risk shape (log insert around a failed TryFunction/GetLastError* path, then raise/propagate), with StartSession as an explicit compliant discriminator instead. - page-design-must-match-bc-page-type-conventions.md: the enum value is NavigatePage, not Navigate; noted the type list is a selected subset, not an exhaustive PageType catalogue (PromptDialog, ConfigurationDialog, UserControlHost, XmlPort also exist, out of this article's scope). Four new correctness gaps: - release-must-update-app-version.md: "the version is the only identity" was backwards - id is the app's stable identity, version identifies a release/code-state of it. - defensive-vs-offensive-code-must-match-blast-radius.good.al: the "low blast radius" example had no else branch, so a failed Customer.Get() left the field at its prior/default value instead of the explicit chosen fallback the article claims to demonstrate. Added the else. - bcpt-scenarios-must-be-app-specific.good.al: InitTest and both measured StartScenario/EndScenario sections were empty/comment-only, so the "app-specific" fixture measured no actual work. Filled in a real, self-contained header+line creation path. - upgrade-tag-logic-must-not-nest-deeply.good.al: the flattened version dropped both safety conditions the bad fixture had (Discount % = 0, nonblank posting group), silently changing behavior instead of just removing nesting. Extracted the guarded update into a helper with both conditions preserved as early exits. Also converted this PR's remaining plain-backtick "See sample:" sample references (16 articles) to the READ-convention markdown-link form, matching the fix already made on #156/#158. Rebased onto upstream/main (conflicts in al-ui-review.md, al-style-review.md, al-upgrade-review.md against merged upstream PRs - all additive, both sides' worklist cues retained).
This commit is contained in:
parent
3842ef7138
commit
67962727f6
27 changed files with 96 additions and 47 deletions
|
|
@ -12,8 +12,13 @@ application-area: [all]
|
|||
## Description
|
||||
|
||||
Business Central's page types — RoleCenter, Card, List, CardPart,
|
||||
ListPart, Worksheet, Document, ListPlus, plus the system dialog types
|
||||
(Navigate, ConfirmationDialog, StandardDialog, HeadlinePart, API) — each
|
||||
ListPart, Worksheet, Document, ListPlus, plus system dialog/special
|
||||
types such as `NavigatePage`, `ConfirmationDialog`, `StandardDialog`,
|
||||
`HeadlinePart`, and `API` (a selected list of conventional types this
|
||||
article covers design conventions for — not an exhaustive catalogue of
|
||||
every current `PageType` value; `PromptDialog`, `ConfigurationDialog`,
|
||||
`UserControlHost`, and `XmlPort` also exist but follow their own
|
||||
design rules, out of scope here) — each
|
||||
fix a naming pattern and a structural constraint, not just a visual
|
||||
layout. A page whose name, primary-key handling, or linkage
|
||||
(`CardPageID`, `SubPageLink`, `AutoSplitKey`) doesn't match its own type's
|
||||
|
|
@ -56,7 +61,7 @@ Match the page's design to its type:
|
|||
header; named for the document (`Sales Invoice`).
|
||||
- **ListPlus** — like Document but with multiple lists instead of one;
|
||||
named like the record/report it summarizes.
|
||||
- System dialog types (`Navigate`, `ConfirmationDialog`,
|
||||
- System dialog types (`NavigatePage`, `ConfirmationDialog`,
|
||||
`StandardDialog`, `HeadlinePart`) are fixed shapes with no page-name
|
||||
suffix convention. `API` pages follow their own property rules and are
|
||||
extended by adding a new API page, never a page extension.
|
||||
|
|
@ -66,7 +71,7 @@ tasks the page serves, the concrete fields/commands/links those tasks
|
|||
need, the page type that matches the content (chosen before the source
|
||||
table), and the source table that actually holds the page's primary data.
|
||||
|
||||
See sample: `page-design-must-match-bc-page-type-conventions.good.al`.
|
||||
See sample: [`page-design-must-match-bc-page-type-conventions.good.al`](page-design-must-match-bc-page-type-conventions.good.al).
|
||||
|
||||
## Anti Pattern
|
||||
|
||||
|
|
@ -82,4 +87,4 @@ and pages intended only to be reached through another workflow correctly
|
|||
have no `UsageCategory` — flag its absence only on a page intended as a
|
||||
searchable entry point in its own right.
|
||||
|
||||
See sample: `page-design-must-match-bc-page-type-conventions.bad.al`.
|
||||
See sample: [`page-design-must-match-bc-page-type-conventions.bad.al`](page-design-must-match-bc-page-type-conventions.bad.al).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue