Add Sentry integration

.github/workflows/release.yml

@@ -14,6 +14,11 @@ jobs:
           python-version: 3.8
       - name: Install Poetry
         uses: snok/install-poetry@v1
+      - name: Run pre-build script (embed Sentry DSN)
+        run: |
+          poetry run python scripts/prebuild.py
+        env:
+          SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
       - name: Release
         uses: bjoluc/semantic-release-config-poetry@v1
         with:

.gitignore

@@ -1,4 +1,5 @@
 dist
+seamapi/utils/get_sentry_dsn.py
 .env
 __pycache__
 */__pycache__

pyproject.toml

@@ -10,11 +10,13 @@ python = "^3.7"
 requests = "^2.26.0"
 python-dotenv = "^0.19.2"
 dataclasses-json = "^0.5.6"
+sentry-sdk = "^1.9.10"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.5"
 black = "^21.12b0"
 testcontainers = {extras = ["postgresql"], version = "^3.4.2"}
+responses = "^0.22.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

scripts/prebuild.py

@@ -0,0 +1,11 @@
+import os
+
+value = os.environ.get("SENTRY_DSN", "None")
+if value != "None":
+  value = f'"{value}"'
+
+f = open("seamapi/utils/get_sentry_dsn.py", "w")
+f.write(f"""
+def get_sentry_dsn():
+  return {value}
+""")

seamapi/access_codes.py

@@ -10,6 +10,7 @@
 from typing import List, Optional, Union, Any
 import requests
 from seamapi.utils.convert_to_id import to_access_code_id, to_device_id
+from seamapi.utils.report_error import report_error
 
 
 class AccessCodes(AbstractAccessCodes):
@@ -48,6 +49,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def list(self, device: Union[DeviceId, Device]) -> List[AccessCode]:
         """Gets a list of access codes for a device.
 
@@ -76,6 +78,7 @@ def list(self, device: Union[DeviceId, Device]) -> List[AccessCode]:
 
         return [AccessCode.from_dict(ac) for ac in access_codes]
 
+    @report_error
     def get(
         self,
         access_code: Optional[Union[AccessCodeId, AccessCode]] = None,
@@ -114,6 +117,7 @@ def get(
 
         return AccessCode.from_dict(res["access_code"])
 
+    @report_error
     def create(
         self,
         device: Union[DeviceId, Device],
@@ -171,6 +175,7 @@ def create(
 
         return AccessCode.from_dict(success_res["access_code"])
 
+    @report_error
     def update(
         self,
         access_code: Union[AccessCodeId, AccessCode],
@@ -233,6 +238,7 @@ def update(
 
         return AccessCode.from_dict(success_res["access_code"])
 
+    @report_error
     def delete(
         self,
         access_code: Union[AccessCodeId, AccessCode],

seamapi/action_attempts.py

@@ -10,6 +10,7 @@
 import requests
 from typing import Union
 from seamapi.utils.convert_to_id import to_action_attempt_id
+from seamapi.utils.report_error import report_error
 
 
 class ActionAttempts(AbstractActionAttempts):
@@ -44,6 +45,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def get(
         self, action_attempt: Union[ActionAttemptId, ActionAttempt]
     ) -> ActionAttempt:
@@ -87,6 +89,7 @@ def get(
             error=error,
         )
 
+    @report_error
     def poll_until_ready(
         self,
         action_attempt: Union[ActionAttemptId, ActionAttempt],

seamapi/connect_webviews.py

@@ -8,6 +8,7 @@
 import requests
 from typing import List, Optional, Union
 from seamapi.utils.convert_to_id import to_connect_webview_id
+from seamapi.utils.report_error import report_error
 
 
 class ConnectWebviews(AbstractConnectWebviews):
@@ -46,6 +47,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def list(self) -> List[ConnectWebview]:
         """Gets a list of connect webviews.
 
@@ -69,6 +71,7 @@ def list(self) -> List[ConnectWebview]:
             ConnectWebview(**json_webview) for json_webview in json_webviews
         ]
 
+    @report_error
     def get(
         self, connect_webview: Union[ConnectWebviewId, ConnectWebview]
     ) -> ConnectWebview:
