-
-
Notifications
You must be signed in to change notification settings - Fork 4k
/
service.py
358 lines (306 loc) · 11.4 KB
/
service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# Please do not use
# from __future__ import annotations
# in modules such as this one where hybrid cloud data models or service classes are
# defined, because we want to reflect on type annotations and avoid forward references.
import abc
from abc import abstractmethod
from typing import Any, Iterable, Mapping, Optional, Union
from django.dispatch import Signal
from sentry.services.hybrid_cloud import OptionValue, silo_mode_delegation
from sentry.services.hybrid_cloud.organization.model import (
RpcAuditLogEntryActor,
RpcOrganization,
RpcOrganizationDeleteResponse,
RpcOrganizationFlagsUpdate,
RpcOrganizationMember,
RpcOrganizationMemberFlags,
RpcOrganizationSignal,
RpcOrganizationSummary,
RpcRegionUser,
RpcTeam,
RpcUserInviteContext,
RpcUserOrganizationContext,
)
from sentry.services.hybrid_cloud.region import (
ByOrganizationId,
ByOrganizationIdAttribute,
ByOrganizationSlug,
ByRegionName,
RequireSingleOrganization,
UnimplementedRegionResolution,
)
from sentry.services.hybrid_cloud.rpc import RpcService, regional_rpc_method
from sentry.services.hybrid_cloud.user.model import RpcUser
from sentry.silo import SiloMode
class OrganizationService(RpcService):
key = "organization"
local_mode = SiloMode.REGION
@classmethod
def get_local_implementation(cls) -> RpcService:
from sentry.services.hybrid_cloud.organization.impl import DatabaseBackedOrganizationService
return DatabaseBackedOrganizationService()
def get(self, id: int) -> Optional[RpcOrganization]:
org_context = self.get_organization_by_id(id=id)
return org_context.organization if org_context else None
@regional_rpc_method(resolve=ByOrganizationId("id"))
@abstractmethod
def serialize_organization(
self,
*,
id: int,
as_user: Optional[RpcUser] = None,
) -> Optional[Any]:
"""
Attempts to serialize a given organization. Note that this can be None if the organization is already deleted
in the corresponding region silo.
"""
pass
@regional_rpc_method(resolve=ByOrganizationId("id"), return_none_if_mapping_not_found=True)
@abstractmethod
def get_organization_by_id(
self, *, id: int, user_id: Optional[int] = None, slug: Optional[str] = None
) -> Optional[RpcUserOrganizationContext]:
"""
Fetches the organization, team, and project data given by an organization id, regardless of its visibility
status. When user_id is provided, membership data related to that user from the organization
is also given in the response. See RpcUserOrganizationContext for more info.
"""
pass
@regional_rpc_method(resolve=ByOrganizationSlug(), return_none_if_mapping_not_found=True)
@abstractmethod
def get_org_by_slug(
self,
*,
slug: str,
user_id: Optional[int] = None,
) -> Optional[RpcOrganizationSummary]:
"""
Fetches the organization, by an organization slug. If user_id is passed, it will enforce visibility
rules. This method is differentiated from get_organization_by_slug by not being cached and returning
RpcOrganizationSummary instead of org contexts
"""
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def update_flags(self, *, organization_id: int, flags: RpcOrganizationFlagsUpdate) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def check_membership_by_email(
self, *, organization_id: int, email: str
) -> Optional[RpcOrganizationMember]:
"""
Used to look up an organization membership by an email
"""
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def check_membership_by_id(
self, *, organization_id: int, user_id: int
) -> Optional[RpcOrganizationMember]:
"""
Used to look up an organization membership by a user id
"""
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def get_invite_by_id(
self,
*,
organization_id: int,
organization_member_id: Optional[int] = None,
user_id: Optional[int] = None,
email: Optional[str] = None,
) -> Optional[RpcUserInviteContext]:
pass
@regional_rpc_method(resolve=ByOrganizationSlug(), return_none_if_mapping_not_found=True)
@abstractmethod
def get_invite_by_slug(
self,
*,
slug: str,
organization_member_id: Optional[int] = None,
user_id: Optional[int] = None,
email: Optional[str] = None,
) -> Optional[RpcUserInviteContext]:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def delete_organization_member(
self, *, organization_id: int, organization_member_id: int
) -> bool:
"""
Delete an organization member by its id.
"""
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def set_user_for_organization_member(
self,
*,
organization_member_id: int,
organization_id: int,
user_id: int,
) -> Optional[RpcOrganizationMember]:
"""
Set the user id for an organization member.
"""
pass
@regional_rpc_method(resolve=ByOrganizationSlug(), return_none_if_mapping_not_found=True)
@abstractmethod
def check_organization_by_slug(self, *, slug: str, only_visible: bool) -> Optional[int]:
"""
If exists and matches the only_visible requirement, returns an organization's id by the slug.
"""
pass
def get_organization_by_slug(
self, *, slug: str, only_visible: bool, user_id: Optional[int] = None
) -> Optional[RpcUserOrganizationContext]:
"""
Defers to check_organization_by_slug -> get_organization_by_id
"""
from sentry.models.organization import OrganizationStatus
org_id = self.check_organization_by_slug(slug=slug, only_visible=only_visible)
if org_id is None:
return None
org_context = self.get_organization_by_id(id=org_id, user_id=user_id)
if (
only_visible
and org_context
and org_context.organization.status != OrganizationStatus.ACTIVE
):
return None
return org_context
@regional_rpc_method(resolve=RequireSingleOrganization())
@abstractmethod
def get_default_organization(self) -> RpcOrganization:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def add_organization_member(
self,
*,
organization_id: int,
default_org_role: str,
user_id: Optional[int] = None,
email: Optional[str] = None,
flags: Optional[RpcOrganizationMemberFlags] = None,
role: Optional[str] = None,
inviter_id: Optional[int] = None,
invite_status: Optional[int] = None,
) -> RpcOrganizationMember:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def get_single_team(self, *, organization_id: int) -> Optional[RpcTeam]:
"""If the organization has exactly one team, return it.
Return None if the organization has no teams or more than one.
"""
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def add_team_member(
self, *, organization_id: int, team_id: int, organization_member_id: int
) -> None:
pass
@regional_rpc_method(resolve=UnimplementedRegionResolution("organization", "get_team_members"))
@abstractmethod
def get_team_members(self, *, team_id: int) -> Iterable[RpcOrganizationMember]:
pass
@regional_rpc_method(resolve=ByOrganizationIdAttribute("organization_member"))
@abstractmethod
def update_membership_flags(self, *, organization_member: RpcOrganizationMember) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def merge_users(self, *, organization_id: int, from_user_id: int, to_user_id: int) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def update_default_role(self, *, organization_id: int, default_role: str) -> RpcOrganization:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def remove_user(self, *, organization_id: int, user_id: int) -> Optional[RpcOrganizationMember]:
pass
@regional_rpc_method(resolve=ByRegionName())
@abstractmethod
def update_region_user(self, *, user: RpcRegionUser, region_name: str) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def reset_idp_flags(self, *, organization_id: int) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def get_option(self, *, organization_id: int, key: str) -> OptionValue:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def update_option(self, *, organization_id: int, key: str, value: OptionValue) -> bool:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def delete_option(self, *, organization_id: int, key: str) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def send_sso_link_emails(
self, *, organization_id: int, sending_user_email: str, provider_key: str
) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def delete_organization(
self, *, organization_id: int, user: RpcUser
) -> RpcOrganizationDeleteResponse:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def create_org_delete_log(
self, *, organization_id: int, audit_log_actor: RpcAuditLogEntryActor
) -> None:
pass
@regional_rpc_method(resolve=ByOrganizationId())
@abstractmethod
def send_signal(
self,
*,
signal: RpcOrganizationSignal,
organization_id: int,
args: Mapping[str, Optional[Union[int, str]]],
) -> None:
pass
def schedule_signal(
self,
signal: Signal,
organization_id: int,
args: Mapping[str, Optional[Union[int, str]]],
) -> None:
_organization_signal_service.schedule_signal(
signal=signal, organization_id=organization_id, args=args
)
class OrganizationSignalService(abc.ABC):
@abc.abstractmethod
def schedule_signal(
self,
signal: Signal,
organization_id: int,
args: Mapping[str, Optional[Union[int, str]]],
) -> None:
pass
def _signal_from_outbox() -> OrganizationSignalService:
from sentry.services.hybrid_cloud.organization.impl import OutboxBackedOrganizationSignalService
return OutboxBackedOrganizationSignalService()
def _signal_from_on_commit() -> OrganizationSignalService:
from sentry.services.hybrid_cloud.organization.impl import (
OnCommitBackedOrganizationSignalService,
)
return OnCommitBackedOrganizationSignalService()
_organization_signal_service: OrganizationSignalService = silo_mode_delegation(
{
SiloMode.REGION: _signal_from_on_commit,
SiloMode.CONTROL: _signal_from_outbox,
SiloMode.MONOLITH: _signal_from_on_commit,
}
)
organization_service = OrganizationService.create_delegation()