feat(svc): rename git_url to template_git_url and return git_url on all endpoints (#3646)

Author: Panaetius

renku/ui/service/cache/models/project.py

@@ -56,7 +56,6 @@ class Project(Model):
     owner = TextField()
     initialized = BooleanField()
     commit_sha = TextField()
-    branch = TextField()
 
     @property
     def abs_path(self) -> Path:

renku/ui/service/controllers/datasets_edit.py

@@ -140,6 +140,7 @@ def to_response(self):
             "edited": edited,
             "warnings": warnings,
             "remote_branch": remote_branch,
+            "git_url": self.ctx["git_url"],
         }
 
         return result_response(self.RESPONSE_SERIALIZER, response)

renku/ui/service/controllers/datasets_unlink.py

@@ -77,6 +77,7 @@ def to_response(self):
         response = {
             "unlinked": [record.entity.path for record in op_result],
             "remote_branch": remote_branch,
+            "git_url": self.ctx["git_url"],
         }
 
         return result_response(self.RESPONSE_SERIALIZER, response)

renku/ui/service/controllers/templates_create_project.py

@@ -65,8 +65,8 @@ def default_metadata(self):
         """Default metadata for project creation."""
 
         metadata = {
-            "__template_source__": self.ctx["git_url"],
-            "__template_ref__": self.ctx["branch"],
+            "__template_source__": self.ctx["template_git_url"],
+            "__template_ref__": self.ctx["ref"],
             "__template_id__": self.ctx["identifier"],
             "__namespace__": self.ctx["project_namespace"],
             "__repository__": self.ctx["project_repository"],
@@ -117,7 +117,7 @@ def setup_new_project(self):
 
     def setup_template(self):
         """Reads template manifest."""
-        templates_source = fetch_templates_source(source=self.ctx["git_url"], reference=self.ctx["branch"])
+        templates_source = fetch_templates_source(source=self.ctx["template_git_url"], reference=self.ctx["ref"])
         identifier = self.ctx["identifier"]
         try:
             self.template = templates_source.get_template(id=identifier, reference=None)

renku/ui/service/controllers/templates_read_manifest.py

@@ -49,7 +49,7 @@ def template_manifest(self):
         """Reads template manifest."""
         from PIL import Image
 
-        templates_source = fetch_templates_source(source=self.ctx["git_url"], reference=self.ctx["branch"])
+        templates_source = fetch_templates_source(source=self.ctx["template_git_url"], reference=self.ctx["ref"])
         manifest = templates_source.manifest.get_raw_content()
 
         # NOTE: convert icons to base64

renku/ui/service/controllers/v1/templates.py

@@ -0,0 +1,32 @@
+# Copyright Swiss Data Science Center (SDSC). A partnership between
+# École Polytechnique Fédérale de Lausanne (EPFL) and
+# Eidgenössische Technische Hochschule Zürich (ETHZ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Renku service templates controller."""
+
+from renku.ui.service.controllers.templates_create_project import TemplatesCreateProjectCtrl
+from renku.ui.service.controllers.templates_read_manifest import TemplatesReadManifestCtrl
+from renku.ui.service.serializers.v1.templates import ManifestTemplatesRequest_v2_2, ProjectTemplateRequest_v2_2
+
+
+class TemplatesCreateProjectCtrl_v2_2(TemplatesCreateProjectCtrl):
+    """V2.2 create project controller."""
+
+    REQUEST_SERIALIZER = ProjectTemplateRequest_v2_2()  # type: ignore
+
+
+class TemplatesReadManifestCtrl_v2_2(TemplatesReadManifestCtrl):
+    """V2.2 read manifest controller."""
+
+    REQUEST_SERIALIZER = ManifestTemplatesRequest_v2_2()  # type: ignore

renku/ui/service/serializers/cache.py

@@ -31,6 +31,7 @@
     AsyncSchema,
     ErrorResponse,
     FileDetailsSchema,
+    GitUrlResponseMixin,
     RemoteRepositorySchema,
     RenkuSyncSchema,
 )
@@ -240,7 +241,7 @@ class ProjectMigrateRequest(AsyncSchema, RemoteRepositorySchema):
     skip_migrations = fields.Boolean(dump_default=False)
 
 
-class ProjectMigrateResponse(RenkuSyncSchema):
+class ProjectMigrateResponse(RenkuSyncSchema, GitUrlResponseMixin):
     """Response schema for project migrate."""
 
     was_migrated = fields.Boolean()
@@ -375,7 +376,7 @@ def get_obj_type(self, obj):
         return "error"
 
 
