Update service to ESM and WDIO v8 #126

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

package.json

src/launcher.js

test/unit/modules/dockerEventsSpec.js

src/utils/dockerEventsListener.js

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!

.nvmrc

.travis.yml

README.md

src/index.ts

src/launcher.ts

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

src/launcher.ts

+    }
+}
+
+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?

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

src/utils/docker.ts

+    startDelay?: number;
+};
+
+export type DockerRunArgs = {


Is there an NPM package that contains these types?

Not that I'm aware of unfortunately. If a good, updated one exists, I'd be happy to migrate to it.

christian-bromann · 2024-01-24T16:00:56Z

src/utils/ping.ts

@@ -0,0 +1,9 @@
+import fetch from 'node-fetch';
+
+class PingClass {


Are your planning to add anything to this class? If not I guess it makes sense to not abstract a single fetch call

This one I'm not particularly opinionated about. It was previously just a regular function export but I migrated it to a class to address a TS issue in Sinon ES Modules cannot be stubbed. I was using one of the suggestions listed here.

Relevant SO threads: One Two

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

seanpoulter · 2024-03-09T04:55:24Z

It's probably no surprise but the update from v7 to v8 requires loading the ES Module @wdio/logger from the CJS code. I don't know how to do that as a concise change. 🤦

Let me know if there's anything else I can do to help.

dons20 · 2024-03-09T16:35:00Z

Totally understand. I'm pushing some changes within this weekend, hopefully it will advance this PR much further so it can cover all the concerns.

…to ESM-update

More usage of sandbox instead of direct stubs

Removed console log Fixed some warnings and errors displayed in some test contexts

dons20 · 2024-03-17T23:41:42Z

So recently I've been working on the unit tests as they were tricky to get started. After much debugging I had realized that one file was blocking the others from executing. Once I commented some of those tests, the others started running and I was able to fix the failing ones. There are about 20 to resolve on the unit tests side.

I'll continue chipping away at it in the coming days whenever I can find time. Just keeping everyone in the loop.

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

Closed

christian-bromann reviewed Oct 31, 2023

View reviewed changes

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

Keno Clayton added 3 commits March 17, 2024 03:46

Merge https://github.com/webdriverio-community/wdio-docker-service in…

a2f73dc

…to ESM-update

Some fixes to failing tests

cab3a62

More usage of sandbox instead of direct stubs

Fixed tests in launcherSpec

42860c2

Removed console log Fixed some warnings and errors displayed in some test contexts

Fixed dockerEventsSpec

f00ea72

This was referenced Mar 25, 2024

style: Check types with TypeScript #137

Closed

Rename the default branch from master to main #136

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update service to ESM and WDIO v8 #126

Update service to ESM and WDIO v8 #126

dons20 commented Oct 31, 2023 •

edited

Loading

christian-bromann commented Oct 31, 2023

dons20 commented Nov 20, 2023

christian-bromann commented Dec 19, 2023

dons20 commented Dec 20, 2023

dons20 commented Jan 22, 2024

christian-bromann commented Jan 22, 2024

dons20 commented Jan 24, 2024 •

edited

Loading

christian-bromann left a comment

christian-bromann Jan 24, 2024

dons20 Jan 24, 2024

christian-bromann Jan 24, 2024

dons20 Jan 24, 2024

christian-bromann Jan 24, 2024

dons20 Jan 24, 2024

dons20 commented Jan 24, 2024

christian-bromann commented Feb 22, 2024

dons20 commented Feb 27, 2024

seanpoulter commented Mar 6, 2024

dons20 commented Mar 7, 2024

seanpoulter commented Mar 9, 2024

dons20 commented Mar 9, 2024

dons20 commented Mar 17, 2024

		@@ -0,0 +1,9 @@
		import fetch from 'node-fetch';

		class PingClass {

Update service to ESM and WDIO v8 #126

Are you sure you want to change the base?

Update service to ESM and WDIO v8 #126

Conversation

dons20 commented Oct 31, 2023 • edited Loading

Description

Checklist

christian-bromann commented Oct 31, 2023

dons20 commented Nov 20, 2023

christian-bromann commented Dec 19, 2023

dons20 commented Dec 20, 2023

dons20 commented Jan 22, 2024

christian-bromann commented Jan 22, 2024

dons20 commented Jan 24, 2024 • edited Loading

christian-bromann left a comment

Choose a reason for hiding this comment

christian-bromann Jan 24, 2024

Choose a reason for hiding this comment

dons20 Jan 24, 2024

Choose a reason for hiding this comment

christian-bromann Jan 24, 2024

Choose a reason for hiding this comment

dons20 Jan 24, 2024

Choose a reason for hiding this comment

christian-bromann Jan 24, 2024

Choose a reason for hiding this comment

dons20 Jan 24, 2024

Choose a reason for hiding this comment

dons20 commented Jan 24, 2024

christian-bromann commented Feb 22, 2024

dons20 commented Feb 27, 2024

seanpoulter commented Mar 6, 2024

dons20 commented Mar 7, 2024

seanpoulter commented Mar 9, 2024

dons20 commented Mar 9, 2024

dons20 commented Mar 17, 2024

dons20 commented Oct 31, 2023 •

edited

Loading

dons20 commented Jan 24, 2024 •

edited

Loading