mirror of
https://github.com/okieselbach/AutopilotMonitor.git
synced 2026-10-24 12:42:38 +00:00
Oliver Kieselbach
5ba5942d0b
The catalog held 2 of 607 entries in entra-join, while the 0x801Cxxxx DSREG family is what an enrollment meets during hybrid join and the ESP account-setup phase. The Windows Hello PIN error page is the only MS table that documents it; both of its tables are now parsed, restricted to 0x801c* (607 -> 641 entries). The block runs after PROSE_ENTRIES so the Autopilot-specific text for 0x801c03ea keeps precedence over the generic one. The Mitigation column is not carried -- the catalog describes codes, it does not advise. A "SYMBOL: text" cell yields a symbol (0x801c004d -> DSREG_NO_DEFAULT_ACCOUNT). The run fails below 30 keys, because parseTables drops non-matching rows silently and a reshaped page would otherwise look like a clean run. decode() now strips zero-width and bidi marks: the page carries U+200B in one hex cell and four description cells, JS \s does not match it, and such a hex cell fails every ^0x...$ test. Placed in decode() rather than in the new source so the next parsed page cannot walk into it -- regeneration shows 34 added, 0 changed. 0x801C044F, the zero-hit lookup that started this, is on none of the three MS pages and deliberately stays unknown.
6.5 KiB
6.5 KiB
Error-code catalog generator
generate.mjs rebuilds src/Shared/AutopilotMonitor.Shared/Resources/error-codes.json
(schemaVersion 2) from primary sources and refreshes the web copy through
src/Web/autopilot-monitor-web/scripts/sync-error-codes.js. The catalog is never edited by
hand: a wrong or missing entry is fixed in the generator (a source, a pin, a family rule) and
regenerated, so the next regeneration cannot lose the fix.
IME_ENUMS_JSON=<path> node tools/error-codes/generate.mjs [--cache-dir DIR] [--check]
IME_ENUMS_JSON— enum extract of one Intune Management Extension build (imeVersion,customErrorCodes,enforcementStates,msiRetriableErrorCodes,deliveryOptimization). Produced by operator tooling; the generator only reads the JSON.--cache-dir DIR— keeps the fetched pages as files for offline reruns.--check— exits 1 when the committed catalog differs from the generator output.
Entry shape
| Field | Meaning |
|---|---|
| key | lowercase 8-digit hex (0x80070005) or a decimal MSI exit code (1603). Decimal keys exist only for 0, 1601–1654 and 3010: exit codes of other installers are author-defined. Win32 codes live only as 0x8007xxxx; a HRESULT_FROM_WIN32 value whose low word is in the MSI range resolves to the decimal entry at lookup time (derivedFromWin32). |
description |
one line, taken from the source (see rules below) |
confidence |
high = MS Learn table/page or the IME build named in source; medium = paraphrase of an enum member name or of an analysis rule; low = carried over from the v1 catalog without a primary source |
source |
msdoc:<learn.microsoft.com URL> · ime:<version> · winerror.h · rule:<RULE-ID> · legacy-catalog-v1 |
category |
msi win32 com appx windows-update cbs intune-win32 intune-mobile mdm-enrollment autopilot entra-join delivery-optimization |
symbol |
optional: the winerror.h/WU/AppX symbol, or the IME enum member name |
imeRetriesDuringEsp |
optional: one of the MSI return codes the IME retries automatically during the Autopilot ESP |
enforcementStates is a second map: IME app enforcement state number → { name, description }.
Sources and family rules
Families are processed in this order; the first family that yields a key wins and later duplicates are reported on stderr.
| Family | Source | Rule |
|---|---|---|
| win32 | System Error Codes (per-range pages), WinHTTP error messages | Seed = codes seen in the field (WIN32_FIELD_SEEN) ∪ the IME MSI-retry list ∪ every 0x8007xxxx code another family names, minus the MSI decimal range and the AppX page's own range. Symbol and text verbatim. A seed code the reference does not list fails the run. |
| msi | Windows Installer error codes | Rows in the MSI decimal range only; verbatim. |
| com | winerror.h |
Hand-listed HRESULTs that are not Win32-derived (S_OK, E_FAIL, E_UNEXPECTED, HTTP/RPC status HRESULTs the Delivery Optimization client names). |
| appx | Troubleshooting packaging, deployment, and query of Windows apps | Whole table; first sentence of the cell. Authority for its own 0x80073Cxx/0x80073Dxx range. |
| windows-update | Windows Update error codes by component | Sections an enrollment can meet (agent core, handlers, download manager, protocol talker, data store, drivers, MSI handler, agent setup, AU client); verbatim. |
| windows-update / cbs | Windows Update common errors | One table per single-code heading; symbol = text before ; in the Message cell, description = text after it, else the Description cell. 0x800F… → cbs. |
| intune-mobile / intune-win32 | Intune app installation error codes | iOS/iPadOS and Windows tables (Android skipped); description = the message cell. |
| mdm-enrollment / autopilot / entra-join | Windows enrollment errors, Autopilot known issues | Prose pages: one-sentence paraphrase listed in PROSE_ENTRIES; the generator asserts the code appears on the page. Codes only our analysis rules name carry rule: and medium. |
| entra-join | Windows Hello errors during PIN creation | Both tables parsed (Hex | Cause | Mitigation and the "unknown mitigation" one); the Cause column is the description, Mitigation is advice and is not carried. Only 0x801c* — the page also lists NTE crypto codes, a Win32 code the win32 family owns, and codes with no category here. Runs after PROSE_ENTRIES so the Autopilot-specific text for 0x801c03ea wins. A SYMBOL: text cell yields symbol. Fails the run below 30 keys, so a reshaped page cannot silently shrink the family. |
intune-win32 (0x87D3xxxx) |
IME CustomErrorCodes enum |
Member name as symbol, humanised as description, medium. Two known sign/digit defects in the enum source are corrected by IME_ENUM_FIXUPS; a build that fixes them makes the run fail so the fixup is removed. |
delivery-optimization (0x80D0xxxx) |
IME DeliveryOptimizationConstants |
Member name as symbol, humanised, medium. |
| legacy | v1 catalog | Entries no primary source covers, low. |
Description rules: whole sentences up to 200 characters, cross-reference sentences
("For more information, see …") dropped, no trailing period. DESCRIPTION_PINS holds the
few wordings consumers depend on (each says the same as the source row it replaces).
Regeneration checklist
- Run the generator (with
--cache-dirwhen iterating). - Read the stderr summary: entry count per family, dropped duplicates.
git diffthe catalog; a removed key needs a reason (the C#, web and MCP tests pin the keys the product relies on).- Spot-check ten random entries per family against the source page.
- Build and run the Backend, Web and MCP test suites.