bug: emulate.userAgent is not used in E2E Screenshot tests

[mlechler]

Prerequisites

• I have read the Contributing Guidelines.
• I agree to follow the Code of Conduct.
• I have searched for existing issues that already report this problem, without success.

Stencil Version

4.12.2-dev.1709767698.0a1aa6b

Current Behavior

The emulate.userAgent is ignored. The sample project should write Dark, Default, Condensed and Presentation to the console, but it writes Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/116.0.5814.0 Safari/537.36.

Expected Behavior

In an earlier version (v3) the emulate.userAgent was used and we could generate different screenshots with different color/spacing themes.

Is there a new way to do stuff like this? Or should it work this way?

System Info

System: node 20.11.0
    Platform: darwin (23.4.0)
   CPU Model: Apple M1 Pro (10 cpus)
    Compiler: /node_modules/@stencil/core/compiler/stencil.js
       Build: 1709767698
     Stencil: 4.12.2-dev.1709767698.0a1aa6b 🤓
  TypeScript: 5.3.3
      Rollup: 2.56.3
      Parse5: 7.1.2
      jQuery: 4.0.0-pre
      Terser: 5.27.0

Steps to Reproduce

Run npm run test.screenshot in the test repo.
Check the console output.

Code Reproduction URL

https://github.com/mlechler/stencil-e2e-test-bug

Additional Information

No response

[alicewriteswrongs]

Hey @mlechler, just was able to confirm that this is indeed an issue! I'll ingest it into our backlog for the team to prioritize. Thanks for reporting!

[mlechler]

@alicewriteswrongs @rwaskiewicz @tanner-reits
Is there any timeline for this issue?

[christian-bromann]

@mlechler the Stencil team has decided to discontinue the screenshot testing feature in favor of screenshot testing capabilities of other more established tools like WebdriverIO or Playwright. Moving forward we are looking into making Stencil lighter to keep it maintainable. Testing is one of the areas where we believe other tools do much better and should be the choice when testing Stencil components.

I am happy to assist with transitioning to e.g. WebdriverIO which provides similar component / screenshot testing capabilities as the current stencil test feature. It allows you to emulate the user agent via the emulate command.

I will go ahead and close the issue.