class_name

Author: Rachel Chen

snuba/admin/capacity_management_utils.py

@@ -6,7 +6,7 @@
 def convert(policy_data: PolicyData) -> dict[str, Any]:
     "We need to convert the policy data to the format that the frontend expects. This will be removed once we update the frontend"
     return {
-        "policy_name": policy_data["configurable_component_config_key"],
+        "policy_name": policy_data["configurable_component_class_name"],
         "configs": policy_data["configurations"],
         "optional_config_definitions": policy_data["optional_config_definitions"],
         "query_type": policy_data["query_type"],

snuba/admin/notifications/slack/utils.py

@@ -12,9 +12,7 @@
 )
 
 
-def build_blocks(
-    data: Any, action: AuditLogAction, timestamp: str, user: str
-) -> List[Any]:
+def build_blocks(data: Any, action: AuditLogAction, timestamp: str, user: str) -> List[Any]:
     if action in RUNTIME_CONFIG_ACTIONS:
         text = build_runtime_config_text(data, action)
     elif action in MIGRATION_ACTIONS:
@@ -32,17 +30,15 @@ def build_blocks(
     return [section, build_context(user, timestamp, action)]
 
 
-def build_configurable_component_changed_text(
-    data: Any, action: AuditLogAction
-) -> Optional[str]:
+def build_configurable_component_changed_text(data: Any, action: AuditLogAction) -> Optional[str]:
 
-    base = f"*Resource {data['resource_identifier']} Configurable Component {data['configurable_component_config_key']} Changed:*"
+    base = f"*Resource {data['resource_identifier']} Configurable Component {data['configurable_component_class_name']} Changed:*"
 
     if action == AuditLogAction.CONFIGURABLE_COMPONENT_DELETE:
-        removed = f"~```'{data['configurable_component_config_key']}.{data['key']}({data.get('params', {})})'```~"
+        removed = f"~```'{data['configurable_component_class_name']}.{data['key']}({data.get('params', {})})'```~"
         return f"{base} :put_litter_in_its_place:\n\n{removed}"
     elif action == AuditLogAction.CONFIGURABLE_COMPONENT_UPDATE:
-        updated = f"```'{data['configurable_component_config_key']}.{data['key']}({data.get('params', {})})' = '{data['value']}'```"
+        updated = f"```'{data['configurable_component_class_name']}.{data['key']}({data.get('params', {})})' = '{data['value']}'```"
         return f"{base} :up: :date:\n\n{updated}"
     else:
         # todo: raise error, cause slack won't accept this
@@ -85,9 +81,7 @@ def build_migration_run_text(data: Any, action: AuditLogAction) -> Optional[str]
     else:
         return None
 
-    text = (
-        f"*Migration:* \n\n{action_text} (force={data['force']}, fake={data['fake']})"
-    )
+    text = f"*Migration:* \n\n{action_text} (force={data['force']}, fake={data['fake']})"
 
     if action in [
         AuditLogAction.REVERSED_MIGRATION_FAILED,

snuba/admin/views.py

@@ -993,15 +993,15 @@ def set_configuration() -> Response:
 
     try:
         configurable_component_namespace = data["configurable_component_namespace"]
-        configurable_component_config_key = data["configurable_component_config_key"]
+        configurable_component_class_name = data["configurable_component_class_name"]
         resource_name = data["resource_name"]
         assert isinstance(
-            configurable_component_config_key, str
-        ), f"Invalid configurable_component_config_key: {configurable_component_config_key}"
+            configurable_component_class_name, str
+        ), f"Invalid configurable_component_class_name: {configurable_component_class_name}"
         assert isinstance(resource_name, str), f"Invalid resource_name {resource_name}"
         configurable_component = (
             ConfigurableComponent.get_component_class(configurable_component_namespace)
-            .get_from_name(configurable_component_config_key)
+            .get_from_name(configurable_component_class_name)
             .create_minimal_instance(resource_name)
         )
 
@@ -1025,7 +1025,7 @@ def set_configuration() -> Response:
             AuditLogAction.CONFIGURABLE_COMPONENT_DELETE,
             {
                 "resource_identifier": resource_name,
-                "configurable_component_config_key": configurable_component.config_key(),
+                "configurable_component_class_name": configurable_component.class_name(),
                 "key": key,
             },
             notify=True,
@@ -1043,7 +1043,7 @@ def set_configuration() -> Response:
                 AuditLogAction.CONFIGURABLE_COMPONENT_UPDATE,
                 {
                     "resource_identifier": resource_name,
-                    "configurable_component_config_key": configurable_component.config_key(),
+                    "configurable_component_class_name": configurable_component.class_name(),
                     "key": key,
                     "value": value,
                     "params": str(params),

snuba/configs/configuration.py

@@ -21,7 +21,7 @@ class InvalidConfig(Exception):
 
 class ConfigurableComponentData(TypedDict):
     configurable_component_namespace: str
-    configurable_component_config_key: str
+    configurable_component_class_name: str
     resource_identifier: str
     configurations: list[dict[str, Any]]
     optional_config_definitions: list[dict[str, Any]]
@@ -454,7 +454,7 @@ def class_name(cls) -> str:
     def to_dict(self) -> ConfigurableComponentData:
         return ConfigurableComponentData(
             configurable_component_namespace=self.component_namespace(),
-            configurable_component_config_key=self.class_name(),
+            configurable_component_class_name=self.class_name(),
             resource_identifier=self.resource_identifier.value,
             configurations=self.get_current_configs(),
             optional_config_definitions=self.get_optional_config_definitions_json(),

tests/admin/notifications/test_build_blocks.py

@@ -15,7 +15,7 @@
         pytest.param(
             {
                 "resource_identifier": "errors",
-                "configurable_component_config_key": "BytesScannedWindowAllocationPolicy",
+                "configurable_component_class_name": "BytesScannedWindowAllocationPolicy",
                 "key": "org_limit_bytes_scanned_override",
                 "value": "420",
                 "params": "{'org_id': 1}",
@@ -27,7 +27,7 @@
         pytest.param(
             {
                 "resource_identifier": "errors",
-                "configurable_component_config_key": "BytesScannedWindowAllocationPolicy",
+                "configurable_component_class_name": "BytesScannedWindowAllocationPolicy",
                 "key": "org_limit_bytes_scanned_override",
                 "params": "{'org_id': 1}",
             },
@@ -37,9 +37,7 @@
         ),
     ],
 )
-def test_build_blocks(
-    data: dict[str, Any], action: AuditLogAction, expected: str
-) -> None:
+def test_build_blocks(data: dict[str, Any], action: AuditLogAction, expected: str) -> None:
 
     res = build_blocks(
         data,

tests/admin/test_api.py

@@ -492,7 +492,7 @@ def test_get_routing_strategy_configs(admin_api: FlaskClient) -> None:
     strategy_data = response.json
 
     # Check strategy-level data
-    assert strategy_data["configurable_component_config_key"] == "FakeRoutingStrategy"
+    assert strategy_data["configurable_component_class_name"] == "FakeRoutingStrategy"
     assert len(strategy_data["configurations"]) == 2
     assert {
         "name": "some_default_config",
@@ -516,7 +516,7 @@ def test_get_routing_strategy_configs(admin_api: FlaskClient) -> None:
     assert len(strategy_data["policies_data"]) == 2
 
     # First policy
-    assert strategy_data["policies_data"][0]["configurable_component_config_key"] == "FakePolicy"
+    assert strategy_data["policies_data"][0]["configurable_component_class_name"] == "FakePolicy"
     assert strategy_data["policies_data"][0]["query_type"] == "select"
     assert len(strategy_data["policies_data"][0]["configurations"]) == 4
     assert {
@@ -562,7 +562,7 @@ def test_get_routing_strategy_configs(admin_api: FlaskClient) -> None:
 
     # Second policy
     assert (
-        strategy_data["policies_data"][1]["configurable_component_config_key"] == "FakeDeletePolicy"
+        strategy_data["policies_data"][1]["configurable_component_class_name"] == "FakeDeletePolicy"
     )
     assert strategy_data["policies_data"][1]["query_type"] == "delete"
     assert len(strategy_data["policies_data"][1]["configurations"]) == 4
@@ -721,7 +721,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
             data=json.dumps(
                 {
                     "configurable_component_namespace": "AllocationPolicy",
-                    "configurable_component_config_key": "BytesScannedWindowAllocationPolicy",
+                    "configurable_component_class_name": "BytesScannedWindowAllocationPolicy",
                     "resource_name": "errors",
                     "key": "org_limit_bytes_scanned_override",
                     "params": {"org_id": 1},
@@ -763,7 +763,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
                 data=json.dumps(
                     {
                         "configurable_component_namespace": "AllocationPolicy",
-                        "configurable_component_config_key": "BytesScannedWindowAllocationPolicy",
+                        "configurable_component_class_name": "BytesScannedWindowAllocationPolicy",
                         "resource_name": "errors",
                         "key": "org_limit_bytes_scanned_override",
                         "params": {"org_id": 1},
@@ -811,7 +811,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
             data=json.dumps(
                 {
                     "configurable_component_namespace": "BaseRoutingStrategy",
-                    "configurable_component_config_key": "FakeRoutingStrategy",
+                    "configurable_component_class_name": "FakeRoutingStrategy",
                     "resource_name": "FakeRoutingStrategy",
                     "key": "fake_strategy_config",
                     "value": "75",
@@ -828,7 +828,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
 
         # Verify the config was set correctly
         strategy_data = response.json
-        assert strategy_data["configurable_component_config_key"] == "FakeRoutingStrategy"
+        assert strategy_data["configurable_component_class_name"] == "FakeRoutingStrategy"
         assert {
             "name": "fake_strategy_config",
             "type": "int",
@@ -844,7 +844,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
             data=json.dumps(
                 {
                     "configurable_component_namespace": "BaseRoutingStrategy",
-                    "configurable_component_config_key": "FakeRoutingStrategy",
+                    "configurable_component_class_name": "FakeRoutingStrategy",
                     "resource_name": "FakeRoutingStrategy",
                     "key": "fake_strategy_config",
                 }
@@ -859,7 +859,7 @@ def mock_record(user: Any, action: Any, data: Any, notify: Any) -> None:
 
         # The config should be back to its default value
         strategy_data = response.json
-        assert strategy_data["configurable_component_config_key"] == "FakeRoutingStrategy"
+        assert strategy_data["configurable_component_class_name"] == "FakeRoutingStrategy"
         assert {
             "name": "fake_strategy_config",
             "type": "int",
@@ -898,7 +898,7 @@ def mock_get_from_name(strategy_name: str) -> Type[BaseRoutingStrategy]:
             data=json.dumps(
                 {
                     "configurable_component_namespace": "AllocationPolicy",
-                    "configurable_component_config_key": "FakePolicy",
+                    "configurable_component_class_name": "FakePolicy",
                     "resource_name": "FakeRoutingStrategy",
                     "key": "fake_optional_config",
                     "params": {"org_id": 1},
@@ -916,16 +916,16 @@ def mock_get_from_name(strategy_name: str) -> Type[BaseRoutingStrategy]:
         assert response.json is not None
 
         strategy_data = response.json
-        assert strategy_data["configurable_component_config_key"] == "FakeRoutingStrategy"
+        assert strategy_data["configurable_component_class_name"] == "FakeRoutingStrategy"
         assert len(strategy_data["policies_data"]) == 2
 
         fake_policy = next(
             policy
             for policy in strategy_data["policies_data"]
-            if policy["configurable_component_config_key"] == "FakePolicy"
+            if policy["configurable_component_class_name"] == "FakePolicy"
         )
 
-        assert fake_policy["configurable_component_config_key"] == "FakePolicy"
+        assert fake_policy["configurable_component_class_name"] == "FakePolicy"
         assert {
             "default": -1,
             "description": "",
@@ -941,7 +941,7 @@ def mock_get_from_name(strategy_name: str) -> Type[BaseRoutingStrategy]:
             data=json.dumps(
                 {
                     "configurable_component_namespace": "AllocationPolicy",
-                    "configurable_component_config_key": "FakePolicy",
+                    "configurable_component_class_name": "FakePolicy",
                     "resource_name": "FakeRoutingStrategy",
                     "key": "fake_optional_config",
                     "params": {"org_id": 1},
@@ -959,7 +959,7 @@ def mock_get_from_name(strategy_name: str) -> Type[BaseRoutingStrategy]:
         fake_policy = next(
             policy
             for policy in strategy_data["policies_data"]
-            if policy["configurable_component_config_key"] == "FakePolicy"
+            if policy["configurable_component_class_name"] == "FakePolicy"
         )
 
         # The config should be back to its default value