@@ -99,6 +102,7 @@ def get(
 
         return ConnectWebview(**json_webview)
 
+    @report_error
     def create(
         self,
         accepted_providers: List[AcceptedProvider],

seamapi/connected_accounts.py

@@ -9,6 +9,7 @@
 import requests
 from typing import Any, Dict, List, Union
 from seamapi.utils.convert_to_id import to_connected_account_id
+from seamapi.utils.report_error import report_error
 
 
 class ConnectedAccounts(AbstractConnectedAccounts):
@@ -43,6 +44,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def list(self) -> List[ConnectedAccount]:
         """Gets a list of connected accounts.
 
@@ -73,6 +75,7 @@ def list(self) -> List[ConnectedAccount]:
             for json_account in json_accounts
         ]
 
+    @report_error
     def get(
         self,
         connected_account: Union[
@@ -129,6 +132,7 @@ def get(
             errors=json_account.get("errors", []),
         )
 
+    @report_error
     def delete(
         self,
         connected_account: Union[ConnectedAccountId, ConnectedAccount],

seamapi/devices.py

@@ -10,12 +10,12 @@
     DeviceType,
 )
 from typing import List, Union, Optional
-import requests
 from seamapi.utils.convert_to_id import (
     to_connect_webview_id,
     to_connected_account_id,
     to_device_id,
 )
+from seamapi.utils.report_error import report_error
 
 
 class Devices(AbstractDevices):
@@ -52,6 +52,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def list(
         self,
         connected_account: Union[ConnectedAccountId, ConnectedAccount] = None,
@@ -100,6 +101,7 @@ def list(
 
         return [Device.from_dict(d) for d in devices]
 
+    @report_error
     def get(
         self,
         device: Optional[Union[DeviceId, Device]] = None,
@@ -133,6 +135,7 @@ def get(
         json_device = res["device"]
         return Device.from_dict(json_device)
 
+    @report_error
     def update(
         self,
         device: Union[DeviceId, Device],
@@ -184,6 +187,7 @@ def update(
 
         return True
 
+    @report_error
     def delete(self, device: Union[DeviceId, Device]) -> bool:
         """Deletes a device.
 

seamapi/events.py

@@ -6,6 +6,8 @@
 from typing import List, Optional
 import requests
 
+from seamapi.utils.report_error import report_error
+
 
 class Events(AbstractEvents):
     """
@@ -35,6 +37,7 @@ def __init__(self, seam: Seam):
         """
         self.seam = seam
 
+    @report_error
     def list(
         self,
         since: str,
@@ -93,6 +96,7 @@ def list(
 
         return res["events"]
 
+    @report_error
     def get(
         self,
         event_id: Optional[str] = None,

seamapi/locks.py

@@ -17,6 +17,7 @@
     to_connected_account_id,
     to_device_id,
 )
+from seamapi.utils.report_error import report_error
 
 
 class Locks(AbstractLocks):
@@ -55,6 +56,7 @@ def __init__(self, seam: Seam):
 
         self.seam = seam
 
+    @report_error
     def list(
         self,
         connected_account: Optional[
@@ -102,6 +104,7 @@ def list(
 
         return [Device.from_dict(d) for d in json_locks]
 
+    @report_error
     def get(
         self,
         device: Optional[Union[DeviceId, Device]] = None,
@@ -141,6 +144,7 @@ def get(
 
         return Device.from_dict(json_lock)
 
+    @report_error
     def lock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
         """Locks a lock.
 
@@ -170,6 +174,7 @@ def lock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
             res["action_attempt"]["action_attempt_id"]
         )
 
+    @report_error
     def unlock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
         """Unlocks a lock.
 

seamapi/seam.py

@@ -1,6 +1,9 @@
 import os
+
+from seamapi.utils.get_sentry_dsn import get_sentry_dsn
 from .routes import Routes
 import requests
+import sentry_sdk
 import pkg_resources
 from typing import Optional, cast
 from .types import AbstractSeam, SeamAPIException
@@ -43,6 +46,7 @@ def __init__(
         self,
         api_key: Optional[str] = None,
         api_url: Optional[str] = None,
+        should_report_exceptions: Optional[bool] = False,
     ):
         """
         Parameters
@@ -51,6 +55,8 @@ def __init__(
           API key
         api_url : str, optional
           API url
+        should_report_exceptions : bool, optional
+          Defaults to False. If true, thrown exceptions will be reported to Seam.
         """
         Routes.__init__(self)
 
@@ -64,6 +70,17 @@ def __init__(
             api_url = os.environ.get("SEAM_API_URL", self.api_url)
         self.api_key = api_key
         self.api_url = cast(str, api_url)
+        self.should_report_exceptions = should_report_exceptions
+
+        if self.should_report_exceptions:
+            self.sentry_client = sentry_sdk.Hub(sentry_sdk.Client(
+                dsn=get_sentry_dsn(),
+            ))
+            self.sentry_client.scope.set_context("sdk_info", {
+                "repository": "https://github.com/seamapi/python",
+                "version": pkg_resources.get_distribution("seamapi").version,
+                "endpoint": self.api_url,
+            })
 
     def make_request(self, method: str, path: str, **kwargs):
         """
@@ -87,6 +104,20 @@ def make_request(self, method: str, path: str, **kwargs):
         }
         response = requests.request(method, url, headers=headers, **kwargs)
 
+        if self.should_report_exceptions and response.status_code:
+            # Add breadcrumb
+            self.sentry_client.add_breadcrumb(
+                category="http",
+                level="info",
+                data={
+                    "method": method,
+                    "url": url,
+                    "status_code": response.status_code,
+                    "request_id": response.headers.get("seam-request-id", "unknown"),
+                },
+            )
+
+
         parsed_response = response.json()
 
         if response.status_code != 200:

seamapi/utils/get_sentry_dsn.py

@@ -0,0 +1,5 @@
+import os
+
+def get_sentry_dsn():
+  # This is replaced with a hard-coded value during the build process (see scripts/prebuild.py)
+  return os.environ.get("SENTRY_DSN", None)

seamapi/utils/report_error.py

@@ -0,0 +1,16 @@
+from seamapi.types import SeamAPIException
+
+"""
+A decorator for model methods that will report errors to Sentry (if enabled).
+Expects that the model has a `seam` attribute that is a `Seam` instance.
+"""
+def report_error(f):
+  def wrapper(self, *args, **kwargs):
+    try:
+      return f(self, *args, **kwargs)
+    except Exception as error:
+      if self.seam.should_report_exceptions and type(error) is not SeamAPIException:
+        self.seam.sentry_client.capture_exception(error)
+
+      raise error
+  return wrapper