Assistance with starting webdriverio v7 and v8 and wdio video reporter v4 and v5 #122

troyyer · 2024-01-15T03:21:33Z

troyyer
Jan 15, 2024

Hi,
I am currently using wdio-video-reporter v3.5 on Webdriverio V7 without any issue. However, when I change my version for V3.5 to Video Reporter V4 and up ( Wdio is left at V7 ) i am getting the issue below

Error: Type check for option "reporters" failed: a reporter should be either a string in the format "wdio-<reportername>-reporter" or a function/class. Please see the docs for more information on custom reporters (https://webdriver.io/docs/customreporter)
    at validateConfig (file:///C:/code/wdiov7-video-reporter/node_modules/@wdio/config/build/utils.js:57:27)
    at Launcher.run (file:///C:/code/wdiov7-video-reporter/node_modules/@wdio/cli/build/launcher.js:52:9)

At the top of my wdio.conf.js file i have the following code

const video = require('wdio-video-reporter');

exports.config = { 
....

and in the reporters section I have

    reporters: ['spec'
				,'junit'
				['video',
	                	//[video,
                    {
                        saveAllVideos: true,
                        videoSlowdownMultiplier: 20,
                        addExcludedActions: [],
                        logLevel: "silent",
                    }],
				],

when in the reporters section, video is a string or if video is a variable I get the below error

2024-01-15T03:13:02.101Z INFO @wdio/local-runner: Start worker 0-0 with arg: run,./wdio.conf.js
[0-0] 2024-01-15T03:13:03.077Z INFO @wdio/local-runner: Run worker command: run
[0-0] 2024-01-15T03:13:03.209Z ERROR @wdio/runner: Error: Type check for option "reporters" failed: a reporter should be either a string in the format "wdio-<reportername>-reporter" or a function/class. Please see the docs for more information on custom reporters (https://webdriver.io/docs/customreporter)
[0-0]     at validateConfig (C:\code\wdiov7-video-reporter\node_modules\@wdio\config\build\utils.js:70:27)
[0-0]     at remote (C:\code\wdiov7-video-reporter\node_modules\webdriverio\build\index.js:58:48)
[0-0]     at initialiseInstance (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\utils.js:64:41)
[0-0]     at Runner._startSession (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\index.js:223:93)
[0-0]     at Runner.run (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\index.js:66:34)
[0-0]     at process.<anonymous> (C:\code\wdiov7-video-reporter\node_modules\@wdio\local-runner\build\run.js:24:30)
[0-0]     at process.emit (node:events:526:35)
[0-0]     at process.emit (node:domain:488:12)
[0-0]     at emit (node:internal/child_process:951:14)
[0-0]     at process.processTicksAndRejections (node:internal/process/task_queues:83:21)
[0-0] 2024-01-15T03:13:03.232Z ERROR @wdio/local-runner: Failed launching test session: Error: Invalid reporters config
[0-0]     at BaseReporter.initReporter (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\reporter.js:166:15)
[0-0]     at Array.map (<anonymous>)
[0-0]     at new BaseReporter (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\reporter.js:22:50)
[0-0]     at Runner.run (C:\code\wdiov7-video-reporter\node_modules\@wdio\runner\build\index.js:78:26)
[0-0]     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

When it comes to Version 5 of wdio-video-reporter, I am getting an error with latest for wdio-video-reporter V5.1.0
my sample code is here
https://github.com/troyyer/wdiov8-sample-for-video-reporter

i'm getting a "cant find module" error

 const video = require('wdio-video-reporter')

--->

Error: Cannot find module 'wdio-video-reporter'
Require stack:
- C:\code\sample\wdio.conf.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1048:15)
    at Module._load (node:internal/modules/cjs/loader:901:27)
    at Module.require (node:internal/modules/cjs/loader:1115:19)
    at require (node:internal/modules/helpers:130:18)
    at Object.<anonymous> (C:\code\sample\wdio.conf.js:1:15)
    at Module._compile (node:internal/modules/cjs/loader:1241:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1295:10)
    at Module.load (node:internal/modules/cjs/loader:1091:32)
    at Module._load (node:internal/modules/cjs/loader:938:12)
    at cjsLoader (node:internal/modules/esm/translators:284:17)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:234:7)
    at ModuleJob.run (node:internal/modules/esm/module_job:217:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:316:24)
    at async ConfigParser.addConfigFile (file:///C:/code/sample/node_modules/@wdio/config/build/node/ConfigParser.js:86:36)
    at async ConfigParser.initialize (file:///C:/code/sample/node_modules/@wdio/config/build/node/ConfigParser.js:48:13)
    at async Launcher.run (file:///C:/code/sample/node_modules/@wdio/cli/build/launcher.js:41:9) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [ 'C:\\code\\sample\\wdio.conf.js' ]

tried the following change also to no avail

 const video = require('../dist/wdio-video-reporter.mjs')
----->
Error: Cannot find module '../dist/wdio-video-reporter.mjs'

not sure what to change in my config files to get the latest versions of wdio-video-reporter

Answered by seanpoulter

Mar 6, 2024

@troyyer, the first error is saying video needs to be a string:

https://github.com/troyyer/wdiov8-sample-for-video-reporter/blob/06b32d200a909c1158c8b1c0f0e74505442378c0/wdio.conf.js#L143-L152

     reporters: ['spec'
 				,'junit'
-				[video,
+				['video',
                     {
                         saveAllVideos: true,

You don't need to import the module in wdio.conf.js it just needs to be installed as a devDependency. You've done that.

I tried running your example in a codespace and this worked without an error from the reporters:

    reporters: ['spec',
                'junit',
                ['video', {
                    saveAllVideos: true,
                    videoSlowdownM…

View full answer

umarkhanTR · 2024-03-05T19:51:15Z

umarkhanTR
Mar 5, 2024

I'm trying to use
const video = require('wdio-video-reporter');

but I get following error:

node_modules\wdio-video-reporter\dist\wdio-video-reporter.mjs:1
import os from 'node:os';
^^^^^^

tried with 5.1.4 video reporter https://www.npmjs.com/package/wdio-video-reporter

1 reply

seanpoulter Mar 6, 2024
Maintainer

What does the error say @umarkhanTR?

Is it something like "No default export for module 'os'?" If that's the case, try import * as os from 'node:os'.

seanpoulter · 2024-03-06T01:18:10Z

seanpoulter
Mar 6, 2024
Maintainer

@troyyer, the first error is saying video needs to be a string:

https://github.com/troyyer/wdiov8-sample-for-video-reporter/blob/06b32d200a909c1158c8b1c0f0e74505442378c0/wdio.conf.js#L143-L152

     reporters: ['spec'
 				,'junit'
-				[video,
+				['video',
                     {
                         saveAllVideos: true,

You don't need to import the module in wdio.conf.js it just needs to be installed as a devDependency. You've done that.

I tried running your example in a codespace and this worked without an error from the reporters:

    reporters: ['spec',
                'junit',
                ['video', {
                    saveAllVideos: true,
                    videoSlowdownMultiplier: 20,
                    addExcludedActions: [],
                    logLevel: "silent",
                }],
    ],

3 replies

troyyer Mar 6, 2024
Author

Hi @seanpoulter
Thanks for the further details you supplied. That was the fix along with a typo blunder on my side as well..
in my code there was no comma between the 'junit' reporter and the video block.....
so ya removing the import/require statement and changing it to string got it working like a charm for V8. however for V7 of wdio I am getting the error that @umarkhanTR is getting

[0-0] 2024-03-06T23:42:32.909Z ERROR @wdio/local-runner: Failed launching test session: Error: Couldn't 
initialise "wdio-video-reporter".
[0-0] C:\code\wdio-guardian-salesforce\node_modules\wdio-video-reporter\dist\wdio-video-reporter.mjs:1
[0-0] import os from 'node:os';
[0-0] ^^^^^^
[0-0]
[0-0] SyntaxError: Cannot use import statement outside a module
[0-0]     at Object.compileFunction (node:vm:352:18)
[0-0]     at wrapSafe (node:internal/modules/cjs/loader:1033:15)
[0-0]     at Module._compile (node:internal/modules/cjs/loader:1069:27)
[0-0]     at Module._compile (C:\code\wdio-guardian-salesforce\node_modules\pirates\lib\index.js:117:24)[0-0]     at Module._extensions..js (node:internal/modules/cjs/loader:1159:10)
[0-0]     at Object.newLoader [as .mjs] (C:\code\wdio-guardian-salesforce\node_modules\pirates\lib\index.js:121:7)
[0-0]     at Module.load (node:internal/modules/cjs/loader:981:32)
[0-0]     at Function.Module._load (node:internal/modules/cjs/loader:822:12)
[0-0]     at Module.require (node:internal/modules/cjs/loader:1005:19)
[0-0]     at require (node:internal/modules/cjs/helpers:102:18)
[0-0]     at safeRequire (C:\code\wdio-guardian-salesforce\node_modules\@wdio\utils\build\utils.js:192:15)
[0-0]     at initialisePlugin (C:\code\wdio-guardian-salesforce\node_modules\@wdio\utils\build\initialisePlugin.js:37:44)
[0-0]     at BaseReporter.initReporter (C:\code\wdio-guardian-salesforce\node_modules\@wdio\runner\build\reporter.js:154:58)
[0-0]     at Array.map (<anonymous>)
[0-0]     at new BaseReporter (C:\code\wdio-guardian-salesforce\node_modules\@wdio\runner\build\reporter.js:22:50)
[0-0]     at Runner.run (C:\code\wdio-guardian-salesforce\node_modules\@wdio\runner\build\index.js:78:26)
[0-0] FAILED

seanpoulter Mar 9, 2024
Maintainer

Ah, right, you might find this article helpful. It's the best one I've found so far to help explain all the rules navigating CommonJS and ES Modules. The error you see is caused by the second rule they present -- Common JS modules are not able to use import.
https://redfin.engineering/node-modules-at-war-why-commonjs-and-es-modules-cant-get-along-9617135eeca1

Unfortunately that's all the help I'm able to provide. I've actively avoided this category of problem by being selective what dependencies I've used to avoid these problems and focus on the interesting problems. If you can, I'd recommend using v8 since v9 is in the works. Good luck!

troyyer Mar 12, 2024
Author

Thanks @seanpoulter,I'll mark your above statement as the answer for V8. For V7 some of the other Test Engineers found that wdio-video-reporter V4.0.4 works with our current V7 wdio Framework so will just leave it on that for now and then do the necessary upgrades to push us to V8 of wdio.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Assistance with starting webdriverio v7 and v8 and wdio video reporter v4 and v5 #122

{{title}}

Replies: 2 comments 4 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

Assistance with starting webdriverio v7 and v8 and wdio video reporter v4 and v5 #122

troyyer Jan 15, 2024

Replies: 2 comments · 4 replies

umarkhanTR Mar 5, 2024

seanpoulter Mar 6, 2024 Maintainer

seanpoulter Mar 6, 2024 Maintainer

troyyer Mar 6, 2024 Author

seanpoulter Mar 9, 2024 Maintainer

troyyer Mar 12, 2024 Author

troyyer
Jan 15, 2024

Replies: 2 comments 4 replies

umarkhanTR
Mar 5, 2024

seanpoulter Mar 6, 2024
Maintainer

seanpoulter
Mar 6, 2024
Maintainer

troyyer Mar 6, 2024
Author

seanpoulter Mar 9, 2024
Maintainer

troyyer Mar 12, 2024
Author