feat(api): enable feature flag renaming via save()

amimas · amimas · commit 379291786c96 · 2026-03-15T17:53:35.000-04:00
The `ProjectFeatureFlag` object uses `name` as its ID attribute.
Previously, modifying the `name` of a flag object and calling `save()`
would fail because the library would attempt to send a PUT request to
the *new* name, which does not yet exist, resulting in a 404 error.

This change overrides the `save()` method in `ProjectFeatureFlag` to
correctly handle renaming. It now detects when the `name` attribute has
been modified and uses the original name for the API request URL, while
sending the new name in the request body.

This makes renaming feature flags more intuitive and consistent with the
behavior of other objects in the library.
diff --git a/gitlab/v4/objects/feature_flags.py b/gitlab/v4/objects/feature_flags.py
@@ -5,7 +5,9 @@
 
 from __future__ import annotations
 
-from gitlab import types
+from typing import Any
+
+from gitlab import types, utils
 from gitlab.base import RESTObject
 from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
 from gitlab.types import RequiredOptional
@@ -15,6 +17,50 @@
 
 class ProjectFeatureFlag(SaveMixin, ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
+    manager: ProjectFeatureFlagManager
+
+    def _get_save_url_id(self) -> str | int | None:
+        """Get the ID used to construct the API URL for the save operation.
+
+        For renames, this must be the *original* name of the flag. For other
+        updates, it is the current name.
+        """
+        if self._id_attr in self._updated_attrs:
+            # If the name is being changed, use the original name for the URL.
+            obj_id = self._attrs.get(self._id_attr)
+            if isinstance(obj_id, str):
+                return utils.EncodedId(obj_id)
+            return obj_id
+        return self.encoded_id
+
+    def save(self, **kwargs: Any) -> dict[str, Any] | None:
+        """Save the changes made to the object to the server.
+
+        The object is updated to match what the server returns.
+
+        This method overrides the default ``save()`` method to handle renaming
+        feature flags. When the name is modified, the API requires the original
+        name in the URL to identify the resource, while the new name is sent
+        in the request body.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Returns:
+            The new object data (*not* a RESTObject)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUpdateError: If the server cannot perform the request
+        """
+        updated_data = self._get_updated_data()
+        if not updated_data:
+            return None
+
+        obj_id = self._get_save_url_id()
+        server_data = self.manager.update(obj_id, updated_data, **kwargs)
+        self._update_attrs(server_data)
+        return server_data
 
 
 class ProjectFeatureFlagManager(CRUDMixin[ProjectFeatureFlag]):
@@ -24,6 +70,8 @@ class ProjectFeatureFlagManager(CRUDMixin[ProjectFeatureFlag]):
     _create_attrs = RequiredOptional(
         required=("name",), optional=("version", "description", "active", "strategies")
     )
-    _update_attrs = RequiredOptional(optional=("description", "active", "strategies"))
+    _update_attrs = RequiredOptional(
+        optional=("name", "description", "active", "strategies")
+    )
     _list_filters = ("scope",)
     _types = {"strategies": types.JsonAttribute}
diff --git a/tests/functional/api/test_project_feature_flags.py b/tests/functional/api/test_project_feature_flags.py
@@ -52,6 +52,26 @@ def test_update_feature_flag(project, feature_flag):
     assert updated_flag.active is False
 
 
+def test_rename_feature_flag(project, feature_flag):
+    # Rename via save()
+    new_name = "renamed_flag"
+    feature_flag.name = new_name
+    feature_flag.save()
+
+    updated_flag = project.feature_flags.get(new_name)
+    assert updated_flag.name == new_name
+
+    # Rename via update()
+    newer_name = "renamed_flag_2"
+    project.feature_flags.update(new_name, {"name": newer_name})
+
+    updated_flag_2 = project.feature_flags.get(newer_name)
+    assert updated_flag_2.name == newer_name
+
+    # Update the fixture object so teardown can delete the correct flag
+    feature_flag.name = newer_name
+
+
 def test_delete_feature_flag(project, feature_flag):
     feature_flag.delete()
     with pytest.raises(exceptions.GitlabGetError):
