Skip to content

Commit 90095e7

Browse files
github-actions[bot]wdio-bot
github-actions[bot]
and
wdio-bot
authored
chore: release [skip ci] (#383)
Co-authored-by: WebdriverIO Release Bot <[email protected]>
1 parent 66b9f11 commit 90095e7

File tree

5 files changed

+109
-55
lines changed

5 files changed

+109
-55
lines changed

‎.changeset/two-geckos-sit.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

‎packages/visual-service/CHANGELOG.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,67 @@
11
# @wdio/visual-service
22

3+
## 5.0.0
4+
5+
### Major Changes
6+
7+
- 66b9f11: # 💥 Breaking
8+
9+
This PR replaces Canvas as a dependency with Jimp. This removes the need to use system dependencies and will reduce the number of system dependency errors/issues (node-gyp/canvas and so on). This will, in the end, make the life of our end users way easier due to:
10+
11+
- less errors
12+
- less complex test environments
13+
14+
> [!note]
15+
> Extensive research has been done and we have chosen to "fork" ResembleJS, adjust it by making use of Jimp instead of Canvas and break the browser API because the fork will only be used in a nodejs environment
16+
> Investigation showed that creating a wrapper would even make it slower, so we went for the breaking change in the API by just replacing Canvas with Jimp
17+
18+
> [!important]
19+
> There is a performance impact where Canvas is around 70% faster than Jimp. This has been measured without using WebdriverIO and only comparing images. When the "old" implementation with WebdriverIO combined with Canvas or Jimp is compared, we hardly see a performance impact.
20+
21+
# 🚀 New Features
22+
23+
Update the baseline images through the command line by adding the argument `--update-visual-baseline`. This will
24+
25+
- automatically copy the actual take screenshot and put it in the baseline folder
26+
- if there are differences it will let the test pass because the baseline has been updated
27+
28+
**Usage:**
29+
30+
```sh
31+
npm run test.local.desktop --update-visual-baseline
32+
```
33+
34+
When running logs info/debug mode you will see the following logs added
35+
36+
```logs
37+
[0-0] ..............
38+
[0-0] #####################################################################################
39+
[0-0] INFO:
40+
[0-0] Updated the actual image to
41+
[0-0] /Users/wswebcreation/Git/wdio/visual-testing/localBaseline/chromel/demo-chrome-1366x768.png
42+
[0-0] #####################################################################################
43+
[0-0] ..........
44+
```
45+
46+
# 💅 Polish
47+
48+
- remove Vitest fix
49+
- add app images
50+
- update the build
51+
52+
### Patch Changes
53+
54+
- Updated dependencies [66b9f11]
55+
- [email protected]
56+
357
## 4.1.3
458

559
### Patch Changes
660

7-
# 🐛 Bug Fixes
61+
# 🐛 Bug Fixes
862

9-
- Fixes https://github.com/webdriverio/visual-testing/issues/286
10-
- Fixes https://github.com/webdriverio/visual-testing/issues/333
63+
- Fixes https://github.com/webdriverio/visual-testing/issues/286
64+
- Fixes https://github.com/webdriverio/visual-testing/issues/333
1165

1266
## 4.1.2
1367

‎packages/visual-service/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@wdio/visual-service",
33
"author": "Wim Selles - wswebcreation",
44
"description": "Image comparison / visual regression testing for WebdriverIO",
5-
"version": "4.1.3",
5+
"version": "5.0.0",
66
"license": "MIT",
77
"homepage": "https://webdriver.io/docs/visual-testing",
88
"repository": {
@@ -30,7 +30,7 @@
3030
"@wdio/logger": "^8.38.0",
3131
"@wdio/types": "^8.38.2",
3232
"node-fetch": "^3.3.2",
33-
"webdriver-image-comparison": "^5.1.0"
33+
"webdriver-image-comparison": "^6.0.0"
3434
},
3535
"devDependencies": {}
3636
}

‎packages/webdriver-image-comparison/CHANGELOG.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,54 @@
11
# webdriver-image-comparison
22

3+
## 6.0.0
4+
5+
### Major Changes
6+
7+
- 66b9f11: # 💥 Breaking
8+
9+
This PR replaces Canvas as a dependency with Jimp. This removes the need to use system dependencies and will reduce the number of system dependency errors/issues (node-gyp/canvas and so on). This will, in the end, make the life of our end users way easier due to:
10+
11+
- less errors
12+
- less complex test environments
13+
14+
> [!note]
15+
> Extensive research has been done and we have chosen to "fork" ResembleJS, adjust it by making use of Jimp instead of Canvas and break the browser API because the fork will only be used in a nodejs environment
16+
> Investigation showed that creating a wrapper would even make it slower, so we went for the breaking change in the API by just replacing Canvas with Jimp
17+
18+
> [!important]
19+
> There is a performance impact where Canvas is around 70% faster than Jimp. This has been measured without using WebdriverIO and only comparing images. When the "old" implementation with WebdriverIO combined with Canvas or Jimp is compared, we hardly see a performance impact.
20+
21+
# 🚀 New Features
22+
23+
Update the baseline images through the command line by adding the argument `--update-visual-baseline`. This will
24+
25+
- automatically copy the actual take screenshot and put it in the baseline folder
26+
- if there are differences it will let the test pass because the baseline has been updated
27+
28+
**Usage:**
29+
30+
```sh
31+
npm run test.local.desktop --update-visual-baseline
32+
```
33+
34+
When running logs info/debug mode you will see the following logs added
35+
36+
```logs
37+
[0-0] ..............
38+
[0-0] #####################################################################################
39+
[0-0] INFO:
40+
[0-0] Updated the actual image to
41+
[0-0] /Users/wswebcreation/Git/wdio/visual-testing/localBaseline/chromel/demo-chrome-1366x768.png
42+
[0-0] #####################################################################################
43+
[0-0] ..........
44+
```
45+
46+
# 💅 Polish
47+
48+
- remove Vitest fix
49+
- add app images
50+
- update the build
51+
352
## 5.1.0
453

554
### Minor Changes

‎packages/webdriver-image-comparison/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "webdriver-image-comparison",
3-
"version": "5.1.0",
3+
"version": "6.0.0",
44
"author": "Wim Selles - wswebcreation",
55
"description": "An image compare module that can be used for different NodeJS Test automation frameworks that support the webdriver protocol",
66
"keywords": [],

0 commit comments

Comments
 (0)