Skip to content

Changelog

Release notes and version history for Stepwright and Fixwright packages.

Versioning

Both packages follow Semantic Versioning:

  • Major (X.0.0): Breaking changes
  • Minor (0.X.0): New features, backward compatible
  • Patch (0.0.X): Bug fixes, backward compatible

@autowright/stepwright

v0.1.3 (Current)

Released: January 2025

Package renamed to @autowright/stepwright scope and integrated with improved Fixwright capabilities.

Changes

  • Package rename: Renamed from stepwright to @autowright/stepwright
  • Export improvements: Export sinks module for external consumption
  • Error sink system: Added error sink system for failure case routing
  • Event bus integration: Integrated with shared event bus for inter-service communication

v0.1.2

Released: January 2025

Added error routing capabilities and improved artifact handling.

Features

  • Error sinks: Route failure cases to external destinations (file, API, S3)
  • Event bus: Inter-service communication for Stepwright/Fixwright integration
  • Improved reporters: JSONReporter now uses run directory by default
  • Video/trace overrides: Configure custom directories for video and trace output

v0.1.1

Released: December 2024

Added recording capabilities and bug fixes.

Features

  • Video recording: Record script execution for debugging
  • Trace recording: Capture Playwright traces for debugging
  • Video/trace directory overrides: Configure custom output directories

Bug Fixes

  • Fixed type errors in website components
  • Improved sidebar configuration for documentation

v0.1.0 (Initial Release)

Released: December 2024

The first release of Stepwright, a fluent API for building structured browser automation scripts.

Features

  • Fluent API: Chain-based script building with .step(), .checkpoint(), and .config()
  • Type-safe data: Generic type parameter for script data with full TypeScript support
  • Checkpoints: Group related steps with retry boundaries
  • Artifacts: Automatic screenshot, DOM, and console capture on failure
  • Multiple reporters: Console, JSON, and custom reporter support
  • CLI: Command line interface for running scripts
  • Browser support: Chromium, Firefox, and WebKit via Playwright

API

import { Stepwright } from '@autowright/stepwright';
const script = Stepwright.create<MyData>('Script Name')
.config({ headless: true })
.data({ key: 'value' })
.checkpoint('Section')
.step('Step 1', async (ctx) => { /* ... */ })
.step('Step 2', async (ctx) => { /* ... */ })
.endCheckpoint()
.run();

@autowright/fixwright

v0.1.3 (Current)

Released: January 2025

Package renamed to @autowright/fixwright scope with AgentFixer integration.

Changes

  • Package rename: Renamed from fixwright to @autowright/fixwright
  • AgentFixer integration: Integrated AgentFixer into FixwrightService pipeline
  • New module exports: Export deduplication, state, sources, and notifications modules

v0.1.2

Released: January 2025

Major feature release with orchestration and monitoring capabilities.

Features

  • FixwrightService: Orchestrated failure processing pipeline
  • Notification system: Get notified about fix status updates (Slack, webhook)
  • Error source system: Ingest failures from multiple sources (file, S3, SQS)
  • Deduplication: Fingerprinting system to avoid duplicate fix attempts
  • State management: Track failure status through the fix lifecycle
  • Event-driven architecture: Subscribe to fix lifecycle events

v0.1.1

Released: December 2024

Documentation and API improvements.

Changes

  • Updated README with accurate API documentation
  • Improved examples for new Stepwright/Fixwright APIs
  • Architecture documentation updates

v0.1.0 (Initial Release)

Released: December 2024

The first release of Fixwright, AI-powered automatic fixing for failing Stepwright scripts.

Features

  • Claude Agent SDK integration: Uses Claude for intelligent script analysis and fixing
  • Automatic retry: AI attempts fixes until success or max attempts reached
  • Git integration: Create branches and commits for fixes
  • PR creation: Automatically create GitHub Pull Requests
  • File source: Watch directories for failure cases
  • Backup support: Automatic backup before modifying files

API

import { FixingLoop, FileFailureSource } from '@autowright/fixwright';
const source = new FileFailureSource('./failure-cases');
const fixingLoop = new FixingLoop({
ai: { apiKey: process.env.ANTHROPIC_API_KEY! },
fixing: { maxAttempts: 3 },
git: { baseBranch: 'main' },
workDir: process.cwd(),
}, source);
fixingLoop.on('attempt:success', (attempt) => {
console.log('Fixed:', attempt.proposedFix?.explanation);
});
await fixingLoop.start();

Upcoming Features

Planned for v0.2.0

  • Parallel step execution: Run independent steps concurrently
  • Step dependencies: Define step prerequisites
  • Custom assertions: Built-in assertion helpers
  • Improved error messages: More actionable failure information
  • Plugin system: Extend functionality via plugins

Planned for v0.3.0

  • Visual regression testing: Compare screenshots across runs
  • Network mocking: Intercept and mock API responses
  • Performance metrics: Capture timing and performance data
  • Distributed execution: Run scripts across multiple machines

Migration Guides

Migrating from Raw Playwright

If you’re migrating from raw Playwright scripts to Stepwright:

// Before: Raw Playwright
import { chromium } from 'playwright';
const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
await page.fill('#email', 'test@example.com');
await page.click('#submit');
await browser.close();
// After: Stepwright
import { Stepwright } from '@autowright/stepwright';
const script = Stepwright.create('Example')
.step('Navigate', async (ctx) => {
await ctx.page.goto('https://example.com');
})
.step('Fill form', async (ctx) => {
await ctx.page.fill('#email', 'test@example.com');
})
.step('Submit', async (ctx) => {
await ctx.page.click('#submit');
});
await script.run();

Benefits of migration:

  1. Automatic browser management
  2. Step-by-step failure tracking
  3. Artifact capture on failure
  4. Retry capabilities
  5. Structured reporting

Deprecation Policy

  • Deprecated features are marked in documentation
  • Deprecated features remain for at least one minor version
  • Breaking changes are only introduced in major versions
  • Migration guides are provided for breaking changes

Reporting Issues

Found a bug or have a feature request?

  1. Check existing issues
  2. Create a new issue with:
    • Package version
    • Node.js version
    • Operating system
    • Reproduction steps
    • Expected vs actual behavior

Contributing

We welcome contributions! See our contributing guide for:

  • Development setup
  • Code style guidelines
  • Pull request process
  • Testing requirements

License

Both packages are released under the MIT License.

MIT License
Copyright (c) 2024 Korvol
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Next Steps