fix(webdriverio): fix script execution by christian-bromann · Pull Request #13470 · webdriverio/webdriverio

christian-bromann · 2024-08-28T03:08:38Z

Proposed changes

In addition, this patch will:

create nicer stack traces and print the line that caused the error, e.g.
given following script:

await browser.execute(async () => {
    const a: number = 1
    console.log('Hello Bidi')
    if (a) {
        if (a) {
            throw new Error('Hello Bidi')
        }
    }
})

 Error: Error: Hello Bidi
     at Context.<anonymous> (/path/to/webdriverio/e2e/wdio/headless/bidi.e2e.ts:207:28)
     207 │ if(a){if(a){throw new Error("Hello Bidi")}}}
         ╵ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

     at parseScriptResult (/path/to/webdriverio/build/index.js:750:19)
     at Browser.execute (/path/to/webdriverio/build/index.js:2982:12)
     at Browser.wrapCommandFn (/path/to/wdio-utils/build/index.js:1368:23)
     at Context.<anonymous> (/path/to/webdriverio/e2e/wdio/headless/bidi.e2e.ts:207:28)
     at Context.executeAsync (/path/to/wdio-utils/build/index.js:1488:20)
     at Context.testFrameworkFnWrapper (/path/to/wdio-utils/build/index.js:1559:14)

it will deprecate executeAsync as there is not need for it anymore

Types of changes

Polish (an improvement for an existing feature)
Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update (improvements to the project's docs)
Specification changes (updates to WebDriver command specifications)
Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

This change is solely for v9 and doesn't need to be back-ported
Back-ported PR at #XXXXX

Further comments

n/a

Reviewers: @webdriverio/project-committers

pkg-pr-new · 2024-08-28T03:11:43Z

Open in Stackblitz

eslint-plugin-wdio

pnpm add https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@13470

@wdio/allure-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@13470

@wdio/appium-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@13470

@wdio/browser-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@13470

@wdio/cli

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@13470

@wdio/browserstack-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@13470

@wdio/config

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@13470

@wdio/concise-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@13470

@wdio/dot-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@13470

@wdio/cucumber-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@13470

@wdio/firefox-profile-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@13470

@wdio/globals

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@13470

@wdio/jasmine-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@13470

@wdio/json-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@13470

@wdio/lighthouse-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@13470

@wdio/junit-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@13470

@wdio/logger

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@13470

@wdio/local-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@13470

@wdio/protocols

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@13470

@wdio/mocha-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@13470

@wdio/reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@13470

@wdio/repl

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@13470

@wdio/runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@13470

@wdio/shared-store-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@13470

@wdio/smoke-test-cjs-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@13470

@wdio/smoke-test-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@13470

@wdio/smoke-test-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@13470

@wdio/spec-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@13470

@wdio/static-server-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@13470

@wdio/sumologic-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@13470

@wdio/testingbot-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@13470

@wdio/types

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@13470

@wdio/utils

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@13470

@wdio/webdriver-mock-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@13470

webdriver

pnpm add https://pkg.pr.new/webdriverio/webdriverio/webdriver@13470

webdriverio

pnpm add https://pkg.pr.new/webdriverio/webdriverio@13470

@wdio/sauce-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@13470

commit: 1345cea

danielhjacobs · 2024-08-28T20:03:06Z

packages/webdriverio/src/polyfill.ts

+                'var __name = (target, value) => __defProp(target, \'name\', { value, configurable: true });' +
+                'globalThis.__name = __name;'
+            )
+            return closure()


Are you sure this is all that's needed. See evanw/esbuild#607 (comment):

The __name function is just one of many code transforms that esbuild can make that assume functions aren't arbitrarily recompiled by converting them to a string and feeding them to eval. Other examples include converting a ** b to __pow(a, b) and {...a, ...b} to __assign({}, a), b).

Are you aware of more polyfills that are needed here?

Ruffle doesn't need any others for its tests currently but that doesn't means others won't or that future tests won't require others. I think any from this file might be needed:

https://github.com/evanw/esbuild/blob/main/internal/runtime/runtime.go

As stated in evanw/esbuild#607 (comment)

Preserving the value of toString() on a function expression is not a design goal of esbuild. If that use case is important to you, it would be best to either arrange for the code to be passed as a string instead, or to use another tool that supports preserving the value of toString() on a function.

Understood. The amount of usecases for WDIO vs someone compiling a TS project with Esbuild is very different, e.g. no one would export variables from the test. My idea was to add more polyfills when needed as this seems the simplest approach while keeping the codebase as simple as possible.

lararojasmr · 2024-09-04T22:36:06Z

@christian-bromann those changes fix #13444 without BiDi? I'm facing this issue now.

christian-bromann · 2024-09-05T07:50:22Z

@lararojasmr non bidi sessions have not been impacted by this issue.

christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Aug 28, 2024

christian-bromann force-pushed the cb/execute-fix branch from f2fee45 to d30b0c5 Compare August 28, 2024 03:09

danielhjacobs reviewed Aug 28, 2024

View reviewed changes

christian-bromann force-pushed the cb/execute-fix branch from e1a94a0 to 8ca843c Compare August 29, 2024 02:16

christian-bromann added 4 commits September 3, 2024 10:57

fix(webdriverio): fix script execution

7ecda91

add another test

4dd2d07

improve test coverage

7475336

fix e2e tests

f1941ee

christian-bromann force-pushed the cb/execute-fix branch from a6722dd to f1941ee Compare September 3, 2024 08:59

skip e2e test in Safari as no bidi is supported

212a3dd

christian-bromann added 2 commits September 5, 2024 10:57

fix test

bf0c73b

fix test

1345cea

christian-bromann merged commit dbda475 into main Sep 5, 2024

christian-bromann deleted the cb/execute-fix branch September 5, 2024 09:41

danielhjacobs mentioned this pull request Sep 17, 2024

[🐛 Bug]: new selector logic doesn't take iframe switches into consideration #13218

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(webdriverio): fix script execution#13470

fix(webdriverio): fix script execution#13470
christian-bromann merged 7 commits intomainfrom
cb/execute-fix

christian-bromann commented Aug 28, 2024 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Aug 28, 2024 •

edited

Loading

Uh oh!

danielhjacobs Aug 28, 2024

Uh oh!

christian-bromann Aug 28, 2024

Uh oh!

danielhjacobs Aug 28, 2024 •

edited

Loading

Uh oh!

christian-bromann Aug 28, 2024

Uh oh!

lararojasmr commented Sep 4, 2024 •

edited

Loading

Uh oh!

christian-bromann commented Sep 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

christian-bromann commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Types of changes

Checklist

Backport Request

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

pkg-pr-new bot commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danielhjacobs Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

christian-bromann Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

danielhjacobs Aug 28, 2024 • 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!

christian-bromann Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

lararojasmr commented Sep 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christian-bromann commented Sep 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

christian-bromann commented Aug 28, 2024 •

edited

Loading

pkg-pr-new bot commented Aug 28, 2024 •

edited

Loading

danielhjacobs Aug 28, 2024 •

edited

Loading

lararojasmr commented Sep 4, 2024 •

edited

Loading