Skip to content

ref: Begin deprecating category from localities #123250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lynnagara wants to merge 6 commits into
base: master
Choose a base branch
from
Open

ref: Begin deprecating category from localities #123250

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
61ca126
ref: Begin deprecating `category` from localities
lynnagara Aug 31, 2026
7b60d9c
Merge branch 'master' into locality-category
lynnagara Aug 31, 2026
53c570f
typing
lynnagara Aug 31, 2026
0bf30a6
org creation honors signup_visible
lynnagara Aug 31, 2026
3043b15
Merge branch 'master' into locality-category
lynnagara Sep 1, 2026
54bacf7
Merge branch 'master' into locality-category
lynnagara Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/sentry/core/endpoints/organization_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@
from sentry.silo.base import SiloMode
from sentry.types.cell import (
CellResolutionError,
RegionCategory,
get_locality_by_name,
)
from sentry.users.services.user.serial import serialize_generic_user
Comment thread
sentry-warden[bot] marked this conversation as resolved.
Expand Down Expand Up @@ -106,7 +105,7 @@ def validate_dataStorageLocation(self, value: str) -> str:
if "request" in self.context and is_active_staff(self.context["request"]):
# Staff users are allowed to create orgs in hidden cells/localities.
return value
if locality.category != RegionCategory.MULTI_TENANT or not locality.visible:
Comment thread
cursor[bot] marked this conversation as resolved.
if not locality.visible:
raise serializers.ValidationError(f"Unknown data storage location {value!r}.")
return value

Comment thread
sentry[bot] marked this conversation as resolved.
Expand Down
3 changes: 1 addition & 2 deletions src/sentry/testutils/cell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from django.test import override_settings

from sentry.types.cell import Cell, CellDirectory, Locality, RegionCategory, get_global_directory
from sentry.types.cell import Cell, CellDirectory, Locality, get_global_directory


