Skip to content

Server versions before 2020.1 do not accept encoded query param delimiters #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shinchris merged 2 commits into from
Dec 9, 2020
Merged

Server versions before 2020.1 do not accept encoded query param delimiters #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f9c65d
Adds support for older server versions that expect different query st…
Nov 20, 2020
0bcff26
Minor fixes
Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions tableauserverclient/server/endpoint/endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .exceptions import ServerResponseError, InternalServerError, NonXMLResponseError
from .exceptions import ServerResponseError, InternalServerError, NonXMLResponseError, EndpointUnavailableError
from functools import wraps
from xml.etree.ElementTree import ParseError
from ..query import QuerySet
Expand Down Expand Up @@ -39,11 +39,9 @@ def _safe_to_log(server_response):
else:
return server_response.content

def _make_request(self, method, url, content=None, request_object=None,
auth_token=None, content_type=None, parameters=None):
def _make_request(self, method, url, content=None, auth_token=None,
content_type=None, parameters=None):
parameters = parameters or {}
if request_object is not None:
parameters["params"] = request_object.get_query_params()
parameters.update(self.parent_srv.http_options)
parameters['headers'] = Endpoint._make_common_headers(auth_token, content_type)

Expand Down Expand Up @@ -78,12 +76,22 @@ def _check_status(self, server_response):
# anything else re-raise here
raise

def get_unauthenticated_request(self, url, request_object=None):
return self._make_request(self.parent_srv.session.get, url, request_object=request_object)
def get_unauthenticated_request(self, url):
return self._make_request(self.parent_srv.session.get, url)

def get_request(self, url, request_object=None, parameters=None):
return self._make_request(self.parent_srv.session.get, url, auth_token=self.parent_srv.auth_token,
request_object=request_object, parameters=parameters)
if request_object is not None:
try:
# Query param delimiters don't need to be encoded for versions before 3.7 (2020.1)
self.parent_srv.assert_at_least_version("3.7")
parameters = parameters or {}
parameters["params"] = request_object.get_query_params()
except EndpointUnavailableError:
url = request_object.apply_query_params(url)

return self._make_request(self.parent_srv.session.get, url,
auth_token=self.parent_srv.auth_token,
parameters=parameters)

def delete_request(self, url):
# We don't return anything for a delete
Expand Down
4 changes: 1 addition & 3 deletions tableauserverclient/server/request_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@


class RequestOptionsBase(object):
# This method is used if server api version is below 3.7 (2020.1)
def apply_query_params(self, url):
import warnings
warnings.simplefilter('always', DeprecationWarning)
warnings.warn('apply_query_params is deprecated, please use get_query_params instead.', DeprecationWarning)
try:
params = self.get_query_params()
params_list = ["{}={}".format(k, v) for (k, v) in params.items()]
Expand Down
66 changes: 45 additions & 21 deletions test/test_request_option.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ def setUp(self):
self.server = TSC.Server('http://test')

# Fake signin
self.server.version = "3.10"
self.server._site_id = 'dad65087-b08b-4603-af4e-2887b8aafc67'
self.server._auth_token = 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM'

Expand Down Expand Up @@ -141,54 +142,77 @@ def test_multiple_filter_options(self):
def test_double_query_params(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = "http://test/api/2.3/sites/12345/views?queryParamExists=true"
url = self.baseurl + "/views?queryParamExists=true"
opts = TSC.RequestOptions()

opts.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags,
TSC.RequestOptions.Operator.In,
['stocks', 'market']))
opts.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Direction.Asc))

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('queryparamexists=true', resp.request.query))
self.assertTrue(re.search('filter=tags%3ain%3a%5bstocks%2cmarket%5d', resp.request.query))
self.assertTrue(re.search('sort=name%3aasc', resp.request.query))

# Test req_options for versions below 3.7
def test_filter_sort_legacy(self):
self.server.version = "3.6"
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views?queryParamExists=true"
opts = TSC.RequestOptions()

opts.filter.add(TSC.Filter(TSC.RequestOptions.Field.Tags,
TSC.RequestOptions.Operator.In,
['stocks', 'market']))
opts.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Direction.Asc))

resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('queryparamexists=true', resp.request.query))
self.assertTrue(re.search('filter=tags:in:%5bstocks,market%5d', resp.request.query))
self.assertTrue(re.search('sort=name:asc', resp.request.query))

