authentik.lib.sync.outgoing.exceptions

 1from json import JSONDecodeError
 2
 3from authentik.lib.sentry import SentryIgnoredException
 4
 5
 6class BaseSyncException(SentryIgnoredException):
 7    """Base class for all sync exceptions"""
 8
 9    error_prefix = "Sync error"
10    error_default = "Error communicating with remote system"
11
12    def __init__(self, response=None):
13        super().__init__()
14        self.response = response
15
16    def __str__(self):
17        if self.response is not None:
18            if hasattr(self.response, "json"):
19                try:
20                    return f"{self.error_prefix}: {self.response.json()}"
21                except JSONDecodeError:
22                    pass
23            if hasattr(self.response, "text"):
24                return f"{self.error_prefix}: {self.response.text}"
25            return f"{self.error_prefix}: {self.response}"
26        return self.error_default
27
28    def __repr__(self):
29        return self.__str__()
30
31
32class TransientSyncException(BaseSyncException):
33    """Transient sync exception which may be caused by network blips, etc"""
34
35    error_prefix = "Network error"
36    error_default = "Network error communicating with remote system"
37
38
39class NotFoundSyncException(BaseSyncException):
40    """Exception when an object was not found in the remote system"""
41
42    error_prefix = "Object not found"
43    error_default = "Object not found in remote system"
44
45
46class ObjectExistsSyncException(BaseSyncException):
47    """Exception when an object already exists in the remote system"""
48
49    error_prefix = "Object exists"
50    error_default = "Object exists in remote system"
51
52
53class BadRequestSyncException(BaseSyncException):
54    """Exception when invalid data was sent to the remote system"""
55
56    error_prefix = "Bad request"
57    error_default = "Bad request to remote system"
58
59
60class DryRunRejected(BaseSyncException):
61    """When dry_run is enabled and a provider dropped a mutating request"""
62
63    def __init__(self, url: str, method: str, body: dict):
64        super().__init__()
65        self.url = url
66        self.method = method
67        self.body = body
68
69    def __repr__(self):
70        return self.__str__()
71
72    def __str__(self):
73        return f"Dry-run rejected request: {self.method} {self.url}"
74
75
76class StopSync(BaseSyncException):
77    """Exception raised when a configuration error should stop the sync process"""
78
79    def __init__(
80        self, exc: Exception, obj: object | None = None, mapping: object | None = None
81    ) -> None:
82        self.exc = exc
83        self.obj = obj
84        self.mapping = mapping
85
86    def detail(self) -> str:
87        """Get human readable details of this error"""
88        msg = f"Error {str(self.exc)}"
89        if self.obj:
90            msg += f", caused by {self.obj}"
91        if self.mapping:
92            msg += f" (mapping {self.mapping})"
93        return msg