Skip to content

fix: preserve case of customSubscriptionEmail and customSubscriptionFooter (#1849) - #1851

Open
jacalata wants to merge 1 commit into
developmentfrom
jac/1849-subscription-lowercase
Open

fix: preserve case of customSubscriptionEmail and customSubscriptionFooter (#1849)#1851
jacalata wants to merge 1 commit into
developmentfrom
jac/1849-subscription-lowercase

Conversation

@jacalata

@jacalata jacalata commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

RequestFactory.Site.update_req and create_req called str(value).lower() on customSubscriptionEmail and customSubscriptionFooter when serializing to XML, silently mangling caller intent.

site.custom_subscription_email = "Sales@Company.com"
site.custom_subscription_footer = "Sent by Tableau -- Confidential."
server.sites.update(site)
# server received: customSubscriptionEmail="sales@company.com"
#                  customSubscriptionFooter="sent by tableau -- confidential."

Impact

  • Email: cosmetic (SMTP treats mailboxes case-insensitively in practice), but recipients saw the wrong-case "from" address.
  • Footer: functionally broken. The footer is displayed verbatim in outgoing subscription emails, so lowercasing removed company-name casing, sentence capitalization, brand terms, etc. Anyone setting a customer-facing footer via TSC got a mangled result with no workaround short of the web UI.

Verification

Read the server-side code path to confirm the server does not itself lowercase these fields:

  • RestApiSiteParamsBuilder.setCustomEmail / setCustomEmailFooter at tab-api-restapi-all/.../RestApiSiteParamsBuilder.java:461-488 — pure passthrough from request payload into withCustomReplyToEmail / withCustomEmailFooter.
  • SiteParams.withCustomReplyToEmail / withCustomEmailFooter at tab-domain-site-interfaces/.../SiteParams.java:671-680 — direct assignment to member fields.
  • Site.setCustomReplyToEmail at tab-domain-site/.../entity/Site.java:495-497 — direct assignment; JPA column custom_subscription_email.
  • SiteParamsValidator.java:170 validates the email is a well-formed address; does not modify case. Footer has no validation.
  • No toLowerCase() anywhere in the server-side write chain.

Cross-checked against tabcmd Classic (which uses a different ClientXML endpoint but same user-facing semantics): Classic sends both strings verbatim as multipart form parts (EditSite.java:179-182, StringPart.java:33-36). No case normalization on the Classic client side either.

Fix

Drop .lower() on both string values in both update_req and create_req. The paired *Enabled boolean attributes still get .lower()'d (they need to serialize as "true"/"false") — just the string values are now sent verbatim.

Closes #1849.

Test plan

  • Two new regression tests in test/test_site.py — one for update_req, one for create_req, both asserting the exact case of email + footer survives to the XML request body
  • Full test_site.py suite: 28 passed
  • mypy clean

Discovered while

Implementing tabcmd editsite parity (tableau/tabcmd#437, tableau/tabcmd#452).

🤖 Generated with Claude Code

…ooter (#1849)

RequestFactory.Site.update_req and create_req called `str(value).lower()`
on customSubscriptionEmail and customSubscriptionFooter when serializing to
XML, silently mangling caller intent:

    site.custom_subscription_email = "Sales@Company.com"
    site.custom_subscription_footer = "Sent by Tableau -- Confidential."
    server.sites.update(site)
    # server received: customSubscriptionEmail="sales@company.com"
    #                  customSubscriptionFooter="sent by tableau -- confidential."

Impact:
- Email: cosmetic only (SMTP treats mailboxes case-insensitively in
  practice), but recipients see the wrong-case "from" address.
- Footer: functionally broken. The footer is displayed verbatim in
  outgoing subscription emails, so lowercasing removes company-name
  casing, sentence capitalization, brand terms, etc. Anyone setting a
  customer-facing footer via TSC got a mangled result with no workaround
  short of the web UI.

Drop the .lower() on both string values in both code paths. The paired
*Enabled boolean attributes still get .lower()d (they need to serialize
as "true"/"false"), just the string values are now sent verbatim.

Discovered while implementing tabcmd editsite parity
(tableau/tabcmd#437, tabcmd PR #452).

Fixes #1849.
@github-actions

github-actions Bot commented Aug 4, 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.py1871010 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%
TOTAL12002142388% 

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.

RequestFactory silently lowercases customSubscriptionEmail and customSubscriptionFooter on site create/update

1 participant