Search Filters when Fetching Entities using the Aggregate to Avoid Manual Filtering

[abhirathmahipal]

Search filters when fetching entities using the aggregate to avoid having to write loops (manually filter) or directly using dao of the entity.

Relevant Links

• Backpopulates
• An Example with Filter

Let's take a simple example of Entry and Members. To get the list of active members, I'm forced to write a repo method.

Simple Example

@domain.aggregate
class Entry:
    members = HasMany(Members)


# partial repo code
@classmethod
 def fetch_members_of_entry(cls, entry_id):
     return current_domain.get_dao(Member).find_by(entry_id=entry_id, is_archived=True)

I could do something like entry.members to get all the members. This is not expressive enough in my opinion.

I suggest something in lines of
We already have methods like add_, remove_ which get created dynamically for every reference. Why not create another method called get_{reference_name}?

Proposed Solution

entry = entry_repo.get("a27bf445-1403-468e-a5bf-f1f2a9631b8b")
entry.get_members(is_archived=True)

A More Involved Example Showcasing the Problem

 @classmethod
    def fetch_pca_finalists(cls, competition_id):
        award_dao = current_domain.get_dao(Award)
        award = award_dao.find_by(
            competition_id=competition_id, default_peoples_choice_award=True
        )
        finalist_pca_award = next(
            (
                award_type
                for award_type in award.award_types
                if award_type.award_type == AwardPosition.FINALIST.value
            ),
            None,
        )
        result = []
        if finalist_pca_award:
            for awarded_entry in award.awarded_entries:
                if awarded_entry.award_type_id == finalist_pca_award.id:
                    result.append(awarded_entry.entry)

        return award, result