[codex] Defer Deepwell text block S3 cleanup until commit from PR #1 #75
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * tests/text_block.rs | ||
| * | ||
| * DEEPWELL - Wikijump API provider and database manager | ||
| * Copyright (C) 2019-2026 Wikijump Team | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| #[allow(unused_imports)] | ||
| mod common; | ||
|
|
||
| use self::common::TestRunner; | ||
| use deepwell::services::PostCommitActions; | ||
| use uuid::Uuid; | ||
|
|
||
| #[tokio::test] | ||
| async fn post_commit_text_block_cleanup_deletes_only_after_drain() { | ||
| let runner = TestRunner::setup().await; | ||
| let bucket = runner.context().s3_tblocks_bucket(); | ||
| let filename = format!("test-post-commit-text-block-{}", Uuid::new_v4()); | ||
|
|
||
| bucket | ||
| .put_object_with_content_type(&filename, b"stale text block", "text/plain") | ||
| .await | ||
| .expect("test text-block object should upload"); | ||
| assert_object_status(bucket, &filename, 200).await; | ||
|
|
||
| let actions = PostCommitActions::default(); | ||
| actions.delete_text_block_objects([filename.clone()]); | ||
| assert_eq!(actions.pending_count(), 1); | ||
|
|
||
| actions.run_after_commit(runner.state()).await; | ||
|
|
||
| assert_eq!(actions.pending_count(), 0); | ||
| assert_object_status(bucket, &filename, 404).await; | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn queued_text_block_cleanup_preserves_objects_when_not_drained() { | ||
| let runner = TestRunner::setup().await; | ||
| let bucket = runner.context().s3_tblocks_bucket(); | ||
| let filename = format!("test-rollback-text-block-{}", Uuid::new_v4()); | ||
|
|
||
| bucket | ||
| .put_object_with_content_type(&filename, b"rollback text block", "text/plain") | ||
| .await | ||
| .expect("test text-block object should upload"); | ||
| assert_object_status(bucket, &filename, 200).await; | ||
|
|
||
| let actions = PostCommitActions::default(); | ||
| actions.delete_text_block_objects([filename.clone()]); | ||
| assert_eq!(actions.pending_count(), 1); | ||
|
|
||
| assert_object_status(bucket, &filename, 200).await; | ||
|
|
||
| bucket | ||
| .delete_object(&filename) | ||
| .await | ||
| .expect("rollback preservation test object should clean up"); | ||
| } | ||
|
Comment on lines
+50
to
+72
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🔵 Trivial | 🏗️ Heavy lift Exercise a real rollback instead of only skipping the drain. This proves queued actions are inert until |
||
|
|
||
| async fn assert_object_status( | ||
| bucket: &s3::bucket::Bucket, | ||
| filename: &str, | ||
| expected: u16, | ||
| ) { | ||
| let (_head, status) = bucket | ||
| .head_object(filename) | ||
| .await | ||
| .expect("test text-block object HEAD should complete"); | ||
| assert_eq!( | ||
| status, expected, | ||
| "unexpected S3 status for text-block object {filename}", | ||
| ); | ||
| } | ||
|
Comment on lines
+74
to
+87
There was a problem hiding this comment. 🩺 Stability & Availability | 🟡 Minor 🧩 Analysis chain🌐 Web query:
💡 Result: In the rust-s3 crate (version 0.37 and later), the Citations:
🏁 Script executed: #!/bin/bash
set -euo pipefail
# Inspect the relevant test and the rust-s3 dependency version used by the repo.
git ls-files deepwell/tests/text_block.rs Cargo.toml Cargo.lock | sed -n '1,20p'
printf '\n== deepwell/tests/text_block.rs ==\n'
cat -n deepwell/tests/text_block.rs | sed -n '1,180p'
printf '\n== rust-s3 references ==\n'
rg -n 'rust-s3|s3 =' Cargo.toml Cargo.lock deepwell -g 'Cargo.toml' -g 'Cargo.lock' -g '*.toml' -g '*.lock' -g '*.rs'Repository: Rokurolize/wikijump Length of output: 4148 🏁 Script executed: #!/bin/bash
set -euo pipefail
# Inspect the relevant test and the rust-s3 dependency version used by the repo.
git ls-files deepwell/tests/text_block.rs Cargo.toml Cargo.lock | sed -n '1,20p'
printf '\n== deepwell/tests/text_block.rs ==\n'
cat -n deepwell/tests/text_block.rs | sed -n '1,180p'
printf '\n== rust-s3 references ==\n'
rg -n 'rust-s3|s3 =' Cargo.toml Cargo.lock deepwell -g 'Cargo.toml' -g 'Cargo.lock' -g '*.toml' -g '*.lock' -g '*.rs'Repository: Rokurolize/wikijump Length of output: 4148 🏁 Script executed: #!/bin/bash
set -euo pipefail
# Inspect the relevant test and the rust-s3 dependency version used by the repo.
git ls-files deepwell/tests/text_block.rs Cargo.toml Cargo.lock | sed -n '1,20p'
printf '\n== deepwell/tests/text_block.rs ==\n'
cat -n deepwell/tests/text_block.rs | sed -n '1,180p'
printf '\n== rust-s3 references ==\n'
rg -n 'rust-s3|s3 =' Cargo.toml Cargo.lock deepwell -g 'Cargo.toml' -g 'Cargo.lock' -g '*.toml' -g '*.lock' -g '*.rs'Repository: Rokurolize/wikijump Length of output: 4148 🏁 Script executed: #!/bin/bash
set -euo pipefail
git ls-files deepwell/tests/text_block.rs Cargo.toml Cargo.lock | sed -n '1,20p'
printf '\n== deepwell/tests/text_block.rs ==\n'
cat -n deepwell/tests/text_block.rs | sed -n '1,180p'
printf '\n== rust-s3 references ==\n'
rg -n 'rust-s3|s3 =' Cargo.toml Cargo.lock deepwell -g 'Cargo.toml' -g 'Cargo.lock' -g '*.toml' -g '*.lock' -g '*.rs'Repository: Rokurolize/wikijump Length of output: 4148 Handle the 404 case explicitly. |
||
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.
🚀 Performance & Scalability | 🔵 Trivial | ⚡ Quick win
Post-commit deletes run inline before returning the response.
run_after_commitawaits each S3delete_objectsequentially on the request task, so the client response is held until cleanup finishes (and slow/failing S3 inflates latency). Consider spawning the drain on a background task (tokio::spawn) so cleanup doesn't block the response path.