From 72ed12e4b296f6169c41f656fa37e4cc67cd37c5 Mon Sep 17 00:00:00 2001 From: Matt Miller Date: Tue, 1 Sep 2026 20:16:26 -0700 Subject: [PATCH] refactor: relocate readFileAsArrayBuffer to src/utils/fileUtil readFileAsArrayBuffer is a generic File -> ArrayBuffer wrapper with no metadata coupling, so living under src/scripts/metadata/ mis-signalled its domain and invited either duplication or an upward import from a non-metadata feature. Move readFile.ts to src/utils/fileUtil.ts alongside jsonUtil.ts (module content unchanged), move its test with it, and point the five metadata parsers at @/utils/fileUtil. No behavior change. The moved test also drops its non-null assertions: readFileAsArrayBuffer returns ArrayBuffer | null and expect().toBeInstanceOf does not narrow, so buffer! turned a regressed null return into an opaque TypeError instead of a failed assertion. assert(buffer instanceof ArrayBuffer) narrows and fails loudly. The capped-read case now seeds distinct bytes and compares contents rather than only byteLength, and the non-ArrayBuffer result branch gained coverage. --- src/scripts/metadata/avif.ts | 3 +- src/scripts/metadata/ebml.ts | 3 +- src/scripts/metadata/flac.ts | 2 +- src/scripts/metadata/gltf.ts | 3 +- src/scripts/metadata/isobmff.ts | 3 +- .../fileUtil.test.ts} | 29 ++++++++++++------- .../readFile.ts => utils/fileUtil.ts} | 0 7 files changed, 24 insertions(+), 19 deletions(-) rename src/{scripts/metadata/readFile.test.ts => utils/fileUtil.test.ts} (55%) rename src/{scripts/metadata/readFile.ts => utils/fileUtil.ts} (100%) diff --git a/src/scripts/metadata/avif.ts b/src/scripts/metadata/avif.ts index 785e5f369d1..a166c56a125 100644 --- a/src/scripts/metadata/avif.ts +++ b/src/scripts/metadata/avif.ts @@ -10,10 +10,9 @@ import { ComfyMetadataTags, type IsobmffBoxContentRange } from '@/types/metadataTypes' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' import { parseJsonWithNonFinite } from '@/utils/jsonUtil' -import { readFileAsArrayBuffer } from './readFile' - const readNullTerminatedString = ( dataView: DataView, start: number, diff --git a/src/scripts/metadata/ebml.ts b/src/scripts/metadata/ebml.ts index 0880cc4765a..ee6c16e5523 100644 --- a/src/scripts/metadata/ebml.ts +++ b/src/scripts/metadata/ebml.ts @@ -10,10 +10,9 @@ import { type TextRange, type VInt } from '@/types/metadataTypes' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' import { parseJsonWithNonFinite } from '@/utils/jsonUtil' -import { readFileAsArrayBuffer } from './readFile' - const WEBM_SIGNATURE = [0x1a, 0x45, 0xdf, 0xa3] const MAX_READ_BYTES = 2 * 1024 * 1024 const EBML_ID = { diff --git a/src/scripts/metadata/flac.ts b/src/scripts/metadata/flac.ts index fae7f374d9e..818e3e1c7bc 100644 --- a/src/scripts/metadata/flac.ts +++ b/src/scripts/metadata/flac.ts @@ -1,4 +1,4 @@ -import { readFileAsArrayBuffer } from './readFile' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' export function getFromFlacBuffer(buffer: ArrayBuffer): Record { const dataView = new DataView(buffer) diff --git a/src/scripts/metadata/gltf.ts b/src/scripts/metadata/gltf.ts index 95484a6d869..0655d63dcbb 100644 --- a/src/scripts/metadata/gltf.ts +++ b/src/scripts/metadata/gltf.ts @@ -11,10 +11,9 @@ import { type GltfJsonData, GltfSizeBytes } from '@/types/metadataTypes' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' import { parseJsonWithNonFinite } from '@/utils/jsonUtil' -import { readFileAsArrayBuffer } from './readFile' - const MAX_READ_BYTES = 1 << 20 const isJsonChunk = (chunk: GltfChunkHeader | null): boolean => diff --git a/src/scripts/metadata/isobmff.ts b/src/scripts/metadata/isobmff.ts index bec78684665..e118d892747 100644 --- a/src/scripts/metadata/isobmff.ts +++ b/src/scripts/metadata/isobmff.ts @@ -8,10 +8,9 @@ import { ComfyMetadataTags, type IsobmffBoxContentRange } from '@/types/metadataTypes' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' import { parseJsonWithNonFinite } from '@/utils/jsonUtil' -import { readFileAsArrayBuffer } from './readFile' - // Set max read high, as atoms are stored near end of file // while search is made to be efficient. const MAX_READ_BYTES = 64 * 1024 * 1024 diff --git a/src/scripts/metadata/readFile.test.ts b/src/utils/fileUtil.test.ts similarity index 55% rename from src/scripts/metadata/readFile.test.ts rename to src/utils/fileUtil.test.ts index 91fdbe44e27..d65c3ea45b5 100644 --- a/src/scripts/metadata/readFile.test.ts +++ b/src/utils/fileUtil.test.ts @@ -1,10 +1,11 @@ -import { describe, expect, it } from 'vitest' +import { assert, describe, expect, it } from 'vitest' import { mockFileReaderAbort, - mockFileReaderError -} from './__fixtures__/helpers' -import { readFileAsArrayBuffer } from './readFile' + mockFileReaderError, + mockFileReaderResult +} from '@/scripts/metadata/__fixtures__/helpers' +import { readFileAsArrayBuffer } from '@/utils/fileUtil' describe('readFileAsArrayBuffer', () => { it('reads the whole file into an ArrayBuffer when no cap is given', async () => { @@ -13,16 +14,18 @@ describe('readFileAsArrayBuffer', () => { const buffer = await readFileAsArrayBuffer(file) - expect(buffer).toBeInstanceOf(ArrayBuffer) - expect(new Uint8Array(buffer!)).toEqual(bytes) + assert(buffer instanceof ArrayBuffer) + expect(new Uint8Array(buffer)).toEqual(bytes) }) it('reads only the first maxBytes when a cap is given', async () => { - const file = new File([new Uint8Array(100)], 'test.bin') + const bytes = Uint8Array.from({ length: 100 }, (_, i) => i) + const file = new File([bytes], 'test.bin') const buffer = await readFileAsArrayBuffer(file, 10) - expect(buffer?.byteLength).toBe(10) + assert(buffer instanceof ArrayBuffer) + expect(new Uint8Array(buffer)).toEqual(bytes.slice(0, 10)) }) it('returns an empty ArrayBuffer (not null) when maxBytes is 0', async () => { @@ -30,8 +33,14 @@ describe('readFileAsArrayBuffer', () => { const buffer = await readFileAsArrayBuffer(file, 0) - expect(buffer).toBeInstanceOf(ArrayBuffer) - expect(buffer?.byteLength).toBe(0) + assert(buffer instanceof ArrayBuffer) + expect(buffer.byteLength).toBe(0) + }) + + it('resolves null when the read yields a non-ArrayBuffer result', async () => { + mockFileReaderResult('readAsArrayBuffer', 'not an array buffer') + + expect(await readFileAsArrayBuffer(new File([], 'test.bin'))).toBeNull() }) it('resolves null when the read fires an error', async () => { diff --git a/src/scripts/metadata/readFile.ts b/src/utils/fileUtil.ts similarity index 100% rename from src/scripts/metadata/readFile.ts rename to src/utils/fileUtil.ts