Fix download job handling and improve logging #1506
Merged
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
There was a problem hiding this comment.
Pull request overview
This pull request enhances error handling for aborted download jobs and improves logging throughout the application. The changes prevent unnecessary stream closure attempts and add more contextual information to log events.
Changes:
- Introduce a
controllerClosedflag in StreamingZip to prevent attempting to close an already-closed controller - Add contextual logging for zip file download lifecycle events (start, completion, abort)
- Refactor Rollbar error reporting to flatten the structure by removing nested
customobjects - Update logger selection to prefer
res.logoverreq.logand pass the response object togetOrgFromHeaderOrQuery
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| libs/salesforce-api/src/lib/zip-utils.ts | Adds controllerClosed flag to track stream closure state and prevents redundant close attempts |
| libs/salesforce-api/src/lib/api-binary-download.ts | Adds contextual logging for zip download lifecycle (start/completion/abort) |
| apps/api/src/app/utils/route.utils.ts | Updates logger selection to prefer res.log and flattens Rollbar custom data structure |
| apps/api/src/app/utils/response.handlers.ts | Flattens Rollbar custom data structure for consistency |
| apps/api/src/app/services/user-feedback.service.ts | Flattens Rollbar custom data structure |
| apps/api/src/app/services/salesforce-org-encryption.service.ts | Flattens Rollbar custom data structure |
| apps/api/src/app/services/jwt-token-encryption.service.ts | Flattens Rollbar custom data structure |
| apps/api/src/app/routes/route.middleware.ts | Updates getOrgFromHeaderOrQuery signature to accept res parameter for improved logger access |
| apps/api/src/app/routes/platform-event.routes.ts | Updates function call to match new getOrgFromHeaderOrQuery signature |
| apps/api/src/app/controllers/oauth.controller.ts | Adds logger parameter to ApiConnection instantiation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
If stream was already aborted (aka closed) don't try to close again. improved logging on zip job completion Ref: rollbar-2292
Ensure we are using res.log to get as much context as possible in the log object Remove the "custom" key from rollbar log events
paustint
force-pushed
the
bug/improve-download-errors
branch
from
65a7293 to
46b95dd
Compare
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.
Enhance the handling of aborted download jobs to prevent unnecessary closure attempts and improve logging for zip job completion. Update logging practices to ensure more context is captured in log events.