Change some exception types thrown in Tar APIs

[carlossanlop]

As discussed here: #74786 (comment)
@bartonjs@jozkee

@danmoseley would you approve this exception type change for RC2? Edit: Dan said yes :)

[ghost]

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

Issue Details

---

As discussed here: #74786 (comment)
@bartonjs@jozkee

@danmoseley would you approve this exception type change for RC2?

Author:	carlossanlop
Assignees:	carlossanlop
Labels:	area-System.IO
Milestone:	-

[danmoseley]

@danmoseley would you approve this exception type change for RC2

Yes as getting the API right is important. We do have upstack dependencies (the new docker tooling) but presumably not relying on this error path.

[jozkee]

runtime/src/libraries/System.Formats.Tar/src/System/Formats/Tar/TarHeader.Read.cs

Line 416 in e5058f6

TarEntryType.SparseFile=>thrownewNotSupportedException(string.Format(SR.TarEntryTypeNotSupported,header._typeFlag)),

@bartonjs, this is thrown when TarReader.GetNextEntry() steps into a sparse file, but AFAIK, NotSupportedException is for members that you choose not to support in your type. Do you know if a better exception could be thrown here?

[bartonjs]

There's certainly prior art for throwing NotSupportedException for "there's a protocol feature that I don't support", and I can't think of a better one to use. (Plus, with some indirection, this would just be the implementation of something like TarSparseFile::Read, where it wouldn't look out of place at all.) (There's also prior art for using it when InvalidOperationException should be used, so make of that what you will.)

FWIW: I feel like I saw places that were using FormatException (an error with string.Format or related APIs) that probably meant InvalidDataException ("The exception that is thrown when a data stream is in an invalid format"). Don't know if those already got tackled.

[carlossanlop]

@bartonjs not tackled yet but I can change them if that exception type is preferred.

[jozkee]

Otherwise, LGTM.

[carlossanlop]

/backport to release/7.0

[github-actions]

Started backporting to release/7.0: https://github.com/dotnet/runtime/actions/runs/2967038898

[carlossanlop]

CI failures are unrelated infra problems.
Everything has been resolved, and it's signed off. Merging now.