mirror of
https://github.com/SamyRai/tercul-backend.git
synced 2025-12-27 05:11:34 +00:00
781b313bf1
This commit addresses all the high-priority tasks outlined in the TASKS.md file, significantly improving the application's observability, completing key features, and refactoring critical parts of the codebase. ### Observability - **Centralized Logging:** Implemented a new structured, context-aware logging system using `zerolog`. A new logging middleware injects request-specific information (request ID, user ID, trace ID) into the logger, and all application logging has been refactored to use this new system. - **Prometheus Metrics:** Added Prometheus metrics for database query performance by creating a GORM plugin that automatically records query latency and totals. - **OpenTelemetry Tracing:** Fully instrumented all application services in `internal/app` and data repositories in `internal/data/sql` with OpenTelemetry tracing, providing deep visibility into application performance. ### Features - **Analytics:** Implemented like, comment, and bookmark counting. The respective command handlers now call the analytics service to increment counters when these actions are performed. - **Enrichment Tool:** Built a new, extensible `enrich` command-line tool to fetch data from external sources. The initial implementation enriches author data using the Open Library API. ### Refactoring & Fixes - **Decoupled Testing:** Refactored the testing utilities in `internal/testutil` to be database-agnostic, promoting the use of mock-based unit tests and improving test speed and reliability. - **Build Fixes:** Resolved numerous build errors, including a critical import cycle between the logging, observability, and authentication packages. - **Search Service:** Fixed the search service integration by implementing the `GetWorkContent` method in the localization service, allowing the search indexer to correctly fetch and index work content.
52 lines
1.2 KiB
Go
52 lines
1.2 KiB
Go
package testutil
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
// BaseSuite is a base test suite with common functionality for tests.
|
|
// It is designed for unit and mock-based integration tests and does not
|
|
// handle database connections.
|
|
type BaseSuite struct {
|
|
suite.Suite
|
|
}
|
|
|
|
// SetupSuite can be overridden by specific test suites for setup.
|
|
func (s *BaseSuite) SetupSuite() {
|
|
// No-op by default.
|
|
}
|
|
|
|
// TearDownSuite can be overridden by specific test suites for teardown.
|
|
func (s *BaseSuite) TearDownSuite() {
|
|
// No-op by default.
|
|
}
|
|
|
|
// SetupTest can be overridden by specific test suites for per-test setup.
|
|
func (s *BaseSuite) SetupTest() {
|
|
// No-op by default.
|
|
}
|
|
|
|
// TearDownTest can be overridden by specific test suites for per-test teardown.
|
|
func (s *BaseSuite) TearDownTest() {
|
|
// No-op by default.
|
|
}
|
|
|
|
// getEnv gets an environment variable or returns a default value.
|
|
// This is kept as a general utility function.
|
|
func getEnv(key, defaultValue string) string {
|
|
value, exists := os.LookupEnv(key)
|
|
if !exists {
|
|
return defaultValue
|
|
}
|
|
return value
|
|
}
|
|
|
|
// SkipIfShort skips a test if the -short flag is provided.
|
|
func SkipIfShort(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("Skipping test in short mode")
|
|
}
|
|
} |