feat: Allow user to set browser preferences

[christian-bromann]

implements: #213

In WebdriverIO we offer to run automated browser tests using WebDriver or CDP (via Puppeteer). When we start a Puppeteer browser we use this package as it gives us more options to set the browser session. However it is not possible to set a custom set of browser preferences, e.g. to define the default download directory. This patch adds this capability to the package. To create feature parity given that Chromedriver allows this, it would be great if we could add this.

[patrickhulce]

thanks @christian-bromann !

[patrickhulce]

LGTM when tests pass, thanks! :)

[christian-bromann]

Is there anything else I can do?

[patrickhulce]

you just did it (a reminder when the tests pass 😉 )

thanks @christian-bromann!

[NavyMint]

Hi guys. @patrickhulce @paulirish sorry for disturbing you, do you guys know when we can expect this feature to be released?

[patrickhulce]

@NavyMint PR is up for release :) #249

[NavyMint]

@NavyMint PR is up for release :) #249

thank you :) @patrickhulce

[paulirish]

@christian-bromann this preference file thing.. works, right?
We've never used this technique, but if it works for you, that's great to hear. :)

[christian-bromann]

@paulirish I tried to verify and it seems to not work anymore. Launching Chrome as following:

"/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary" --remote-debugging-port=61586 --user-data-dir=/var/folders/3_/pzc_f56j15vbd9z3r0j050sh0000gn/T/lighthouse.XXXXXXX.cofPsDof --enable-automation --disable-popup-blocking --disable-extensions --disable-background-networking --disable-background-timer-throttling --disable-backgrounding-occluded-windows --disable-sync --metrics-recording-only --disable-default-apps --mute-audio --no-first-run --no-default-browser-check --disable-hang-monitor --disable-prompt-on-repost --disable-client-side-phishing-detection --password-store=basic --use-mock-keychain --disable-component-extensions-with-background-pages --disable-breakpad --disable-dev-shm-usage --disable-ipc-flooding-protection --disable-renderer-backgrounding --force-fieldtrials=*BackgroundTracing/default/ --enable-features=NetworkService,NetworkServiceInProcess --disable-features=site-per-process,TranslateUI,BlinkGenPropertyTrees --window-position=0,0 --window-size=1200,900 --auto-open-devtools-for-tabs --window-size=1600,1200 about:blank

While having a pref file written at /var/folders/3_/pzc_f56j15vbd9z3r0j050sh0000gn/T/lighthouse.XXXXXXX.cofPsDof/Preferences with the contents of

{
    "devtools.preferences.currentDockState": "\"bottom\"",
    "devtools.preferences.splitLocation": "\"50%\"",
    "devtools.preferences.panel-selectedTab": "\"console\""
}

Does not to have any effect anymore.

[Junyan]

@christian-bromann Try setting it to this file: /var/folders/3_/pzc_f56j15vbd9z3r0j050sh0000gn/T/lighthouse.XXXXXXX.cofPsDof/Default/Preferences

This is a demo.

[paulirish]

@christian-bromann yeah i think you're missing the /Default/ in the pref file path. I just tried this out and it seems to work.

[christian-bromann]

Thanks @paulirish , I will look into raising a PR with a fix for this.