craftdriver 1.1.1 → 1.3.0

package/skills/craftdriver/cheatsheet.md

@@ -12,7 +12,8 @@ import { Browser } from 'craftdriver';
 const browser = await Browser.launch({
   browserName: 'chrome',   // 'chrome' | 'chromium' | 'firefox'
   headless: true,
-  enableBiDi: true,        // required for network / logs / tracing / init scripts
+  // enableBiDi defaults to true — network / logs / tracing / init scripts
+  // all need it, so only set enableBiDi: false if you must disable it.
 });
 try {
   await browser.navigateTo('https://example.com');
@@ -158,8 +159,10 @@ const download = await browser.waitForDownload(() => browser.click('#download'))
 ```ts
 await browser.screenshot({ path: 'out.png', fullPage: true });
 
-await browser.startTrace({ outDir: './artefacts/run' });
-try { /* ... */ } finally { await browser.stopTrace(); }
+await browser.startTrace({ outDir: './artefacts/run', title: 'Smoke flow' });
+try { /* ... */ } finally {
+  await browser.stopTrace({ path: './artefacts/run.zip' }); // player.vibium.dev
+}
 ```
 
 ## Accessibility

package/skills/craftdriver/patterns.md

@@ -6,7 +6,7 @@ Worked recipes. Each is ≤ ~200 tokens; load on demand from
 ## 1. Login, save storage state for reuse
 
 ```ts
-const browser = await Browser.launch({ enableBiDi: true });
+const browser = await Browser.launch();
 await browser.navigateTo('https://app.example.com/login');
 await browser.locator(By.labelText('Email')).fill('jane@example.com');
 await browser.locator(By.labelText('Password')).fill(process.env.PW!);
@@ -23,10 +23,7 @@ await browser.quit();
 
 ```ts
 const state = JSON.parse(await fs.readFile('.auth/state.json', 'utf8'));
-const browser = await Browser.launch({
-  enableBiDi: true,
-  storageState: state,
-});
+const browser = await Browser.launch({ storageState: state });
 await browser.navigateTo('https://app.example.com/dashboard');
 await browser.locator(By.testId('dashboard')).expect().toBeVisible();
 ```
@@ -63,6 +60,7 @@ const due = await row.locator('[data-col=due]').text();
 ```ts
 await browser.startTrace({
   outDir: './artefacts/checkout-fail',
+  title: 'Checkout failure',
   screenshots: 'auto',
   network: true,
   console: true,
@@ -73,7 +71,7 @@ try {
   // Trace lands on disk regardless — thrown expects never lose data.
   throw e;
 } finally {
-  await browser.stopTrace();
+  await browser.stopTrace({ path: './artefacts/checkout-fail.zip' });
 }
 ```
 

package/docs/recipes/trace-failing-test.md

@@ -1,51 +0,0 @@
-# Capture Failure Evidence With Tracing
-
-When a complex or occasionally-flaky test fails, the message alone rarely tells
-you why. A trace records the actions, navigation, console output, JavaScript
-errors, network events, and screenshots so you can replay what happened. Wrap
-the flow in a helper that starts a trace, keeps it on failure, and always stops
-it. This recipe traces a sign-in against the live
-[login example](https://dtopuzov.github.io/craftdriver/examples/login.html).
-
-The `try/catch` here is deliberate — it is what keeps the trace directory when
-the flow throws.
-
-```ts
-async function withTrace(name: string, run: () => Promise<void>) {
-  const outDir = `./traces/${name}-${Date.now()}`;
-  await browser.startTrace({ outDir });
-
-  try {
-    await run();
-  } catch (error) {
-    console.error(`Trace kept at ${outDir}`);
-    throw error;
-  } finally {
-    await browser.stopTrace().catch(() => undefined);
-  }
-}
-
-await withTrace('login', async () => {
-  await browser.navigateTo('https://dtopuzov.github.io/craftdriver/examples/login.html');
-  await browser.getByLabel('Username').fill('alice');
-  await browser.getByLabel('Password').fill('secret');
-  await browser.getByRole('button', { name: 'Sign in' }).click();
-  await browser.expect('#welcome').toContainText('Welcome back, alice!');
-});
-```
-
-## Notes
-
-- The trace file is NDJSON, so it stays useful even if the test throws before `stopTrace()`.
-- Screenshots are stored under the trace directory.
-- For high-volume suites, turn screenshots off unless a test is under investigation:
-
-```ts
-await browser.startTrace({ outDir: './traces/smoke', screenshots: 'off' });
-```
-
-## Learn More
-
-- [Tracing](../tracing.md)
-- [Screenshots](../screenshots.md)
-- [Console Logs And JavaScript Errors](../browser-logs.md)