Repository Integration Plan

Overview

Integrate the repository pattern across all services in the nemesis codebase. Currently, repositories exist but are unused (0% integration). Services make direct ORM calls which should be routed through repositories.

Current State

• Existing Repositories: UserRepository, CompanyRepository, CompanyEmployeeRepository, EmployeeContractRepository, EmployeeDetailRepository, DocumentRepository, DocumentLinkRepository, DocumentTypeRepository
• Current Usage: 0% - No service uses any repository
• Direct ORM calls: 60+ model queries across 9 services

Architecture

Views → Services → Repositories → Models (ORM)

Phase 1: Create Missing Repositories

1.1 Contractor Repository (repositories/contractor_repository.py)

# Models: ContractorContract, ContractorInvite, ContractorDetail, CompanyContractor

1.2 Holiday Repository (repositories/holiday_repository.py)

# Models: CompanyHoliday, CompanyFloatingHoliday, FixedHoliday, FloatingHoliday

1.3 Leave Repository (repositories/leave_repository.py)

# Models: CompanyLeaveType, EmployeeLeaveType, LeaveRequest, CompanyLeavePolicy

1.4 Expense Repository (repositories/expense_repository.py)

# Models: CompanyExpenseType, ExpenseRequest, CompanyExpensePolicy

1.5 EKYC Repository (repositories/ekyc_repository.py)

# Models: KYCVerificationDetail, FaceMatchDetail

1.6 Commons Repository (repositories/commons_repository.py)

# Models: BankAccount, EmergencyContact, Address, Organization

1.7 Employee Extended Repository (add to existing employee_repository.py)

# Add: EmployeeSalaryStructureRepository, EmployeeInviteRepository

1.8 Company Extended Repository (add to existing company_repository.py)

# Add: BonusPolicyRepository, ProbationAndNoticePeriodRepository,
#      CompanyBGVPlanRepository, CompanyWelcomeKitPlanRepository,
#      CompanyHealthInsurancePlanRepository, CompanySettingVisitRepository,
#      CompanyEmployerRepository, OrganizationRepository

1.9 Signature Repository (repositories/signature_repository.py)

# Models: SignatureRequest

Phase 2: Update repositories/__init__.py

Export all repositories for easy imports:

from .base_repository import BaseRepository
from .user_repository import UserRepository
from .company_repository import (
    CompanyRepository, CompanyEmployeeRepository, CompanyEmployerRepository,
    BonusPolicyRepository, ...
)
from .employee_repository import (
    EmployeeContractRepository, EmployeeDetailRepository,
    EmployeeSalaryStructureRepository, EmployeeInviteRepository
)
# ... all other repositories

Phase 3: Integrate Repositories into Services

3.1 employee_service.py

Replace direct ORM with:

• EmployeeContractRepository for EmployeeContract queries
• EmployeeDetailRepository for EmployeeDetail queries
• EmployeeSalaryStructureRepository for salary structure
• EmployeeInviteRepository for invites
• BankAccountRepository for bank details
• EmergencyContactRepository for emergency contacts
• CompanyEmployeeRepository for CompanyEmployee

Changes:

class EmployeeService(BaseService):
    def __init__(self):
        super().__init__()
        self.contract_repo = EmployeeContractRepository()
        self.detail_repo = EmployeeDetailRepository()
        self.salary_repo = EmployeeSalaryStructureRepository()
        self.invite_repo = EmployeeInviteRepository()
        self.bank_repo = BankAccountRepository()
        self.emergency_repo = EmergencyContactRepository()
        self.company_employee_repo = CompanyEmployeeRepository()

3.2 company_service.py

Replace direct ORM with:

• CompanyRepository
• CompanyEmployeeRepository
• CompanyEmployerRepository
• BonusPolicyRepository
• ProbationAndNoticePeriodRepository
• CompanyHolidayRepository
• CompanyFloatingHolidayRepository
• CompanyBGVPlanRepository
• CompanyWelcomeKitPlanRepository
• CompanyHealthInsurancePlanRepository

3.3 contractor_service.py

Replace direct ORM with:

• ContractorContractRepository
• ContractorInviteRepository
• ContractorDetailRepository
• CompanyContractorRepository

3.4 user_service.py

Replace direct ORM with:

• UserRepository
• EmployeeContractRepository
• CompanyEmployeeRepository
• CompanyEmployerRepository
• ContractorContractRepository
• CompanyContractorRepository
• DocumentRepository
• FaceMatchDetailRepository

3.5 holiday_service.py

Replace direct ORM with:

• CompanyHolidayRepository
• CompanyFloatingHolidayRepository
• CompanyRepository
• CompanySettingVisitRepository

3.6 leave_service.py

Replace direct ORM with:

• EmployeeLeaveTypeRepository
• CompanyLeaveTypeRepository
• CompanySettingVisitRepository

3.7 expense_service.py

Replace direct ORM with:

• CompanyExpenseTypeRepository

3.8 document_service.py

Replace direct ORM with:

• DocumentRepository
• DocumentLinkRepository
• EmployeeDetailRepository

3.9 ekyc_service.py

Replace direct ORM with:

• KYCVerificationDetailRepository
• FaceMatchDetailRepository
• BankAccountRepository
• EmployeeDetailRepository
• DocumentRepository
• CompanyEmployeeRepository

Phase 4: Files to Create/Modify

New Files (6):

1. repositories/contractor_repository.py
2. repositories/holiday_repository.py
3. repositories/leave_repository.py
4. repositories/expense_repository.py
5. repositories/ekyc_repository.py
6. repositories/commons_repository.py
7. repositories/signature_repository.py

Modified Files (12):

1. repositories/__init__.py - Export all repos
2. repositories/employee_repository.py - Add salary/invite repos
3. repositories/company_repository.py - Add plan/policy repos
4. services/employee_service.py - Use repositories
5. services/company_service.py - Use repositories
6. services/contractor_service.py - Use repositories
7. services/user_service.py - Use repositories
8. services/holiday_service.py - Use repositories
9. services/leave_service.py - Use repositories
10. services/expense_service.py - Use repositories
11. services/document_service.py - Use repositories
12. services/ekyc_service.py - Use repositories

Phase 5: Implementation Order

1. Create all new repository files (Phase 1) - No dependencies
2. Update existing repository files - Add missing model repositories
3. Update repositories/__init__.py - Export everything
4. Update services one by one (easiest to hardest):
   • expense_service.py (1 model)
   • holiday_service.py (4 models)
   • leave_service.py (3 models)
   • document_service.py (5 models)
   • contractor_service.py (4 models)
   • user_service.py (10 models)
   • ekyc_service.py (6 models)
   • employee_service.py (9 models)
   • company_service.py (18 models) - Most complex

Verification

After implementation:

1. Run existing tests: python manage.py test
2. Manual API testing of key endpoints:
   • GET /api/v1/users/details/ - User context
   • GET /api/v1/companies/<id>/employees/ - Employee list
   • GET /api/v1/companies/<id>/dashboard/team_info/ - Dashboard
   • POST /api/v1/companies/<id>/employee_contracts/ - Create contract
3. Check for import errors: python manage.py check

Notes

• No API changes: URLs and response structures remain identical
• Backward compatible: Services still return same data types
• Transaction safety: Repositories use same transaction context as services
• Performance: Repositories include select_related optimizations in get_queryset()