Tar: Improve unseekable stream handling

[carlossanlop]

Fixes #76690

Addresses the issue reported in dotnet/sdk-container-builds#192 (comment) by @rainersigwald

Before this change, it wasn't possible to write into an archive a file entry that contained an unseekable data stream. The undelying cause was that we were calling Length to try to get the total number of bytes of the data stream, but it is unsupported when the stream's CanSeek is false.

The way I fixed this was by separating the code that writes an entry into two possible paths:

• One path for entries with seekable data streams, which remains mostly unmodified.

• A new path for entries with unseekable streams, which changes the order in which we collect the entry information into the buffer:

  • First, write into the buffer all the metadata except for the size field.
  • Then, write the data stream into the archive (this is possible because we know the exact location where the data should start), counting the number of bytes that are written.
  • Afterwards, write that collected length value in the location for the size field in the buffer.
  • Finally, calculate the checksum, then write the buffer into the archive.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-formats-tar
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Fixes #76690

Addresses the issue reported in dotnet/sdk-container-builds#192 (comment) by @rainersigwald

Before this change, it wasn't possible to write into an archive a file entry that contained an unseekable data stream. The undelying cause was that we were calling Length to try to get the total number of bytes of the data stream, but it is unsupported when the stream's CanSeek is false.

The way I fixed this was by separating the code that writes an entry into two possible paths:

• One path for entries with seekable data streams, which remains mostly unmodified.

• A newnew path for entries with unseekable streams, which changes the order in which we collect the entry information into the buffer:

  • First, write into the buffer all the metadata except for the size field.
  • Then, write the data stream into the archive (this is possible because we know the exact location where the data should start), counting the number of bytes that are written.
  • Afterwards, write that collected length value in the location for the size field in the buffer.
  • Finally, calculate the checksum, then write the buffer into the archive.

Author:	carlossanlop
Assignees:	carlossanlop
Labels:	area-System.Formats.Tar
Milestone:	-

[carlossanlop]

I'll remove the new file TarFile.CreateFromDirectoryAsync.File.Roundtrip.cs and will submit it in a separate PR. It isn't related to this change.
Edit: Merged in separate PR: #84303

[adamsitnik]

Overall it LGTM, but it would be nice if we could reduce the code duplication before merging.

Thank you @carlossanlop !

[adamsitnik]

LGTM, please apply my suggestions before merging.

[carlossanlop]

Failures are unrelated.