Commit 9847f9f
committed
fix(io-compression): the three streams enforce their own mode (#2152)
DeflateStream, GZipStream and ZLibStream now reject a Read on a Compress-mode
stream and a Write on a Decompress-mode stream with InvalidOperationException,
matching .NET's EnsureDecompressionMode/EnsureCompressionMode
(DeflateStream.cs:387-403) and carrying SR.CannotReadFromDeflateStream /
SR.CannotWriteToDeflateStream verbatim (Strings.resx:122,125).
THE READ ROW IS THE ONE THAT MATTERED. It used to return 0 -- indistinguishable
from end-of-stream -- so a read loop over a Compress-mode stream terminated
normally having produced nothing, with no diagnostic anywhere. The Write row
already threw, but named zlib's internal Z_STREAM_ERROR ("deflate error -2") for
what is a caller mistake.
A caller that checks CanRead/CanWrite is unaffected; those properties already
reported the right answer, which is exactly why the defect was invisible.
THE ORDER IS TRANSCRIBED, NOT CHOSEN. .NET runs ValidateBufferArguments in
Read(byte[],int,int) and then ReadCore opens with EnsureDecompressionMode()
followed by EnsureNotDisposed() (DeflateStream.cs:284-309; Write is the same shape
at :531-570). So arguments, then mode, then disposed -- and a stream that is BOTH
disposed and in the wrong mode reports the MODE. One existing test asserted the
opposite for a Compress-mode Read and is updated rather than worked around.
A MUTATION PROVED THE EXCEPTION TYPE ALONE CANNOT EXPRESS THAT ORDERING.
ObjectDisposedException derives from InvalidOperationException here as it does in
.NET, so EXPECT_THROW(..., InvalidOperationException) is satisfied by BOTH orders
and the swapped-order mutation went uncaught. The message is the only
discriminator, so the message is what the test asserts. Recorded rather than
quietly fixed.
FLUSH DELIBERATELY GETS NO GUARD. .NET's Flush() opens with EnsureNotDisposed()
alone and then no-ops for a Decompress-mode stream (DeflateStream.cs:210-215).
Adding one would be a plausible-looking symmetry the reference does not have, so a
test pins its absence.
A CORRECTION MADE ON THE WAY PAST. ThrowInvalidCompressionMode's doc-comment
recorded that #2148 chose the base ArgumentException from the audit's managed probe
and that "/rv is absent here to narrow it further". /rv is present now and confirms
the choice exactly: DeflateStream.cs:99 is
`throw new ArgumentException(SR.ArgumentOutOfRange_Enum, nameof(mode))`, and
ArgumentOutOfRange_Enum is "Enum value was out of legal range." -- same type, same
message, same parameter name. The caveat is replaced by the measurement.
Two pins inverted, four cases added (IO_Compression 101 -> 103). Five mutations,
all caught -- one only after the ordering test stopped asserting a type and started
asserting a message.
Downstream, measured per SA-2 condition 5: neither cna nor mobile-eggbert
references any of the three stream types -- zero sites in both. Neither modified.
Gate: 17,304 run, 17,304 passed, 0 failed, 0 skipped across 38 executables, GREEN.
docs/Migration-CompressionStreamModeGuards.md1 parent ddbb4c9 commit 9847f9f
9 files changed
Lines changed: 314 additions & 23 deletions
File tree
- docs
- modules/io-compression
- include/System/IO/Compression
- src/System/IO/Compression
- tests
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
Lines changed: 64 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
100 | | - | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
107 | 165 | | |
108 | 166 | | |
109 | 167 | | |
| |||
Lines changed: 13 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
| |||
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
40 | 53 | | |
41 | 54 | | |
42 | 55 | | |
| |||
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
149 | 154 | | |
150 | 155 | | |
151 | 156 | | |
| |||
186 | 191 | | |
187 | 192 | | |
188 | 193 | | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
189 | 199 | | |
190 | 200 | | |
191 | 201 | | |
| |||
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
140 | 145 | | |
141 | 146 | | |
142 | 147 | | |
| |||
177 | 182 | | |
178 | 183 | | |
179 | 184 | | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
180 | 190 | | |
181 | 191 | | |
182 | 192 | | |
| |||
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
139 | 144 | | |
140 | 145 | | |
141 | 146 | | |
| |||
176 | 181 | | |
177 | 182 | | |
178 | 183 | | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
179 | 189 | | |
180 | 190 | | |
181 | 191 | | |
| |||
0 commit comments