From 0eb54a801ba7fbc9fba2fc1eabce620900829b1b Mon Sep 17 00:00:00 2001 From: morluto <76467478+morluto@users.noreply.github.com> Date: Wed, 18 Nov 2026 06:53:17 +0800 Subject: [PATCH] test(esp): keep distinct flash read interruption checks with smaller fixtures (#11884) --- ...lashImageArtifactReader.boundaries.test.ts | 19 - .../EspFlashImageArtifactReader.test.ts | 367 +++++++----------- 2 files changed, 148 insertions(+), 238 deletions(-) delete mode 100644 src/artifacts/EspFlashImageArtifactReader.boundaries.test.ts diff --git a/src/artifacts/EspFlashImageArtifactReader.boundaries.test.ts b/src/artifacts/EspFlashImageArtifactReader.boundaries.test.ts deleted file mode 100644 index 5c3d55a6f6..0000000000 --- a/src/artifacts/EspFlashImageArtifactReader.boundaries.test.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { artifactReaderLifecycleCases } from "../../tests/fixtures/artifactReaderLifecycle.js"; -import { - ESP32C3_BOOTLOADER_SEGMENTS, - espImage, -} from "../../tests/fixtures/espImage.js"; -import { espFlashDump } from "../domain/firmware/espFlash.fixture.js"; -import { EspFlashImageArtifactReader } from "./EspFlashImageArtifactReader.js"; - -artifactReaderLifecycleCases({ - image: () => - espFlashDump({ - bootloader: { - at: 0, - bytes: espImage({ segments: ESP32C3_BOOTLOADER_SEGMENTS }), - }, - }), - createReader: (path, admitted) => - new EspFlashImageArtifactReader(path, admitted), -}); diff --git a/src/artifacts/EspFlashImageArtifactReader.test.ts b/src/artifacts/EspFlashImageArtifactReader.test.ts index 20046ac9aa..7eedf94d29 100644 --- a/src/artifacts/EspFlashImageArtifactReader.test.ts +++ b/src/artifacts/EspFlashImageArtifactReader.test.ts @@ -26,6 +26,7 @@ import { espImage, pattern, } from "../../tests/fixtures/espImage.js"; +import { awaitAcknowledgement } from "../../tests/fixtures/lifecycleAcknowledgement.js"; import { createTestTempDirectory } from "../../tests/fixtures/temporaryDirectory.js"; import { scanCanonicalArtifactInventory } from "../../tests/fixtures/artifactInventory.js"; @@ -372,17 +373,6 @@ describe("ESP flash layout coverage and selection", () => { }); describe("ESP flash layout reader identity", () => { - it("rejects a changed carrier during extraction preparation", async () => { - const reader = new EspFlashImageArtifactReader(await writeDump(DUMP)); - try { - await expect( - reader.prepareContainer("0".repeat(64)), - ).rejects.toMatchObject({ reason: "integrity" }); - } finally { - await reader.close(); - } - }); - it("rejects forged entries and changed carrier identity, then closes idempotently", async () => { const path = await writeDump(DUMP); const reader = new EspFlashImageArtifactReader(path); @@ -413,22 +403,6 @@ describe("ESP flash layout reader identity", () => { } }); - it("settles an active entry stream when closed", async () => { - const reader = new EspFlashImageArtifactReader(await writeDump(DUMP)); - try { - const [entry] = await list(reader); - if (entry === undefined) throw new Error("Missing entry"); - const stream = await reader.open(entry); - await reader.close(); - expect(stream.destroyed).toBe(true); - await expect( - reader.entries()[Symbol.asyncIterator]().next(), - ).rejects.toMatchObject({ reason: "unavailable" }); - } finally { - await reader.close(); - } - }); - it("opens a partition past the end as the empty range at the end of the file", async () => { const cut = DUMP.subarray(0, 0x2_8000); const reader = new EspFlashImageArtifactReader(await writeDump(cut)); @@ -521,236 +495,191 @@ describe("ESP flash layout extraction and lifecycle", () => { await resourceScope.close(); } }); +}); +const multiChunkSize = 0x4_0000; + +const checkPreparationInterruption = async ( + reader: EspFlashImageArtifactReader, + action: "cancel" | "close", + stage: string, + observe: (read: () => void) => { mockRestore(): void }, +) => { + const controller = new AbortController(); + const reason = { stage }; + let acknowledge!: () => void; + const acknowledgement = new Promise((resolve) => { + acknowledge = resolve; + }); + let reads = 0; + const observer = observe(() => { + if (++reads === 1) acknowledge(); + }); + const pending = reader + .entries(controller.signal) + [Symbol.asyncIterator]() + .next(); + try { + await awaitAcknowledgement(acknowledgement, pending, stage); + const requestedAt = reads; + if (action === "cancel") controller.abort(reason); + await Promise.all([ + expect(pending).rejects.toMatchObject( + action === "cancel" + ? { reason: "cancelled", cause: reason } + : { reason: "unavailable" }, + ), + action === "close" ? reader.close() : undefined, + ]); + expect(reads).toBe(requestedAt); + await reader.close(); + await expect( + reader.entries()[Symbol.asyncIterator]().next(), + ).rejects.toMatchObject({ reason: "unavailable" }); + } finally { + try { + await reader.close(); + } finally { + await pending.catch(() => undefined); + observer.mockRestore(); + } + } +}; + +describe("ESP flash layout preparation interruption", () => { it.each(["cancel", "close"] as const)( - "settles app decoding when the caller requests %s after the first decoded chunk", + "settles app decoding on %s after a decoded chunk", async (action) => { - const large = espImage({ - segments: [{ address: 0x4038_0000, data: Buffer.alloc(8 << 20, 0x5a) }], + const appOffset = 0x1_0000; + const partitionSize = multiChunkSize + 0x1_0000; + const image = espImage({ + segments: [ + { address: 0x4038_0000, data: Buffer.alloc(multiChunkSize, 0x5a) }, + ], }); - const parts = [ - { - label: "factory", - type: 0, - subtype: 0, - offset: 0x1_0000, - size: 0x90_0000, - }, - ]; const reader = new EspFlashImageArtifactReader( await writeDump( espFlashDump({ - size: 0x91_0000, + size: appOffset + partitionSize, bootloader: { at: 0, bytes: BOOTLOADER }, - table: partitionTable(parts), - parts: [{ at: 0x1_0000, bytes: large }], + table: partitionTable([ + { + label: "factory", + type: 0, + subtype: 0, + offset: appOffset, + size: partitionSize, + }, + ]), + parts: [{ at: appOffset, bytes: image }], }), ), ); - const controller = new AbortController(); - const reason = { stage: "decoding" }; - let completion: Promise | undefined; - let decoded = 0; - let acknowledge = (): void => undefined; - const decoding = new Promise((resolve) => { - acknowledge = resolve; - }); const create = espImageDecoding.createEspImageDecoder; - // The bootloader decodes in one chunk; acknowledge the app's second chunk. - const observer = vi - .spyOn(espImageDecoding, "createEspImageDecoder") - .mockImplementation((size) => { - const decoder = create(size); - let writes = 0; - return { - write: (chunk) => { - decoder.write(chunk); - decoded += 1; - writes += 1; - if (size > 0x10_0000 && writes === 1) acknowledge(); - }, - get satisfied() { - return decoder.satisfied; - }, - finish: () => decoder.finish(), - }; - }); - try { - const pending = reader - .entries(controller.signal) - [Symbol.asyncIterator]() - .next(); - await Promise.race([ - decoding, - pending.then(() => { - throw new Error("Preparation settled before app decoding began"); - }), - ]); - const requestedAt = decoded; - if (action === "cancel") controller.abort(reason); - else completion = reader.close(); - await expect(pending).rejects.toMatchObject( - action === "cancel" - ? { reason: "cancelled", cause: reason } - : { reason: "unavailable" }, - ); - await completion; - expect(decoded).toBe(requestedAt); - await reader.close(); - await expect( - reader.entries()[Symbol.asyncIterator]().next(), - ).rejects.toMatchObject({ - reason: "unavailable", - }); - } finally { - observer.mockRestore(); - await reader.close(); - } + await checkPreparationInterruption( + reader, + action, + "app decoding", + (read) => + vi + .spyOn(espImageDecoding, "createEspImageDecoder") + .mockImplementation((size) => { + const decoder = create(size); + return { + write: (chunk) => { + decoder.write(chunk); + if (size === partitionSize) read(); + }, + get satisfied() { + return decoder.satisfied; + }, + finish: () => decoder.finish(), + }; + }), + ); }, ); -}); -describe("ESP flash layout written-bytes scan lifecycle", () => { it.each(["cancel", "close"] as const)( - "settles the written-bytes scan when the caller requests %s after its first chunk", + "settles the written-bytes scan on %s after an admitted chunk", async (action) => { - // Only the written-bytes scan reads a data partition's bytes. - const parts = [ - { - label: "storage", - type: 1, - subtype: 0x81, - offset: 0x1_0000, - size: 0x90_0000, - }, - ]; + // Only the written-bytes scan reads this data partition's bytes. + const dataOffset = 0x1_0000; const reader = new EspFlashImageArtifactReader( await writeDump( espFlashDump({ - size: 0x91_0000, + size: dataOffset + multiChunkSize, bootloader: { at: 0, bytes: BOOTLOADER }, - table: partitionTable(parts), - parts: [{ at: 0x1_0000, bytes: Buffer.alloc(0x90_0000, 0x5a) }], + table: partitionTable([ + { + label: "storage", + type: 1, + subtype: 0x81, + offset: dataOffset, + size: multiChunkSize, + }, + ]), + parts: [ + { at: dataOffset, bytes: Buffer.alloc(multiChunkSize, 0x5a) }, + ], }), ), ); - const controller = new AbortController(); - const reason = { stage: "written-bytes scan" }; - let completion: Promise | undefined; - let scanned = 0; - let acknowledge = (): void => undefined; - const scanning = new Promise((resolve) => { - acknowledge = resolve; - }); const scan = regionReads.writtenExtents; - // Count the chunks the scan examines once the reader admits them. - const observer = vi - .spyOn(regionReads, "writtenExtents") - .mockImplementation((context, regions, assertOpen) => - scan(context, regions, () => { - assertOpen(); - if (!regions.some(({ length }) => length >= 0x10_0000)) return; - scanned += 1; - if (scanned === 1) acknowledge(); - }), - ); - try { - const pending = reader - .entries(controller.signal) - [Symbol.asyncIterator]() - .next(); - await Promise.race([ - scanning, - pending.then(() => { - throw new Error("Preparation settled before the scan began"); - }), - ]); - const requestedAt = scanned; - if (action === "cancel") controller.abort(reason); - else completion = reader.close(); - await expect(pending).rejects.toMatchObject( - action === "cancel" - ? { reason: "cancelled", cause: reason } - : { reason: "unavailable" }, - ); - await completion; - expect(scanned).toBe(requestedAt); - await reader.close(); - await expect( - reader.entries()[Symbol.asyncIterator]().next(), - ).rejects.toMatchObject({ - reason: "unavailable", - }); - } finally { - observer.mockRestore(); - await reader.close(); - } + await checkPreparationInterruption( + reader, + action, + "written-bytes scan", + (read) => + vi + .spyOn(regionReads, "writtenExtents") + .mockImplementation((context, regions, assertOpen) => + scan(context, regions, () => { + assertOpen(); + read(); + }), + ), + ); }, ); -}); -describe("ESP flash layout erased-gap scan lifecycle", () => { it.each(["cancel", "close"] as const)( - "settles the erased-gap scan when the caller requests %s after its first chunk", + "settles the erased-gap scan on %s after an admitted chunk", async (action) => { - // One small partition leaves the rest of a 9 MiB dump as one erased gap. - const parts = [ - { label: "nvs", type: 1, subtype: 2, offset: 0x9000, size: 0x1000 }, - ]; + const gapStart = 0xa000; const reader = new EspFlashImageArtifactReader( await writeDump( espFlashDump({ - size: 0x90_0000, + size: gapStart + multiChunkSize, bootloader: { at: 0, bytes: BOOTLOADER }, - table: partitionTable(parts), + table: partitionTable([ + { + label: "nvs", + type: 1, + subtype: 2, + offset: 0x9000, + size: 0x1000, + }, + ]), }), ), ); - const controller = new AbortController(); - const reason = { stage: "erased-gap scan" }; - let completion: Promise | undefined; - let scanned = 0; - let acknowledge = (): void => undefined; - const scanning = new Promise((resolve) => { - acknowledge = resolve; - }); const scan = regionReads.firstUnerasedInRange; - // Count the chunks the scan examines once the reader admits them. - const observer = vi - .spyOn(regionReads, "firstUnerasedInRange") - .mockImplementation((context, range, assertOpen) => - scan(context, range, () => { - assertOpen(); - if (range.length < 0x10_0000) return; - scanned += 1; - if (scanned === 1) acknowledge(); - }), - ); - try { - const pending = reader - .entries(controller.signal) - [Symbol.asyncIterator]() - .next(); - await Promise.race([ - scanning, - pending.then(() => { - throw new Error("Preparation settled before the scan began"); - }), - ]); - const requestedAt = scanned; - if (action === "cancel") controller.abort(reason); - else completion = reader.close(); - await expect(pending).rejects.toMatchObject( - action === "cancel" - ? { reason: "cancelled", cause: reason } - : { reason: "unavailable" }, - ); - await completion; - expect(scanned).toBe(requestedAt); - } finally { - observer.mockRestore(); - await reader.close(); - } + await checkPreparationInterruption( + reader, + action, + "erased-gap scan", + (read) => + vi + .spyOn(regionReads, "firstUnerasedInRange") + .mockImplementation((context, range, assertOpen) => + scan(context, range, () => { + assertOpen(); + if (range.start === gapStart && range.length === multiChunkSize) + read(); + }), + ), + ); }, ); });