Skip to content

Make HTTPS the default protocol in emitter (close #14) #288

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
Jack Keene (Jack-Keene) merged 3 commits into from
Oct 31, 2022
Merged

Make HTTPS the default protocol in emitter (close #14) #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db0c988
Set https as default protocol
Jack-Keene Oct 31, 2022
c7b0f55
Add unit tests
Jack-Keene Oct 31, 2022
121a404
Edit set assignment
Jack-Keene Oct 31, 2022
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
13 changes: 9 additions & 4 deletions snowplow_tracker/emitters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class Emitter(object):
def __init__(
self,
endpoint: str,
protocol: HttpProtocol = "http",
protocol: HttpProtocol = "https",
port: Optional[int] = None,
method: Method = "get",

@matus-tomlein Matus Tomlein (matus-tomlein) Oct 31, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fyi, I think it would be good to move to POST as the default method, but I have a dilemma about the default buffer size that I think we should discuss a bit more. Wrote it down in the issue here.

buffer_size: Optional[int] = None,
Expand All @@ -60,9 +60,9 @@ def __init__(
byte_limit: Optional[int] = None,
request_timeout: Optional[Union[float, Tuple[float, float]]] = None) -> None:
"""
:param endpoint: The collector URL. Don't include "http://" - this is done automatically.
:param endpoint: The collector URL. If protocol is not set in endpoint it will automatically set to "https://" - this is done automatically.
:type endpoint: string
:param protocol: The protocol to use - http or https. Defaults to http.
:param protocol: The protocol to use - http or https. Defaults to https.
:type protocol: protocol
:param port: The collector port to connect to
:type port: int | None
Expand Down Expand Up @@ -116,7 +116,7 @@ def __init__(
@staticmethod
def as_collector_uri(
endpoint: str,
protocol: HttpProtocol = "http",
protocol: HttpProtocol = "https",
port: Optional[int] = None,
method: Method = "get") -> str:
"""
Expand All @@ -133,6 +133,11 @@ def as_collector_uri(
if len(endpoint) < 1:
raise ValueError("No endpoint provided.")

if bool(PROTOCOLS & set(endpoint.split("://"))):
endpoint_arr = endpoint.split("://")
protocol = endpoint_arr[0]
endpoint = endpoint_arr[1]

if method == "get":
path = "/i"
else:
Expand Down
22 changes: 15 additions & 7 deletions snowplow_tracker/test/unit/test_emitters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def setUp(self) -> None:

def test_init(self) -> None:
e = Emitter('0.0.0.0')
self.assertEqual(e.endpoint, 'http://0.0.0.0/i')
self.assertEqual(e.endpoint, 'https://0.0.0.0/i')
self.assertEqual(e.method, 'get')
self.assertEqual(e.buffer_size, 1)
self.assertEqual(e.buffer, [])
Expand Down Expand Up @@ -83,24 +83,32 @@ def test_init_requests_timeout(self) -> None:

def test_as_collector_uri(self) -> None:
uri = Emitter.as_collector_uri('0.0.0.0')
self.assertEqual(uri, 'http://0.0.0.0/i')
self.assertEqual(uri, 'https://0.0.0.0/i')

def test_as_collector_uri_post(self) -> None:
uri = Emitter.as_collector_uri('0.0.0.0', method="post")
self.assertEqual(uri, 'http://0.0.0.0/com.snowplowanalytics.snowplow/tp2')
self.assertEqual(uri, 'https://0.0.0.0/com.snowplowanalytics.snowplow/tp2')

def test_as_collector_uri_port(self) -> None:
uri = Emitter.as_collector_uri('0.0.0.0', port=9090, method="post")
self.assertEqual(uri, 'http://0.0.0.0:9090/com.snowplowanalytics.snowplow/tp2')
self.assertEqual(uri, 'https://0.0.0.0:9090/com.snowplowanalytics.snowplow/tp2')

def test_as_collector_uri_https(self) -> None:
uri = Emitter.as_collector_uri('0.0.0.0', protocol="https")
self.assertEqual(uri, 'https://0.0.0.0/i')
def test_as_collector_uri_http(self) -> None:
uri = Emitter.as_collector_uri('0.0.0.0', protocol="http")
self.assertEqual(uri, 'http://0.0.0.0/i')

def test_as_collector_uri_empty_string(self) -> None:
with self.assertRaises(ValueError):
Emitter.as_collector_uri('')

def test_as_collector_uri_endpoint_protocol(self) -> None:
uri = Emitter.as_collector_uri("https://0.0.0.0")
self.assertEqual(uri, "https://0.0.0.0/i")

def test_as_collector_uri_endpoint_protocol_http(self) -> None:
uri = Emitter.as_collector_uri("http://0.0.0.0")
self.assertEqual(uri, "http://0.0.0.0/i")

@mock.patch('snowplow_tracker.Emitter.flush')
def test_input_no_flush(self, mok_flush: Any) -> None:
mok_flush.side_effect = mocked_flush
Expand Down