feat: wdio v8 enablement (#498)

fixes #384 and solves https://github.com/orgs/ui5-community/projects/2?pane=issue&itemId=18873623

---------

Co-authored-by: dominikfeininger <[email protected]>
Co-authored-by: Simon Coen <[email protected]>

.github/workflows/codeql-analysis.yml

@@ -14,7 +14,7 @@ name: "CodeQL"
 on:
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [main]
+    branches: [main, main-v2]
   schedule:
     - cron: "43 16 * * 4"
 

.github/workflows/gh-release.yml

@@ -23,6 +23,6 @@ jobs:
       - run: npm run build
       - uses: ncipollo/release-action@v1
         with:
-          artifacts: "dist/**/*,client-side-js/**/*"
+          artifacts: "cjs/**/*,esm/**/*,client-side-js/**/*"
           bodyFile: "CHANGELOG.md"
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -8,9 +8,11 @@ on:
   push:
     branches:
       - main
+      - main-v2
   pull_request:
     branches:
       - main
+      - main-v2
 
 jobs:
   run-linters:

.github/workflows/wdi5-tests_core.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - main-v2
     paths:
       # relevant
       - "client-side-js/**"

.github/workflows/wdi5-tests_fe-app.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - main-v2
     paths:
       # relevant
       - "client-side-js/**"
@@ -19,21 +20,21 @@ on:
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     strategy:
       matrix:
         node-version: [16, 18, 19, 20]
 
     steps:
-      - name: update chrome
-        run: |
-          wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
-          sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
-          sudo apt-get update
-          sudo apt-get --only-upgrade install google-chrome-stable
-          # check chrome version
-          google-chrome --version
+      # - name: update chrome
+      #   run: |
+      #     wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+      #     sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+      #     sudo apt-get update
+      #     sudo apt-get --only-upgrade install google-chrome-stable
+      #     # check chrome version
+      #     google-chrome --version
 
       - name: check out repo
         uses: actions/checkout@v3

.github/workflows/wdi5-tests_js-app.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - main
+      - main-v2
+
     paths:
       # relevant
       - "client-side-js/**"
@@ -20,21 +22,21 @@ on:
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     strategy:
       matrix:
         node-version: [16, 18, 19, 20]
 
     steps:
-      - name: update chrome
-        run: |
-          wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
-          sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
-          sudo apt-get update
-          sudo apt-get --only-upgrade install google-chrome-stable
-          # check chrome version
-          google-chrome --version
+      # - name: update chrome
+      #   run: |
+      #     wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+      #     sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+      #     sudo apt-get update
+      #     sudo apt-get --only-upgrade install google-chrome-stable
+      #     # check chrome version
+      #     google-chrome --version
 
       - name: check out repo
         uses: actions/checkout@v3

.github/workflows/wdi5-tests_ts-app.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - main-v2
     paths:
       # relevant
       - "client-side-js/**"

.gitignore

@@ -61,6 +61,8 @@ typings/
 .idea
 
 # don't include build artifacts
+cjs/**/*
+esm/**/*
 dist/**/*
 
 # Gitkeep generally

.mocharc.json

@@ -1,5 +1,6 @@
 {
   "extension": ["ts"],
   "spec": "test/**/*.test.ts",
-  "require": "ts-node/register"
+  "require": "ts-node/register",
+  "node-option": ["experimental-specifier-resolution=node", "loader=ts-node/esm"]
 }

.nvmrc

@@ -1 +1 @@
-16
+18

.retrofit-pkg-json.js

@@ -0,0 +1,9 @@
+// transmogrifying wdi5's package.json to a cjs version
+import { promises as fs } from "fs"
+import pkgJson from "./package.json" assert { type: "json" }
+;["type", "exports", "types", "files", "workspaces", "scripts", "lint-staged"].forEach((section) => {
+    delete pkgJson[section]
+})
+;(async () => {
+    await fs.writeFile("./cjs/package.json", JSON.stringify(pkgJson, null, 2))
+})()

.vscode/settings.json

@@ -2,5 +2,7 @@
   "editor.formatOnSave": true,
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
+  },
+  "javascript.preferences.importModuleSpecifierEnding": "js",
+  "typescript.preferences.importModuleSpecifierEnding": "js"
 }

