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
c2e9a118e2
tercul-backend/internal/app/work
History
google-labs-jules[bot] c2e9a118e2 feat(testing): Increase test coverage and fix authz bugs 
This commit significantly increases the test coverage across the application and fixes several underlying bugs that were discovered while writing the new tests.

The key changes include:

- **New Tests:** Added extensive integration and unit tests for GraphQL resolvers, application services, and data repositories, substantially increasing the test coverage for packages like `graphql`, `user`, `translation`, and `analytics`.

- **Authorization Bug Fixes:**
  - Fixed a critical bug where a user creating a `Work` was not correctly associated as its author, causing subsequent permission failures.
  - Corrected the authorization logic in `authz.Service` to properly check for entity ownership by non-admin users.

- **Test Refactoring:**
  - Refactored numerous test suites to use `testify/mock` instead of manual mocks, improving test clarity and maintainability.
  - Isolated integration tests by creating a fresh admin user and token for each test run, eliminating test pollution.
  - Centralized domain errors into `internal/domain/errors.go` and updated repositories to use them, making error handling more consistent.

- **Code Quality Improvements:**
  - Replaced manual mock implementations with `testify/mock` for better consistency.
  - Cleaned up redundant and outdated test files.

These changes stabilize the test suite, improve the overall quality of the codebase, and move the project closer to the goal of 80% test coverage.
2025-10-09 07:03:45 +00:00
..
.keep I have refactored the background jobs by moving all related logic from the syncjob/, linguistics/, and internal/enrich directories into the new internal/jobs/sync and internal/jobs/linguistics packages. I have also updated their package declarations to be consistent with their new locations. 2025-09-02 15:02:04 +00:00
commands.go feat(testing): Increase test coverage and fix authz bugs 2025-10-09 07:03:45 +00:00
dto.go This commit introduces a series of significant improvements to bring the codebase closer to a production-ready state. 2025-10-08 17:25:02 +00:00
main_test.go feat(testing): Increase test coverage and fix authz bugs 2025-10-09 07:03:45 +00:00
mock_analytics_service_test.go feat(testing): Increase test coverage and fix authz bugs 2025-10-09 07:03:45 +00:00
queries_test.go feat(testing): Increase test coverage and fix authz bugs 2025-10-09 07:03:45 +00:00
queries.go This commit introduces a series of significant improvements to bring the codebase closer to a production-ready state. 2025-10-08 17:25:02 +00:00
README.md This commit introduces a series of significant improvements to bring the codebase closer to a production-ready state. 2025-10-08 17:25:02 +00:00
service.go feat(testing): Increase test coverage and fix authz bugs 2025-10-09 07:03:45 +00:00

README.md

Work Service

This package manages the core Work domain entity in the Tercul platform. It provides the primary application service for all operations related to literary works, including creating, updating, deleting, and retrieving them.

Architecture Overview

The work service is designed following the Command Query Responsibility Segregation (CQRS) pattern. This separation makes the service more maintainable, scalable, and easier to understand.

Key Components

  • service.go: The main entry point for the work service. It composes the WorkCommands and WorkQueries into a single Service struct, which is then used by the rest of the application (e.g., in the GraphQL resolvers).

  • commands.go: Contains all the command handlers for mutating Work entities. This includes:

    • CreateWork: Creates a new work.
    • UpdateWork: Updates an existing work.
    • DeleteWork: Deletes a work.
    • AnalyzeWork: Triggers a comprehensive linguistic analysis of a work and its translations.
    • MergeWork: Merges two works into one, consolidating their translations and statistics.

  • queries.go: Contains all the query handlers for retrieving Work data. These handlers return specialized WorkDTO read models to ensure a clean separation between the domain and the API layer.

  • dto.go: Defines the WorkDTO struct, which is the read model used for all query responses.

  • interfaces.go (external): The service depends on the WorkRepository interface defined in internal/domain/interfaces.go for data persistence.

Usage

The work.Service is intended to be injected into the application's top-level layers, such as the GraphQL resolvers, which then call the appropriate command or query handlers.

Example: Creating a Work

// In a GraphQL resolver
work, err := workService.Commands.CreateWork(ctx, &domain.Work{...})

Example: Retrieving a Work

// In a GraphQL resolver
workDTO, err := workService.Queries.GetWorkByID(ctx, workID)

Dependencies

  • internal/domain: Uses and returns the core Work domain entity and the WorkDTO read model.
  • internal/app/authz: Relies on the authorization service to perform permission checks before executing commands like UpdateWork and DeleteWork.
  • internal/app/analytics: The AnalyzeWork command calls the analytics service to perform and store linguistic analysis.
  • internal/domain/search: Uses the SearchClient interface to index works in the search engine after they are created or updated.
  • Database: Persists all Work data via the WorkRepository.
  • Logging: Uses the centralized logger from internal/platform/log.
  • OpenTelemetry: All command and query methods are instrumented for distributed tracing.