fix: (CDK) (AsyncRetriever) - fix bug when TIMEOUT Jobs are retried, ignoring the polling_job_timeout setting
#429
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
2 tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request fixes an issue where TIMEOUT jobs were being retried despite the polling job timeout setting, while also adding enhanced context interpolation for HTTP job responses.
- In job_orchestrator.py, TIMEOUT jobs are now treated as terminal with improved error messaging and allocation freeing.
- New helper methods have been added in http_job_repository.py to generate interpolation contexts for creation and polling responses.
- The related test has been updated to assert the new timeout error message.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| airbyte_cdk/sources/declarative/async_job/job_orchestrator.py | Updated logic to avoid re-queuing TIMEOUT jobs and improved error handling and cleanup, along with new helper methods for partition job management. |
| airbyte_cdk/sources/declarative/requesters/http_job_repository.py | Added methods for generating interpolation contexts for job responses, maintaining consistency in extra_fields. |
| unit_tests/sources/declarative/async_job/test_job_orchestrator.py | Modified test to capture and assert the updated timeout error message. |
Contributor
📝 WalkthroughWalkthroughThis pull request updates the asynchronous job orchestration and HTTP job repository logic. In the orchestrator, job status handling is refined to distinguish between FAILED and TIMED_OUT states. New methods remove completed or timed-out jobs and reallocate partitions for failed jobs, while error reporting for timeouts is enhanced. The HTTP job repository now centralizes response context creation with dedicated methods for job creation and polling, streamlining the data extraction process. The unit test has been adjusted to focus on validating the proper error message when a job times out. Changes
Sequence Diagram(s)Async Job Orchestration FlowsequenceDiagram
participant O as AsyncJobOrchestrator
participant P as Partition
participant J as Job
O->>O: Evaluate job status (FAILED vs TIMED_OUT)
alt Job status is FAILED
O->>P: Invoke _replace_failed_jobs
O->>P: Call _reallocate_partition to start a new job
else Job status is TIMED_OUT/COMPLETED
O->>P: Call _remove_completed_or_timed_out_jobs
O->>O: Free allocation and raise AirbyteTracedException
end
HTTP Job Repository Context FlowsequenceDiagram
participant Repo as AsyncHttpJobRepository
participant Job as AsyncJob
Job->>Repo: Request creation context
Repo->>Repo: Execute _get_creation_response_interpolation_context
Repo-->>Job: Return creation response data
Job->>Repo: Request polling context
Repo->>Repo: Execute _get_polling_response_interpolation_context
Repo-->>Job: Return polling response data
Suggested reviewers
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (9)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
maxi297
reviewed
Mar 18, 2025
airbyte_cdk/sources/declarative/requesters/http_job_repository.py
Outdated
Show resolved
Hide resolved
pnilan
approved these changes
Mar 18, 2025
Contributor
pnilan
left a comment
pnilan
left a comment
There was a problem hiding this comment.
Thanks for quickly updating this!
I have one comment regarding the use of .json() in the AsyncHttpJobRepository, other than that LGTM.
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.
What
Original Slack thread:
Additional side-fix for the:
How
make the
TIMEOUTJob status to beTerminalmake the
TIMEOUTJob status non-retriableadd more interpolation context required by certain sources, like
source-amazon-ads, relying oncreation_response['headrs']['My-Header-Value']. Also valid for thepolling_responsecase.User Impact
No impact is expected, this is not a Breaking Change.
Summary by CodeRabbit
New Features
Tests