Update service to ESM and WDIO v9 by dons20 · Pull Request #126 · webdriverio-community/wdio-docker-service

dons20 · 2023-10-31T06:15:56Z

Description

This started as a small experiment to make some changes locally to update the service. I figured it may be a good idea to update this to use ESM as well as Node v20 since it's the latest LTS at this time.

Leaving this up as a draft to get some initial thoughts. I'm not particularly opinionated as to the direction this should go either. Will need to do additional testing so that everything is compatible, but hopefully some of these changes help 🙂

Checklist

Unit/Integration test added (if applicable)
Documentation added/updated (wiki or md)
Code style is consistent with the rest of the project

Updated to WDIO v8 Updated to Node v18

Switch to jsconfig for now Updated necessary types for spec files Specify browserVersion for wdio conf

Replaced import all with default import Removed unnecessary export

christian-bromann · 2023-10-31T16:52:56Z

@dons20 thanks for taking a stab at it. Happy to help if needed.

dons20 · 2023-11-20T05:03:51Z

Haven't forgotten about this one, I had some major PC issues. SSD failed but I got it replaced. Will have some changes out soon again.

Removed older babel references, configs Added types in place of JSDoc types

Update files to correct line-endings

christian-bromann · 2023-12-19T19:14:28Z

Hey @dons20 , thanks for all your work so far! Let me know when you think this is ready for review!

dons20 · 2023-12-20T21:31:06Z

Will do, I only have to retest the test directory with these new changes. Everything else should be done

Updated deps Added temporary file for further run arg types and comments

dons20 · 2024-01-22T04:51:52Z

Back at it, pushed some of my changes, and I'll have some more incoming soon. Trying to get the local build and tests working fully.

christian-bromann · 2024-01-22T05:50:32Z

Awesome, looking forward to the changes. Let me know when I can review something.

Added mocks where needed Updated tsconfigs to handle build vs development type-checking Updated imports where applicable Other minor improvements

Updated more configs Added some dev dependencies

dons20 · 2024-01-24T15:31:02Z

I'm pretty happy with the results so far, and I think most of this can start to be reviewed, but you can let me know if I should take this out of draft yet. I still have these items on my todo list:

Fixing failing unit tests and verify coverage is displaying correctly
Fixing WDIO config so that it connects in its integration tests
Updating CJS directory to output the necessary cjs module (I took inspiration from some other services which implemented this such as wdio-nuxt-service)
Verifying output from build

christian-bromann

Some comments, overall looks aweseome!

christian-bromann · 2024-01-24T15:58:03Z

