|
| 1 | +# @wdio/image-comparison-core |
| 2 | + |
| 3 | +## 1.0.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- 1326e99: ## 💥 Major Release: New @wdio/image-comparison-core Package |
| 8 | + |
| 9 | + ### 🏗️ Architectural Refactor |
| 10 | + |
| 11 | + This release introduces a **completely new core architecture** with the dedicated `@wdio/image-comparison-core` package, replacing the generic `webdriver-image-comparison` module with a WDIO-specific solution. |
| 12 | + |
| 13 | + #### What was the problem? |
| 14 | + |
| 15 | + - The old `webdriver-image-comparison` package was designed for generic webdriver usage |
| 16 | + - Complex integration between generic and WDIO-specific code |
| 17 | + - Limited test coverage (~58%) making maintenance difficult |
| 18 | + - Mixed responsibilities between core logic and service integration |
| 19 | + |
| 20 | + #### What changed? |
| 21 | + |
| 22 | + ✅ **New dedicated core package**: `@wdio/image-comparison-core` - purpose-built for WebdriverIO |
| 23 | + ✅ **Cleaner architecture**: Modular design with clear separation of concerns |
| 24 | + ✅ **Enhanced test coverage**: Improved from ~58% to ~90% across all metrics |
| 25 | + ✅ **Better maintainability**: Organized codebase with comprehensive TypeScript interfaces |
| 26 | + ✅ **WDIO-specific dependencies**: Only depends on `@wdio/logger`, `@wdio/types`, etc. |
| 27 | + |
| 28 | + ### 🧪 Testing Improvements |
| 29 | + |
| 30 | + - **100% branch coverage** on critical decision points |
| 31 | + - **Comprehensive unit tests** for all major functions |
| 32 | + - **Optimized mocks** for complex scenarios |
| 33 | + - **Better test isolation** and reliability |
| 34 | + |
| 35 | + | Before/After | % Stmts | % Branch | % Funcs | % Lines | |
| 36 | + | ------------------ | ------- | -------- | ------- | ------- | |
| 37 | + | **Previous** | 58.59 | 91.4 | 80.71 | 58.59 | |
| 38 | + | **After refactor** | 90.55 | 96.38 | 93.99 | 90.55 | |
| 39 | + |
| 40 | + ### 🔧 Service Integration |
| 41 | + |
| 42 | + The `@wdio/visual-service` now imports from the new `@wdio/image-comparison-core` package while maintaining the same public API and functionality for users. |
| 43 | + |
| 44 | + ### 📈 Performance & Quality |
| 45 | + |
| 46 | + - **Modular architecture**: Easier to maintain and extend |
| 47 | + - **Type safety**: Comprehensive TypeScript coverage |
| 48 | + - **Clean exports**: Well-defined public API |
| 49 | + - **Internal interfaces**: Proper separation of concerns |
| 50 | + |
| 51 | + ### 🔄 Backward Compatibility |
| 52 | + |
| 53 | + ✅ **No breaking changes** for end users |
| 54 | + ✅ **Same public API** maintained |
| 55 | + ✅ **Existing configurations** continue to work |
| 56 | + ✅ **All existing functionality** preserved |
| 57 | + |
| 58 | + ### 🎯 Future Benefits |
| 59 | + |
| 60 | + This refactor sets the foundation for: |
| 61 | + |
| 62 | + - Easier addition of new features |
| 63 | + - Better bug fixing capabilities |
| 64 | + - Enhanced mobile and native app support |
| 65 | + - More reliable MultiRemote functionality |
| 66 | + |
| 67 | + ### 📦 Dependency Updates |
| 68 | + |
| 69 | + - Updated most dependencies to their latest versions |
| 70 | + - Improved security with latest package versions |
| 71 | + - Better compatibility with current WebdriverIO ecosystem |
| 72 | + - Enhanced performance through updated dependencies |
| 73 | + - Remove unused packages |
| 74 | + |
| 75 | + *** |
| 76 | + |
| 77 | + **Note**: This is an architectural improvement that modernizes the codebase while maintaining full backward compatibility. All existing functionality remains unchanged for users. |
| 78 | + |
| 79 | + *** |
| 80 | + ## Committers: 1 |
| 81 | + |
| 82 | + - Wim Selles ([@wswebcreation](https://github.com/wswebcreation)) |
0 commit comments