Update only generated Code during gRPC Code Re-generation (#92)

The "user-defined" area has been removed from the cpp header template.
Instead all code is persisted between two "code re-generations" except
of the "auto-generated" code. The "auto-generated" code is correctly
updated depending on if services where added or removed between two
consecutive "code re-generations".

grpc-interface-support/data/templates/cpp/ServiceImpl.h

@@ -30,10 +30,6 @@ class ${{ service_name_camel_case }}Service final : public ${{ package_id }}::${
 // <auto-generated>
 ${{ service_header_code }}
 // </auto-generated>
-
-// <user-defined>
-${{ service_header_user_code }}
-// </user-defined>
 };
 
 } // namespace velocitas

grpc-interface-support/requirements.txt

@@ -1,2 +1,2 @@
-velocitas-lib==0.0.12
+velocitas-lib==0.0.13
 proto-schema-parser==1.3.4

grpc-interface-support/src/cpp.py

@@ -32,9 +32,13 @@
     export_conan_project,
     get_required_sdk_version,
 )
+from velocitas_lib.file_utils import (
+    capture_area_in_file,
+    read_file,
+    write_file,
+)
 from velocitas_lib.templates import CopySpec, copy_templates
 from velocitas_lib.text_utils import (
-    capture_area_in_file,
     to_camel_case,
 )
 
@@ -335,32 +339,30 @@ def __transform_source_stub_code(self, lines: List[str]) -> List[str]:
         return result
 
     def __create_or_update_service_header(self) -> None:
-        header_stub_code = GrpcCodeExtractor(
-            self.__proto_file_handle, self.__package_directory_path
-        ).get_header_stub_code(self.__get_include_dir())
-
-        header_stub_code = self.__transform_header_stub_code(header_stub_code)
-
         app_source_dir = os.path.join(get_workspace_dir(), "app", "src")
-        service_header_file_name = f"{to_camel_case(self.__service_name)}ServiceImpl.h"
+        service_header_file_name = (
+            f"{self.__proto_file_handle.get_service_name()}ServiceImpl.h"
+        )
         service_header_file_path = os.path.join(
             app_source_dir, service_header_file_name
         )
 
-        user_defined_code: List[str] = []
         if os.path.exists(service_header_file_path):
-            # there is a previous version of the header
-            # extract the user-defined code
+            self.__update_service_header()
+        else:
+            self.__create_service_header()
 
-            user_defined_code = capture_area_in_file(
-                open(service_header_file_path, encoding="utf-8"),
-                "// <user-defined>",
-                "// </user-defined>",
-            )
+    def __create_service_header(self) -> None:
+        header_stub_code = GrpcCodeExtractor(
+            self.__proto_file_handle, self.__package_directory_path
+        ).get_header_stub_code(self.__get_include_dir())
+
+        header_stub_code = self.__transform_header_stub_code(header_stub_code)
 
+        app_source_dir = os.path.join(get_workspace_dir(), "app", "src")
+        service_header_file_name = f"{to_camel_case(self.__service_name)}ServiceImpl.h"
         variables = self.__get_template_variables()
         variables["service_header_code"] = "\n".join(header_stub_code)
-        variables["service_header_user_code"] = "\n".join(user_defined_code)
 
         copy_templates(
             get_template_dir(),
@@ -369,6 +371,33 @@ def __create_or_update_service_header(self) -> None:
             variables,
         )
 
+    def __update_service_header(self) -> None:
+        header_generated_code = GrpcCodeExtractor(
+            self.__proto_file_handle, self.__package_directory_path
+        ).get_header_stub_code(self.__get_include_dir())
+
+        header_generated_code = self.__transform_header_stub_code(header_generated_code)
+
+        app_source_dir = os.path.join(get_workspace_dir(), "app", "src")
+        service_header_file_name = (
+            f"{self.__proto_file_handle.get_service_name()}ServiceImpl.h"
+        )
+        service_header_file_path = os.path.join(
+            app_source_dir, service_header_file_name
+        )
+
+        auto_generated_code = capture_area_in_file(
+            open(service_header_file_path, encoding="utf-8"),
+            "// <auto-generated>",
+            "// </auto-generated>",
+        )
+
+        header_file_content = read_file(service_header_file_path)
+        modified_content = header_file_content.replace(
+            "\n".join(auto_generated_code), "\n".join(header_generated_code)
+        )
+        write_file(service_header_file_path, modified_content)
+
     def __create_service_source(self) -> None:
         app_source_dir = os.path.join(get_workspace_dir(), "app", "src")
         service_source_file_name = (

grpc-interface-support/src/python.py

@@ -23,12 +23,14 @@
 from generator import GrpcServiceSdkGenerator, GrpcServiceSdkGeneratorFactory
 from proto import ProtoFileHandle
 from velocitas_lib import get_package_path, get_workspace_dir, templates
+from velocitas_lib.file_utils import (
+    capture_area_in_file,
+    replace_text_in_file,
+)
 from velocitas_lib.templates import CopySpec, copy_templates
 from velocitas_lib.text_utils import (
-    capture_area_in_file,
     replace_item_in_list,
     replace_text_area,
-    replace_text_in_file,
 )