Feat: Complete Snippet Module Implementation, Integration Tests & API Docs - #32
Merged
MathCunha16 merged 3 commits intoAug 4, 2026
Merged
Conversation
…stments - Implement `SnippetUseCase` for Create, Read, Update, and Delete operations. - Add unit tests for Snippet use case. - Modify repository to support project-scoped Snippet operations with `FindByIDAndProjectID` and `DeleteByIDAndProjectID`. - Refactor auxiliary functions to ensure project existence.
…tion - Implement SnippetHandler for Create, Read, Update, and Delete endpoints. - Add integration tests for SnippetHandler. - Extend OpenAPI documentation to include Snippet operations. - Introduce `ExtractUUIDParam` helper for parameter validation.
MathCunha16
added
documentation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
backend-go/internal/adapter/in/web/handler/snippet_handler_test.go (2)
274-278: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winConfirme a exclusão persistida.
Este caso valida somente
204. Uma implementação que responda com sucesso sem remover o registro também passa. Após o DELETE, consulte a mesma URL e espere404.Teste proposto
resp := app.DoRequest(t, http.MethodDelete, urlDelete, nil, true) assert.Equal(t, http.StatusNoContent, resp.StatusCode) + + resp = app.DoRequest(t, http.MethodGet, urlDelete, nil, true) + assert.Equal(t, http.StatusNotFound, resp.StatusCode)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@backend-go/internal/adapter/in/web/handler/snippet_handler_test.go` around lines 274 - 278, Extend the “Delete success” test to verify persistence: after asserting the DELETE response is 204, issue a GET request to the same urlDelete and assert it returns http.StatusNotFound, confirming the snippet was actually removed.
167-177: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winTeste o conteúdo e o escopo da página.
Os dois casos de sucesso usam um projeto sem snippets e validam somente
200. Uma implementação que ignorepage,sizeouprojectIDe retorne uma página vazia fixa passa nesses testes. Crie snippets em dois projetos, use mais itens quesizee validecontent,number,size,totalElements,totalPagese o isolamento dos IDs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@backend-go/internal/adapter/in/web/handler/snippet_handler_test.go` around lines 167 - 177, The "GetAll success - default pagination" and "GetAll success - custom page and size" test cases only validate the HTTP status code without checking the response body structure or pagination behavior. Update both test cases to create snippets across multiple projects with counts exceeding the page size, then assert on the response body fields: content (to verify correct items returned), number (page index), size (items per page), totalElements (total snippet count), and totalPages, ensuring results are isolated to the requested project. Replace the single assert.Equal call with comprehensive body validation that confirms pagination parameters are respected and project isolation is maintained.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@backend-go/docs/openapi.yaml`:
- Around line 161-164: Corrija a semântica de nulidade no schema OpenAPI: alinhe
`SnippetLanguage` com a obrigatoriedade de `CreateSnippetCommand.language`,
removendo `nullable: true` ou retirando o campo de `required`. Em
`UpdateSnippetCommand`, implemente `UnmarshalJSON` customizado para preservar a
distinção entre campo omitido, explicitamente nulo e presente para `language` e
os campos nullable, garantindo que a atualização explícita para `null` seja
aplicada.
In `@backend-go/internal/adapter/in/web/handler/snippet_handler.go`:
- Around line 35-42: In the snippet_handler error handling blocks, replace the
generic 400 fallback responses with proper error categorization. Keep the
specific error checks like errors.Is for usecase.ErrProjectNotFound mapping to
404, but update the remaining catch-all error path to log the actual error
details server-side and return HTTP 500 with a stable generic error message to
the client instead of exposing err.Error(). Apply this same pattern consistently
across all affected handler methods (including those around lines 65-73, 92-98,
134-146, and 165-167), and update the OpenAPI specification to document the 500
error response for these endpoints.
- Around line 164-167: Atualize o tratamento de erro no handler do DELETE após a
chamada a SnippetUseCase.Delete: mapeie usecase.ErrProjectNotFound para
http.StatusNotFound antes do fallback de BadRequest. Aplique o mesmo mapeamento
404 quando o erro for usecase.ErrSnippetNotFound, preservando 400 para os demais
erros.
In `@backend-go/internal/domain/port/snippet_repository.go`:
- Line 14: Atualize o contrato DeleteByIDAndProjectID em
backend-go/internal/domain/port/snippet_repository.go:14-14 para retornar
deleted bool além do erro; em
backend-go/internal/adapter/out/persistence/snippet_repository.go:57-59, use
RowsAffected para indicar se alguma linha foi removida. Em
backend-go/internal/usecase/snippet_usecase.go:120-125, converta deleted ==
false em ErrSnippetNotFound. Ajuste o mock em
backend-go/internal/usecase/snippet_usecase_test.go:40-43 e cubra, em :297-331,
a exclusão de snippet inexistente esperando ErrSnippetNotFound.
In `@backend-go/internal/usecase/snippet_usecase.go`:
- Around line 70-79: Valide a existência do projeto antes de buscar o snippet em
SnippetUseCase.GetByID, chamando ensureProjectExists antes de
FindByIDAndProjectID para propagar ErrProjectNotFound. Em
backend-go/internal/usecase/snippet_usecase.go:70-79 aplique a alteração; em
backend-go/internal/usecase/snippet_usecase_test.go:122-163 configure ExistsByID
nos testes existentes e adicione um caso para projeto inexistente que espere
ErrProjectNotFound.
---
Nitpick comments:
In `@backend-go/internal/adapter/in/web/handler/snippet_handler_test.go`:
- Around line 274-278: Extend the “Delete success” test to verify persistence:
after asserting the DELETE response is 204, issue a GET request to the same
urlDelete and assert it returns http.StatusNotFound, confirming the snippet was
actually removed.
- Around line 167-177: The "GetAll success - default pagination" and "GetAll
success - custom page and size" test cases only validate the HTTP status code
without checking the response body structure or pagination behavior. Update both
test cases to create snippets across multiple projects with counts exceeding the
page size, then assert on the response body fields: content (to verify correct
items returned), number (page index), size (items per page), totalElements
(total snippet count), and totalPages, ensuring results are isolated to the
requested project. Replace the single assert.Equal call with comprehensive body
validation that confirms pagination parameters are respected and project
isolation is maintained.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: dfb51ab4-361f-45ef-b9e0-97f6b226cc8d
📒 Files selected for processing (13)
backend-go/cmd/api/main.gobackend-go/docs/openapi.yamlbackend-go/internal/adapter/in/web/common/params.gobackend-go/internal/adapter/in/web/handler/project_handler.gobackend-go/internal/adapter/in/web/handler/snippet_handler.gobackend-go/internal/adapter/in/web/handler/snippet_handler_test.gobackend-go/internal/adapter/in/web/handler/test_helper_test.gobackend-go/internal/adapter/in/web/router.gobackend-go/internal/adapter/out/persistence/snippet_repository.gobackend-go/internal/domain/port/snippet_repository.gobackend-go/internal/usecase/project_usecase.gobackend-go/internal/usecase/snippet_usecase.gobackend-go/internal/usecase/snippet_usecase_test.go
…tions - Enhance error responses in ProjectHandler and SnippetHandler with proper status codes and logging. - Modify repository delete methods to return success status and adjust use cases accordingly. - Update integration and unit tests to validate deletion behavior and persistence. - Extend OpenAPI documentation with 500 error responses and specific error scenarios for delete endpoints.
MathCunha16
merged commit Aug 4, 2026
786bdfd
into
feature/backend/refactor-to-golang
1 check passed
MathCunha16
added a commit
that referenced
this pull request
Aug 14, 2026
…dules (#40) * feat: integrate Tauri framework with initial splash screen, IPC commands, and automatic version synchronization script * refactor: migrate to Tauri-based packaging by bundling the backend JAR and removing legacy Java desktop components. * feat(backend-go): setup initial sql migrations and domain models" -m "- Initialize Go module (go.mod, go.sum) and project structure - Add 9 SQL database migrations mirroring Java Liquibase changesets - Add domain entity models (BaseEntity, AppSetting, Project, Snippet, Link, Problem, Note, Credential, Tag, ItemTag) - Add .gitignore for Go backend" * Feat: (GO) add repository interfaces and implement persistence layer (#30) * feat(backend-go): add repository interfaces for domain models * feat(backend-go): implement persistence layer and adapters for repositories * fix(backend-go): improve error handling and update repository method consistency - Handle `sql.ErrNoRows` in `FindByID` to return `nil` instead of error. - Standardize method naming (`ExistsById` → `ExistsByID`). - Simplify and optimize `NewPage` calculations. - Align `ItemTagRepository` methods with additional `projectID` parameter for consistency and data integrity. * Enhance backend API with project management features and documentation (#31) * feat(backend-go): add API entry point, project use case, and unit tests - Implement main.go as the entry point for the backend API - Add `ProjectUseCase` with CRUD, archive, and unarchive methods for projects - Write unit tests for the project use case with a mock repository - Update go.mod and go.sum with new dependencies for testing and validation * feat(backend-go): add project API with middleware, routing, and migrations - Extend `main.go` with server setup, project routing, and UUID token handling - Implement `ProjectHandler` for project creation and retrieval via Gin - Add CORS and auth middleware to secure and facilitate API requests - Update database migrations to use `DATETIME` for timestamps - Add validation to `CreateProjectCommand` - Update dependencies in `go.mod` and `go.sum` for API and middleware functionality * refactor(backend-go): reorganize project handler into separate package and enhance test coverage - Move `ProjectHandler` to `handler` package for better modularity - Add comprehensive test coverage for project handler, including success and failure cases - Introduce `GetAll`, `Update`, `Archive`, `Unarchive`, and `Delete` methods to `ProjectHandler` - Implement pagination support via `PaginationQuery` in `GetAll` - Adjust router and test helper to reflect structural changes * feat(backend-go): add OpenAPI documentation hosting and API reference routes - Introduce `/docs` and `/openapi.yaml` routes for hosting API documentation - Implement `registerDocsRoutes` function to serve documentation in development environment - Add dependency `go-scalar-api-reference` for generating interactive API reference - Include OpenAPI YAML specification for Devaulty API * feat(backend-go): enhance error handling, validation, and CORS middleware - Add detailed error handling in project APIs for "not found" and invalid states - Update pagination validation with binding rules for `PageNumber` and `PageSize` - Improve CORS middleware with restricted allowed origins list - Replace direct string comparisons with constant-time comparison in auth middleware - Extend OpenAPI specification with validation, error responses, and pagination constraints - Enhance test coverage for new validation and error scenarios * Feat: Complete Snippet Module Implementation, Integration Tests & API Docs (#32) * feat(backend-go): add Snippet use case with tests and repository adjustments - Implement `SnippetUseCase` for Create, Read, Update, and Delete operations. - Add unit tests for Snippet use case. - Modify repository to support project-scoped Snippet operations with `FindByIDAndProjectID` and `DeleteByIDAndProjectID`. - Refactor auxiliary functions to ensure project existence. * feat(backend-go): add SnippetHandler with tests and OpenAPI documentation - Implement SnippetHandler for Create, Read, Update, and Delete endpoints. - Add integration tests for SnippetHandler. - Extend OpenAPI documentation to include Snippet operations. - Introduce `ExtractUUIDParam` helper for parameter validation. * reafactor(backend-go): improve error handling and extend delete operations - Enhance error responses in ProjectHandler and SnippetHandler with proper status codes and logging. - Modify repository delete methods to return success status and adjust use cases accordingly. - Update integration and unit tests to validate deletion behavior and persistence. - Extend OpenAPI documentation with 500 error responses and specific error scenarios for delete endpoints. * Feat: Complete Link Module Implementation, Integration Tests & OpenAPI Documentation (#33) * reafactor(backend-go): improve error handling and extend delete operations - Enhance error responses in ProjectHandler and SnippetHandler with proper status codes and logging. - Modify repository delete methods to return success status and adjust use cases accordingly. - Update integration and unit tests to validate deletion behavior and persistence. - Extend OpenAPI documentation with 500 error responses and specific error scenarios for delete endpoints. * docs(openapi): remove nullable attribute from several fields * Feat: Complete Problem Module Implementation (#34) * feat(backend-go): implement problem use case with repository and unit tests - Added `ProblemUseCase` handling CRUD operations and business logic for problems. - Implemented `Create`, `Update`, `UpdateStatus`, `GetByID`, `GetAllByProjectID`, and `Delete` methods. - Updated `ProblemRepository` to include project-scoped methods (`FindByIDAndProjectID`, `DeleteByIDAndProjectID`, `ExistsByIDAndProjectID`). - Added comprehensive unit tests to validate problem use case functionality. * feat(backend-go): add problem handler, routes, and integration tests - Implemented `ProblemHandler` to handle HTTP operations for problems. - Added CRUD and pagination routes for problem management under `/projects/:project_id/problems`. - Extended OpenAPI documentation with schemas and endpoints for problems. - Updated integration test suite with comprehensive tests for problem API operations. - Modified `ProblemUseCase` and repository types to include summary support. * Feat: Complete Tag & ItemTag Module Implementation (#35) * feat(tag): enhance tag repository methods and add use cases - Update repository methods to include project scope (`FindByIDAndProjectID`, `DeleteByIDAndProjectID`). - Implement `TagUseCase` with create, update, delete, and search operations. - Add unit tests for `TagUseCase` methods. - Introduce `ItemTagUseCase` for associating/disassociating tags with items. * feat(usecase): integrate item-tag repository into use cases - Extend `ProblemUseCase`, `SnippetUseCase`, and `LinkUseCase` to manage item-tag associations. - Remove all related tags during deletion of problems, snippets, and links. - Update constructors and unit tests to include `ItemTagRepository`. - Adjust API handlers and test helpers to support the new dependency. * feat(handler): implement tag and item-tag HTTP handlers with tests - Add `TagHandler` to manage CRUD operations and search functionality for tags. - Introduce `ItemTagHandler` to handle tag associations and disassociations with items. - Update `router.go` and initialization logic to register new routes and handlers. - Add comprehensive unit tests for both handlers covering success and error scenarios. * refactor(dto): replace inline command structs with DTO package - Move command structs (`CreateProblemCommand`, `UpdateProblemCommand`, etc.) to `dto` package for better reuse and consistency. - Update use cases, handlers, and tests to use the new DTO package. - Refactor logic in related use case methods (`Create`, `Update`, etc.) to map domain models to view models. - Adjust unit tests to align with the DTO-based refactor. * docs: update security and tag architecture docs for Go backend - Revise local development token documentation to align with Go backend implementation. - Update token naming conventions, middleware logic, and local testing instructions. - Rewrite tag system architecture docs to reflect Go backend design, including database schema, use cases, and DTO changes. * refactor(usecase): update tag use cases to return DTOs and enhance item-tag handling - Refactor `TagUseCase` methods to return `TagView` DTOs instead of domain models. - Add mapping functions to convert domain models to DTOs (`mapTagToView`, `mapTagsToViews`) for consistency. - Extend `ItemTagUseCase` to properly handle duplicate item IDs during tag associations. - Update related tests to reflect DTO usage and improved item-tag logic. - Introduce better error logging for tag removal failures across use cases (`LinkUseCase`, `SnippetUseCase`, `ProblemUseCase`). - Modify OpenAPI spec to reflect supported item types for tag operations. * Feat: implement note module (#36) * feat(backend-go): implement project-scoped note use cases and repository updates - Update `NoteRepository` with project-scoped methods: - `FindByIDAndProjectID` - `DeleteByIDAndProjectID` - Introduce `NoteUseCase` for CRUD operations on notes, ensuring project context. - Add DTOs (`CreateNoteCommand`, `NoteView`, `NoteSummary`) for note-related operations. - Update `ItemTagUseCase` to support `ItemTypeNote`. * feat(backend-go): enhance note use cases with update and delete operations, add associated tests - Implement `NoteUseCase.Update` and `NoteUseCase.Delete` methods. - Update `NoteUseCase.GetByID` to improve error handling and tag retrieval. - Integrate `NoteRepository` into `ItemTagUseCase`. - Add mock repository for notes in tests. - Adjust `NoteView` and `NoteSummary` DTO fields for consistency. - Add unit tests for note use cases. * feat(backend-go): add NoteHandler for managing notes with full CRUD operations - Implement `NoteHandler` for handling notes within project context. - Add router mappings and integrate `NoteHandler` into the API. - Update test helpers and add extensive tests for note routes and handler logic. * feat(api-docs): add OpenAPI documentation for notes management - Document CRUD operations for notes: create, read (single and paginated), update, and delete. - Add schemas for `Note`, `NoteSummary`, `NoteSummaryPage`, `CreateNoteCommand`, and `UpdateNoteCommand`. - Extend `ItemType` enum with `NOTE`. - Define paths for `/projects/{project_id}/notes` and `/projects/{project_id}/notes/{note_id}`. * fix(backend-go): improve error logging in NoteHandler and update OpenAPI docs for NOTE item type - Log detailed error information in `NoteHandler.Create` on internal server errors. - Extend OpenAPI `ItemType` descriptions to include support for `NOTE` in tag association endpoints. * feat: Vault Security Engine & AppSettings (#37) * feat(backend-go): implement secure vault use case and key management - Add VaultUseCase to manage master password setup, unlocking, and session status. - Introduce MasterKeySession and Argon2KeyDeriver adapters for secure key handling. - Add DTOs for handling API interactions related to the vault and app settings. - Implement unit tests for VaultUseCase methods. - Upgrade dependencies in go.mod and go.sum for crypto and security improvements. * feat(backend-go): add SecurityHandler and integrate Vault APIs - Introduce SecurityHandler to manage master password setup, unlocking, session status, and vault locking. - Extend Gin router with security-related routes. - Update DTO validation for master password constraints. - Add OpenAPI documentation for security endpoints. - Implement unit tests for SecurityHandler functions. - Refactor memory hygiene guide to align with backend-go security standards. * refactor(backend-go): improve memory handling and add comprehensive security tests - Enhance memory hygiene in SecurityHandler by ensuring proper password reference clearing. - Add extensive unit tests for Argon2KeyDeriver and MasterKeySessionHolder for key derivation, salt generation, and session management. - Simplify VaultUseCase by consolidating app setting save operations with `SaveMasterPasswordSettings`. - Improve synchronization and defensive copying in MasterKeySessionHolder. - Introduce transaction handling and constraints for saving master password settings in AppSettingRepository. * Feat: Credentials Module Implementation & AES-256-GCM Security Integration (#38) * feat(backend-go): implement AES-GCM crypto adapter and related DTOs - Add AES-GCM encryption/decryption implementation (`AESGCMCryptoAdapter`) - Create Crypto port interface for encryption abstraction - Include tests for AES-GCM encryption/decryption scenarios - Add credential-related DTOs for command and view models - Update `CredentialRepositoryAdapter` to refine query for credential retrieval * **feat(backend-go): add credential use case with unit tests and repository enhancements** - Implement `CredentialUseCase` for CRUD operations, including: - `Create`, `GetById`, `GetAllByProjectID`, `Update`, and `Delete`. - Add corresponding unit tests to ensure robustness. - Extend `CredentialRepository` interface for project-scoped queries. - Update `CredentialRepositoryAdapter` with project-specific operations for `FindByID` and `DeleteByID`. * **feat(backend-go): add CredentialHandler and API routes for credential management** - Introduced `CredentialHandler` with CRUD operations (`Create`, `GetAll`, `GetById`, `Update`, `Delete`). - Mapped routes under `/projects/:project_id/credentials`. - Updated dependency injection for `CredentialHandler` in `main.go`. - Enhanced test coverage with integration tests for credential APIs. * **feat(backend-go): add VaultAutoLock scheduler to purge expired sessions** - Introduced `VaultAutoLock` in the `scheduler` package to handle automatic session purging. - Integrated the scheduler into `main.go` for periodic cleanup of expired sessions. - Refactored `MasterKeySession` field casing for consistency across the codebase. * **feat: extend OpenAPI spec to include credential management and secret payload handling** - Added schemas for `CredentialSecretType`, `CreateCredentialCommand`, `UpdateCredentialCommand`, `CredentialView`, and paginated responses. - Documented new endpoints under `/projects/{project_id}/credentials` for CRUD operations. - Updated handling for item types to support `CREDENTIAL`. - Improved sensitive data marshaling using `SecretBytes` for enhanced memory hygiene. * **refactor(backend-go): improve test memory hygiene and update credential update logic** - Refactored unit tests to ensure zeroing of sensitive `masterKey` during runtime. - Updated `UpdateCredential` to handle partial updates with secret payload merging. - Improved error messages for decryption failure scenarios. - Adjusted OpenAPI spec error description for clarity on UUID validation. * Feature/adapt frontend to golang (#39) * feat(frontend): adapt REST API client to Go backend - Update internal security token header to DEVAULTY_INTERNAL_TOKEN - Adapt error interceptor to handle Go backend error payload format ({ error: string }) - Align MasterPassword setup check response with MasterPasswordSetupRequiredView schema - Update tag search query parameter to tag_name - Add tag badges rendering and tag search filtering to Snippets list view * feat(tauri): integrate native Go backend and optimize memory usage - Replace Java JRE integration in Tauri Rust shell with native Go sidecar execution - Implement secure IPC using CSPRNG UUID token and stdout stream handshake - Embed SQL migrations inside Go binary via go:embed for a self-contained executable - Reduce Go backend RAM footprint down to 19MB via Gin ReleaseMode and GOGC tuning - Implement 3-phase app startup (handshake, HTTP health check, minimum 2s splash screen) - Update cross-platform build scripts and purge all remaining Java/Spring dependencies * refactor: migrate backend from Gradle/Java to Go and update CI/CD pipelines to build installers via Tauri * fix: improve backend data directory resolution, clean build artifacts, and normalize application versioning for Tauri compatibility. * refactor!: replace Java backend with native Go backend and update Tauri v2 pipeline
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Summary
This Pull Request delivers the complete end-to-end implementation of the Snippet domain module for the Go backend, following Hexagonal Architecture and clean code principles.
It includes:
✨ Key Changes
⚙️ 1. Domain & Use Cases (
internal/domain/,internal/usecase/)Domain Models (
internal/domain/model/snippet.go)Snippetentity.SnippetTypeenum (COMMAND,CODE).SnippetLanguageenum supporting 70+ programming, markup, database, shell, and infrastructure languages.Repository Port (
internal/domain/port/snippet_repository.go)SnippetRepositoryinterface extendingProjectScopedRepository.FindByIDAndProjectIDFindAllByProjectIDDeleteByIDAndProjectIDUse Case (
internal/usecase/snippet_usecase.go)Implemented the complete CRUD flow:
Create
ensureProjectExists.GetByID
projectIDandsnippetID.GetAllByProjectID
model.Page[model.Snippet]).created_at DESC.Update
updatedAt.Delete
projectIDandsnippetID.🌐 2. Web Adapter & HTTP Handlers (
internal/adapter/in/web/)SnippetHandler(internal/adapter/in/web/handler/snippet_handler.go)Exposes REST endpoints under:
Sets the
Locationheader on201 Createdresponses:Maps sentinel errors to HTTP responses:
ErrProjectNotFound→ 404 Not FoundErrSnippetNotFound→ 404 Not FoundURL Parameter Helper (
internal/adapter/in/web/common/params.go)Added
common.ExtractUUIDParam(c, paramName)to eliminate duplicated UUID parsing logic across handlers.💾 3. Persistence Layer (
internal/adapter/out/persistence/)Implemented
SnippetRepositoryAdapterusingsqlx.Features include:
Save
INSERT ... ON CONFLICT(id) DO UPDATEupsert.FindByIDAndProjectID
nil, nilonsql.ErrNoRows.FindAllByProjectID
PaginateExec[model.Snippet]helper.DeleteByIDAndProjectID
📚 4. OpenAPI 3.0 & Scalar UI Documentation
docs/openapi.yamlAdded documentation for:
Schemas
SnippetSnippetTypeSnippetLanguageCreateSnippetCommandUpdateSnippetCommandSnippetPageEndpoints
POSTGETPATCHDELETEDocumented response codes:
201 Created200 OK204 No Content400 Bad Request401 Unauthorized404 Not Found🧪 5. Testing & Quality Assurance
Unit Tests
internal/usecase/snippet_usecase_test.gotestifymocks.HTTP Integration Tests
internal/adapter/in/web/handler/snippet_handler_test.go:memory:).Covers:
POSTGETPATCHDELETE401)404)🧪 Test Execution
Run the full test suite:
go test ./... -vResult
Additional verification:
go vet ./...— Passed with 0 errors.Summary by CodeRabbit
Release Notes
New Features
Documentation
Tests
Refactor