wdio-electron-service

New:

• The service now detects the use of old Electron versions (< v26) when the user is attempting to use service-managed Chromedriver and throws an error stating that CD needs to be manually configured (#747)

Docs:

• Added missing README back to NPM package (#748)
• Added READMEs for utils and types packages (#748)

Developer:

• Fixed: Versioning issues with release process (#750)
• Fixed: Release bumping triggers Husky pre-push (#751)
• Updated to ESLint 9 & config updated for new repo structure (#749)
• Now using eslint-plugin-import-x (#749)

Full Changelog

New:

• Complete restructure of the repo, now using Turborepo (#443, #623, #645)
• Works with WDIO v9 (#623, #666, #729)
• Node 16 support dropped (#666)
• "No Binary" mode for testing an app without having to build it using e.g. Electron Forge or electron-builder (#704)

Fixed:

• Windows CI timeouts with Electron 30 (#578)
• Executable name on Forge builds doesn't take account of packagerConfig (#621)
• Multiple build tools present in a project produces errors (#622)
• E2E debug is too verbose (#634)
• Windows CI errors with latest electron-builder (#599)
• Forge Mac-universal E2E errors (#576)

Docs:

• Updated for "No Binary" mode
• Updated for WDIO v9
• Minimum required Electron version to avoid having to self-configure chromedriver moved to main README

Developer:

• ts-node removed in favour of tsx (#666)
• Now using native fetch (#666)
• Updated dependencies

Full Changelog

Fixed:

• @electron/packager import error in electron-builder projects (#578)

Developer:

• Updated dependencies

Full Changelog

New:

• Support for mac-universal builds using Forge and electron-builder (#575)
• Support for Forge custom output directories - the service will now respect the output directory you specify in forge.config.js (c6bf002)

Documentation:

• Added debugging information and example to Common Issues page (#577)

Developer:

• Standardised PNPM version across CI and repo (#573)
• Updated dependencies

Full Changelog

New:

• Standalone Mode - the ability to use the service in a regular Node.js script, without the WDIO testrunner (#521)

Documentation:

• Standalone mode page (1843726, 5a2903a)
• Improved chromedriver configuration page - detailing user management for older Electron versions (#511)
• Standardised code sample filename formatting (#512)

Developer:

• CI: Dependabot ignores electron-builder and all major updates (d422505)
• CI: Updated node (dba31ee), pnpm (4538597), and actions (69fe5aa)
• Removed bundling for main process in ESM examples (af18718)
• Updated dependencies

Full Changelog

Fixed:

• Preload guard causes errors in vite-based projects (78b6d83)

Documentation:

• More specific security instructions around API access (79aac35)
• Improved text around sandboxing and non-bundled preload scripts (79aac35)
• Improved code samples (486a916)
• Updated CD user management section, specfically for older Electron versions (#511)

Developer:

• CI: fixed dry run in release script (#475)
• Updated dependencies (#476, #477, #479, #480, #481, #482, #483, #484, #485, #486, #489, #490, #491, #492, #493, #494, #495, #496, #497, #498, #499, #500, #501, #503, #504, #505, #506, #507, #509)

Full Changelog

New:

• isMockFunction utility for determining whether a given parameter is an Electron mock (#450)
• Types for mock object properties - calls, lastCall, results, invocationCallOrder (#442)

Fixed:

• before hook throws error when run without IPC bridge (#462)

Documentation:

• Added docs for isMockFunction utility (6dc6251)
• Added docs for mock object properties (1787c73)

Developer:

• CI: Add expense contribution workflow (#445, #451)
• CI: Release workflow improvements (#444, #460)
• Test: Add E2Es for mock object properties (cf1a71f)
• Test: Speed up onPrepare units by mocking Electron release response (#448)
• Scripts updated for husky v9 (#447)
• Updated Electron to v29 (#441)
• Updated dependencies (#430, #431, #432, #433, #434, #435, #436, #437, #438, #439, #463, #464, #465, #466, #467, #468, #469, #470, #471, #472, #473, a7c548d)

Full Changelog

• Merge pull request #450 from webdriverio-community/sm/ismockfunction (e9913da)
• refactor: move private members to the end, mark as @private (7b3f309)
• docs: add isMockFunction (6dc6251)
• test: add units for isMockFunction (ebd5d3b)
• test: fix by removing vitest import and replacing with abstracted dynamic import (4247b2e)
• fix: harden and simplify isMockFunction without vitest import (f56d943)
• Fix filepath (#451) (d43a92b)
• fix: standardisation nits of type comments (6829d9c)
• test: isMockFunction E2Es (77cfcaf)
• fix: re-export vitest from typedef (1442a85)
• feat: isMockFunction command (d9e698b)
• Merge pull request #448 from webdriverio-community/sm/fix-onprepare-b0rkage (f9eff32)
• test: speed up onPrepare units by mocking electron release response (a07d3da)
• Merge pull request #445 from seanpoulter/expense-workflow (d65220a)
• Format (0b22285)
• Merge pull request #447 from webdriverio-community/sm/husky-fix (710cca5)
• fix: update git hooks for husky v9 (2ba639f)
• docs: update for husky v9, improve formatting text (f627b18)
• fix: husky install is deprecated, run husky on prepare (dccc8f6)
• Merge pull request #444 from seanpoulter/main (df8d91d)
• ci: Add Expense Contribution workflow (8f09dde)
• Fix formatting (dbd38c8)
• Add a note to patch pre-releases (943f267)
• ci: Add pre-release to release workflow (a4fe63b)
• Merge pull request #442 from webdriverio-community/sm/update-mock-2 (54e79b0)
• chore: update lockfiles (f0c0378)
• test: improve readability, remove todo (d98728f)
• refactor: update types for mock context (3a977f6)
• docs: add mock object properties (1787c73)
• test: add tests for mock object properties (cf1a71f)
• feat: add types for mock object properties (251db91)
• Merge pull request #441 from webdriverio-community/sm/update-electron (9fcbddd)
• chore: update lockfiles (e1201e7)
• chore: update electron (057d1b5)
• chore(deps-dev): bump eslint from 8.56.0 to 8.57.0 (#431) (5f61310)
• chore(deps-dev): bump nock from 13.5.3 to 13.5.4 (#432) (8ec8777)
• chore(deps): bump electron-to-chromium from 1.4.674 to 1.4.682 (#437) (b245091)
• chore(deps-dev): bump webdriverio from 8.32.2 to 8.32.3 (#435) (2e145d4)
• chore(deps-dev): bump @wdio/cli from 8.32.2 to 8.32.3 (#434) (47605f1)
• chore(deps-dev): bump expect-webdriverio from 4.11.8 to 4.11.9 (#436) (5fb6da8)
• chore(deps-dev): bump vitest and @vitest/coverage-v8 (#433) (a0b9aaa)
• chore(deps-dev): bump @wdio/globals from 8.32.2 to 8.32.3 (#438) (346505b)
• chore(deps): bump @vitest/spy from 1.3.0 to 1.3.1 (#439) (f881b10)
• chore(deps-dev): bump @types/node from 20.11.19 to 20.11.20 (#430) (7c99747)

Fixed:

• Direct eval used in mocking functions (#427)

Developer:

• Updated dependencies (#425, #424, #423)

Full Changelog

Fixed:

• CJS output depends on @vitest/spy which is ESM only (#421)
• mockRestore should explicitly clear mocks (df0ecad)

Developer:

• Test: removed workaround for expect-webdriver E2E failures (100d27c)
• Test: removed bundling from example-cjs as it was masking errors (e0ad6a3)
• CJS symlinks replaced with copy at build time (bdc24e7, f784da0, 1515e80)
• Updated dependencies (#420, #418, #419, #417, #416, 599dd9b)

Full Changelog

• Merge pull request #410 from webdriverio-community/sm/remaining-mock-methods (c76a44e)
• refactor: tweaks, update typedocs (b6a5323)
• refactor: call mockName on outerMock (3fe917a)
• docs: update mockReturnThis (c380406)
• docs: add new functions (cd9fdd5)
• test: add default mock implementation test for getMockImplementation (1cc1095)
• chore: please prettier (7827665)
• fix: add workaround for expect-webdriver b0rkage (6a0b041)
• fix: move fast-copy to deps (8ab64ba)
• refactor: use unknown (7d29fa5)
• chore: fix formatting (7afda0e)
• Merge branch 'main' into sm/remaining-mock-methods (e5d6f27)
• chore: update jsdom (2c9a98d)
• chore: update lockfiles (a908638)
• test: increase mock coverage (debdef9)
• feat: mockReturnThis, withImplementation (5a0f39a)
• chore(deps-dev): bump @vitest/coverage-v8 from 1.2.0 to 1.2.1 (#407) (be8f5c0)
• chore(deps-dev): bump expect-webdriverio from 4.8.1 to 4.9.3 (#401) (83c83f9)
• chore(deps-dev): bump electron from 28.1.3 to 28.1.4 (#405) (4556b9e)
• chore(deps-dev): bump webdriverio from 8.27.2 to 8.28.8 (#399) (f0dce2c)
• chore(deps-dev): bump vitest from 1.2.0 to 1.2.1 (#408) (22bd249)
• chore(deps-dev): bump jsdom from 23.2.0 to 24.0.0 (#406) (7a4f703)
• chore(deps-dev): bump @wdio/cli from 8.27.2 to 8.28.8 (#403) (3ed12bb)
• chore(deps): bump electron-to-chromium from 1.4.632 to 1.4.641 (#400) (6dae347)
• chore(deps-dev): bump @typescript-eslint/parser from 6.19.0 to 6.19.1 (#404) (0e3365f)
• chore(deps-dev): bump @types/node from 20.11.4 to 20.11.5 (#402) (e0ebd3f)
• chore(deps-dev): bump @wdio/globals from 8.27.2 to 8.28.8 (#398) (285125e)

New:

• Added mock promise methods - mockResolvedValue, mockResolvedValueOnce, mockRejectedValue, mockRejectedValueOnce (#391)
• Improved mock performance by restricting mock updates to happen after non-internal execute commands (#393)

Documentation:

• Updated documentation for new mock promise methods (8959c9b)

Developer:

• Improved unit test coverage (#344)
• Updated dependencies

Full Changelog

Same code as 6.1.0

New:

• Mocking has been reworked again for a much improved, more Vitest-like experience (#346)
  • Mock objects now auto-update
  • mockImplementation, mockReturnValue and "once" variants are supported
  • Utilities and config options for clearing, resetting and restoring all mocks

Fixed:

• The service doesn't delay test execution until a BrowserWindow is available (#340)

Documentation:

• Rework of documentation - now using docs directory, README is streamlined (#346)
• Updated mocking documentation for the new approach (#346)

Developer:

• CI: release script distTag is now hooked up to release-it (#342)
• Formatting scripts now include yml, md, json (#343)
• Improved unit test coverage (#344)
• Miscellaneous type improvements
• Updated dependencies

Full Changelog

Fixed:

• Log entries for execute display the CONTEXT_BRIDGE_NOT_AVAILABLE error message string (#338)
• Single instance multiremote execute calls return an array of values (#329)

Developer:

• Refactored types, mostly around the CJS entrypoint (#325)
• Test: added retries to the E2Es to work around flaky interaction specs (#336)
• Test: updated vitest config for more accurate coverage (c4cee46), (30d9410), (262d192)
• Updated dependencies (9687c41)

Full Changelog

Developer:

• Test: added E2Es for an app built with electron-builder (#323)
• Updated electron to v28 everywhere (5bf5b37)

Full Changelog

• Merge pull request #255 from webdriverio-community/cb/better-mock (8d7a478)
• chore: update deps (95f8cda)
• refactor: standardise on runtime privacy (ad134e9)
• docs: update for new mocking (5b3f4cf)
• test: update for strict equality check (c2808f1)
• Merge pull request #310 from webdriverio-community/sm/remove-apis (abe59cb)
• chore: update lockfiles (ac9f0cd)
• refactor: update & extract types (0154a17)
• test: update units for apis removal (4ca698c)
• test: update e2es for apis removal (2f79be1)
• refactor: remove old api methods (2dadcae)
• Merge branch 'main' into cb/better-mock (c88e46a)
• docs: remove old API functions (25e94e3)
• Bump electron-to-chromium from 1.4.589 to 1.4.597 (#309) (25c67eb)
• Merge branch 'main' into cb/better-mock (30d0194)
• Merge pull request #269 from webdriverio-community/sm/better-mock-updates (b13b0d1)
• chore: update coverage (60f4994)
• chore: update lockfiles (75ceb33)
• feat: mockAll (f3e187f)
• refactor: streamlining mock API (0924870)
• feat: single line mocking (42dad2f)
• chore: update dependencies (e054c03)
• test: temporarily reduce coverage (dfede3a)
• test: add execute units (4bd0dcf)
• chore: update imports (8b62f23)
• test: add removeMock units (bd17446)
• chore: rename clearMocks => removeMocks (643477c)
• chore: standardise test imports (d9b122a)
• chore: update Electron (e94c6c0)
• fix: type for internal globalThis.fn (98f885b)
• chore: update lockfiles (c9ffd74)
• chore: formatting (b8b0f00)
• feat: mockReturnValue (2775064)
• test: expand mocking tests, misc fixes (475ff96)
• chore: update types (78e78ae)
• Bump @typescript-eslint/parser from 6.12.0 to 6.13.0 (#307) (5de7779)
• Bump @wdio/cli from 8.23.3 to 8.24.3 (#302) (29f26c5)
• Bump @wdio/types from 8.21.0 to 8.24.2 (#306) (02fa728)
• Bump @wdio/globals from 8.22.1 to 8.24.3 (#294) (918e4b8)
• Bump @typescript-eslint/eslint-plugin from 6.12.0 to 6.13.0 (#305) (b11f95b)
• Bump electron from 27.1.0 to 27.1.2 (#303) (18b1c46)
• Bump expect-webdriverio from 4.5.2 to 4.6.1 (#304) (b0bef77)
• Bump webdriverio from 8.23.3 to 8.24.3 (#296) (5f006fa)
• Bump @types/chromedriver from 81.0.4 to 81.0.5 (#300) (9019bd6)
• Bump @types/mocha from 10.0.4 to 10.0.6 (#298) (d54e941)
• Bump @eslint/js from 8.53.0 to 8.54.0 (#299) (d5ba88b)
• Bump @types/node from 20.8.10 to 20.10.0 (#295) (fc221f4)
• Bump jsdom from 22.1.0 to 23.0.0 (#297) (17506ab)
• chore: fix linting (2b6849b)
• test: update e2es for new mock (8941c5f)
• chore: update lockfiles (58715f8)
• feat: update mock (72b2c1a)
• chore: update mock tests for new approach (f94fdbe)
• chore: update missing types, add debug (d0289f0)
• chore: update deps (f43d9cd)
• Bump eslint-plugin-vitest from 0.3.9 to 0.3.10 (#291) (1814203)
• Bump eslint from 8.53.0 to 8.54.0 (#287) (d965abb)
• Bump webdriverio from 8.22.1 to 8.23.3 (#286) (c45f061)
• Bump electron from 27.0.4 to 27.1.0 (#290) (03a81e3)
• Bump @typescript-eslint/eslint-plugin from 6.11.0 to 6.12.0 (#293) (fc08cdc)
• Bump typescript from 5.2.2 to 5.3.2 (#292) (77bb83d)
• Bump @typescript-eslint/parser from 6.11.0 to 6.12.0 (#289) (38c5bad)
• Bump expect-webdriverio from 4.5.1 to 4.5.2 (#288) (b77e6b9)
• Bump @types/chromedriver from 81.0.3 to 81.0.4 (#284) (5e33a18)
• Bump @wdio/cli from 8.21.0 to 8.23.3 (#283) (f438a6c)
• Bump release-it from 16.2.1 to 17.0.0 (#285) (ab5c828)
• Bump electron-to-chromium from 1.4.582 to 1.4.589 (#282) (3caccc7)
• update electron-forge (553a6d8)
• update @vitest/spy (7923e8f)
• Bump lint-staged from 15.0.2 to 15.1.0 (#275) (7587a37)
• fix test (70c23e9)
• update deps (35c9840)
• Bump expect-webdriverio from 4.4.1 to 4.5.1 (#279) (901dd32)
• Bump @types/mocha from 10.0.3 to 10.0.4 (#281) (15eb462)
• Bump @typescript-eslint/eslint-plugin from 6.10.0 to 6.11.0 (#276) (d784af3)
• Bump @wdio/globals from 8.21.0 to 8.22.1 (#272) (5b52bfc)
• Bump @types/eslint-config-prettier from 6.11.2 to 6.11.3 (#280) (8fc6c77)
• Bump electron-to-chromium from 1.4.576 to 1.4.582 (#278) (d58667d)
• Bump @types/debug from 4.1.10 to 4.1.12 (#277) (4f2403e)
• Bump prettier from 3.0.3 to 3.1.0 (#273) (765a668)
• Bump @typescript-eslint/parser from 6.10.0 to 6.11.0 (#274) (bd41bce)
• Bump electron from 27.0.3 to 27.0.4 (#271) (3aa3481)
• Bump webdriverio from 8.21.0 to 8.22.1 (#270) (e8c7abd)
• update @vitest/spy, update lockfiles (e861e45)
• Merge branch 'cb/better-mock' into sm/better-mock-updates (a79ecd6)
• remove commonjs plugin from esm bundle (5bbd5a7)
• use @vitest/spy (0a9b505)
• move npmrc back to example-cjs (b7178f6)
• Merge branch 'main' into cb/better-mock (2118363)
• use @vitest/spy (63d2e2a)
• use WebdriverClientFunc type (7d7aad7)
• update lockfiles (4016091)
• add filter to init-dev (a09e586)
• ignore fixtures lockfiles (aa12125)
• fix test (b3ac35a)
• move npmrc to root (1bd6dbb)
• Bump eslint-plugin-vitest from 0.3.8 to 0.3.9 (#268) (a3b353a)
• Bump @typescript-eslint/eslint-plugin from 6.9.1 to 6.10.0 (#265) (1041065)
• Bump @wdio/globals from 8.20.5 to 8.21.0 (#261) (e74adac)
• Bump electron-to-chromium from 1.4.572 to 1.4.576 (#266) (17ec16a)
• Bump eslint from 8.52.0 to 8.53.0 (#267) (763529f)
• Bump nock from 13.3.7 to 13.3.8 (#263) (1032e27)
• Bump @wdio/cli from 8.20.5 to 8.21.0 (#264) (b87c285)
• Bump @eslint/js from 8.52.0 to 8.53.0 (#262) (f205d09)
• Bump webdriverio from 8.20.4 to 8.21.0 (#260) (2d50742)
• Bump electron from 27.0.2 to 27.0.3 (#258) (59f4bb3)
• Bump @wdio/types from 8.20.0 to 8.21.0 (#259) (ba34a8d)
• Bump read-pkg-up from 10.1.0 to 11.0.0 (#257) (6e3a295)
• Bump @typescript-eslint/parser from 6.9.1 to 6.10.0 (#256) (d3b6f44)
• (feat): jest/vitest like API mocking (114bebc)
• (feat): support function execution in main process (34a1f76)

• (feat): support function execution in main process (#254) (d58b62d)
• Merge pull request #253 from webdriverio-community/electron-builder-json-support (8f50a92)
• update electron 28 to beta (c52c361)
• fix electron-boilerplate link (8c5e24f)

New:

• Improved build tool config handling (#245) (b0fadd3)
  • Support for electron-builder.json
  • Support for forge.config.js
  • Custom JS config file support (Electron Forge)
  • More error cases handled - multiple build tools, no build tools, no app name
  • App name read from Forge config

Fixed:

• Detected app existence check returning false positives (8cb8159)
• CI: unnecessary recursive install on release (676cdfc)

Documentation:

• Removed reference to getBinaryPath util (6217116)
• Minor tweaks

Developer:

• Electron Forge now used in example-cjs (#243) (107d4f1)
• CI: Added auto update action for dependabot (6c8f329)
• CI: Updated PNPM in actions (48933da), (f334c63)
• Updated dependencies (c842ef3)

Full Changelog

• (feat): support multiremote (#223) (092ee8d)
• Update README.md (88ce9ef)