feat(LLMO-1023): integrate logWrapper for trace ID logging #1526
Conversation
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
API Enhancements: - Add sortBy and sortOrder query parameters to all listing endpoints - Support sorting by: rank, traffic, url, createdAt, updatedAt - Add rank and traffic fields to add/update operations - Update OpenAPI documentation with new parameters and fields Performance Improvements: - Refactor bulk operations to use Promise.allSettled for parallel processing - Replace sequential for-loops with parallel map operations - Improve response time for bulk add/update/delete operations Code Quality: - Fix all 15 pre-existing linting errors - Remove unused encodeUrlToBase64 function - Eliminate no-continue statements (7 instances) - Eliminate no-await-in-loop violations (7 instances) - Fix trailing spaces and OpenAPI YAML syntax errors - All linting now passing (0 errors)
- Resolved conflicts in src/index.js and src/routes/index.js - Kept both URL Store Controller and PTA2 Controller features
Add REST API endpoints to manage and query offsite brand presence URLs
(Wikipedia, YouTube, social media, etc.) alongside primary site URLs.
New Endpoints:
- GET /sites/{siteId}/url-store/by-platform/{platformType}
Query URLs by specific platform type with sorting/pagination
- GET /sites/{siteId}/url-store/offsite
Get all offsite URLs with sorting/pagination
Controller Changes:
- Add listUrlsByPlatform() endpoint handler
- Add listOffsiteUrls() endpoint handler
- Update addUrls() to accept and validate platformType
- Update updateUrls() to accept and validate platformType
- Import PLATFORM_TYPES from data access layer
OpenAPI Documentation:
- Document new endpoints with full specifications
- Add platformType field to all URL schemas
- Include sorting parameters (rank, traffic, etc.)
- Add platform type enum validation
Testing:
- Add 13 comprehensive controller tests
- Test platform type validation
- Test sorting and pagination
- Test default value behavior
All endpoints support sorting by rank, traffic, url, createdAt, updatedAt
with asc/desc ordering and cursor-based pagination.
Note: OpenAPI validation warnings for nullable fields are pre-existing
and tracked separately.
Contributor
|
The changes are a mix of URL store implementation and the trace id one. |
HollywoodTonight
force-pushed
the
LLMO-1023-trace-id
branch
from
867005d to
a572480
Compare
|
This PR will trigger a minor release when merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Integrates
logWrapperto enable automatic trace ID logging in the SpaceCat API Service, supporting end-to-end distributed tracing across all SpaceCat services.Changes
1. Add logWrapper Integration
logWrapperfrom@adobe/spacecat-shared-utilslogWrapperto the wrapper chain afterenrichPathInfox-trace-idrequest headers2. Version Updates
@adobe/spacecat-shared-utilsto^1.76.0How It Works
The API service now captures trace IDs from incoming HTTP requests:
x-trace-idheader → trace ID is extracted byenrichPathInfoand stored incontext.traceIdsqswrapper) automatically propagate the trace IDx-trace-idheader is present, AWS X-Ray trace ID is used automaticallyBenefits
✅ Complete visibility into request flows across services
✅ Correlation of logs across HTTP → API → Worker chains
✅ Easier debugging of distributed workflows
✅ No code changes needed in controllers - automatic propagation
Testing
Related