Skip to content

Commit 7fc78c7

Browse files
authored
chore(cells): deprecate group-details endpoint (#106613)
Add deprecation notices to GroupDetailsEndpoint and update all tests to use the org-scoped variant's URL pattern. Follow-up PR incoming for frontend tests.
1 parent 037c826 commit 7fc78c7

9 files changed

Lines changed: 87 additions & 91 deletions

File tree

‎fixtures/events/issue_detection/n-plus-one-api-calls/not-n-plus-one-api-calls.json‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@
7070
"trace_id": "98be611cb95e24f72813487f12922a01",
7171
"status": "ok",
7272
"tags": {"http.status_code": "200"},
73-
"data": {"http.method": "GET", "type": "fetch", "url": "/api/0/organizations/?member=1"},
73+
"data": {
74+
"http.method": "GET",
75+
"type": "fetch",
76+
"url": "/api/0/organizations/?member=1"
77+
},
7478
"hash": "cbc1d1c7a6500a75"
7579
},
7680
{
@@ -141,7 +145,11 @@
141145
"trace_id": "98be611cb95e24f72813487f12922a01",
142146
"status": "ok",
143147
"tags": {"http.status_code": "200"},
144-
"data": {"http.method": "GET", "type": "fetch", "url": "/api/0/subscriptions/sentry/"},
148+
"data": {
149+
"http.method": "GET",
150+
"type": "fetch",
151+
"url": "/api/0/subscriptions/sentry/"
152+
},
145153
"hash": "d09dea4693554039"
146154
},
147155
{
@@ -698,7 +706,7 @@
698706
"timestamp": 1668493712.796,
699707
"start_timestamp": 1668493711.677,
700708
"exclusive_time": 1118.999958,
701-
"description": "GET /api/0/issues/1888481/?collapse=release",
709+
"description": "GET /api/0/organizations/sentry/issues/1888481/?collapse=release",
702710
"op": "http.client",
703711
"span_id": "895caf36a21300a2",
704712
"parent_span_id": "9e4e36110481b5b5",
@@ -708,7 +716,7 @@
708716
"data": {
709717
"http.method": "GET",
710718
"type": "fetch",
711-
"url": "/api/0/issues/1888481/?collapse=release"
719+
"url": "/api/0/organizations/sentry/issues/1888481/?collapse=release"
712720
},
713721
"hash": "33a59c92255fb9b2"
714722
},

‎fixtures/page_objects/issue_details.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ def get_environment(self):
4343
def go_back_to_issues(self):
4444
self.global_selection.go_back_to_issues()
4545

46-
def api_issue_get(self, groupid):
47-
return self.client.get(f"/api/0/issues/{groupid}/")
46+
def api_issue_get(self, group):
47+
return self.client.get(f"/api/0/organizations/{group.organization.slug}/issues/{group.id}/")
4848

4949
def go_to_subtab(self, key):
5050
tabs = self.browser.find_element(by=By.CSS_SELECTOR, value='[role="tablist"]')

‎src/sentry/issues/endpoints/group_details.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
from sentry.api import client
1313
from sentry.api.api_publish_status import ApiPublishStatus
1414
from sentry.api.base import region_silo_endpoint
15+
from sentry.api.helpers.deprecation import deprecated
1516
from sentry.api.helpers.environments import get_environment_func, get_environments
1617
from sentry.api.helpers.group_index import (
1718
delete_group_list,
@@ -22,6 +23,7 @@
2223
from sentry.api.serializers import GroupSerializer, GroupSerializerSnuba, serialize
2324
from sentry.api.serializers.models.group_stream import get_actions, get_available_issue_plugins
2425
from sentry.api.serializers.models.plugin import PluginSerializer
26+
from sentry.constants import CELL_API_DEPRECATION_DATE
2527
from sentry.integrations.api.serializers.models.external_issue import ExternalIssueSerializer
2628
from sentry.integrations.models.external_issue import ExternalIssue
2729
from sentry.issues.constants import get_issue_tsdb_group_model
@@ -132,6 +134,7 @@ def __group_hourly_daily_stats(
132134

133135
return hourly_stats, daily_stats
134136

137+
@deprecated(CELL_API_DEPRECATION_DATE, url_names=["sentry-api-0-group-details"])
135138
def get(self, request: Request, group: Group) -> Response:
136139
"""
137140
Retrieve an Issue
@@ -310,6 +313,7 @@ def get(self, request: Request, group: Group) -> Response:
310313
)
311314
raise
312315

316+
@deprecated(CELL_API_DEPRECATION_DATE, url_names=["sentry-api-0-group-details"])
313317
def put(self, request: Request, group: Group) -> Response:
314318
"""
315319
Update an Issue
@@ -390,6 +394,7 @@ def put(self, request: Request, group: Group) -> Response:
390394
)
391395
return Response(e.body, status=e.status_code)
392396

397+
@deprecated(CELL_API_DEPRECATION_DATE, url_names=["sentry-api-0-group-details"])
393398
def delete(self, request: Request, group: Group) -> Response:
394399
"""
395400
Remove an Issue

‎tests/acceptance/test_issue_details_workflow.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def test_resolve_basic(self, mock_update_open_period: mock.MagicMock) -> None:
5252
self.page.resolve_issue()
5353
self.wait_for_loading()
5454

55-
res = self.page.api_issue_get(event.group.id)
55+
res = self.page.api_issue_get(event.group)
5656
assert res.status_code == 200, res
5757
assert res.data["status"] == "resolved"
5858

@@ -63,7 +63,7 @@ def test_archive_basic(self) -> None:
6363
self.page.archive_issue()
6464
self.wait_for_loading()
6565

66-
res = self.page.api_issue_get(event.group.id)
66+
res = self.page.api_issue_get(event.group)
6767
assert res.status_code == 200, res
6868
assert res.data["status"] == "ignored"
6969

@@ -74,7 +74,7 @@ def test_bookmark(self) -> None:
7474
self.page.bookmark_issue()
7575
self.wait_for_loading()
7676

77-
res = self.page.api_issue_get(event.group.id)
77+
res = self.page.api_issue_get(event.group)
7878
assert res.status_code == 200, res
7979
assert res.data["isBookmarked"]
8080

@@ -84,7 +84,7 @@ def test_assign_issue(self) -> None:
8484
self.page.visit_issue(self.org.slug, event.group.id)
8585
self.page.assign_to(self.user.email)
8686

87-
res = self.page.api_issue_get(event.group.id)
87+
res = self.page.api_issue_get(event.group)
8888
assert res.status_code == 200, res
8989
assert res.data["assignedTo"]
9090

@@ -106,6 +106,6 @@ def test_mark_reviewed(self) -> None:
106106
self.page.visit_issue(self.org.slug, event.group.id)
107107
self.page.mark_reviewed()
108108

109-
res = self.page.api_issue_get(event.group.id)
109+
res = self.page.api_issue_get(event.group)
110110
assert res.status_code == 200, res
111111
assert "inbox" not in res.data

‎tests/integration/test_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def setUp(self) -> None:
3737
f"/api/0/organizations/{self.organization.slug}/",
3838
f"/api/0/projects/{self.organization.slug}/{self.project.slug}/",
3939
f"/api/0/teams/{self.organization.slug}/{self.team.slug}/",
40-
f"/api/0/issues/{group_id}/",
40+
f"/api/0/organizations/{self.organization.slug}/issues/{group_id}/",
4141
# this uses the internal API, which once upon a time was broken
4242
f"/api/0/issues/{group_id}/events/latest/",
4343
)

0 commit comments

Comments
 (0)