class TestEnvCellDirectory(CellDirectory):
Expand All @@ -24,7 +24,6 @@ def _apply_cells(
Locality(
name=c.name,
cells=frozenset([c.name]),
category=RegionCategory.MULTI_TENANT,
visible=c.visible,
new_org_cell=c.name,
)
Expand Down
15 changes: 5 additions & 10 deletions src/sentry/types/cell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ class Locality:
cells: frozenset[str]
"""The set of cell names that belong to this locality."""

category: RegionCategory

new_org_cell: str
"""The cell within this locality where new organizations are provisioned."""

Expand All @@ -45,6 +43,9 @@ class Locality:
signup_visible: bool = True
"""Whether or not a locality should be visible for org signup/relocation."""

category: RegionCategory = RegionCategory.MULTI_TENANT
"""Deprecated. Visibility is defined via `visible` and `signup_visible`."""

def to_url(self, path: str) -> str:
"""Resolve a path into a customer facing URL on this locality.

Expand Down Expand Up @@ -495,19 +496,13 @@ def find_all_multitenant_locality_names() -> list[str]:
"""
Return all visible multi-tenant localities.
"""
return [
loc.name
for loc in get_global_directory().localities
if loc.category == RegionCategory.MULTI_TENANT and loc.visible
]
return [loc.name for loc in get_global_directory().localities if loc.visible]
Comment on lines 498 to +499

@sentry sentry Bot Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Removing the category check in find_all_multitenant_locality_names may incorrectly expose single-tenant localities in the UI if they are configured with visible=True.
Severity: HIGH

Suggested Fix

Verify that all production configurations for single-tenant localities have been updated to set visible=False. To mitigate risk, consider adding logging to detect and alert on any single-tenant localities with visible=True during a transition period. Ensure the breaking nature of this change is clearly communicated.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: src/sentry/types/cell.py#L498-L499

Potential issue: The function `find_all_multitenant_locality_names` was changed to
filter localities solely based on the `visible` flag, removing the previous check for
`category == RegionCategory.MULTI_TENANT`. This change assumes that all single-tenant
localities in production configurations have been updated to `visible=False`. If any
single-tenant locality is configured with `visible=True`, it will now be incorrectly
exposed in the frontend UI and included in DNS prefetching. This represents a breaking
change and a migration risk, as the required configuration updates are not mentioned or
enforced, potentially leading to unintended exposure of single-tenant environments.

Also affects:

  • src/sentry/web/client_config.py:367~372



def find_all_signup_locality_names() -> list[str]:
"""
Return all locality names that are visible to org signup.
"""
return [
loc.name
for loc in get_global_directory().localities
if loc.category == RegionCategory.MULTI_TENANT and loc.visible and loc.signup_visible
loc.name for loc in get_global_directory().localities if loc.visible and loc.signup_visible
]
2 changes: 0 additions & 2 deletions src/sentry/web/client_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from sentry.types.cell import (
Cell,
Locality,
RegionCategory,
find_all_cell_names,
find_all_multitenant_locality_names,
find_all_signup_locality_names,
Expand Down Expand Up @@ -368,7 +367,6 @@ def localities(self) -> list[Mapping[str, Any]]:
def region_display_order(region: Locality) -> tuple[bool, bool, str]:
return (
region.name != monolith_locality, # default locality comes first
region.category != RegionCategory.MULTI_TENANT, # multi-tenant before single
region.name, # then sort alphabetically
)

Comment on lines 364 to 372

@sentry sentry Bot Sep 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Removing region.category from the region_display_order sort key means a misconfigured single-tenant region (visible=True) could be displayed and sorted alphabetically with multi-tenant regions, breaking the expected order.
Severity: MEDIUM

Suggested Fix

To provide defense-in-depth, either restore the region.category check in the region_display_order sort key to maintain the ordering guarantee, or add explicit validation to find_all_multitenant_locality_names() to assert that no single-tenant regions are present in its results.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: src/sentry/web/client_config.py#L364-L372

Potential issue: The function `region_display_order` no longer uses `region.category` in
its sort key. This change removes the guarantee that multi-tenant regions are sorted
before single-tenant ones. The new logic relies entirely on configuration to filter out
single-tenant regions by their `visible` flag before sorting. If a single-tenant region
is ever misconfigured with `visible=True`, it will be included in the list returned by
`find_all_multitenant_locality_names()` and sorted alphabetically alongside multi-tenant
regions. This could lead to confusing or unexpected ordering for UI and API consumers
that rely on a consistent grouping of multi-tenant regions.

Expand Down
3 changes: 0 additions & 3 deletions tests/sentry/core/endpoints/test_organization_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,12 @@ def test_locality_to_cell_resolution(self) -> None:
Locality(
name="us",
cells=frozenset(["us", "us2"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="us2",
visible=True,
),
Locality(
name="de",
cells=frozenset(["de"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="de",
visible=True,
),
Expand Down Expand Up @@ -339,7 +337,6 @@ def test_staff_user_override_cell_visiblity(self) -> None:
Locality(
name="ja",
cells=frozenset(["ja"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="ja",
visible=False,
),
Expand Down
6 changes: 3 additions & 3 deletions tests/sentry/middleware/integrations/parsers/test_jira.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
from sentry.testutils.cell import override_cells
from sentry.testutils.outbox import assert_no_webhook_payloads, assert_webhook_payloads_for_mailbox
from sentry.testutils.silo import control_silo_test
from sentry.types.cell import Cell, Locality, RegionCategory
from sentry.types.cell import Cell, Locality

cell = Cell("us", 1, "http://us.testserver")
eu_cell = Cell("eu", 2, "http://eu.testserver")
locality = Locality("us", frozenset(["us"]), RegionCategory.MULTI_TENANT, new_org_cell="us")
eu_locality = Locality("eu", frozenset(["eu"]), RegionCategory.MULTI_TENANT, new_org_cell="eu")
locality = Locality("us", frozenset(["us"]), new_org_cell="us")
eu_locality = Locality("eu", frozenset(["eu"]), new_org_cell="eu")

cell_config = (cell, eu_cell)

Expand Down
7 changes: 1 addition & 6 deletions tests/sentry/types/test_cell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ def test_validate_cell(self) -> None:
cell.validate()

def test_locality_to_url(self) -> None:
locality = Locality("us", frozenset(["us"]), RegionCategory.MULTI_TENANT, new_org_cell="us")
locality = Locality("us", frozenset(["us"]), new_org_cell="us")
with override_settings(SILO_MODE=SiloMode.CELL, SENTRY_LOCAL_CELL="us"):
assert locality.to_url("/avatar/abcdef/") == "http://us.testserver/avatar/abcdef/"
with override_settings(SILO_MODE=SiloMode.CONTROL, SENTRY_LOCAL_CELL=""):
Expand Down Expand Up @@ -345,14 +345,12 @@ def test_get_new_org_cell_for_locality(self) -> None:
Locality(
name="us",
cells=frozenset(["us", "us2"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="us2",
visible=True,
),
Locality(
name="de",
cells=frozenset(["de1", "de2"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="de2",
visible=True,
),
Expand Down Expand Up @@ -392,22 +390,19 @@ def test_find_all_signup_locality_names(self) -> None:
Locality(
name="us",
cells=frozenset(["us"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="us",
visible=True,
),
Locality(
name="de",
cells=frozenset(["de"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="de",
visible=True,
signup_visible=False,
),
Locality(
name="ja",
cells=frozenset(["ja"]),
category=RegionCategory.MULTI_TENANT,
new_org_cell="de",
visible=False,
signup_visible=True,
Expand Down
8 changes: 2 additions & 6 deletions tests/sentry/users/api/endpoints/test_user_regions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,8 @@
cell_config = (us, de, st)
SECRET = "test-seer-api-shared-secret-thirty-two-bytes!"

us_locality = Locality(
name="us", cells=frozenset(["us"]), category=RegionCategory.MULTI_TENANT, new_org_cell="us"
)
de_locality = Locality(
name="de", cells=frozenset(["de"]), category=RegionCategory.MULTI_TENANT, new_org_cell="de"
)
us_locality = Locality(name="us", cells=frozenset(["us"]), new_org_cell="us")
de_locality = Locality(name="de", cells=frozenset(["de"]), new_org_cell="de")
st_locality = Locality(
name="acme",
cells=frozenset(["acme"]),
Expand Down
6 changes: 1 addition & 5 deletions tests/sentry/web/test_client_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,8 @@ def create_test_localities(
cell.Locality(
name=c.name,
cells=frozenset([c.name]),
category=(
cell.RegionCategory.SINGLE_TENANT
if c.name in single_tenants
else cell.RegionCategory.MULTI_TENANT
),
new_org_cell=c.name,
visible=c.name not in single_tenants,
)
for c in cells
)
Expand Down
Loading