Implement a way to return the sequential_number after create (#3326)

* Implement a way to return the sequential_number after create

* Remove commented out code from database writer

Author: luisa-beerboom

openslides_backend/action/action.py

@@ -82,6 +82,8 @@ def original_instances(method: Callable) -> Callable:
 
 T = TypeVar("T", bound=WriteRequest)
 
+EditFunction = Callable[[dict, dict[FullQualifiedId, dict[str, Any]]], None]
+
 
 class Action(BaseServiceProvider, metaclass=SchemaProvider):
     """
@@ -817,6 +819,13 @@ def execute_presenter(
         presenter_instance.validate()
         return presenter_instance.get_result()
 
+    def get_post_edit_function(self) -> EditFunction | None:
+        """
+        Returns a function that allows post-editing the action result
+        with the return data from the database writer.
+        """
+        return None
+
 
 def merge_history_informations(
     a: HistoryInformation | None, *other: HistoryInformation | None

openslides_backend/action/action_handler.py

@@ -68,6 +68,8 @@
     }
 )
 
+META_POST_EDIT_FN_KEY = "META_EDIT_FN_GHETZHSRHSRGG"
+
 
 class ActionHandler(BaseHandler):
     """
@@ -122,6 +124,7 @@ def handle_request(
 
             try:
                 with get_new_os_conn() as conn:
+                    self.post_edit_necessary = False
                     self.datastore = ExtendedDatabase(conn, self.logging, self.env)
                     results: ActionsResponseResults = []
                     if atomic:
@@ -190,7 +193,8 @@ def execute_write_requests(
                 try:
                     write_requests, data = get_write_requests(*args)
                     if write_requests:
-                        self.datastore.write(write_requests)
+                        results = self.datastore.write(write_requests)
+                        data = self.update_action_data_with_write_results(data, results)
                     return data
                 except DatastoreLockedException as exception:
                     retries += 1
@@ -199,6 +203,20 @@ def execute_write_requests(
                     else:
                         self.datastore.reset()
 
+    def update_action_data_with_write_results(
+        self, data: T, results: dict[str, dict[str, Any]]
+    ) -> T:
+        if self.post_edit_necessary:
+            if isinstance(data, list):
+                for element in data:
+                    if element:
+                        self.update_action_data_with_write_results(element, results)
+            elif isinstance(data, dict):
+                edit_fn = data.pop(META_POST_EDIT_FN_KEY, None)
+                if edit_fn:
+                    return edit_fn(data, results)
+        return data
+
     def parse_actions(
         self, payload: Payload
     ) -> tuple[list[WriteRequest], ActionsResponseResults]:
@@ -275,6 +293,12 @@ def perform_action(
                 write_request, results = action.perform(
                     action_data, self.user_id, internal=self.internal
                 )
+                if results and (edit_fn := action.get_post_edit_function()):
+                    for element in results:
+                        if element and isinstance(element, dict):
+                            element[META_POST_EDIT_FN_KEY] = edit_fn
+                            self.post_edit_necessary = True
+
             if write_request:
                 action.validate_write_request(write_request)
 

openslides_backend/action/actions/assignment/create_update_delete.py

@@ -8,6 +8,7 @@
 from ...action_set import ActionSet
 from ...generics.update import UpdateAction
 from ...mixins.create_action_with_dependencies import CreateActionWithDependencies
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action_set
 from ..agenda_item.agenda_creation import (
@@ -25,6 +26,7 @@
 
 class AssignmentCreate(
     AttachmentMixin,
+    SequentialNumbersMixin,
     CreateActionWithDependencies,
     CreateActionWithAgendaItemMixin,
     CreateActionWithListOfSpeakersMixin,

openslides_backend/action/actions/motion/base_create_forwarded.py

@@ -352,6 +352,14 @@ def create_action_result_element(
         result.update(self.id_to_result_extra_data.get(result["id"], {}))
         return result
 
+    def post_edit_fn(self, data: dict, results: dict[str, dict[str, Any]]) -> None:
+        super().post_edit_fn(data, results)
+        dates = [*data.get("amendment_result_data", [])]
+        while len(dates):
+            date = dates.pop(0)
+            super().post_edit_fn(date, results)
+            dates.extend(date.get("amendment_result_data", []))
+
     def handle_number(self, instance: dict[str, Any]) -> dict[str, Any]:
         origin = self.datastore.get(
             fqid_from_collection_and_id("motion", instance["origin_id"]),

openslides_backend/action/actions/motion/create_base.py

@@ -5,6 +5,7 @@
 from ....models.models import Motion
 from ....shared.patterns import fqid_from_collection_and_id
 from ...mixins.create_action_with_dependencies import CreateActionWithDependencies
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ..agenda_item.agenda_creation import CreateActionWithAgendaItemMixin
 from ..agenda_item.create import AgendaItemCreate
 from ..list_of_speakers.create import ListOfSpeakersCreate
@@ -22,6 +23,7 @@ class MotionCreateBase(
     MeetingUserHelperMixin,
     CreateActionWithDependencies,
     CreateActionWithAgendaItemMixin,
+    SequentialNumbersMixin,
     SetNumberMixin,
     CreateActionWithListOfSpeakersMixin,
 ):

openslides_backend/action/actions/motion_block/create_update_delete.py

@@ -2,6 +2,7 @@
 from ....permissions.permissions import Permissions
 from ...action_set import ActionSet
 from ...mixins.create_action_with_dependencies import CreateActionWithDependencies
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action_set
 from ..agenda_item.agenda_creation import (
@@ -16,6 +17,7 @@
 
 
 class MotionBlockCreate(
+    SequentialNumbersMixin,
     CreateActionWithDependencies,
     CreateActionWithAgendaItemMixin,
     CreateActionWithListOfSpeakersMixin,

openslides_backend/action/actions/motion_category/create_update_delete.py

@@ -3,13 +3,13 @@
 from ....models.models import MotionCategory
 from ....permissions.permissions import Permissions
 from ...action_set import ActionSet
-from ...generics.create import CreateAction
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...mixins.weight_mixin import WeightMixin
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action_set
 
 
-class MotionCategoryCreate(CreateAction, WeightMixin):
+class MotionCategoryCreate(SequentialNumbersMixin, WeightMixin):
     def update_instance(self, instance: dict[str, Any]) -> dict[str, Any]:
         instance["weight"] = self.get_weight(instance["meeting_id"])
         return super().update_instance(instance)

openslides_backend/action/actions/motion_comment_section/create.py

@@ -2,14 +2,16 @@
 
 from ....models.models import MotionCommentSection
 from ....permissions.permissions import Permissions
-from ...generics.create import CreateAction
 from ...mixins.forbid_anonymous_group_mixin import ForbidAnonymousGroupMixin
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action
 
 
 @register_action("motion_comment_section.create")
-class MotionCommentSectionCreateAction(CreateAction, ForbidAnonymousGroupMixin):
+class MotionCommentSectionCreateAction(
+    SequentialNumbersMixin, ForbidAnonymousGroupMixin
+):
     """
     Create Action with default weight.
     """

openslides_backend/action/actions/motion_workflow/create.py

@@ -4,8 +4,8 @@
 from ....models.models import MotionWorkflow
 from ....permissions.permissions import Permissions
 from ...action import Action
-from ...generics.create import CreateAction
 from ...mixins.create_action_with_dependencies import CreateActionWithDependencies
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...util.action_type import ActionType
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action
@@ -16,7 +16,7 @@
 
 
 @register_action("motion_workflow.create")
-class MotionWorkflowCreateAction(CreateActionWithDependencies):
+class MotionWorkflowCreateAction(SequentialNumbersMixin, CreateActionWithDependencies):
     """
     Action to create a motion workflow.
     """
@@ -43,7 +43,7 @@ def get_dependent_action_data(
 @register_action(
     "motion_workflow.create_simple_workflow", action_type=ActionType.BACKEND_INTERNAL
 )
-class MotionWorkflowCreateSimpleWorkflowAction(CreateAction):
+class MotionWorkflowCreateSimpleWorkflowAction(SequentialNumbersMixin):
     """
     Action to create a simple motion workflow.
     """
@@ -113,7 +113,7 @@ def update_instance(self, instance: dict[str, Any]) -> dict[str, Any]:
 @register_action(
     "motion_workflow.create_complex_workflow", action_type=ActionType.BACKEND_INTERNAL
 )
-class MotionWorkflowCreateComplexWorkflowAction(CreateAction):
+class MotionWorkflowCreateComplexWorkflowAction(SequentialNumbersMixin):
     """
     Action to create a complex motion workflow.
     """

openslides_backend/action/actions/motion_workflow/import_.py

@@ -5,15 +5,15 @@
 from ....permissions.permissions import Permissions
 from ....shared.exceptions import ActionException
 from ....shared.schema import str_list_schema
-from ...generics.create import CreateAction
+from ...mixins.sequential_numbers_mixin import SequentialNumbersMixin
 from ...util.default_schema import DefaultSchema
 from ...util.register import register_action
 from ..motion_state.create import MotionStateCreateAction
 from ..motion_state.update import MotionStateUpdateAction
 
 
 @register_action("motion_workflow.import")
-class MotionWorkflowImport(CreateAction):
+class MotionWorkflowImport(SequentialNumbersMixin):
     """
     Action to import a motion workflow.
     """