MIGRATION_GUIDE.md

@@ -0,0 +1,19 @@
+# migrating to `wdi5` 2.x
+
+Version >= 2 of `wdi5` are WebdriverIO v8 compatible. This entails a move to ESM as primary module, with CJS compatibility ensured.
+
+## check file sys dir references in your test code
+
+dir references start from the dir the file is in now,  
+not from `cwd`
+
+```diff
+const _config = {
+  wdi5: {
+      skipInjectUI5OnStart: true
+  },
+  - specs: [join("webapp", "test", "e2e", "ui5-late.test.js")],
+  + specs: [join("..", "webapp", "test", "e2e", "ui5-late.test.js")],
+  baseUrl: "https://github.com/ui5-community/wdi5/"
+}
+```

docker/package-standalone.json

@@ -8,19 +8,19 @@
   },
   "devDependencies": {
     "@ui5/cli": "latest",
-    "@wdio/cli": "^7",
-    "@wdio/mocha-framework": "^7",
-    "@wdio/spec-reporter": "^7",
+    "@wdio/cli": "^8",
+    "@wdio/mocha-framework": "^8",
+    "@wdio/spec-reporter": "^8",
     "chromedriver": "latest",
-    "@wdio/local-runner": "^7",
+    "@wdio/local-runner": "^8",
     "fs-extra": "^10.1.0",
     "mocha": "^9.2.2",
     "npm-run-all": "^4.1.5",
     "ui5-middleware-simpleproxy": "latest",
     "wait-on": "^6.0.1",
-    "wdio-chromedriver-service": "^7",
+    "wdio-chromedriver-service": "^8",
     "wdio-ui5-service": "latest",
-    "webdriverio": "^7"
+    "webdriverio": "^8"
   },
   "ui5": {
     "dependencies": ["ui5-middleware-simpleproxy"]

docker/package-wdi5-dev.json

@@ -10,19 +10,19 @@
     "test:docker:standalone": "run-p start test:standalone"
   },
   "devDependencies": {
-    "@wdio/cli": "^7.19.1",
-    "@wdio/mocha-framework": "^7.19.1",
-    "@wdio/spec-reporter": "^7.19.1",
+    "@wdio/cli": "^8",
+    "@wdio/mocha-framework": "^8",
+    "@wdio/spec-reporter": "^8",
     "chromedriver": "latest",
-    "@wdio/local-runner": "^7.19.1",
+    "@wdio/local-runner": "^8",
     "fs-extra": "^10.0.1",
     "mocha": "^9.2.2",
     "npm-run-all": "^4.1.5",
     "soerver": "^0.0.3",
     "wait-on": "^6.0.1",
-    "wdio-chromedriver-service": "^7",
+    "wdio-chromedriver-service": "^8",
     "wdio-ui5-service": "file:wdio-ui5-service",
-    "webdriverio": "^7.19.1"
+    "webdriverio": "^8"
   },
   "engines": {
     "node": ">=14",

docker/package-wdi5.json

@@ -11,19 +11,19 @@
     "test:docker:standalone": "run-p start test:standalone"
   },
   "devDependencies": {
-    "@wdio/cli": "^7.19.1",
-    "@wdio/mocha-framework": "^7.19.1",
-    "@wdio/spec-reporter": "^7.19.1",
+    "@wdio/cli": "^8",
+    "@wdio/mocha-framework": "^8",
+    "@wdio/spec-reporter": "^8",
     "chromedriver": "latest",
-    "@wdio/local-runner": "^7.19.1",
+    "@wdio/local-runner": "^8",
     "fs-extra": "^10.0.1",
     "mocha": "^9.2.2",
     "npm-run-all": "^4.1.5",
     "soerver": "^0.0.3",
     "wait-on": "^6.0.1",
-    "wdio-chromedriver-service": "^7",
+    "wdio-chromedriver-service": "^8",
     "wdio-ui5-service": "*",
-    "webdriverio": "^7.19.1"
+    "webdriverio": "^8"
   },
   "engines": {
     "node": ">=14",

examples/cucumber/package.json

@@ -1,12 +1,12 @@
 {
   "devDependencies": {
-    "@wdio/cli": "^7.27.0",
-    "@wdio/cucumber-framework": "^7.27.0",
-    "@wdio/local-runner": "^7.27.0",
-    "@wdio/mocha-framework": "^7.26.0",
-    "@wdio/spec-reporter": "^7.26.0",
+    "@wdio/cli": "^8",
+    "@wdio/cucumber-framework": "^8",
+    "@wdio/local-runner": "^8",
+    "@wdio/mocha-framework": "^8",
+    "@wdio/spec-reporter": "^8",
     "chromedriver": "latest",
-    "wdio-chromedriver-service": "^7.3.2",
+    "wdio-chromedriver-service": "^8",
     "wdio-ui5-service": "*"
   },
   "scripts": {

examples/fe-app/.eslintrc.cjs

@@ -0,0 +1,26 @@
+module.exports = {
+    extends: "eslint:recommended",
+    env: {
+        node: true,
+        es6: true,
+        jest: true
+    },
+    parserOptions: {
+        ecmaVersion: 2017
+    },
+    globals: {
+        browser: true,
+        before: true,
+        SELECT: true,
+        INSERT: true,
+        UPDATE: true,
+        DELETE: true,
+        CREATE: true,
+        DROP: true,
+        cds: true
+    },
+    rules: {
+        "no-console": "off",
+        "require-atomic-updates": "off"
+    }
+}

examples/fe-app/package.json

@@ -15,14 +15,13 @@
     "serve": "ui5 serve --port 8088"
   },
   "devDependencies": {
-    "@wdio/cli": "^7",
+    "@wdio/cli": "^8",
     "detect-libc": "^2.0.1",
-    "@wdio/local-runner": "^7",
-    "@wdio/mocha-framework": "^7",
-    "@wdio/selenium-standalone-service": "^7",
-    "@wdio/spec-reporter": "^7",
+    "@wdio/local-runner": "^8",
+    "@wdio/mocha-framework": "^8",
+    "@wdio/spec-reporter": "^8",
     "chromedriver": "latest",
-    "wdio-chromedriver-service": "^7",
+    "wdio-chromedriver-service": "^8",
     "wdio-ui5-service": "*",
     "@sap-ux/ui5-middleware-fe-mockserver": "latest"
   },

examples/fe-app/wdio.conf.js

@@ -4,7 +4,7 @@ exports.config = {
     wdi5: {
         screenshotPath: join("app", "incidents", "webapp", "wdi5-test", "__screenshots__"),
         logLevel: "verbose", // error | verbose | silent
-        waitForUI5Timeout: 30000
+        waitForUI5Timeout: 90000
     },
     //// wdio runner config
     specs: [join("webapp", "wdi5-test", "**/*.test.js")],
@@ -34,7 +34,7 @@ exports.config = {
     bail: 0,
     baseUrl: "http://localhost:8088/index.html#fe-lrop-v4",
 
-    waitforTimeout: 10000,
+    waitforTimeout: 20000,
     connectionRetryTimeout: 120000,
     connectionRetryCount: 3,
 

examples/ui5-js-app/e2e-test-config/wdi5-multiversion.js

@@ -1,7 +1,7 @@
 const fsExtra = require("fs-extra")
 const path = require("path")
 const replace = require("replace-in-file")
-const Launcher = require("@wdio/cli").default
+const { Launcher } = require("@wdio/cli")
 
 // lts versions (> 1.60)
 // empty string will get the newest Version which can be a "SNAPSHOT" version
@@ -37,6 +37,9 @@ const versions = ["", "1.71", "1.84", "1.96"]
 
         // run it
         const wdio = new Launcher(targetWdioConf)
+        //> REVISIT: this is only necessary to wait for the async constructor to resolve
+        //> seehttps://github.com/webdriverio/webdriverio/pull/10607
+        await new Promise((resolve) => setTimeout(resolve, 1000))
         await wdio.run().then((code) => {
             if (code === 1) {
                 process.exit(1)