starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-02-03 21:23:38 +00:00
Code Issues 975 Packages Projects Releases 20 Wiki Activity

[PR #1137] [MERGED] Fix async test failures after xunit v3 upgrade #1571

New Issue
Open
opened 2026-01-29 22:21:11 +00:00 by claunia · 0 comments
claunia commented 2026-01-29 22:21:11 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/adamhathcock/sharpcompress/pull/1137
Author: @Copilot
Created: 1/16/2026
Status: ✅ Merged
Merged: 1/16/2026
Merged by: @adamhathcock

Base: adam/upgrade-xunit ← Head: copilot/sub-pr-1136

📝 Commits (5)

  • 75cc368 Initial plan
  • 2906529 Fix ReaderFactory.OpenAsyncReader to use async IsArchiveAsync methods
  • e919930 Fix Archive async tests to not use AsyncOnlyStream (archives need seekable streams)
  • c7da19f Format code with CSharpier
  • 0de5c59 Restore AsyncOnlyStream in archive async tests as requested

📊 Changes

13 files changed (+48 additions, -37 deletions)

View changed files

📝 src/SharpCompress/Readers/ReaderFactory.cs (+13 -5)
📝 tests/SharpCompress.Test/Ace/AceReaderAsyncTests.cs (+3 -3)
📝 tests/SharpCompress.Test/Arj/ArjReaderAsyncTests.cs (+4 -4)
📝 tests/SharpCompress.Test/GZip/AsyncTests.cs (+4 -4)
📝 tests/SharpCompress.Test/GZip/GZipReaderAsyncTests.cs (+2 -2)
📝 tests/SharpCompress.Test/ProgressReportTests.cs (+1 -1)
📝 tests/SharpCompress.Test/Rar/RarReaderAsyncTests.cs (+5 -5)
📝 tests/SharpCompress.Test/ReaderTests.cs (+1 -1)
📝 tests/SharpCompress.Test/Tar/TarArchiveAsyncTests.cs (+4 -1)
📝 tests/SharpCompress.Test/Tar/TarReaderAsyncTests.cs (+5 -5)
📝 tests/SharpCompress.Test/WriterTests.cs (+1 -1)
📝 tests/SharpCompress.Test/Zip/Zip64AsyncTests.cs (+1 -1)
📝 tests/SharpCompress.Test/Zip/ZipReaderAsyncTests.cs (+4 -4)

📄 Description

The xunit v3 upgrade exposed that async tests were not properly awaiting async operations. Tests were passing ValueTask<IAsyncReader> directly to await using statements instead of awaiting the task first, and ReaderFactory.OpenAsyncReader was calling synchronous IsArchive methods during format detection.

Changes

  • Made ReaderFactory.OpenAsyncReader properly async: Changed return type to ValueTask<IAsyncReader> and replaced synchronous IsArchive() calls with IsArchiveAsync() during format detection
  • Fixed test await patterns: Added explicit await before ReaderFactory.OpenAsyncReader() in all async test methods
  • Kept AsyncOnlyStream in Archive async tests: Archive async tests continue to use AsyncOnlyStream to validate that archive operations properly handle async-only streams, exposing areas where synchronous I/O is still used in async code paths

Example

Before:

await using var reader = ReaderFactory.OpenAsyncReader(stream); // Sync IsArchive() called internally

After:

await using var reader = await ReaderFactory.OpenAsyncReader(stream); // Async IsArchiveAsync() called

Known Limitations

  • Archive APIs: Archive opening performs synchronous I/O during format probing, causing tests with AsyncOnlyStream to fail. These tests intentionally expose the need for async archive opening support.
  • Compressed tar formats: Reader opening for compressed tar formats (tar.bz2, tar.lz, tar.gz) requires multi-step format probing not yet implemented in the async path, causing "Cannot determine compressed stream type" errors.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/adamhathcock/sharpcompress/pull/1137 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 1/16/2026 **Status:** ✅ Merged **Merged:** 1/16/2026 **Merged by:** [@adamhathcock](https://github.com/adamhathcock) **Base:** `adam/upgrade-xunit` ← **Head:** `copilot/sub-pr-1136` --- ### 📝 Commits (5) - [`75cc368`](https://github.com/adamhathcock/sharpcompress/commit/75cc36849bc3db04479f19f8b1bbaaafff0b7c4a) Initial plan - [`2906529`](https://github.com/adamhathcock/sharpcompress/commit/29065290808e2ffb85e8864fccfbd244b7ad73b9) Fix ReaderFactory.OpenAsyncReader to use async IsArchiveAsync methods - [`e919930`](https://github.com/adamhathcock/sharpcompress/commit/e919930cf6ce1b4e6f96f6f00272c55790c3e6cd) Fix Archive async tests to not use AsyncOnlyStream (archives need seekable streams) - [`c7da19f`](https://github.com/adamhathcock/sharpcompress/commit/c7da19f3a5e0ca103261ce3f1967fe5d08ab3793) Format code with CSharpier - [`0de5c59`](https://github.com/adamhathcock/sharpcompress/commit/0de5c59a77745a3109a70ea58301d3ffe8951bda) Restore AsyncOnlyStream in archive async tests as requested ### 📊 Changes **13 files changed** (+48 additions, -37 deletions) <details> <summary>View changed files</summary> 📝 `src/SharpCompress/Readers/ReaderFactory.cs` (+13 -5) 📝 `tests/SharpCompress.Test/Ace/AceReaderAsyncTests.cs` (+3 -3) 📝 `tests/SharpCompress.Test/Arj/ArjReaderAsyncTests.cs` (+4 -4) 📝 `tests/SharpCompress.Test/GZip/AsyncTests.cs` (+4 -4) 📝 `tests/SharpCompress.Test/GZip/GZipReaderAsyncTests.cs` (+2 -2) 📝 `tests/SharpCompress.Test/ProgressReportTests.cs` (+1 -1) 📝 `tests/SharpCompress.Test/Rar/RarReaderAsyncTests.cs` (+5 -5) 📝 `tests/SharpCompress.Test/ReaderTests.cs` (+1 -1) 📝 `tests/SharpCompress.Test/Tar/TarArchiveAsyncTests.cs` (+4 -1) 📝 `tests/SharpCompress.Test/Tar/TarReaderAsyncTests.cs` (+5 -5) 📝 `tests/SharpCompress.Test/WriterTests.cs` (+1 -1) 📝 `tests/SharpCompress.Test/Zip/Zip64AsyncTests.cs` (+1 -1) 📝 `tests/SharpCompress.Test/Zip/ZipReaderAsyncTests.cs` (+4 -4) </details> ### 📄 Description The xunit v3 upgrade exposed that async tests were not properly awaiting async operations. Tests were passing `ValueTask<IAsyncReader>` directly to `await using` statements instead of awaiting the task first, and `ReaderFactory.OpenAsyncReader` was calling synchronous `IsArchive` methods during format detection. ## Changes - **Made `ReaderFactory.OpenAsyncReader` properly async**: Changed return type to `ValueTask<IAsyncReader>` and replaced synchronous `IsArchive()` calls with `IsArchiveAsync()` during format detection - **Fixed test await patterns**: Added explicit `await` before `ReaderFactory.OpenAsyncReader()` in all async test methods - **Kept `AsyncOnlyStream` in Archive async tests**: Archive async tests continue to use `AsyncOnlyStream` to validate that archive operations properly handle async-only streams, exposing areas where synchronous I/O is still used in async code paths ## Example Before: ```csharp await using var reader = ReaderFactory.OpenAsyncReader(stream); // Sync IsArchive() called internally ``` After: ```csharp await using var reader = await ReaderFactory.OpenAsyncReader(stream); // Async IsArchiveAsync() called ``` ## Known Limitations - **Archive APIs**: Archive opening performs synchronous I/O during format probing, causing tests with `AsyncOnlyStream` to fail. These tests intentionally expose the need for async archive opening support. - **Compressed tar formats**: Reader opening for compressed tar formats (tar.bz2, tar.lz, tar.gz) requires multi-step format probing not yet implemented in the async path, causing "Cannot determine compressed stream type" errors. <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 22:21:11 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
duplicate
enhancement
feedback requested
not bug
pull-request
Mirrored from GitHub Pull Request
 question
up for grabs
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/sharpcompress#1571
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?