fix: broken URLs on Windows due to os.path.join() (#587)

When trying to submit a workflow with Hera v5 on Windows, the use of
os.path.join breaks the URLs because it joins with backslashes on
Windows. Using urllib.parse.urljoin instead makes it compatible with
both Linux and Windows.

The error when trying to create a workflow on Windows is
"json.decoder.JSONDecodeError: Expecting value: line 1
column 1 (char 0)" because Hera assumes a JSON response, but gets HTML
because of the bad URL.

No tests because you test on Linux.

---------

Signed-off-by: Alina Borrisholt Schmidt <[email protected]>
Signed-off-by: Helge Willum Thingvad <[email protected]>
Co-authored-by: Sambhav Kothari <[email protected]>
Co-authored-by: Helge Willum Thingvad <[email protected]>

Author: 3 people

scripts/service.py

@@ -126,7 +126,7 @@ def __str__(self) -> str:
         # url
         path_params = [p for p in self.params if p.in_ == "path"]
         if len(path_params) == 0:
-            req_url = f"os.path.join(self.host, '{self.url}')"
+            req_url = f"urljoin(self.host, '{self.url}')"
         else:
             # note that here we have a condition on `namespace` because `namespace` can be a global configuration. So,
             # we either take it from the endpoint (prioritized just in case users rely on the service to use
@@ -137,7 +137,7 @@ def __str__(self) -> str:
                     req_url_params.append("namespace=namespace if namespace is not None else self.namespace")
                 else:
                     req_url_params.append(f"{p.field}={p.name}")
-            req_url = f"os.path.join(self.host, '{self.url}').format({', '.join(req_url_params)})"
+            req_url = f"urljoin(self.host, '{self.url}').format({', '.join(req_url_params)})"
 
         # query params
         query_params = [p for p in self.params if p.in_ == "query"]
@@ -400,8 +400,8 @@ def get_endpoints(
 def get_service_def() -> str:
     """Assembles the service definition string/code representation"""
     return """
+from urllib.parse import urljoin
 import requests
-import os
 from hera.{module}.models import {imports}
 from hera.shared import global_config
 from typing import Optional, cast

src/hera/events/service.py

@@ -1,5 +1,5 @@
-import os
 from typing import Optional, cast
+from urllib.parse import urljoin
 
 import requests
 
@@ -55,7 +55,7 @@ def list_event_sources(
         continue_: Optional[str] = None,
     ) -> EventSourceList:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/event-sources/{namespace}").format(
+            url=urljoin(self.host, "api/v1/event-sources/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -81,7 +81,7 @@ def list_event_sources(
 
     def create_event_source(self, req: CreateEventSourceRequest, namespace: Optional[str] = None) -> EventSource:
         resp = requests.post(
-            url=os.path.join(self.host, "api/v1/event-sources/{namespace}").format(
+            url=urljoin(self.host, "api/v1/event-sources/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -99,7 +99,7 @@ def create_event_source(self, req: CreateEventSourceRequest, namespace: Optional
 
     def get_event_source(self, name: str, namespace: Optional[str] = None) -> EventSource:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/event-sources/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/event-sources/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -117,7 +117,7 @@ def update_event_source(
         self, name: str, req: UpdateEventSourceRequest, namespace: Optional[str] = None
     ) -> EventSource:
         resp = requests.put(
-            url=os.path.join(self.host, "api/v1/event-sources/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/event-sources/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -145,7 +145,7 @@ def delete_event_source(
         dry_run: Optional[list] = None,
     ) -> EventSourceDeletedResponse:
         resp = requests.delete(
-            url=os.path.join(self.host, "api/v1/event-sources/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/event-sources/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -168,7 +168,7 @@ def delete_event_source(
 
     def receive_event(self, discriminator: str, req: Item, namespace: Optional[str] = None) -> EventResponse:
         resp = requests.post(
-            url=os.path.join(self.host, "api/v1/events/{namespace}/{discriminator}").format(
+            url=urljoin(self.host, "api/v1/events/{namespace}/{discriminator}").format(
                 discriminator=discriminator, namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -186,7 +186,7 @@ def receive_event(self, discriminator: str, req: Item, namespace: Optional[str]
 
     def get_info(self) -> InfoResponse:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/info"),
+            url=urljoin(self.host, "api/v1/info"),
             params=None,
             headers={"Authorization": f"Bearer {self.token}"},
             data=None,
@@ -212,7 +212,7 @@ def list_sensors(
         continue_: Optional[str] = None,
     ) -> SensorList:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/sensors/{namespace}").format(
+            url=urljoin(self.host, "api/v1/sensors/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -238,7 +238,7 @@ def list_sensors(
 
     def create_sensor(self, req: CreateSensorRequest, namespace: Optional[str] = None) -> Sensor:
         resp = requests.post(
-            url=os.path.join(self.host, "api/v1/sensors/{namespace}").format(
+            url=urljoin(self.host, "api/v1/sensors/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -256,7 +256,7 @@ def create_sensor(self, req: CreateSensorRequest, namespace: Optional[str] = Non
 
     def get_sensor(self, name: str, namespace: Optional[str] = None, resource_version: Optional[str] = None) -> Sensor:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/sensors/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/sensors/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params={"getOptions.resourceVersion": resource_version},
@@ -272,7 +272,7 @@ def get_sensor(self, name: str, namespace: Optional[str] = None, resource_versio
 
     def update_sensor(self, name: str, req: UpdateSensorRequest, namespace: Optional[str] = None) -> Sensor:
         resp = requests.put(
-            url=os.path.join(self.host, "api/v1/sensors/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/sensors/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params=None,
@@ -300,7 +300,7 @@ def delete_sensor(
         dry_run: Optional[list] = None,
     ) -> DeleteSensorResponse:
         resp = requests.delete(
-            url=os.path.join(self.host, "api/v1/sensors/{namespace}/{name}").format(
+            url=urljoin(self.host, "api/v1/sensors/{namespace}/{name}").format(
                 name=name, namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -335,7 +335,7 @@ def watch_event_sources(
         continue_: Optional[str] = None,
     ) -> EventSourceWatchEvent:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/stream/event-sources/{namespace}").format(
+            url=urljoin(self.host, "api/v1/stream/event-sources/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -378,7 +378,7 @@ def event_sources_logs(
         insecure_skip_tls_verify_backend: Optional[bool] = None,
     ) -> EventsourceLogEntry:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/stream/event-sources/{namespace}/logs").format(
+            url=urljoin(self.host, "api/v1/stream/event-sources/{namespace}/logs").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -421,7 +421,7 @@ def watch_events(
         continue_: Optional[str] = None,
     ) -> Event:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/stream/events/{namespace}").format(
+            url=urljoin(self.host, "api/v1/stream/events/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -459,7 +459,7 @@ def watch_sensors(
         continue_: Optional[str] = None,
     ) -> SensorWatchEvent:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/stream/sensors/{namespace}").format(
+            url=urljoin(self.host, "api/v1/stream/sensors/{namespace}").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -501,7 +501,7 @@ def sensors_logs(
         insecure_skip_tls_verify_backend: Optional[bool] = None,
     ) -> SensorLogEntry:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/stream/sensors/{namespace}/logs").format(
+            url=urljoin(self.host, "api/v1/stream/sensors/{namespace}/logs").format(
                 namespace=namespace if namespace is not None else self.namespace
             ),
             params={
@@ -531,7 +531,7 @@ def sensors_logs(
 
     def get_user_info(self) -> GetUserInfoResponse:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/userinfo"),
+            url=urljoin(self.host, "api/v1/userinfo"),
             params=None,
             headers={"Authorization": f"Bearer {self.token}"},
             data=None,
@@ -545,7 +545,7 @@ def get_user_info(self) -> GetUserInfoResponse:
 
     def get_version(self) -> Version:
         resp = requests.get(
-            url=os.path.join(self.host, "api/v1/version"),
+            url=urljoin(self.host, "api/v1/version"),
             params=None,
             headers={"Authorization": f"Bearer {self.token}"},
             data=None,
@@ -568,7 +568,7 @@ def get_artifact_file(
     ) -> str:
         """Get an artifact."""
         resp = requests.get(
-            url=os.path.join(
+            url=urljoin(
                 self.host,
                 "artifact-files/{namespace}/{idDiscriminator}/{id}/{nodeId}/{artifactDiscriminator}/{artifactName}",
             ).format(
@@ -593,7 +593,7 @@ def get_artifact_file(
     def get_output_artifact_by_uid(self, uid: str, node_id: str, artifact_name: str) -> str:
         """Get an output artifact by UID."""
         resp = requests.get(
-            url=os.path.join(self.host, "artifacts-by-uid/{uid}/{nodeId}/{artifactName}").format(
+            url=urljoin(self.host, "artifacts-by-uid/{uid}/{nodeId}/{artifactName}").format(
                 uid=uid, nodeId=node_id, artifactName=artifact_name
             ),
             params=None,
@@ -610,7 +610,7 @@ def get_output_artifact_by_uid(self, uid: str, node_id: str, artifact_name: str)
     def get_output_artifact(self, name: str, node_id: str, artifact_name: str, namespace: Optional[str] = None) -> str:
         """Get an output artifact."""
         resp = requests.get(
-            url=os.path.join(self.host, "artifacts/{namespace}/{name}/{nodeId}/{artifactName}").format(
+            url=urljoin(self.host, "artifacts/{namespace}/{name}/{nodeId}/{artifactName}").format(
                 name=name,
                 nodeId=node_id,
                 artifactName=artifact_name,
@@ -630,7 +630,7 @@ def get_output_artifact(self, name: str, node_id: str, artifact_name: str, names
     def get_input_artifact_by_uid(self, uid: str, node_id: str, artifact_name: str) -> str:
         """Get an input artifact by UID."""
         resp = requests.get(
-            url=os.path.join(self.host, "input-artifacts-by-uid/{uid}/{nodeId}/{artifactName}").format(
+            url=urljoin(self.host, "input-artifacts-by-uid/{uid}/{nodeId}/{artifactName}").format(
                 uid=uid, nodeId=node_id, artifactName=artifact_name
             ),
             params=None,
@@ -647,7 +647,7 @@ def get_input_artifact_by_uid(self, uid: str, node_id: str, artifact_name: str)
     def get_input_artifact(self, name: str, node_id: str, artifact_name: str, namespace: Optional[str] = None) -> str:
         """Get an input artifact."""
         resp = requests.get(
-            url=os.path.join(self.host, "input-artifacts/{namespace}/{name}/{nodeId}/{artifactName}").format(
+            url=urljoin(self.host, "input-artifacts/{namespace}/{name}/{nodeId}/{artifactName}").format(
                 name=name,
                 nodeId=node_id,
                 artifactName=artifact_name,