Skip to content

Commit d899055

Browse files
committed
fix: normalize corrupt-data errors across inflate backends
1 parent 6955814 commit d899055

9 files changed

Lines changed: 110 additions & 30 deletions

‎__tests__/test-browserInflate.js‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/* eslint-env node, browser, jasmine */
2+
/* global DecompressionStream */
3+
import pako from 'pako'
4+
5+
import { browserInflate } from '../src/utils/browserInflate.js'
6+
7+
import { corruptZlibCases } from './__helpers__/corruptZlib.js'
8+
9+
const describeNative =
10+
typeof DecompressionStream === 'function' &&
11+
typeof Blob === 'function' &&
12+
typeof Blob.prototype.stream === 'function' &&
13+
typeof Response === 'function'
14+
? describe
15+
: xdescribe
16+
17+
describeNative('browserInflate', () => {
18+
it('inflates valid binary data', async () => {
19+
const bytes = Uint8Array.from([0, 1, 127, 128, 255])
20+
expect(await browserInflate(pako.deflate(bytes))).toEqual(bytes)
21+
})
22+
23+
it('inflates a valid empty stream', async () => {
24+
const bytes = new Uint8Array(0)
25+
expect(await browserInflate(pako.deflate(bytes))).toEqual(bytes)
26+
})
27+
28+
for (const [name, bytes] of corruptZlibCases) {
29+
it(`reports ${name} compressed data with a nonempty error`, async () => {
30+
let error = null
31+
try {
32+
await browserInflate(Uint8Array.from(bytes))
33+
} catch (err) {
34+
error = err
35+
}
36+
// Native stream errors can originate outside Jest's VM realm.
37+
expect(Object.prototype.toString.call(error)).toBe('[object Error]')
38+
expect(error.message.length).toBeGreaterThan(0)
39+
expect(error.message).not.toMatch(/internal error|file an issue/)
40+
})
41+
}
42+
43+
for (const original of [
44+
new TypeError(''),
45+
new TypeError('native diagnostic'),
46+
]) {
47+
it(`handles an asynchronous TypeError with message "${original.message}"`, async () => {
48+
const arrayBuffer = Response.prototype.arrayBuffer
49+
Response.prototype.arrayBuffer = async function () {
50+
await arrayBuffer.call(this)
51+
throw original
52+
}
53+
let error = null
54+
try {
55+
await browserInflate(pako.deflate(Uint8Array.from([1, 2, 3])))
56+
} catch (err) {
57+
error = err
58+
} finally {
59+
Response.prototype.arrayBuffer = arrayBuffer
60+
}
61+
if (original.message) {
62+
expect(error).toBe(original)
63+
} else {
64+
expect(error.message).toBe(
65+
'Invalid compressed buffer: decompression failed'
66+
)
67+
}
68+
})
69+
}
70+
})

‎__tests__/test-inflate.js‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/* eslint-env node, browser, jasmine */
22
import pako from 'pako'
33

4-
import { InternalError } from '../src/errors/InternalError.js'
54
import { inflate } from '../src/utils/inflate.js'
65

76
import { corruptZlibCases } from './__helpers__/corruptZlib.js'
@@ -41,12 +40,10 @@ describe('inflate', () => {
4140
} catch (err) {
4241
error = err
4342
}
44-
expect(error instanceof InternalError).toBe(true)
45-
expect(error.data.message).toMatch(/^Invalid compressed buffer: .+/)
46-
const serialized = error.toJSON()
47-
expect(serialized.code).toBe('InternalError')
48-
expect(serialized.data).toEqual(error.data)
49-
expect(error.fromJSON(serialized).toJSON()).toEqual(serialized)
43+
expect(error instanceof Error).toBe(true)
44+
expect(error.name).toBe('Error')
45+
expect(error.message).toMatch(/^Invalid compressed buffer: .+/)
46+
expect(error.message).not.toMatch(/internal error|file an issue/)
5047
})
5148
}
5249
})

‎__tests__/test-readObject-in-submodule.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -658,9 +658,10 @@ describe('readObject', () => {
658658
} catch (err) {
659659
error = err
660660
}
661-
expect(error instanceof Errors.InternalError).toBe(true)
661+
expect(error instanceof Error).toBe(true)
662+
expect(error.name).toBe('Error')
662663
expect(error.caller).toBe('git.readObject')
663-
expect(error.data.message).toMatch(/^Invalid compressed buffer: .+/)
664+
expect(error.message).toMatch(/^Invalid compressed buffer: .+/)
664665
}
665666
const raw = await readObject({ fs, gitdir, oid, format: 'deflated' })
666667
expect(raw.format).toBe('deflated')

