[DOP-23976] Use PUT instead of PATCH for connections & transfers (#215)

Author: IlyasDevelopment

docs/changelog/next_release/215.breaking.rst

@@ -0,0 +1 @@
+Use PUT instead of PATCH for `Connection` and `Transfer` models

syncmaster/db/repositories/connection.py

@@ -89,21 +89,17 @@ async def create(
     async def update(
         self,
         connection_id: int,
-        name: str | None,
-        type: str | None,
-        description: str | None,
+        name: str,
+        type: str,
+        description: str,
         data: dict[str, Any],
     ) -> Connection:
         try:
-            connection = await self.read_by_id(connection_id=connection_id)
-            for key in connection.data:
-                data[key] = data.get(key, None) or connection.data[key]
-
             return await self._update(
                 Connection.id == connection_id,
-                type=type or connection.type,
-                name=name or connection.name,
-                description=description or connection.description,
+                type=type,
+                name=name,
+                description=description,
                 data=data,
             )
         except IntegrityError as e:

syncmaster/db/repositories/credentials_repository.py

@@ -71,10 +71,7 @@ async def update(
         connection_id: int,
         data: dict,
     ) -> AuthData:
-        creds = await self.read(connection_id)
         try:
-            for key in creds:
-                data[key] = data.get(key, None) or creds[key]
             return await self._update(
                 AuthData.connection_id == connection_id,
                 value=encrypt_auth_data(value=data, settings=self._settings),

syncmaster/db/repositories/transfer.py

@@ -150,44 +150,35 @@ async def create(
 
     async def update(
         self,
-        transfer: Transfer,
-        name: str | None,
-        description: str | None,
-        source_connection_id: int | None,
-        target_connection_id: int | None,
+        transfer_id: int,
+        name: str,
+        description: str,
+        source_connection_id: int,
+        target_connection_id: int,
         source_params: dict[str, Any],
         target_params: dict[str, Any],
         strategy_params: dict[str, Any],
         transformations: list[dict[str, Any]],
         resources: dict[str, Any],
-        is_scheduled: bool | None,
+        is_scheduled: bool,
         schedule: str | None,
-        new_queue_id: int | None,
+        queue_id: int,
     ) -> Transfer:
         try:
-            for old, new in [
-                (transfer.source_params, source_params),
-                (transfer.target_params, target_params),
-                (transfer.strategy_params, strategy_params),
-            ]:
-                for key in old:
-                    if key not in new or new[key] is None:
-                        new[key] = old[key]
-
             return await self._update(
-                Transfer.id == transfer.id,
-                name=name or transfer.name,
-                description=description or transfer.description,
+                Transfer.id == transfer_id,
+                name=name,
+                description=description,
                 strategy_params=strategy_params,
-                is_scheduled=is_scheduled if is_scheduled is not None else transfer.is_scheduled,
-                schedule=schedule or transfer.schedule,
-                source_connection_id=source_connection_id or transfer.source_connection_id,
-                target_connection_id=target_connection_id or transfer.target_connection_id,
+                is_scheduled=is_scheduled,
+                schedule=schedule or "",
+                source_connection_id=source_connection_id,
+                target_connection_id=target_connection_id,
                 source_params=source_params,
                 target_params=target_params,
-                transformations=transformations or transfer.transformations,
-                resources=resources or transfer.resources,
-                queue_id=new_queue_id or transfer.queue_id,
+                transformations=transformations,
+                resources=resources,
+                queue_id=queue_id,
             )
         except IntegrityError as e:
             self._raise_error(e)

syncmaster/exceptions/connection.py

@@ -19,6 +19,10 @@ class ConnectionTypeUpdateError(SyncmasterError):
     pass
 
 
+class ConnectionAuthDataUpdateError(SyncmasterError):
+    pass
+
+
 class UserDoNotHaveRightsInTheTargetGroupError(SyncmasterError):
     pass
 

syncmaster/schemas/v1/__init__.py

@@ -28,7 +28,6 @@
     ReadFullTransferSchema,
     ReadTransferSchema,
     TransferPageSchema,
-    UpdateTransferSchema,
 )
 from syncmaster.schemas.v1.transfers.db import (
     HiveReadTransferSourceAndTarget,

syncmaster/schemas/v1/auth/basic.py

@@ -18,6 +18,9 @@ class ReadBasicAuthSchema(BasicAuthSchema):
     user: str
 
 
-class UpdateBasicAuthSchema(BasicAuthSchema):
-    user: str | None = None  # noqa: F722
+class UpdateBasicAuthSchema(CreateBasicAuthSchema):
     password: SecretStr | None = None
+
+    @property
+    def secret_field(self) -> str:
+        return "password"

syncmaster/schemas/v1/auth/s3.py

@@ -18,6 +18,9 @@ class ReadS3AuthSchema(S3AuthSchema):
     access_key: str
 
 
-class UpdateS3AuthSchema(S3AuthSchema):
-    access_key: str | None = None
+class UpdateS3AuthSchema(CreateS3AuthSchema):
     secret_key: SecretStr | None = None
+
+    @property
+    def secret_field(self) -> str:
+        return "secret_key"

syncmaster/schemas/v1/auth/samba.py

@@ -20,7 +20,9 @@ class ReadSambaAuthSchema(SambaAuthSchema):
     auth_type: Literal["NTLMv1", "NTLMv2"]
 
 
-class UpdateSambaAuthSchema(SambaAuthSchema):
-    user: str | None = None
+class UpdateSambaAuthSchema(CreateSambaAuthSchema):
     password: SecretStr | None = None
-    auth_type: Literal["NTLMv1", "NTLMv2"] | None = None
+
+    @property
+    def secret_field(self) -> str:
+        return "password"

syncmaster/schemas/v1/connections/clickhouse.py

@@ -5,13 +5,12 @@
 from syncmaster.schemas.v1.auth import (
     CreateBasicAuthSchema,
     ReadBasicAuthSchema,
-    UpdateBasicAuthSchema,
 )
+from syncmaster.schemas.v1.auth.basic import UpdateBasicAuthSchema
 from syncmaster.schemas.v1.connection_types import CLICKHOUSE_TYPE
 from syncmaster.schemas.v1.connections.connection_base import (
     CreateConnectionBaseSchema,
     ReadConnectionBaseSchema,
-    UpdateConnectionBaseSchema,
 )
 
 
@@ -29,13 +28,6 @@ class ReadClickhouseConnectionDataSchema(BaseModel):
     additional_params: dict = Field(default_factory=dict)
 
 
-class UpdateClickhouseConnectionDataSchema(BaseModel):
-    host: str | None = None
-    port: int | None = None
-    database_name: str | None = None
-    additional_params: dict | None = Field(default_factory=dict)
-
-
 class CreateClickhouseConnectionSchema(CreateConnectionBaseSchema):
     type: CLICKHOUSE_TYPE = Field(..., description="Connection type")
     data: CreateClickhouseConnectionDataSchema = Field(
@@ -56,7 +48,7 @@ class ReadClickhouseConnectionSchema(ReadConnectionBaseSchema):
     auth_data: ReadBasicAuthSchema | None = None
 
 
-class UpdateClickhouseConnectionSchema(UpdateConnectionBaseSchema):
-    type: CLICKHOUSE_TYPE
-    data: UpdateClickhouseConnectionDataSchema | None = Field(alias="connection_data", default=None)
-    auth_data: UpdateBasicAuthSchema | None = None
+class UpdateClickhouseConnectionSchema(CreateClickhouseConnectionSchema):
+    auth_data: UpdateBasicAuthSchema = Field(
+        description="Credentials for authorization",
+    )