Skip to content

feat: parse <statusNotes>/<statusNote> into JobItem.status_notes (#1850) - #1852

Open
jacalata wants to merge 1 commit into
developmentfrom
jac/1850-statusnotes
Open

feat: parse <statusNotes>/<statusNote> into JobItem.status_notes (#1850)#1852
jacalata wants to merge 1 commit into
developmentfrom
jac/1850-statusnotes

Conversation

@jacalata

@jacalata jacalata commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

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.

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

  • The existing test/assets/job_get_by_id.xml test asset already contains both a <notes> element and a <statusNotes>/<statusNote> block. test_get_by_id now asserts the structured value in addition to the legacy notes list.
  • Live-verified against Tableau Server 2025.1 via POST /sites/<id>/users/import + GET /sites/<id>/jobs/<job-id> — the server sends <statusNote type="line" value="0" />, <statusNote type="errorCode" value="1" />, etc. for failures. The prior job.notes was [] for these responses.

Closes #1850.

Test plan

  • test/test_job.py::test_get_by_id augmented to assert the structured status_notes from the existing asset
  • test_status_notes_empty_when_absent — job with no <statusNotes> yields []
  • test_status_notes_multiple_entries — 4-entry list, exercises the text attribute coming back as None when omitted
  • Full test_job.py suite: 16 passed
  • Full TSC test suite: 868 passed, 1 skipped

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

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.
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

Coverage

Coverage Report
FileStmtsMissCoverMissing
tableauserverclient
   __init__.py50100% 
   config.py150100% 
   datetime_helpers.py2511 96%
   exponential_backoff.py200100% 
   filesys_helpers.py310100% 
   namespace.py2633 88%
tableauserverclient/bin
   __init__.py20100% 
   _version.py358212212 41%
tableauserverclient/helpers
   __init__.py10100% 
   logging.py20100% 
   strings.py3111 97%
tableauserverclient/models
   __init__.py460100% 
   collection_item.py4177 83%
   column_item.py553232 42%
   connection_credentials.py351111 69%
   connection_item.py941414 85%
   custom_view_item.py1442121 85%
   data_acceleration_report_item.py5411 98%
   data_alert_item.py15844 97%
   data_freshness_policy_item.py1551515 90%
   database_item.py2073636 83%
   datasource_item.py3001212 96%
   dqw_item.py10455 95%
   exceptions.py40100% 
   extensions_item.py13244 97%
   extract_item.py4444 91%
   favorites_item.py6988 88%
   fileupload_item.py190100% 
   flow_item.py1491010 93%
   flow_run_item.py710100% 
   group_item.py8966 93%
   groupset_item.py4977 86%
   interval_item.py1823232 82%
   job_item.py1921010 95%
   linked_tasks_item.py7911 99%
   location_item.py2922 93%
   metric_item.py1291313 90%
   oidc_item.py6333 95%
   pagination_item.py3411 97%
   permissions_item.py1111212 89%
   project_item.py2073131 85%
   property_decorators.py1001818 82%
   reference_item.py2622 92%
   revision_item.py5911 98%
   schedule_item.py20966 97%
   server_info_item.py3777 81%
   site_item.py6361313 98%
   subscription_item.py10122 98%
   table_item.py1191818 85%
   tableau_auth.py612525 59%
   tableau_types.py2711 96%
   tag_item.py150100% 
   target.py60100% 
   task_item.py5622 96%
   user_item.py3101818 94%
   view_item.py2201616 93%
   virtual_connection_item.py6488 88%
   webhook_item.py6911 99%
   workbook_item.py3621616 96%
tableauserverclient/server
   __init__.py90100% 
   exceptions.py40100% 
   filter.py2911 97%
   pager.py3311 97%
   query.py1431515 90%
   request_factory.py1335195195 85%
   request_options.py38655 99%
   server.py1882323 88%
   sort.py60100% 
tableauserverclient/server/endpoint
   __init__.py350100% 
   auth_endpoint.py771111 86%
   custom_views_endpoint.py1521212 92%
   data_acceleration_report_endpoint.py210100% 
   data_alert_endpoint.py942323 76%
   databases_endpoint.py1113030 73%
   datasources_endpoint.py3233333 90%
   default_permissions_endpoint.py4433 93%
   dqw_endpoint.py451616 64%
   endpoint.py2122020 91%
   exceptions.py7766 92%
   extensions_endpoint.py310100% 
   favorites_endpoint.py942222 77%
   fileuploads_endpoint.py510100% 
   flow_runs_endpoint.py6299 85%
   flow_task_endpoint.py2122 90%
   flows_endpoint.py1985353 73%
   groups_endpoint.py12699 93%
   groupsets_endpoint.py7277 90%
   jobs_endpoint.py6799 87%
   linked_tasks_endpoint.py370100% 
   metadata_endpoint.py881414 84%
   metrics_endpoint.py5566 89%
   oidc_endpoint.py4211 98%
   permissions_endpoint.py4433 93%
   projects_endpoint.py1782424 87%
   resource_tagger.py1273535 72%
   schedules_endpoint.py1191111 91%
   server_info_endpoint.py361010 72%
   sites_endpoint.py1302727 79%
   subscriptions_endpoint.py561414 75%
   tables_endpoint.py1103636 67%
   tasks_endpoint.py6366 90%
   users_endpoint.py18388 96%
   views_endpoint.py15099 94%
   virtual_connections_endpoint.py1131010 91%
   webhooks_endpoint.py5499 83%
   workbooks_endpoint.py3382222 93%
TOTAL12007142388% 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JobItem drops statusNotes from job responses (per-row detail lost)

1 participant