-
Notifications
You must be signed in to change notification settings - Fork 1.4k
ci: fetch base branch in regression test check #916
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,9 @@ jobs: | |
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Fetch base branch | ||
| run: git fetch origin ${{ github.event.pull_request.base.ref }} | ||
|
Comment on lines
+16
to
+17
|
||
|
|
||
| - name: Check for regression tests | ||
| env: | ||
| PR_TITLE: ${{ github.event.pull_request.title }} | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -372,30 +372,36 @@ async fn process_message( | |
| None | ||
| }; | ||
|
|
||
| // Send message to the channel | ||
| let tx_guard = state.tx.read().await; | ||
| if let Some(tx) = tx_guard.as_ref() { | ||
| if tx.send(msg).await.is_err() { | ||
| return ( | ||
| StatusCode::INTERNAL_SERVER_ERROR, | ||
| Json(WebhookResponse { | ||
| message_id: msg_id, | ||
| status: "error".to_string(), | ||
| response: Some("Channel closed".to_string()), | ||
| }), | ||
| ); | ||
| // Send message to the channel — clone sender to avoid holding lock across await. | ||
| // Note: after cloning, shutdown() can run and clear the Option while we still hold | ||
| // a valid Sender clone. This is safe: the send will succeed (receiver still alive | ||
| // in the agent loop) or fail cleanly if the receiver was dropped. | ||
| let tx = { | ||
| let tx_guard = state.tx.read().await; | ||
| match tx_guard.as_ref() { | ||
| Some(tx) => tx.clone(), | ||
| None => { | ||
| return ( | ||
| StatusCode::SERVICE_UNAVAILABLE, | ||
| Json(WebhookResponse { | ||
| message_id: msg_id, | ||
| status: "error".to_string(), | ||
| response: Some("Channel not started".to_string()), | ||
| }), | ||
| ); | ||
| } | ||
| } | ||
| } else { | ||
| }; | ||
| if tx.send(msg).await.is_err() { | ||
| return ( | ||
| StatusCode::SERVICE_UNAVAILABLE, | ||
| StatusCode::INTERNAL_SERVER_ERROR, | ||
| Json(WebhookResponse { | ||
| message_id: msg_id, | ||
| status: "error".to_string(), | ||
| response: Some("Channel not started".to_string()), | ||
| response: Some("Channel closed".to_string()), | ||
| }), | ||
| ); | ||
|
Comment on lines
+395
to
403
|
||
| } | ||
| drop(tx_guard); | ||
|
|
||
| // Wait for response if requested | ||
| let response = if let Some(rx) = response_rx { | ||
|
|
@@ -543,6 +549,67 @@ mod tests { | |
| assert_eq!(resp.status(), StatusCode::UNAUTHORIZED); | ||
| } | ||
|
|
||
| /// Regression test for issue #869: RwLock read guard was held across | ||
| /// tx.send(msg).await in `process_message()`, blocking shutdown() from | ||
| /// acquiring the write lock when the channel buffer was full. | ||
| /// | ||
| /// This test exercises the actual production code path (`process_message`) | ||
| /// with a full channel buffer, then verifies shutdown() can still complete. | ||
| #[tokio::test] | ||
| async fn shutdown_completes_while_process_message_blocked() { | ||
| let channel = Arc::new(test_channel(Some("secret"))); | ||
| let stream = channel.start().await.unwrap(); | ||
|
|
||
| // Fill all 256 slots in the channel buffer | ||
| { | ||
| let tx = { | ||
| let guard = channel.state.tx.read().await; | ||
| guard.as_ref().unwrap().clone() | ||
| }; | ||
| for i in 0..256 { | ||
| let msg = IncomingMessage::new("http", "user", format!("fill-{}", i)); | ||
| tx.send(msg).await.unwrap(); | ||
|
Comment on lines
+563
to
+571
|
||
| } | ||
| } | ||
|
|
||
| // Signal so we know the spawned task has started and is about to | ||
| // call process_message (which will block on the full channel). | ||
| let started = Arc::new(tokio::sync::Notify::new()); | ||
| let started_clone = started.clone(); | ||
|
|
||
| // Spawn a task that calls the actual production code path. | ||
| // process_message() internally acquires the RwLock read guard and | ||
| // sends on the channel. With the fix, the guard is released before | ||
| // send().await; without the fix, shutdown() would deadlock. | ||
| let state = channel.state.clone(); | ||
| let blocked_send = tokio::spawn(async move { | ||
| started_clone.notify_one(); | ||
| let msg = IncomingMessage::new("http", "user", "blocked-257th"); | ||
| let _ = process_message(state, msg, false).await; | ||
| }); | ||
|
|
||
| // Wait for the spawned task to start, then give it time to reach | ||
| // the send().await and verify that it is still pending (i.e., blocked). | ||
| started.notified().await; | ||
| tokio::time::sleep(std::time::Duration::from_millis(50)).await; | ||
| assert!( | ||
| !blocked_send.is_finished(), | ||
| "process_message task should still be pending before shutdown()" | ||
| ); | ||
|
|
||
| // shutdown() must complete even though process_message is blocked on | ||
| // send(). Before the fix, the read guard held across send().await | ||
| // would prevent shutdown() from acquiring the write lock. | ||
| let result = | ||
| tokio::time::timeout(std::time::Duration::from_secs(2), channel.shutdown()).await; | ||
| assert!(result.is_ok(), "shutdown() must not deadlock"); | ||
| assert!(result.unwrap().is_ok()); | ||
|
|
||
| // Drop the stream (receiver) so the blocked send task can complete | ||
| drop(stream); | ||
| let _ = blocked_send.await; | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn webhook_missing_secret_returns_unauthorized() { | ||
| let channel = test_channel(Some("correct-secret")); | ||
|
|
||
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The added fetch step may still not create the
origin/<base>remote-tracking ref that the script relies on (BASE_REF="origin/..."). To make this robust regardless ofactions/checkout's configured refspec, fetch with an explicit destination (e.g.,refs/heads/<base>:refs/remotes/origin/<base>) and quote the ref to avoid shell word-splitting for unusual branch names.