def test_vf(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = "http://test/api/2.3/sites/123/views/456/data"
url = self.baseurl + "/views/456/data"
opts = TSC.PDFRequestOptions()
opts.vf("name1#", "value1")
opts.vf("name2$", "value2")
opts.page_type = TSC.PDFRequestOptions.PageType.Tabloid

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('vf_name1%23=value1', resp.request.query))
self.assertTrue(re.search('vf_name2%24=value2', resp.request.query))
self.assertTrue(re.search('type=tabloid', resp.request.query))

# Test req_options for versions beloe 3.7
def test_vf_legacy(self):
self.server.version = "3.6"
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = self.baseurl + "/views/456/data"
opts = TSC.PDFRequestOptions()
opts.vf("name1@", "value1")
opts.vf("name2$", "value2")
opts.page_type = TSC.PDFRequestOptions.PageType.Tabloid

resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('vf_name1@=value1', resp.request.query))
self.assertTrue(re.search('vf_name2\\$=value2', resp.request.query))
self.assertTrue(re.search('type=tabloid', resp.request.query))

def test_all_fields(self):
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = "http://test/api/2.3/sites/123/views/456/data"
url = self.baseurl + "/views/456/data"
opts = TSC.RequestOptions()
opts._all_fields = True

resp = self.server.users._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.users.get_request(url, request_object=opts)
self.assertTrue(re.search('fields=_all_', resp.request.query))

def test_multiple_filter_options_shorthand(self):
Expand Down
12 changes: 2 additions & 10 deletions test/test_requests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,7 @@ def test_make_get_request(self):
m.get(requests_mock.ANY)
url = "http://test/api/2.3/sites/dad65087-b08b-4603-af4e-2887b8aafc67/workbooks"
opts = TSC.RequestOptions(pagesize=13, pagenumber=15)
resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)

self.assertTrue(re.search('pagesize=13', resp.request.query))
self.assertTrue(re.search('pagenumber=15', resp.request.query))
Expand All @@ -37,10 +32,7 @@ def test_make_post_request(self):
with requests_mock.mock() as m:
m.post(requests_mock.ANY)
url = "http://test/api/2.3/sites/dad65087-b08b-4603-af4e-2887b8aafc67/workbooks"
resp = self.server.workbooks._make_request(requests.post,
url,
content=b'1337',
request_object=None,
resp = self.server.workbooks._make_request(requests.post, url, content=b'1337',
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='multipart/mixed')
self.assertEqual(resp.request.headers['x-tableau-auth'], 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM')
Expand Down
29 changes: 5 additions & 24 deletions test/test_sort.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
class SortTests(unittest.TestCase):
def setUp(self):
self.server = TSC.Server('http://test')
self.server.version = "3.10"
self.server._site_id = 'dad65087-b08b-4603-af4e-2887b8aafc67'
self.server._auth_token = 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM'
self.baseurl = self.server.workbooks.baseurl
Expand All @@ -24,12 +25,7 @@ def test_filter_equals(self):
TSC.RequestOptions.Operator.Equals,
'Superstore'))

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)

self.assertTrue(re.search('pagenumber=13', resp.request.query))
self.assertTrue(re.search('pagesize=13', resp.request.query))
Expand All @@ -53,12 +49,7 @@ def test_filter_in(self):
TSC.RequestOptions.Operator.In,
['stocks', 'market']))

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)
self.assertTrue(re.search('pagenumber=13', resp.request.query))
self.assertTrue(re.search('pagesize=13', resp.request.query))
self.assertTrue(re.search('filter=tags%3ain%3a%5bstocks%2cmarket%5d', resp.request.query))
Expand All @@ -71,12 +62,7 @@ def test_sort_asc(self):
opts.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
TSC.RequestOptions.Direction.Asc))

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)

self.assertTrue(re.search('pagenumber=13', resp.request.query))
self.assertTrue(re.search('pagesize=13', resp.request.query))
Expand All @@ -96,12 +82,7 @@ def test_filter_combo(self):
TSC.RequestOptions.Operator.Equals,
'Publisher'))

resp = self.server.workbooks._make_request(requests.get,
url,
content=None,
request_object=opts,
auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
content_type='text/xml')
resp = self.server.workbooks.get_request(url, request_object=opts)

expected = 'pagenumber=13&pagesize=13&filter=lastlogin%3agte%3a' \
'2017-01-15t00%3a00%3a00%3a00z%2csiterole%3aeq%3apublisher'
Expand Down