feat: parse <statusNotes>/<statusNote> into JobItem.status_notes (#1850) - #1852
Merged
stephendeoca merged 1 commit intoAug 6, 2026
Merged
feat: parse <statusNotes>/<statusNote> into JobItem.status_notes (#1850)#1852stephendeoca merged 1 commit into
stephendeoca merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
The REST Query Job response schema documents a structured status-notes
block:
<statusNotes>
<statusNote type="CountOfUsersAddedToSite" value="5" text="..." />
<statusNote type="CountOfUsersSkipped" value="1" text="..." />
</statusNotes>
JobItem was parsing only the sibling legacy `<notes>` element (emitted
by some job types like extractRefreshJob), missing the modern
statusNotes entirely. For UserImport jobs and any other multi-row job
where individual rows have distinct outcomes, `job.notes` came back as
an empty list even when the server had sent detailed structured status.
Add `JobItem.status_notes: list[dict]`, each dict with keys `type`,
`value`, `text` (any of which may be None if the server omitted them).
The legacy `notes: list[str]` attribute is unchanged for backwards
compatibility -- it still parses the `<notes>` element still emitted by
extract-refresh and similar older job types.
Verified against the public REST doc:
https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job
The existing job_get_by_id.xml test asset already contained a
statusNotes block; the get_by_id test now asserts the structured value
in addition to the legacy notes list. Two new tests cover the absent
case (yields []) and the multi-note case with attribute omissions.
Discovered while planning tabcmd createsiteusers nowait / silent-progress
work (tableau/tabcmd#35); a live probe against Tableau Server 2025.1
confirmed the server emits this schema for UserImport jobs.
Fixes #1850.
Copy link
Copy Markdown
Sorry, something went wrong.
stephendeoca
self-requested a review
August 6, 2026 17:39
stephendeoca
approved these changes
Aug 6, 2026
4 tasks
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.
Summary
The REST Query Job response schema documents a structured status-notes block:
JobItem was parsing only the sibling legacy <notes> element (emitted by some job types like extractRefreshJob), missing the modern statusNotes entirely. For UserImport jobs and any other multi-row job where individual rows have distinct outcomes, job.notes came back as an empty list even when the server had sent detailed structured status.
Fix
Add JobItem.status_notes: list[dict], each dict with keys type, value, text (any of which may be None if the server omitted them). The legacy notes: list[str] attribute is unchanged for backwards compatibility — it still parses the <notes> element still emitted by extract-refresh and similar older job types.
Verification
Closes #1850.
Test plan
Discovered while
Planning tabcmd createsiteusers --nowait / --silent-progress work (tableau/tabcmd#35). Switching from the per-user users.add loop to bulk_add + wait_for_job for Classic parity needs per-row status back — which needed this data.
🤖 Generated with Claude Code