fix(vitest): headless mode not working when using webdriverio (fix #3930) by LorenzoBloedow · Pull Request #3996 · vitest-dev/vitest

LorenzoBloedow · 2023-08-21T23:29:24Z

I skimmed through the v6, v7, and v8 docs for webdriverio but I didn't really find any documentation for the wdio:devtoolsOptions key on the current code causing this issue:

capabilities: {
  'browserName': this.browser,
  'wdio:devtoolsOptions': { headless: options.headless },
},

IMPORTANT:
I couldn't reproduce this issue, I realize this was my mistake and I should've tried that before starting to write the code.
I have a suggestion regarding reproductions (let me know if I should open a discussion for this): they should be made mandatory and the issue should be automatically (and/or manually) closed until a repro that actually works is provided, otherwise false-positives made by user error may become very common, but that's just my take on it, let me know what you think!

This fixes #3930 (if it's confirmed to be an issue)

bolt-new-by-stackblitz · 2023-08-21T23:29:26Z

Run & review this pull request in StackBlitz Codeflow.

netlify · 2023-08-21T23:29:30Z

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Name	Link
🔨 Latest commit	`fb021d4`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/6516239db04d9d0007edc7c5
😎 Deploy Preview	https://deploy-preview-3996--fastidious-cascaron-4ded94.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sheremet-va · 2023-08-22T06:23:55Z

Please, don't remove PR checklist when creating PR. One of the points there is to not push pnpm-lockfile changes.

LorenzoBloedow · 2023-08-22T14:16:34Z

Please, don't remove PR checklist when creating PR. One of the points there is to not push pnpm-lockfile changes.

Sorry, I should've read it.
I've removed pnpm-lockfile.yaml now

LorenzoBloedow · 2023-08-23T20:00:00Z

Please, don't remove PR checklist when creating PR. One of the points there is to not push pnpm-lockfile changes.

Sorry, I should've read it.
I've removed pnpm-lockfile.yaml now

Just noticed I mistakenly ran git rm instead of checking out to the unchanged file 🤦

I'll revert this soon

sheremet-va · 2023-08-24T12:42:33Z

I just noticed that remote accepts "headless" option. Can't we just pass it down?

LorenzoBloedow · 2023-08-25T03:06:49Z

I just noticed that remote accepts "headless" option. Can't we just pass it down?

webdriverio doesn't seem to have complete documentation for the options for remote on their website.
But I inspected the declaration file with the headless option and this is what I found:

/**
* Sauce Labs provides a headless offering that allows you to run Chrome and Firefox tests headless.
*/
headless?: boolean;

I thought it was weird so I decided to test it myself, and yeah I can confirm it doesn't work (at least without Sauce Labs)

sheremet-va · 2023-08-25T06:58:00Z

I thought it was weird so I decided to test it myself, and yeah I can confirm it doesn't work (at least without Sauce Labs)

Ok, no problem 👍🏻

LorenzoBloedow · 2023-08-25T20:38:30Z

@sheremet-va I'm not sure how to proceed since we're getting the ERR_PNPM_OUTDATED_LOCKFILE error on CI and I'm not supposed to upload the lock file.

sheremet-va · 2023-08-28T07:34:02Z

@sheremet-va I'm not sure how to proceed since we're getting the ERR_PNPM_OUTDATED_LOCKFILE error on CI and I'm not supposed to upload the lock file.

Sorry, since you added a new package, you can update the lockfile. But make sure it only includes the new package there (example of good lockfile update in #4027).

sheremet-va · 2023-08-29T08:50:30Z

Looks like it's still broken

LorenzoBloedow · 2023-08-30T00:06:27Z

Looks like it's still broken

I'm having some trouble trying to update only @wdio/types.
I tried using many different command and version combinations including pnpm add --filter ./vitest --prefer-offline --lockfile-only @wdio/types (cwd: vitest/packages) but I always get a lot of unrelated packages updated as well (like /@babel/helper-create-class-features-plugin@7.22.11(@babel/core@7.22.11).

I also found a recent issue from someone with the same problem as me.

sheremet-va · 2023-08-30T05:48:55Z

Looks like it's still broken

I'm having some trouble trying to update only @wdio/types.

I tried using many different command and version combinations including pnpm add --filter ./vitest --prefer-offline --lockfile-only @wdio/types (cwd: vitest/packages) but I always get a lot of unrelated packages updated as well (like /@babel/helper-create-class-features-plugin@7.22.11(@babel/core@7.22.11).

I also found a recent issue from someone with the same problem as me.

The jus updating it should be fine I think

LorenzoBloedow · 2023-09-02T03:04:13Z

The jus updating it should be fine I think

Not sure what you meant but I'm assuming you asked me to just run the previous install command and commit so that's what I did (it does look like there are some unrelated packages being updated in the lockfile though)

pnpm-lock.yaml

…dow/vitest into fix-headless-browser

LorenzoBloedow · 2023-09-09T18:53:10Z

Fixed the types and ran all CI commands on my machine, not sure why test:ci threw in the last run though, works fine here.

sheremet-va · 2023-09-14T08:34:06Z

I don't understand why your CI fails when main doesn't 🤔

…eys in lockfile

LorenzoBloedow · 2023-09-17T21:20:48Z

I don't understand why your CI fails when main doesn't 🤔

The errors are weird because they don't seem to have much to do with what I think caused it, but basically I didn't need to add some mapping keys in the lockfile because they were already there.

I thought pnpm install would fail when that happens but apparently not.
It should be fixed now since I ran the github actions locally with act before and after and the problem seems to be fixed.

sheremet-va · 2023-09-18T10:07:51Z

Browser tests fail now 😄 (Because of the changes here looks like)

LorenzoBloedow · 2023-09-18T23:10:24Z

Browser tests fail now 😄 (Because of the changes here looks like)

This PR is making me feel silly lol.
I tried to fix it but unfortunately I don't have a Mac and it's failing because of Safari so I can't confirm my changes locally.
It seems like a pretty simple fix though, let's just hope the next CI run is finally the last one! :)

…dow/vitest into fix-headless-browser

LorenzoBloedow · 2023-09-29T01:27:09Z

This is weird... I ran the failed CI commands on Windows and they all passed, the lockfile looks fine, and everything else hasn't
changed. Not sure how to proceed here, could this possibly be a problem with the CI cache?

Replace karma, chai, mocha, puppeteer, and sinon with vitest, @vitest/browser and webdriverio Remove `^` from all dependencies and update their version to the locked version `@vitest/browser` is an experimental package with some "bugs" so a patch to fix headless flag and add support for custom browser binary was needed in order to run the test in Github Actions Closes: #250 Closes: #180 Rel: https://github.com/karma-runner/karma#karma-is-deprecated-and-is-not-accepting-new-features-or-general-bug-fixes Rel: https://vitest.dev/guide/ Rel: vitest-dev/vitest#3996

userquin · 2023-10-13T13:36:43Z

packages/vitest/src/node/browser/webdriver.ts

+            webdriverBrowserExtensionMap[this.browser].value.args.push('-headless')
+            break
+          case 'edge':
+            webdriverBrowserExtensionMap[this.browser].value.args.push('--headless')


we can use same configuration for chrome

sheremet-va added the invalid label Aug 22, 2023

sheremet-va removed the invalid label Aug 24, 2023

AriPerkkio reviewed Sep 2, 2023

View reviewed changes

pnpm-lock.yaml Outdated Show resolved Hide resolved

LorenzoBloedow added 6 commits September 4, 2023 14:59

fix(vitest): headless mode not working when using webdriverio

81c67c6

Revert changes to pnpm-lock.yaml

eb9b04e

Add only the new dev dependency to lockfile

0cb1d4b

Revert lockfile to upstream

4a98aea

Move @wdio/types to the package where it's used

8e3e308

Add @wdio/types and its dependencies to lockfile

63d5fe5

LorenzoBloedow force-pushed the fix-headless-browser branch from a52d4d5 to 63d5fe5 Compare September 5, 2023 00:13

sheremet-va and others added 3 commits September 8, 2023 15:37

Merge branch 'main' into fix-headless-browser

a27202c

Fix capabilities types

585dbf3

Merge branch 'fix-headless-browser' of https://github.com/LorenzoBloe…

b47efde

…dow/vitest into fix-headless-browser

sheremet-va approved these changes Sep 9, 2023

View reviewed changes

cre8ivejp mentioned this pull request Sep 11, 2023

test: fix headless mode not working when using webdriverio bucketeer-io/javascript-client-sdk#105

Merged

LorenzoBloedow and others added 2 commits September 13, 2023 15:08

Merge upstream 'main' into fix-headless-browser

3f5a36d

Merge branch 'main' into fix-headless-browser

843ed21

LorenzoBloedow added 2 commits September 17, 2023 13:29

Merge branch 'main' into fix-headless-browser

54f0a29

Merge upstream 'main' into 'fix-headless-browser' and fix duplicate k…

3e6e76a

…eys in lockfile

Fix test trying to use headless mode with Safari

890d60d

LorenzoBloedow and others added 5 commits September 18, 2023 20:11

Merge branch 'main' into fix-headless-browser

afb999d

Merge branch 'main' into fix-headless-browser

fd32cfe

Merge branch 'main' into fix-headless-browser

e65a3d4

Merge branch 'main' into fix-headless-browser

3260a31

Merge branch 'fix-headless-browser' of https://github.com/LorenzoBloe…

fb021d4

…dow/vitest into fix-headless-browser

frodeaa mentioned this pull request Oct 7, 2023

Replace depricated karma with vitest Dintero/Dintero.Checkout.Web.SDK#254

Merged

userquin reviewed Oct 13, 2023

View reviewed changes

sheremet-va mentioned this pull request Oct 24, 2023

feat!: move browser providers to @vitest/browser package #4364

Merged

6 tasks

sheremet-va closed this in #4364 Oct 27, 2023

Uh oh!

Conversation

LorenzoBloedow commented Aug 21, 2023

Uh oh!

bolt-new-by-stackblitz bot commented Aug 21, 2023

Uh oh!

netlify bot commented Aug 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Uh oh!

sheremet-va commented Aug 22, 2023

Uh oh!

LorenzoBloedow commented Aug 22, 2023

Uh oh!

LorenzoBloedow commented Aug 23, 2023

Uh oh!

sheremet-va commented Aug 24, 2023

Uh oh!

LorenzoBloedow commented Aug 25, 2023

Uh oh!

sheremet-va commented Aug 25, 2023

Uh oh!

LorenzoBloedow commented Aug 25, 2023

Uh oh!

sheremet-va commented Aug 28, 2023

Uh oh!

sheremet-va commented Aug 29, 2023

Uh oh!

LorenzoBloedow commented Aug 30, 2023

Uh oh!

sheremet-va commented Aug 30, 2023

Uh oh!

LorenzoBloedow commented Sep 2, 2023

Uh oh!

Uh oh!

LorenzoBloedow commented Sep 9, 2023

Uh oh!

sheremet-va commented Sep 14, 2023

Uh oh!

LorenzoBloedow commented Sep 17, 2023

Uh oh!

sheremet-va commented Sep 18, 2023

Uh oh!

LorenzoBloedow commented Sep 18, 2023

Uh oh!

LorenzoBloedow commented Sep 29, 2023

Uh oh!

userquin Oct 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Aug 21, 2023 •

edited

Loading

userquin Oct 13, 2023 •

edited

Loading