-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/SK-1462 | Add Combiner DTO #832
Open
carl-andersson
wants to merge
2
commits into
feature/SK-1434
Choose a base branch
from
feature/SK-1462
base: feature/SK-1434
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
254 changes: 72 additions & 182 deletions
254
fedn/network/storage/statestore/stores/combiner_store.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,217 +1,107 @@ | ||
| from datetime import datetime | ||
| from typing import Any, Dict, List, Optional, Tuple | ||
| from abc import abstractmethod | ||
| from typing import Dict, List | ||
|
|
||
| import pymongo | ||
| from bson import ObjectId | ||
| from pymongo.database import Database | ||
| from sqlalchemy import String, func, or_, select | ||
| from sqlalchemy.orm import Mapped, mapped_column | ||
|
|
||
| from fedn.network.storage.statestore.stores.sql.shared import MyAbstractBase | ||
| from fedn.network.storage.statestore.stores.store import MongoDBStore, SQLStore, Store | ||
|
|
||
| from .shared import from_document | ||
|
|
||
|
|
||
| class Combiner: | ||
| def __init__( | ||
| self, | ||
| id: str, | ||
| name: str, | ||
| address: str, | ||
| certificate: str, | ||
| config: dict, | ||
| fqdn: str, | ||
| ip: str, | ||
| key: str, | ||
| parent: dict, | ||
| port: int, | ||
| status: str, | ||
| updated_at: str, | ||
| ): | ||
| self.id = id | ||
| self.name = name | ||
| self.address = address | ||
| self.certificate = certificate | ||
| self.config = config | ||
| self.fqdn = fqdn | ||
| self.ip = ip | ||
| self.key = key | ||
| self.parent = parent | ||
| self.port = port | ||
| self.status = status | ||
| self.updated_at = updated_at | ||
|
|
||
|
|
||
| class CombinerStore(Store[Combiner]): | ||
| pass | ||
|
|
||
|
|
||
| class MongoDBCombinerStore(MongoDBStore[Combiner]): | ||
| def __init__(self, database: Database, collection: str): | ||
| super().__init__(database, collection) | ||
|
|
||
| def get(self, id: str) -> Combiner: | ||
| """Get an entity by id | ||
| param id: The id of the entity | ||
| type: str | ||
| description: The id of the entity, can be either the id or the name (property) | ||
| return: The entity | ||
| """ | ||
| if ObjectId.is_valid(id): | ||
| id_obj = ObjectId(id) | ||
| document = self.database[self.collection].find_one({"_id": id_obj}) | ||
| else: | ||
| document = self.database[self.collection].find_one({"name": id}) | ||
|
|
||
| if document is None: | ||
| return None | ||
| from fedn.network.storage.statestore.stores.dto import CombinerDTO | ||
| from fedn.network.storage.statestore.stores.new_store import MongoDBStore, SQLStore, Store, from_document | ||
| from fedn.network.storage.statestore.stores.sql.shared import CombinerModel, from_orm_model | ||
|
|
||
| return from_document(document) | ||
|
|
||
| def update(self, id: str, item: Combiner) -> bool: | ||
| raise NotImplementedError("Update not implemented for CombinerStore") | ||
| class CombinerStore(Store[CombinerDTO]): | ||
| @abstractmethod | ||
| def get_by_name(name: str) -> CombinerDTO: | ||
| pass | ||
|
|
||
| def add(self, item: Combiner) -> Tuple[bool, Any]: | ||
| return super().add(item) | ||
|
|
||
| def delete(self, id: str) -> bool: | ||
| if ObjectId.is_valid(id): | ||
| kwargs = {"_id": ObjectId(id)} | ||
| else: | ||
| return False | ||
| class MongoDBCombinerStore(CombinerStore, MongoDBStore): | ||
| def __init__(self, database: Database, collection: str): | ||
| super().__init__(database, collection, "id") | ||
|
|
||
| document = self.database[self.collection].find_one(kwargs) | ||
| def get(self, id: str) -> CombinerDTO: | ||
| obj = self.mongo_get(id) | ||
| if obj is None: | ||
| return None | ||
| return self._dto_from_document(obj) | ||
|
|
||
| if document is None: | ||
| return False | ||
|
|
||
| return super().delete(document["_id"]) | ||
|
|
||
| def list(self, limit: int, skip: int, sort_key: str, sort_order=pymongo.DESCENDING, **kwargs) -> Dict[int, List[Combiner]]: | ||
| """List entities | ||
| param limit: The maximum number of entities to return | ||
| type: int | ||
| param skip: The number of entities to skip | ||
| type: int | ||
| param sort_key: The key to sort by | ||
| type: str | ||
| param sort_order: The order to sort by | ||
| type: pymongo.DESCENDING | pymongo.ASCENDING | ||
| param kwargs: Additional query parameters | ||
| type: dict | ||
| example: {"key": "models"} | ||
| return: A dictionary with the count and the result | ||
| """ | ||
| response = super().list(limit, skip, sort_key or "updated_at", sort_order, **kwargs) | ||
|
|
||
| return response | ||
| def update(self, item: CombinerDTO): | ||
| raise NotImplementedError("Update not implemented for CombinerStore") | ||
|
|
||
| def count(self, **kwargs) -> int: | ||
| return super().count(**kwargs) | ||
| def add(self, item: CombinerDTO): | ||
| item_dict = item.to_db(exclude_unset=False) | ||
| success, obj = self.mongo_add(item_dict) | ||
| if success: | ||
| return success, self._dto_from_document(obj) | ||
| return success, obj | ||
|
|
||
| def delete(self, id: str) -> bool: | ||
| return self.mongo_delete(id) | ||
|
|
||
| class CombinerModel(MyAbstractBase): | ||
| __tablename__ = "combiners" | ||
| def select(self, limit: int = 0, skip: int = 0, sort_key: str = None, sort_order=pymongo.DESCENDING, **filter_kwargs) -> List[CombinerDTO]: | ||
| entities = self.mongo_select(limit, skip, sort_key, sort_order, **filter_kwargs) | ||
| result = [] | ||
| for entity in entities: | ||
| result.append(self._dto_from_document(entity)) | ||
| return result | ||
|
|
||
| address: Mapped[str] = mapped_column(String(255)) | ||
| fqdn: Mapped[Optional[str]] = mapped_column(String(255)) | ||
| ip: Mapped[Optional[str]] = mapped_column(String(255)) | ||
| name: Mapped[str] = mapped_column(String(255)) | ||
| parent: Mapped[Optional[str]] = mapped_column(String(255)) | ||
| port: Mapped[int] | ||
| updated_at: Mapped[datetime] = mapped_column(default=datetime.now()) | ||
| def count(self, **kwargs) -> int: | ||
| return self.mongo_count(**kwargs) | ||
|
|
||
| def get_by_name(self, name: str) -> CombinerDTO: | ||
| document = self.database[self.collection].find_one({"name": name}) | ||
| if document is None: | ||
| return None | ||
| return self._dto_from_document(document) | ||
|
|
||
| def from_row(row: CombinerModel) -> Combiner: | ||
| return { | ||
| "id": row.id, | ||
| "committed_at": row.committed_at, | ||
| "address": row.address, | ||
| "ip": row.ip, | ||
| "name": row.name, | ||
| "parent": row.parent, | ||
| "fqdn": row.fqdn, | ||
| "port": row.port, | ||
| "updated_at": row.updated_at, | ||
| } | ||
| def _dto_from_document(self, document: Dict) -> CombinerDTO: | ||
| return CombinerDTO().populate_with(from_document(document)) | ||
|
|
||
|
|
||
| class SQLCombinerStore(CombinerStore, SQLStore[Combiner]): | ||
| class SQLCombinerStore(CombinerStore, SQLStore[CombinerDTO]): | ||
| def __init__(self, Session): | ||
| super().__init__(Session) | ||
| super().__init__(Session, CombinerModel) | ||
|
|
||
| def get(self, id: str) -> Combiner: | ||
| def get(self, id: str) -> CombinerDTO: | ||
| with self.Session() as session: | ||
| stmt = select(CombinerModel).where(or_(CombinerModel.id == id, CombinerModel.name == id)) | ||
| item = session.scalars(stmt).first() | ||
| if item is None: | ||
| entity = self.sql_get(session, id) | ||
| if entity is None: | ||
| return None | ||
| return from_row(item) | ||
| return self._dto_from_orm_model(entity) | ||
|
|
||
| def update(self, id, item): | ||
| def update(self, item): | ||
| raise NotImplementedError | ||
|
|
||
| def add(self, item): | ||
| with self.Session() as session: | ||
| entity = CombinerModel( | ||
| address=item["address"], | ||
| fqdn=item["fqdn"], | ||
| ip=item["ip"], | ||
| name=item["name"], | ||
| parent=item["parent"], | ||
| port=item["port"], | ||
| ) | ||
| session.add(entity) | ||
| session.commit() | ||
| return True, from_row(entity) | ||
| item_dict = item.to_db(exclude_unset=False) | ||
| item_dict = self._to_orm_dict(item_dict) | ||
| entity = CombinerModel(**item_dict) | ||
| success, obj = self.sql_add(session, entity) | ||
| if success: | ||
| return success, self._dto_from_orm_model(obj) | ||
| return success, obj | ||
|
|
||
| def delete(self, id: str) -> bool: | ||
| with self.Session() as session: | ||
| stmt = select(CombinerModel).where(CombinerModel.id == id) | ||
| item = session.scalars(stmt).first() | ||
| if item is None: | ||
| return False | ||
| session.delete(item) | ||
| return True | ||
|
|
||
| def list(self, limit: int, skip: int, sort_key: str, sort_order=pymongo.DESCENDING, **kwargs): | ||
| with self.Session() as session: | ||
| stmt = select(CombinerModel) | ||
|
|
||
| for key, value in kwargs.items(): | ||
| stmt = stmt.where(getattr(CombinerModel, key) == value) | ||
|
|
||
| _sort_order: str = "DESC" if sort_order == pymongo.DESCENDING else "ASC" | ||
| _sort_key: str = sort_key or "committed_at" | ||
|
|
||
| if _sort_key in CombinerModel.__table__.columns: | ||
| sort_obj = CombinerModel.__table__.columns.get(_sort_key) if _sort_order == "ASC" else CombinerModel.__table__.columns.get(_sort_key).desc() | ||
|
|
||
| stmt = stmt.order_by(sort_obj) | ||
|
|
||
| if limit: | ||
| stmt = stmt.offset(skip or 0).limit(limit) | ||
| elif skip: | ||
| stmt = stmt.offset(skip) | ||
| return self.sql_delete(id) | ||
|
|
||
| items = session.scalars(stmt).all() | ||
|
|
||
| result = [] | ||
| for i in items: | ||
| result.append(from_row(i)) | ||
|
|
||
| count = session.scalar(select(func.count()).select_from(CombinerModel)) | ||
|
|
||
| return {"count": count, "result": result} | ||
| def select(self, limit=0, skip=0, sort_key=None, sort_order=pymongo.DESCENDING, **kwargs): | ||
| with self.Session() as session: | ||
| entities = self.sql_select(session, limit, skip, sort_key, sort_order, **kwargs) | ||
| return [self._dto_from_orm_model(item) for item in entities] | ||
|
|
||
| def count(self, **kwargs): | ||
| with self.Session() as session: | ||
| stmt = select(func.count()).select_from(CombinerModel) | ||
| return self.sql_count(**kwargs) | ||
|
|
||
| for key, value in kwargs.items(): | ||
| stmt = stmt.where(getattr(CombinerModel, key) == value) | ||
| def get_by_name(self, name: str) -> CombinerDTO: | ||
| with self.Session() as session: | ||
| entity = session.query(CombinerModel).filter(CombinerModel.name == name).first() | ||
| if entity is None: | ||
| return None | ||
| return self._dto_from_orm_model(entity) | ||
|
|
||
| count = session.scalar(stmt) | ||
| def _to_orm_dict(self, item_dict: Dict) -> Dict: | ||
| return item_dict | ||
|
|
||
| return count | ||
| def _dto_from_orm_model(self, item: CombinerModel) -> CombinerDTO: | ||
| return CombinerDTO().populate_with(from_orm_model(item, CombinerModel)) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing the get_by_name method? Is this solved in another way? If so great, we should remove get_by_name from the interface...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be there? It is a new method, so added it to both mongo and sql. I believe it is required but could be discussed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! Yes, I think in the future we can think of removing it... Name should not be used as key I think...