Skip to content

Keep parent finalize alive through popup dispose failures #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmkal wants to merge 1 commit into
base: main
Choose a base branch
from
+49 −7
Open

Keep parent finalize alive through popup dispose failures #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions spec/popup.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,41 @@ test("wrapping an already-wrapped page throws", async ({ page: basePage, context
);
});

test("a failing popup plugin finalizer does not stop the parent finalizing", async ({
page: basePage,
context,
}, testInfo) => {
await routeAuthDemoApp(context);
const events: string[] = [];
const plugin: Plugin = {
name: "flaky-on-popups",
forPopup: () => ({
name: "flaky-on-popups-child",
testLifecycle: (emitter) => {
emitter.on("afterTestFinalize", () => {
throw new Error("popup teardown exploded");
});
},
}),
testLifecycle: (emitter) => {
emitter.on("afterTestFinalize", () => {
events.push("parent finalized");
});
},
};
const page = await addPlugins({ page: basePage, testInfo, plugins: [plugin] });
await page.goto("https://app.middlewright.test/");
const popupPromise = basePage.waitForEvent("popup");
await page.getByRole("button", { name: "Sign in" }).click();
await (await popupPromise).getByRole("button", { name: "Approve" }).click();
await page.getByText("Signed in as mmkal").waitFor();

// The child's failure surfaces, but only after the parent finalized — a
// popup teardown hiccup must not drop the main page's artifacts.
await expect(page[Symbol.asyncDispose]()).rejects.toThrow("popup teardown exploded");
expect(events).toEqual(["parent finalized"]);
});

test("popups: false leaves popups unwrapped", async ({ page: basePage, context }, testInfo) => {
await routeAuthDemoApp(context);
const actions: string[] = [];
Expand Down
21 changes: 14 additions & 7 deletions src/plugin-system.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,21 +287,28 @@ export const addPlugins = async <const Plugins extends readonly MaybePlugin[]>(p
page.off("popup", onPopup);
}
// Children dispose first (newest first) so their plugins can finalize --
// and, later, feed facts to parent plugins -- before the parent's own
// lifecycle events run. A failed child wrap must not stop the parent
// finalizing; it rethrows below once cleanup is done.
// and feed facts to parent plugins -- before the parent's own lifecycle
// events run. A failed child wrap OR a throwing child dispose must not
// stop the parent finalizing (that would drop the main page's artifacts);
// failures rethrow below once the parent's own teardown has run.
const childFailures: unknown[] = [];
const settledChildren = await Promise.allSettled(childWraps);
for (const result of [...settledChildren].reverse()) {
if (result.status === "fulfilled") {
if (result.status === "rejected") {
childFailures.push(result.reason);
continue;
}
try {
await result.value[Symbol.asyncDispose]();
} catch (error) {
childFailures.push(error);
}
}
await state.lifecycleEmitter.emitSerial("afterTest", { page, testInfo });
await state.lifecycleEmitter.emitSerial("afterTestFinalize", { page, testInfo });
state.lifecycleCleanups.forEach((cleanup) => cleanup());
const failedChildWrap = settledChildren.find((result) => result.status === "rejected");
if (failedChildWrap) {
throw failedChildWrap.reason;
if (childFailures.length > 0) {
throw childFailures[0];
}
};

Expand Down
Loading