diff --git a/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage.py b/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage.py index ad058445..88cb2f61 100644 --- a/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage.py +++ b/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage.py @@ -148,7 +148,7 @@ def __init__( to share, as well as those prefixed with '51D_', when share_all_query_string_parameters is False. A string of names separated by commas, which is how a configuration file gives a - list, is read as those names. None shares every parameter. + list, is read as those names. None holds no names. @type header_blacklist: list or str @param header_blacklist: By default, all HTTP headers except Cookie are shared. diff --git a/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage_evidencekeyfilter.py b/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage_evidencekeyfilter.py index c813f627..9438ff5a 100644 --- a/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage_evidencekeyfilter.py +++ b/pipeline/fiftyone_pipeline_engines_fiftyone/src/fiftyone_pipeline_engines_fiftyone/share_usage_evidencekeyfilter.py @@ -74,8 +74,7 @@ def __init__( @param cookie: the name of the cookie that identifies the session @type query_whitelist: list or str @param query_whitelist: query string and form parameters to share as - well as those starting 51D_, or None to share every parameter. A - string is read as names separated by commas. + well as those starting 51D_. None holds no names. A string is read as names separated by commas. @type header_blacklist: list or str @param header_blacklist: headers not to share. A string is read as names separated by commas. @@ -93,8 +92,8 @@ def __init__( query_whitelist = _split_names(query_whitelist) header_blacklist = _split_names(header_blacklist) - self.query_whitelist = None if query_whitelist is None else \ - [parameter.lower() for parameter in query_whitelist] + self.query_whitelist = \ + [parameter.lower() for parameter in query_whitelist or ()] self.header_blacklist = \ [header.lower() for header in header_blacklist or ()] @@ -148,10 +147,9 @@ def filter_evidence_key(self, key): # cookie prefix return field.startswith(FIFTYONE_PREFIX) elif prefix == "query": - # Share every parameter when asked to or when no list was - # given. Otherwise only those starting 51d_ or in the list. + # Share every parameter only when asked to. Otherwise only + # those starting 51d_ or in the list. return self.share_all_query_string_parameters or \ - self.query_whitelist is None or \ field.startswith(FIFTYONE_PREFIX) or \ field in self.query_whitelist else: diff --git a/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_share_usage_evidencekeyfilter.py b/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_share_usage_evidencekeyfilter.py index b31e3ea1..0256ca15 100644 --- a/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_share_usage_evidencekeyfilter.py +++ b/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_share_usage_evidencekeyfilter.py @@ -95,18 +95,24 @@ def test_lists_from_comma_separated_strings(self): self.assertFalse(keys.filter_evidence_key("header.x-other")) self.assertTrue(keys.filter_evidence_key("header.x")) - def test_no_parameter_list_shares_every_parameter(self): + def test_no_parameter_list_shares_only_51d_parameters(self): """! - Check that None in place of the parameters to share shares every - parameter, and an empty list only those starting 51D_. + Check that None in place of the parameters to share holds no + names, as an empty list does, so only parameters starting 51D_ are + shared unless every parameter is. """ - every = ShareUsageEvidenceKeyFilter(query_whitelist=None) - prefixed = ShareUsageEvidenceKeyFilter(query_whitelist=[]) - - self.assertTrue(every.filter_evidence_key("query.campaign")) - self.assertFalse(prefixed.filter_evidence_key("query.campaign")) - self.assertTrue(prefixed.filter_evidence_key("query.51d_campaign")) + for query_whitelist in (None, []): + prefixed = ShareUsageEvidenceKeyFilter( + query_whitelist=query_whitelist) + every = ShareUsageEvidenceKeyFilter( + query_whitelist=query_whitelist, + share_all_query_string_parameters=True) + + self.assertFalse(prefixed.filter_evidence_key("query.campaign")) + self.assertTrue( + prefixed.filter_evidence_key("query.51d_campaign")) + self.assertTrue(every.filter_evidence_key("query.campaign")) def test_session_cookie(self): """! diff --git a/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_usage.py b/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_usage.py index adff0aa0..c415387e 100644 --- a/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_usage.py +++ b/pipeline/fiftyone_pipeline_engines_fiftyone/tests/test_usage.py @@ -1038,11 +1038,11 @@ def test_parameter_names_with_dots(self): def test_empty_query_whitelist(self): """! Check that, with sharing every parameter turned off, an empty - list of parameters to share shares only those starting 51D_, and - that None shares every parameter. + list of parameters to share and None both share only those + starting 51D_. """ - for query_whitelist, shared in (([], False), (None, True)): + for query_whitelist in ([], None): app.received = [] usage = ShareUsage( requested_package_size=1, @@ -1062,7 +1062,7 @@ def test_empty_query_whitelist(self): self.waitForUsageThreads() self.assertEqual(len(app.received), 1) self.assertIn("fiftyone value", app.received[0]) - self.assertEqual("campaign value" in app.received[0], shared) + self.assertNotIn("campaign value", app.received[0]) def test_session_cookie(self): """!