+    }
+}
+
+class DockerLauncherForTests extends DockerLauncher {


Why is this needed, seems like DockerLauncher defines this props to be public

When writing the tests, it complained about some variables being private or protected when trying to stub or spy. Perhaps there's a better way of resolving this?

dons20 · 2024-01-24T19:43:48Z

Thanks for reviewing! Will go through the comments shortly

christian-bromann · 2024-02-22T03:14:19Z

@dons20 any updates or anything I can help with?

dons20 · 2024-02-27T23:20:17Z

No updates yet, had a couple of busy weeks but I will make some updates in the coming days 🤞🏾

seanpoulter · 2024-03-06T22:08:04Z

Would it help if I separated out the upgrade from v7 to v8 to fix the CI pipeline added in #132?

dons20 · 2024-03-07T18:25:43Z

@seanpoulter If that is something you can manage in a short period of time, then feel free to

dons20 · 2025-11-23T22:54:37Z

Okay so after a few hours of troubleshooting the pipeline, I was able to identify a few necessary fixes to the code itself. Here's what I identified and fixed.

The pipeline would hang at the end of the test step. This was fixed with a call to process.unref() so that Node could move on with the remaining steps.
After pulling a fresh image, the container wouldn't automatically startup, so the health checks to the URL would never work. Fixed by changing return to await in await this._pullImage(). I identified that if I added a step before the tests to simply pre-fetch the image I wanted to run in the test, the test would actually pass 100% of the time. So it was simply an issue of the image being fetched but not started when needed.
Health check polling logic was a bit incorrect in terms of when it would increment the retry counter, so that was updated, though it may not be critical anymore.
I had to add a workaround for the CI environment so that it would use the loopback IP address 127.0.0.1 instead of host.docker.internal. Note: It might be possible to use the latter on all platforms with another workaround, but I'm exhausted from all the retries 😆 so maybe that's a future improvement.

@christian-bromann you can take a look at the latest changes as well as the pipeline. This should be good to go now.

christian-bromann

Amazing work 👏 Thanks a ton!

wdio-bot · 2025-11-24T20:20:36Z

Hey dons20 👋

Thank you for your contribution to WebdriverIO! Your pull request has been marked as an "Expensable" contribution.

We've sent you an email with further instructions on how to claim your expenses from our development fund.
Please make sure to check your spam folder as well. If you have any questions, feel free to reach out to us at expense@webdriver.io or in the contributing channel on Discord.

We are looking forward to more contributions from you in the future 🙌

Have a nice day,
The WebdriverIO Team 🤖

Keno added 2 commits October 30, 2023 00:45

Updated project to ESM only

c0ca4c8

Updated to WDIO v8 Updated to Node v18

Additional config updates

44235e4

Switch to jsconfig for now Updated necessary types for spec files Specify browserVersion for wdio conf

dons20 mentioned this pull request Oct 31, 2023

Move project to WebdriverIO Community Org #124

Open

christian-bromann reviewed Oct 31, 2023

View reviewed changes

Comment thread package.json Outdated

Comment thread package.json Outdated

Comment thread src/launcher.js Outdated

Comment thread test/unit/modules/dockerEventsSpec.js Outdated

Comment thread src/utils/dockerEventsListener.js Outdated

Reverted manual version change

00150cf

Replaced import all with default import Removed unnecessary export

dons20 added 4 commits November 21, 2023 23:38

Updates to dependencies and tsconfig

96853b0

Updated js src files to ts

368f05f

Removed older babel references, configs Added types in place of JSDoc types

Removed additional babel references

eaf0d8d

Update files to correct line-endings

More TS Changes

b41f3cf

Updated most of test directory to ts

94cf67a

Updated deps Added temporary file for further run arg types and comments

dons20 and others added 3 commits January 22, 2024 22:34

Updated remaining test files with TS

d21531f

Added mocks where needed Updated tsconfigs to handle build vs development type-checking Updated imports where applicable Other minor improvements

WIP change to update tsconfig layout

8185e58

Fixed some issues preventing unit tests to run

d511ab3

Updated more configs Added some dev dependencies

christian-bromann reviewed Jan 24, 2024

View reviewed changes

Keno Clayton added 2 commits January 24, 2024 14:50

Address most of the feedback

8559d97

Update onPrepare to promise syntax instead of async/await

bf2a1bf

christian-bromann mentioned this pull request Feb 22, 2024

Remove fs-extra dependency #50

Open

seanpoulter mentioned this pull request Mar 5, 2024

ci: Add GitHub Workflow #132

Merged

3 tasks

dons20 and others added 26 commits November 23, 2025 00:31

Troubleshooting~6

441ea56

Troubleshooting~7

9c28832

Troubleshooting~8

07e7d87

Troubleshooting~9

8ee3b14

Troubleshooting~10

6979fff

Troubleshooting~11

c75ceec

Troubleshooting~12

7c51190

Troubleshooting~13

31d44ca

Troubleshooting~14

3697bc3

Troubleshooting~14

bf5e352

Troubleshooting~15

e8d1f27

Cleanup~1

e04c5ce

Cleanup~2

47df595

Cleanup~3

3eed5ba

Cleanup~4

6ac65f7

Cleanup~5

3b1d1e4

Troubleshooting~16

9ad574b

Troubleshooting~17

8f2ff9c

Troubleshooting~18

344b024

Troubleshooting~19

3093db6

Troubleshooting~20

b1ebc3f

Troubleshooting~21

b94d40a

Troubleshooting~22

e1bc01c

Troubleshooting~23

786e645

Troubleshooting~24

0f2a8d1

Remaining Cleanup~1

5904580

christian-bromann approved these changes Nov 24, 2025

View reviewed changes

christian-bromann merged commit 33fdf44 into webdriverio-community:main Nov 24, 2025
1 check passed

Conversation

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

Uh oh!

Description

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann commented Oct 31, 2023

Uh oh!

dons20 commented Nov 20, 2023

Uh oh!

christian-bromann commented Dec 19, 2023

Uh oh!

dons20 commented Dec 20, 2023

Uh oh!

dons20 commented Jan 22, 2024

Uh oh!

christian-bromann commented Jan 22, 2024

Uh oh!

dons20 commented Jan 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann Jan 24, 2024

Choose a reason for hiding this comment

Uh oh!

dons20 Jan 24, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dons20 commented Jan 24, 2024

Uh oh!

christian-bromann commented Feb 22, 2024

Uh oh!

dons20 commented Feb 27, 2024

Uh oh!

seanpoulter commented Mar 6, 2024

Uh oh!

dons20 commented Mar 7, 2024

Uh oh!

dons20 commented Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wdio-bot commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dons20 commented Oct 31, 2023 •

edited

Loading

dons20 commented Jan 24, 2024 •

edited

Loading

dons20 commented Nov 23, 2025 •

edited

Loading