‎__tests__/test-readObject.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -656,9 +656,10 @@ describe('readObject', () => {
656656
} catch (err) {
657657
error = err
658658
}
659-
expect(error instanceof Errors.InternalError).toBe(true)
659+
expect(error instanceof Error).toBe(true)
660+
expect(error.name).toBe('Error')
660661
expect(error.caller).toBe('git.readObject')
661-
expect(error.data.message).toMatch(/^Invalid compressed buffer: .+/)
662+
expect(error.message).toMatch(/^Invalid compressed buffer: .+/)
662663
}
663664
const raw = await readObject({ fs, gitdir, oid, format: 'deflated' })
664665
expect(raw.format).toBe('deflated')

‎__tests__/test-readTree-in-submodule.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -595,9 +595,10 @@ describe('readTree', () => {
595595
} catch (err) {
596596
error = err
597597
}
598-
expect(error instanceof Errors.InternalError).toBe(true)
598+
expect(error instanceof Error).toBe(true)
599+
expect(error.name).toBe('Error')
599600
expect(error.caller).toBe('git.readTree')
600-
expect(error.data.message).toMatch(/^Invalid compressed buffer: .+/)
601+
expect(error.message).toMatch(/^Invalid compressed buffer: .+/)
601602
})
602603
}
603604
})

‎__tests__/test-readTree.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -593,9 +593,10 @@ describe('readTree', () => {
593593
} catch (err) {
594594
error = err
595595
}
596-
expect(error instanceof Errors.InternalError).toBe(true)
596+
expect(error instanceof Error).toBe(true)
597+
expect(error.name).toBe('Error')
597598
expect(error.caller).toBe('git.readTree')
598-
expect(error.data.message).toMatch(/^Invalid compressed buffer: .+/)
599+
expect(error.message).toMatch(/^Invalid compressed buffer: .+/)
599600
})
600601
}
601602
})

‎src/errors/BaseError.js‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ export class BaseError extends Error {
88

99
toJSON() {
1010
// Error objects aren't normally serializable. So we do something about that.
11-
const metadata = /** @type {any} */ (this)
1211
return {
13-
code: metadata.code,
14-
data: metadata.data,
12+
code: this.code,
13+
data: this.data,
1514
caller: this.caller,
1615
message: this.message,
1716
stack: this.stack,
@@ -20,9 +19,8 @@ export class BaseError extends Error {
2019

2120
fromJSON(json) {
2221
const e = new BaseError(json.message)
23-
const metadata = /** @type {any} */ (e)
24-
metadata.code = json.code
25-
metadata.data = json.data
22+
e.code = json.code
23+
e.data = json.data
2624
e.caller = json.caller
2725
e.stack = json.stack
2826
return e

‎src/utils/browserInflate.js‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/* eslint-env node, browser */
2+
/* global DecompressionStream */
3+
4+
export async function browserInflate(buffer) {
5+
const ds = new DecompressionStream('deflate')
6+
const d = new Blob([buffer]).stream().pipeThrough(ds)
7+
try {
8+
return new Uint8Array(await new Response(d).arrayBuffer())
9+
} catch (err) {
10+
// Some native implementations reject corrupt data with an empty TypeError.
11+
if (err && err.name === 'TypeError' && err.message === '') {
12+
throw new Error('Invalid compressed buffer: decompression failed')
13+
}
14+
throw err
15+
}
16+
}

‎src/utils/inflate.js‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
/* global DecompressionStream */
33
import pako from 'pako'
44

5-
import { InternalError } from '../errors/InternalError.js'
5+
import { browserInflate } from './browserInflate.js'
66

77
let supportsDecompressionStream = false
88

@@ -12,22 +12,17 @@ export async function inflate(buffer) {
1212
}
1313
try {
1414
return supportsDecompressionStream
15-
? browserInflate(buffer)
15+
? await browserInflate(buffer)
1616
: pako.inflate(buffer)
1717
} catch (err) {
1818
if (typeof err === 'string') {
19-
throw new InternalError(`Invalid compressed buffer: ${err}`)
19+
// Pako throws strings for corrupt data; preserve existing Error objects.
20+
throw new Error(`Invalid compressed buffer: ${err}`)
2021
}
2122
throw err
2223
}
2324
}
2425

25-
async function browserInflate(buffer) {
26-
const ds = new DecompressionStream('deflate')
27-
const d = new Blob([buffer]).stream().pipeThrough(ds)
28-
return new Uint8Array(await new Response(d).arrayBuffer())
29-
}
30-
3126
function testDecompressionStream() {
3227
try {
3328
const ds = new DecompressionStream('deflate')

0 commit comments

Comments
 (0)