docs: verify services by Harshal6927 · Pull Request #619 · litestar-org/advanced-alchemy

Harshal6927 · 2025-12-05T04:30:55Z

Verify service docs

cofin · 2025-12-06T19:28:05Z

docs/usage/services.rst

+        title: str | None = None
+        content: str | None = None
+        published: bool | None = None


You'll need to use Optional since we still need to show 3.9 support here.

cofin · 2025-12-06T19:29:28Z

docs/usage/services.rst

+            data = data_dict
+
+            post = await self.to_model(data, "create")


Suggested change

data = data_dict

post = await self.to_model(data, "create")

post = await self.to_model(data_dict, "create")

cofin · 2025-12-06T19:32:00Z

docs/usage/services.rst

        # Override update behavior to handle tags
        async def update(
            self,
            data: ModelDictT[Post],


We should probably make the override mirror the service spec properly so there's no linting issues on the copy/paste

cofin · 2025-12-06T19:33:58Z

docs/usage/services.rst

        async def update(
            self,
            data: ModelDictT[Post],
            item_id: Any | None = None,
-            **kwargs,
+            **kwargs: Any,
        ) -> Post:
            """Update a post with tags, if provided."""
-            tags_updated: list[str] = []
-            if isinstance(data, dict):
-                tags_updated.extend(data.pop("tags", None) or [])
-                data["id"] = item_id
-                data = await self.to_model(data, "update")
-                existing_tags = [tag.name for tag in data.tags]
-                tags_to_remove = [tag for tag in data.tags if tag.name not in tags_updated]
-                tags_to_add = [tag for tag in tags_updated if tag not in existing_tags]
+            data_dict = schema_dump(data)
+            tags_updated = data_dict.pop("tags", [])
+
+            # Determine the effective item_id - either from parameter or from the data itself
+            effective_item_id = item_id if item_id is not None else data_dict.get("id")
+
+            # Get existing post to access current tags
+            if effective_item_id is not None:
+                existing_post = await self.get(effective_item_id)
+                existing_tags = [tag.name for tag in existing_post.tags]
+            else:
+                existing_tags = []
+
+            post = await self.to_model(data_dict, "update")
+
+            if tags_updated:
+                tags_updated = [schema_dump(tag) for tag in tags_updated]
+                # Determine tags to remove and add
+                tags_to_remove = [tag for tag in post.tags if tag.name not in [t["name"] for t in tags_updated]]
+                tags_to_add = [tag for tag in tags_updated if tag["name"] not in existing_tags]
+
                for tag_rm in tags_to_remove:
-                    data.tags.remove(tag_rm)
-                data.tags.extend(
+                    post.tags.remove(tag_rm)
+
+                post.tags.extend(
                    [
-                        await Tag.as_unique_async(self.repository.session, name=tag_text, slug=slugify(tag_text))
-                        for tag_text in tags_to_add
+                        await Tag.as_unique_async(self.repository.session, name=tag["name"], slug=slugify(tag["name"]))
+                        for tag in tags_to_add
                    ],
                )
-            return await super().update(
-                data=data,
-                item_id=item_id,
-                **kwargs,
-            )


This needs to be remove or modified to mirror exactly how the TeamService works in fullstack. Here's the service for reference:

class TeamService(service.SQLAlchemyAsyncRepositoryService[m.Team]): """Team Service.""" class Repo(repository.SQLAlchemyAsyncSlugRepository[m.Team]): """Team Repository.""" model_type = m.Team repository_type = Repo match_fields = ["name"] async def to_model_on_create(self, data: ModelDictT[m.Team]) -> ModelDictT[m.Team]: data = service.schema_dump(data) data = await self._populate_slug(data) return await self._populate_with_owner_and_tags(data, "create") async def to_model_on_update(self, data: ModelDictT[m.Team]) -> ModelDictT[m.Team]: data = service.schema_dump(data) data = await self._populate_slug(data) return await self._populate_with_owner_and_tags(data, "update") async def to_model_on_upsert(self, data: ModelDictT[m.Team]) -> ModelDictT[m.Team]: data = service.schema_dump(data) data = await self._populate_slug(data) return await self._populate_with_owner_and_tags(data, "upsert") @staticmethod def can_view_all(user: m.User) -> bool: return bool( user.is_superuser or any( assigned_role.role.name for assigned_role in user.roles if assigned_role.role.name == constants.SUPERUSER_ACCESS_ROLE ), ) async def _populate_slug(self, data: ModelDictT[m.Team]) -> ModelDictT[m.Team]: if service.is_dict_without_field(data, "slug") and service.is_dict_with_field(data, "name"): data["slug"] = await self.repository.get_available_slug(data["name"]) return data async def _populate_with_owner_and_tags( self, data: ModelDictT[m.Team], operation: str | None, ) -> ModelDictT[m.Team]: if service.is_dict(data): owner_id: UUID | None = data.pop("owner_id", None) owner: m.User | None = data.pop("owner", None) input_tags: list[str] = data.pop("tags", []) data["id"] = data.get("id", uuid4()) data = await super().to_model(data) if input_tags: existing_tags = [tag.name for tag in data.tags] tags_to_remove = [tag for tag in data.tags if tag.name not in input_tags] tags_to_add = [tag for tag in input_tags if tag not in existing_tags] for tag_rm in tags_to_remove: data.tags.remove(tag_rm) data.tags.extend( [ await m.Tag.as_unique_async(self.repository.session, name=tag_text, slug=slugify(tag_text)) for tag_text in tags_to_add ], ) if owner or owner_id: for member in data.members: if member.user_id == owner.id if owner is not None else owner_id and not member.is_owner: member.is_owner = True member.role = m.TeamRoles.ADMIN break else: owner_data: dict[str, Any] = {"user": owner} if owner else {"user_id": owner_id} data.members.append(m.TeamMember(**owner_data, role=m.TeamRoles.ADMIN, is_owner=True)) return data

cofin · 2025-12-06T19:35:19Z

docs/usage/services.rst

        async def publish_post(
            self,
            post_id: int,
            publish: bool = True,
        ) -> PostResponse:
-            """Publish or unpublish a post with timestamp."""
-            data = PostUpdate(
-                published=publish,
-                published_at=datetime.datetime.utcnow() if publish else None,
-            )
-            post = await self.repository.update(
+            """Publish or unpublish a post."""
+            post = await self.update(
                item_id=post_id,
-                data=data,
+                data={"published": publish},
                auto_commit=True,
            )
            return self.to_schema(post, schema_type=PostResponse)


What do we want to demonstrate here exactly? this looks like all the default behavior you can do out of the box.

We should consider removing it to reduce confusion if there's nothing new.

docs/usage/services.rst

cofin · 2025-12-06T19:38:15Z

docs/usage/services.rst

+    post_data = post_service.to_schema(rows[0][0], schema_type=PostSchema)
+    posts_list = post_service.to_schema([row[0] for row in rows], schema_type=PostSchema)


I'm not sure 2 level of arrays is the best thing to demo here.

sonarqubecloud · 2025-12-24T02:19:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

cofin

It looks ok other than the type hint for Optional

docs/usage/services.rst

Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Signed-off-by: Harshal Laheri <73422191+Harshal6927@users.noreply.github.com>

cofin · 2026-01-24T20:38:12Z

docs/usage/services.rst

+        content: str
+        published: bool

        model_config = {"from_attributes": True}


I don't think you need this any more - you can double check and remove if so.

Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Signed-off-by: Harshal Laheri <73422191+Harshal6927@users.noreply.github.com>

cofin · 2026-01-24T20:39:51Z

docs/usage/services.rst

+    result = await db_session.execute(select(Post))
+    posts = result.scalars().all()  # Returns list of Post models
+    posts_list = post_service.to_schema(posts, schema_type=PostSchema)


What's the intent here? I think we should use the service here instead of showing "raw" sqlalchemy

cofin · 2026-01-24T20:40:08Z

docs/usage/services.rst

+    result = await db_session.execute(select(Post))
+    row_mapping = result.mappings().first()
+    mapping_data = post_service.to_schema(row_mapping["Post"], schema_type=PostSchema)


codecov-commenter · 2026-01-24T20:48:06Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.05%. Comparing base (ebc1c2a) to head (97b5d7f).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #619      +/-   ##
==========================================
- Coverage   79.06%   79.05%   -0.02%     
==========================================
  Files          99       99              
  Lines        7915     7915              
  Branches     1073     1073              
==========================================
- Hits         6258     6257       -1     
  Misses       1315     1315              
- Partials      342      343       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sonarqubecloud · 2026-01-24T20:48:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

docs: verify services

76d8d7d

Harshal6927 requested review from a team as code owners December 5, 2025 04:30

Merge branch 'main' into docs-services

413a388

github-actions bot added area/docs size: small type/docs pr/external Triage Required 🏥 labels Dec 5, 2025

Harshal6927 added 2 commits December 4, 2025 23:33

docs: verify services

b0db643

docs: verify services

76fbeae

cofin reviewed Dec 6, 2025

View reviewed changes

docs/usage/services.rst Show resolved Hide resolved

cofin reviewed Dec 6, 2025

View reviewed changes

Harshal6927 and others added 2 commits December 21, 2025 13:12

Merge branch 'main' into docs-services

1c70ba2

docs: verify services

947994c

cofin requested changes Jan 17, 2026

View reviewed changes

Merge branch 'main' into docs-services

a5f4f50