mukimovd/tercul-backend
1
0
Fork 0
mirror of https://github.com/SamyRai/tercul-backend.git synced 2025-12-27 05:11:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8ddc4a7986
tercul-backend/TODO.md
google-labs-jules[bot] 1c4dcbcf99 Refactor: Introduce service layer for application logic 
This change introduces a service layer to encapsulate the business logic
for each domain aggregate. This will make the code more modular,
testable, and easier to maintain.

The following services have been created:
- author
- bookmark
- category
- collection
- comment
- like
- tag
- translation
- user

The main Application struct has been updated to use these new services.
The integration test suite has also been updated to use the new
Application struct and services.

This is a work in progress. The next step is to fix the compilation
errors and then refactor the resolvers to use the new services.
2025-09-09 02:28:25 +00:00

5.7 KiB
Raw Blame History

TODO List for Tercul Go Application

Suggested Next Objectives

  • Complete the Architecture Refactor (High, 5d): Finalize the transition to a clean, domain-driven architecture. This will significantly improve maintainability, scalability, and developer velocity.
    • Ensure resolvers call application services only and add dataloaders per aggregate.
    • Adopt a migrations tool and move all SQL to migration files.
    • Implement full observability with centralized logging, metrics, and tracing.
  • Full Test Coverage (High, 5d): Increase test coverage across the application to ensure stability and prevent regressions.
    • Write unit tests for all models, repositories, and services.
    • Refactor existing tests to use mocks instead of a real database.
  • Implement Analytics Features (High, 3d): Add analytics to provide insights into user engagement and content popularity.
    • Implement view, like, comment, and bookmark counting.
    • Track translation analytics to identify popular translations.
  • Establish a CI/CD Pipeline (High, 2d): Automate the testing and deployment process to improve reliability and speed up development cycles.
    • Add make lint test test-integration to the CI pipeline.
    • Set up automated deployments to a staging environment.
  • Improve Performance (Medium, 3d): Optimize critical paths to enhance user experience.
    • Implement batching for Weaviate operations.
    • Add performance benchmarks for critical paths.

[ ] High Priority

[ ] Architecture Refactor (DDD-lite)

  • Refactor domains to be more testable and decoupled, with 100% unit test coverage and logging.
    • localization domain
    • auth domain
    • copyright domain
    • monetization domain
    • search domain
    • work domain
  • Resolvers call application services only; add dataloaders per aggregate (High, 3d)
  • Adopt migrations tool (goose/atlas/migrate); move SQL to internal/data/migrations; delete migrations.go (High, 2d)
  • Observability: centralize logging; add Prometheus metrics and OpenTelemetry tracing; request IDs (High, 3d)
  • CI: add make lint test test-integration and integration tests with Docker compose (High, 2d)

[x] Testing

  • Add unit tests for all models, repositories, and services (High, 3d)
  • Remove DB logic from BaseSuite for mock-based integration tests (High, 2d)

[ ] Features

  • Implement analytics data collection (High, 3d)
    • Implement view counting for works and translations
    • Implement like counting for works and translations
    • Implement comment counting for works
    • Implement bookmark counting for works
    • Implement translation counting for works
    • Implement translation analytics to show popular translations

[ ] Medium Priority

[ ] Performance Improvements

  • Implement batching for Weaviate operations (Medium, 2d)

[ ] Code Quality & Architecture

  • Expand Weaviate client to support all models (Medium, 2d)
  • Add code documentation and API docs (Medium, 2d)
  • Replace bespoke cached repositories with decorators in internal/data/cache (reads only; deterministic invalidation) (Medium, 2d)
  • Config: replace ad-hoc config with env parsing + validation (e.g., koanf/envconfig); no globals (Medium, 1d)

[ ] Testing

  • Add performance benchmarks for critical paths (Medium, 2d)
    • Add benchmarks for text analysis (sequential vs concurrent) and cache hit/miss rates

[ ] Monitoring & Logging

  • Add monitoring for background jobs and API endpoints (Medium, 2d)
    • Add metrics for linguistics: analysis duration, cache hit/miss, provider usage

[ ] Low Priority

[ ] Testing

  • Refactor RunTransactional to be mock-friendly (Low, 1d)

[ ] Completed

  • Add comprehensive input validation for all GraphQL mutations (High, 2d) - Partially complete. Core mutations are validated.
  • Create skeleton packages: cmd/, internal/platform/, internal/domain/, internal/app/, internal/data/, internal/adapters/graphql/, internal/jobs/
  • Move infra to internal/platform/* (config, db, cache, auth, http, log, search)
  • Wire DI in cmd/api/main.go and expose an Application facade to adapters
  • Unify GraphQL under internal/adapters/graphql and update gqlgen.yml; move schema.graphqls and resolvers
  • Introduce Unit-of-Work: platform/db.WithTx(ctx, func(ctx) error) and repo factory for *sql.DB / *sql.Tx
  • Split write vs read paths for work (commands.go, queries.go); make read models cacheable
  • Restructure models/* into domain aggregates with constructors and invariants
  • Security: move JWT/middleware to internal/platform/auth; add authz policy helpers (e.g., CanEditWork)
  • Search: move Weaviate client/schema to internal/platform/search, optional domain interface
  • Background jobs: move to cmd/worker and internal/jobs/*; ensure idempotency and lease
  • Python ops: move scripts to /ops/migration and /ops/analysis; keep outputs under /ops/migration/outputs/
  • Cleanup: delete dead packages (store, duplicate repositories); consolidate to internal/data/sql
  • Add integration tests for GraphQL API and background jobs (High, 3d) - Partially complete. Core mutations are tested.
  • Stabilize non-linguistics tests and interfaces (High, 2d)
    • Fix graph mocks to accept context in service interfaces
    • Update repositories tests (missing TestModel) and align with new repository interfaces
    • Update services tests to pass context and implement missing repo methods in mocks

TODO items include context, priority, and estimated effort. Update this list after each milestone.