failure-reason-suggestions wip (#69)

* Failure reason suggestions

.gitignore

@@ -16,3 +16,4 @@ yarn-error.log
 packages/root-cause/api-reference
 verdaccio/verdaccio-storage
 lerna-debug.log
+guid_container

docs/failure-suggestions-telemetry.md

@@ -0,0 +1,17 @@
+# Failure suggestions telemetry
+
+As part of an incubating feature, we are collection some basic telemetry & usage statistics.
+
+We don't collect any personal/business data nor information about the application under test or the test code itself.
+
+The data we collect per root cause execution:
+
+- Operating system name (windows/linux/darwin)
+- uid - randomly generated local project identifier
+- artifacts: count of Root Cause artifacts generated during test run (eg: screenshots)
+- age: Project install time
+- Crashes: number of failed tests
+
+## Opt-out
+
+It's possible to out-out from the telemetry collection by setting an environment variable: `SUGGESTIONS_OPT_OUT`

integration-examples/jest-and-puppeteer/jest.config.js

@@ -1,20 +1,7 @@
 'use strict';
 
-const puppeteerPreset = require('jest-puppeteer-preset/jest-preset.json');
-
-// The run id should be unique across runs
-const runId = Date.now().toString();
-
 module.exports = {
-    ...puppeteerPreset,
-    reporters: [
-        ['@testim/root-cause-jest/lib/reporter/default', { runId }],
-    ],
-    setupFilesAfterEnv: [
-        ...puppeteerPreset.setupFilesAfterEnv,
-        '@testim/root-cause-jest/lib/forSetupFilesAfterEnv'
-    ],
-    globals: {
-        runId,
-    },
+  preset: 'jest-puppeteer-preset',
+  testEnvironment: '@testim/root-cause-jest/lib/RootCauseJestEnv',
+  reporters: ['@testim/root-cause-jest/lib/reporter/default'],
 };