-class ProjectMigrationCheckResponse(Schema):
+class ProjectMigrationCheckResponse(GitUrlResponseMixin):
     """Response schema for project migration check."""
 
     project_supported = fields.Boolean(

renku/ui/service/serializers/common.py

@@ -28,7 +28,7 @@
 class RemoteRepositoryBaseSchema(Schema):
     """Schema for tracking a remote repository."""
 
-    git_url = fields.String(metadata={"description": "Remote git repository url."})
+    git_url = fields.String(required=True, metadata={"description": "Remote git repository url."})
 
     @pre_load
     def normalize_url(self, data, **_):
@@ -168,3 +168,9 @@ class ErrorResponse(Schema):
     userReference = fields.String()
     devReference = fields.String()
     sentry = fields.String()
+
+
+class GitUrlResponseMixin(Schema):
+    """Response containing a git url."""
+
+    git_url = fields.String(required=True, metadata={"description": "Remote git repository url."})

renku/ui/service/serializers/config.py

@@ -20,6 +20,7 @@
 from renku.ui.service.serializers.common import (
     AsyncSchema,
     GitCommitSHA,
+    GitUrlResponseMixin,
     MigrateSchema,
     RemoteRepositorySchema,
     RenkuSyncSchema,
@@ -37,7 +38,7 @@ class ConfigShowSchema(Schema):
     config = fields.Dict(metadata={"description": "Dictionary of configuration items."}, required=True)
 
 
-class ConfigShowResponse(ConfigShowSchema):
+class ConfigShowResponse(ConfigShowSchema, GitUrlResponseMixin):
     """Response schema for project config show."""
 
     default = fields.Dict(metadata={"description": "Dictionary of default configuration items."}, required=True)
@@ -53,7 +54,7 @@ class ConfigSetRequest(AsyncSchema, ConfigShowSchema, MigrateSchema, RemoteRepos
     """Request schema for config set."""
 
 
-class ConfigSetResponse(ConfigShowSchema, RenkuSyncSchema):
+class ConfigSetResponse(ConfigShowSchema, RenkuSyncSchema, GitUrlResponseMixin):
     """Response schema for project config set."""
 
     default = fields.Dict(metadata={"description": "Dictionary of default configuration items."})

renku/ui/service/serializers/datasets.py

@@ -23,6 +23,7 @@
 from renku.ui.service.serializers.common import (
     AsyncSchema,
     GitCommitSHA,
+    GitUrlResponseMixin,
     JobDetailsResponse,
     MigrateSchema,
     RemoteRepositorySchema,
@@ -55,7 +56,7 @@ class DatasetCreateRequest(AsyncSchema, DatasetDetailsRequest, RemoteRepositoryS
     )
 
 
-class DatasetCreateResponse(DatasetSlugSchema, RenkuSyncSchema):
+class DatasetCreateResponse(DatasetSlugSchema, RenkuSyncSchema, GitUrlResponseMixin):
     """Response schema for a dataset create view."""
 
 
@@ -69,7 +70,7 @@ class DatasetRemoveRequest(AsyncSchema, DatasetSlugSchema, RemoteRepositorySchem
     """Request schema for a dataset remove."""
 
 
-class DatasetRemoveResponse(DatasetSlugSchema, RenkuSyncSchema):
+class DatasetRemoveResponse(DatasetSlugSchema, RenkuSyncSchema, GitUrlResponseMixin):
     """Response schema for a dataset create view."""
 
 
@@ -108,7 +109,7 @@ def check_files(self, data, **kwargs):
         return data
 
 
-class DatasetAddResponse(DatasetSlugSchema, RenkuSyncSchema):
+class DatasetAddResponse(DatasetSlugSchema, RenkuSyncSchema, GitUrlResponseMixin):
     """Response schema for a dataset add file view."""
 
     project_id = fields.String(required=True)
@@ -131,7 +132,7 @@ class DatasetDetailsResponse(DatasetDetails):
     images = fields.List(fields.Nested(ImageObject))
 
 
-class DatasetListResponse(Schema):
+class DatasetListResponse(GitUrlResponseMixin):
     """Response schema for dataset list view."""
 
     datasets = fields.List(fields.Nested(DatasetDetailsResponse), required=True)
@@ -156,7 +157,7 @@ class DatasetFileDetails(Schema):
     added = fields.DateTime()
 
 
-class DatasetFilesListResponse(DatasetSlugSchema):
+class DatasetFilesListResponse(DatasetSlugSchema, GitUrlResponseMixin):
     """Response schema for dataset files list view."""
 
     files = fields.List(fields.Nested(DatasetFileDetails), required=True)
@@ -212,7 +213,7 @@ class DatasetEditRequest(
     )
 
 
-class DatasetEditResponse(RenkuSyncSchema):
+class DatasetEditResponse(RenkuSyncSchema, GitUrlResponseMixin):
     """Dataset edit metadata response."""
 
     edited = fields.Dict(required=True)
@@ -243,7 +244,7 @@ def check_filters(self, data, **kwargs):
         return data
 
 
-class DatasetUnlinkResponse(RenkuSyncSchema):
+class DatasetUnlinkResponse(RenkuSyncSchema, GitUrlResponseMixin):
     """Dataset unlink files response."""
 
     unlinked = fields.List(fields.String())