Don't create thumbnails by default

[taiki-fw]

Purpose

Make thumbnails generation customizable when taking screenshots.
(By default, thumbnails are not generated when taking screenshots.)

Approach

• Added thumbnails to Screenshot Options for the -s (--screenshots) command line flag. (e.g. -s thumbnails=true)
• Added the thumbnails parameter of the screenshots API method. (e.g. takeScreenshot({thumbnails: true}))

References

resolved #1550

Pre-Merge TODO

• Write tests for your proposed changes
• Make sure that existing tests do not fail

[testcafe-build-bot]

❌ Tests for the commit 9a95ddc have failed. See details:

• ✅ continuous-integration/appveyor/branch

• ✅ continuous-integration-azure-desktop

• ❌ continuous-integration-azure-mobile

• ❌ Travis CI - Branch.

[testcafe-build-bot]

❌ Tests for the commit ab8e7a8 have failed. See details:

• ✅ continuous-integration/appveyor/branch

• ✅ continuous-integration-azure-mobile

• ✅ continuous-integration-azure-desktop

• ❌ Travis CI - Branch.

[testcafe-build-bot]

❌ Tests for the commit c9b7a07 have failed. See details:

• ✅ continuous-integration/appveyor/branch

• ❌ continuous-integration-azure-mobile

• ✅ continuous-integration-azure-desktop

• ❌ Travis CI - Branch.

[AndreyBelym]

Thank you for your contribution! The code is very good, but I feel that we should discuss some points:

1. Disabling thumbnails by default can be considered as a breaking change. If someone has a scripts that simply counts all files in the screenshots directory, they will have failed tests after this change. So let's just use true as the default value for the thumbnails options.
2. It's awesome that you added a functional test. Could you please add some a unit test for the configuration parser:
   https://github.com/DevExpress/testcafe/blob/master/test/server/configuration-test.js#L159

[AndreyBelym]

Hi @taiki-fw, would you like to address my suggestions? If you don't plan to maintain this PR anymore, I can assign myself or some other TestCafe developer to it.

[taiki-fw]

Hi! @AndreyBelym. Thank you for replying to the message.
Sorry, I couldn't handle it because I was busy.
But, I want to deal with your suggestion on May 1st.
Please wait a little more:pray:.

[taiki-fw]

Hi! @AndreyBelym.
I deal with your suggestion , so please review it.
I made a different change from the original Purpose and Approach, should I change it?

[wentwrong]

@taiki-fw, thank you for addressing the suggestions. We'll review this PR and get back to you soon.

[joma74]

1.16.0

• Does not work if via runTestCafe programmatic configuration
• typescript definitions not updated

[miherlosev]

Does not work if via runTestCafe programmatic configuration

I ran a test using the programmatic interface - everything works correctly on my side.
run.js

(async () => {
    const createTestCafe = require('testcafe');

    const testcafe = await createTestCafe();

    await testcafe
        .createRunner()
        .src('test.ts')
        .browsers('chrome')
	.screenshots({ thumbnails: false })
        .run();

    await testcafe.close();
})();

test.ts

fixture `Fixture`;

test('test', async t => {
	await t.takeScreenshot();
});

Could you please share an example where the issue is reproduced?

typescript definitions not updated

I created a PR with the definition update.

[joma74]

Confirm that object style option works as per your example. Which i will switch to as soon as that TS Def is available :)

But, comment refered to the parameter style option https://testcafe.io/documentation/402654/reference/testcafe-api/runner/screenshots which is described as:
obsolete: screenshots(path [, takeOnFails] [, pathPattern] [,fullPage] [,thumbnails]) → this.

Definition of obsolete is missing for me. Do you mean deprecated? That is supported but will be removed in future version?

If parameter style option is still supported, this case is not working. Plus the TS Def for that style is also missing.

Example:
.screenshots( // @ts-ignore ENVMODE.hasVDevelopment() ? process.env["npm_package_config_screenshots_dev"] : process.env["npm_package_config_screenshots_prod"], true, process.env["npm_package_config_screenshot-path-pattern"], // @ts-ignore false, // @ts-ignore false, )

[miherlosev]

Definition of obsolete is missing for me. Do you mean deprecated?

Yes, you are right. Deprecated is a more suitable word. I created an issue for this.

If parameter style option is still supported, this case is not working. Plus the TS Def for that style is also missing.

The new options are only supported when using the 'object parameter' style. The TypeScript definitions are present for the supported options. In the future, we have plans to add a warning when using deprecated API.