@chromatic-com/vitest 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/archive-storybook-Bqn7D3Ez.mjs +55 -0
- package/dist/bin/archive-storybook.mjs +47 -0
- package/dist/bin/build-archive-storybook.mjs +65 -0
- package/dist/constants-Dos4OOMt.mjs +68 -0
- package/dist/{index.d.ts → index.d.mts} +48 -42
- package/dist/index.mjs +44 -0
- package/dist/plugin.d.mts +102 -0
- package/dist/plugin.mjs +2604 -0
- package/dist/setupFile.mjs +66 -0
- package/dist/storybook-config/main.mjs +62 -0
- package/dist/storybook-config/manager.mjs +12 -0
- package/dist/storybook-config/preview.mjs +113 -0
- package/dist/telemetry-DOABfuU5.mjs +320 -0
- package/dist/telemetry-sender.mjs +14 -0
- package/dist/waitForIdleNetwork-CEON19Zg.mjs +193 -0
- package/package.json +28 -23
- package/dist/bin/archive-storybook.d.ts +0 -1
- package/dist/bin/archive-storybook.js +0 -368
- package/dist/bin/build-archive-storybook.d.ts +0 -1
- package/dist/bin/build-archive-storybook.js +0 -383
- package/dist/index.js +0 -250
- package/dist/plugin.d.ts +0 -99
- package/dist/plugin.js +0 -2148
- package/dist/setupFile.d.ts +0 -2
- package/dist/setupFile.js +0 -287
- package/dist/storybook-config/main.d.ts +0 -5
- package/dist/storybook-config/main.js +0 -88
- package/dist/storybook-config/manager.d.ts +0 -2
- package/dist/storybook-config/manager.js +0 -14
- package/dist/storybook-config/preview.d.ts +0 -17
- package/dist/storybook-config/preview.js +0 -138
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { createMirror, snapshot } from "@chromaui/rrweb-snapshot";
|
|
2
|
+
import * as vitest from "vitest";
|
|
3
|
+
import { assert, inject } from "vitest";
|
|
4
|
+
import { commands, server } from "vitest/browser";
|
|
5
|
+
|
|
6
|
+
//#region src/browser/getCurrentTest.ts
|
|
7
|
+
const hooks = await resolveHooks();
|
|
8
|
+
function getCurrentTest() {
|
|
9
|
+
return hooks.getCurrentTest();
|
|
10
|
+
}
|
|
11
|
+
function getCurrentSuite() {
|
|
12
|
+
return hooks.getCurrentSuite();
|
|
13
|
+
}
|
|
14
|
+
async function resolveHooks() {
|
|
15
|
+
if (vitest.TestRunner) return vitest.TestRunner;
|
|
16
|
+
return await import("vitest/suite");
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
//#endregion
|
|
20
|
+
//#region src/browser/isChromium.ts
|
|
21
|
+
function isChromium() {
|
|
22
|
+
return server.browser === "chromium";
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
//#endregion
|
|
26
|
+
//#region src/browser/telemetry.ts
|
|
27
|
+
function trackEvent(event) {
|
|
28
|
+
if (inject("__chromatic_options")?.telemetry.enabled ?? false) commands.__chromatic_telemetry(event).catch(() => {});
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
//#endregion
|
|
32
|
+
//#region src/browser/public/takeSnapshot.ts
|
|
33
|
+
async function takeSnapshot(name, options) {
|
|
34
|
+
if (!isChromium()) return;
|
|
35
|
+
const test = getCurrentTest();
|
|
36
|
+
if (!test) {
|
|
37
|
+
trackEvent({
|
|
38
|
+
eventType: "take_snapshot_invalid_call",
|
|
39
|
+
level: "error",
|
|
40
|
+
payload: {
|
|
41
|
+
isInsideTest: false,
|
|
42
|
+
isRegisteredTest: void 0,
|
|
43
|
+
isAwaited: void 0
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
throw new TypeError("takeSnapshot() must be called within a test()");
|
|
47
|
+
}
|
|
48
|
+
if (!test.meta.__chromatic_isRegistered) {
|
|
49
|
+
trackEvent({
|
|
50
|
+
eventType: "take_snapshot_invalid_call",
|
|
51
|
+
level: "error",
|
|
52
|
+
payload: {
|
|
53
|
+
isInsideTest: true,
|
|
54
|
+
isRegisteredTest: false,
|
|
55
|
+
isAwaited: void 0
|
|
56
|
+
}
|
|
57
|
+
});
|
|
58
|
+
throw new TypeError(`takeSnapshot() cannot be called in a test that is not registered for Chromatic plugin.\nMake sure ${test.file.projectName || "root"} project has chromaticPlugin() enabled.`);
|
|
59
|
+
}
|
|
60
|
+
const mirror = createMirror();
|
|
61
|
+
const domSnapshot = snapshot$1({
|
|
62
|
+
document,
|
|
63
|
+
mirror,
|
|
64
|
+
onError: trackSnapshotError("capture")
|
|
65
|
+
});
|
|
66
|
+
const pseudoClassIds = {};
|
|
67
|
+
for (const className of [
|
|
68
|
+
":hover",
|
|
69
|
+
":focus",
|
|
70
|
+
":focus-visible",
|
|
71
|
+
":active"
|
|
72
|
+
]) {
|
|
73
|
+
const elements = document.querySelectorAll(className);
|
|
74
|
+
pseudoClassIds[className] = Array.from(elements, (el) => mirror.getId(el)).filter((id) => id !== -1);
|
|
75
|
+
}
|
|
76
|
+
const save = async () => {
|
|
77
|
+
await replaceBlobUrls(domSnapshot).catch(trackSnapshotError("replace-blob-urls"));
|
|
78
|
+
await commands.__chromatic_uploadDOMSnapshot(test.id, domSnapshot, pseudoClassIds, name ?? null, options).catch(trackSnapshotError("upload"));
|
|
79
|
+
test.meta.__chromatic_isTakeSnapshotCalled = true;
|
|
80
|
+
};
|
|
81
|
+
if (options?.isAutomaticSnapshot) return await save();
|
|
82
|
+
const error = /* @__PURE__ */ new Error("takeSnapshot() call was not awaited!");
|
|
83
|
+
Error.captureStackTrace?.(error, takeSnapshot);
|
|
84
|
+
const pendingCall = {
|
|
85
|
+
promise: save(),
|
|
86
|
+
error
|
|
87
|
+
};
|
|
88
|
+
test.meta.__chromatic_pendingTakeSnapshots ||= [];
|
|
89
|
+
test.meta.__chromatic_pendingTakeSnapshots.push(pendingCall);
|
|
90
|
+
await pendingCall.promise.finally(() => {
|
|
91
|
+
const index = test.meta.__chromatic_pendingTakeSnapshots?.indexOf(pendingCall);
|
|
92
|
+
if (index !== void 0 && index !== -1) test.meta.__chromatic_pendingTakeSnapshots?.splice(index, 1);
|
|
93
|
+
});
|
|
94
|
+
function trackSnapshotError(operation) {
|
|
95
|
+
return function onError(error) {
|
|
96
|
+
trackEvent({
|
|
97
|
+
eventType: "snapshot_error",
|
|
98
|
+
level: "error",
|
|
99
|
+
payload: {
|
|
100
|
+
operation,
|
|
101
|
+
isAutomaticSnapshot: options?.isAutomaticSnapshot ?? false,
|
|
102
|
+
error: error instanceof Error ? error.stack ?? error.message : String(error)
|
|
103
|
+
}
|
|
104
|
+
});
|
|
105
|
+
throw error;
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
function snapshot$1(options) {
|
|
110
|
+
try {
|
|
111
|
+
const domSnapshot = snapshot(options.document, {
|
|
112
|
+
recordCanvas: true,
|
|
113
|
+
mirror: options.mirror
|
|
114
|
+
});
|
|
115
|
+
assert(domSnapshot, "Failed to capture DOM snapshot");
|
|
116
|
+
return domSnapshot;
|
|
117
|
+
} catch (error) {
|
|
118
|
+
options.onError(error);
|
|
119
|
+
throw error;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
async function replaceBlobUrls(node) {
|
|
123
|
+
if (!("childNodes" in node)) return;
|
|
124
|
+
await Promise.all(node.childNodes.map(async (childNode) => {
|
|
125
|
+
if ("tagName" in childNode && childNode.tagName === "img" && typeof childNode.attributes.src === "string" && childNode.attributes.src?.startsWith("blob:")) {
|
|
126
|
+
const base64Url = await toDataURL(childNode.attributes.src);
|
|
127
|
+
childNode.attributes.src = base64Url;
|
|
128
|
+
}
|
|
129
|
+
if ("childNodes" in childNode && childNode.childNodes?.length) await replaceBlobUrls(childNode);
|
|
130
|
+
}));
|
|
131
|
+
}
|
|
132
|
+
async function toDataURL(url) {
|
|
133
|
+
const blob = await fetch(url).then((res) => res.blob());
|
|
134
|
+
return new Promise((resolveFileRead, reject) => {
|
|
135
|
+
const reader = new FileReader();
|
|
136
|
+
reader.onloadend = () => resolveFileRead(reader.result?.toString() || "");
|
|
137
|
+
reader.onerror = reject;
|
|
138
|
+
reader.readAsDataURL(blob);
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
//#endregion
|
|
143
|
+
//#region src/browser/public/waitForIdleNetwork.ts
|
|
144
|
+
async function waitForIdleNetwork(timeout, options) {
|
|
145
|
+
if (!isChromium()) return;
|
|
146
|
+
const isCalledByUser = options?._internal !== true;
|
|
147
|
+
const test = getCurrentTest();
|
|
148
|
+
if (!test) {
|
|
149
|
+
trackEvent({
|
|
150
|
+
eventType: "wait_for_idle_network_invalid_call",
|
|
151
|
+
level: "error",
|
|
152
|
+
payload: {
|
|
153
|
+
isInsideTest: false,
|
|
154
|
+
isRegisteredTest: void 0,
|
|
155
|
+
isCalledByUser
|
|
156
|
+
}
|
|
157
|
+
});
|
|
158
|
+
throw new TypeError("waitForIdleNetwork() must be called within a test()");
|
|
159
|
+
}
|
|
160
|
+
if (!test.meta.__chromatic_isRegistered) {
|
|
161
|
+
trackEvent({
|
|
162
|
+
eventType: "wait_for_idle_network_invalid_call",
|
|
163
|
+
level: "error",
|
|
164
|
+
payload: {
|
|
165
|
+
isInsideTest: true,
|
|
166
|
+
isRegisteredTest: false,
|
|
167
|
+
isCalledByUser
|
|
168
|
+
}
|
|
169
|
+
});
|
|
170
|
+
throw new TypeError(`waitForIdleNetwork() cannot be called in a test that is not registered for Chromatic plugin.\nMake sure ${test.file.projectName || "root"} project has chromaticPlugin() enabled.`);
|
|
171
|
+
}
|
|
172
|
+
if (isCalledByUser) trackEvent({
|
|
173
|
+
eventType: "wait_for_idle_network_called",
|
|
174
|
+
level: "info",
|
|
175
|
+
payload: { timeout }
|
|
176
|
+
});
|
|
177
|
+
try {
|
|
178
|
+
await commands.__chromatic_waitForIdleNetwork(timeout);
|
|
179
|
+
} catch (error) {
|
|
180
|
+
if (error instanceof Error && error.message.includes("Timed out waiting for network to be idle")) trackEvent({
|
|
181
|
+
eventType: "wait_for_idle_network_timeout",
|
|
182
|
+
level: "error",
|
|
183
|
+
payload: {
|
|
184
|
+
timeout,
|
|
185
|
+
isCalledByUser
|
|
186
|
+
}
|
|
187
|
+
});
|
|
188
|
+
throw error;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
//#endregion
|
|
193
|
+
export { getCurrentSuite as a, isChromium as i, takeSnapshot as n, getCurrentTest as o, trackEvent as r, waitForIdleNetwork as t };
|
package/package.json
CHANGED
|
@@ -1,39 +1,45 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chromatic-com/vitest",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Chromatic Visual Regression Testing for Vitest",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Chromatic <tom@chromatic.com>",
|
|
5
7
|
"repository": {
|
|
6
8
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/chromaui/chromatic-e2e.git",
|
|
9
|
+
"url": "git+https://github.com/chromaui/chromatic-e2e.git",
|
|
8
10
|
"directory": "packages/vitest"
|
|
9
11
|
},
|
|
10
|
-
"
|
|
11
|
-
|
|
12
|
+
"bin": {
|
|
13
|
+
"archive-storybook": "dist/bin/archive-storybook.mjs",
|
|
14
|
+
"build-archive-storybook": "dist/bin/build-archive-storybook.mjs"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"embedded"
|
|
19
|
+
],
|
|
12
20
|
"type": "module",
|
|
21
|
+
"main": "dist/index.mjs",
|
|
22
|
+
"types": "dist/index.d.mts",
|
|
13
23
|
"exports": {
|
|
14
24
|
".": {
|
|
15
|
-
"types": "./dist/index.d.
|
|
16
|
-
"
|
|
25
|
+
"types": "./dist/index.d.mts",
|
|
26
|
+
"default": "./dist/index.mjs"
|
|
17
27
|
},
|
|
18
28
|
"./plugin": {
|
|
19
|
-
"types": "./dist/plugin.d.
|
|
20
|
-
"
|
|
29
|
+
"types": "./dist/plugin.d.mts",
|
|
30
|
+
"default": "./dist/plugin.mjs"
|
|
21
31
|
},
|
|
22
|
-
"./bin/archive-storybook": "./dist/bin/archive-storybook.
|
|
23
|
-
"./bin/build-archive-storybook": "./dist/bin/build-archive-storybook.
|
|
32
|
+
"./bin/archive-storybook": "./dist/bin/archive-storybook.mjs",
|
|
33
|
+
"./bin/build-archive-storybook": "./dist/bin/build-archive-storybook.mjs",
|
|
34
|
+
"./package.json": "./package.json"
|
|
24
35
|
},
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
"build-archive-storybook": "dist/bin/build-archive-storybook.js"
|
|
36
|
+
"publishConfig": {
|
|
37
|
+
"access": "public"
|
|
28
38
|
},
|
|
29
|
-
"files": [
|
|
30
|
-
"dist",
|
|
31
|
-
"embedded"
|
|
32
|
-
],
|
|
33
39
|
"dependencies": {
|
|
34
40
|
"@chromaui/rrweb-snapshot": "2.0.0-alpha.19-noAbsolute",
|
|
35
|
-
"storybook": "10.2.13",
|
|
36
41
|
"std-env": "^4.2.0",
|
|
42
|
+
"storybook": "10.2.13",
|
|
37
43
|
"tinyexec": "^1.2.4",
|
|
38
44
|
"tinyrainbow": "^3.1.0"
|
|
39
45
|
},
|
|
@@ -45,19 +51,18 @@
|
|
|
45
51
|
"@vitest/browser-playwright": "^5.0.0",
|
|
46
52
|
"extend-to-be-announced": "2.0.0",
|
|
47
53
|
"msw": "^2.12.10",
|
|
48
|
-
"
|
|
49
|
-
"tsup": "^7.3.0",
|
|
54
|
+
"tsdown": "^0.22.14",
|
|
50
55
|
"vitest": "^5.0.0",
|
|
51
56
|
"@chromatic-com/shared-e2e": "0.11.6"
|
|
52
57
|
},
|
|
53
58
|
"peerDependencies": {
|
|
54
59
|
"vitest": "^4 || ^5"
|
|
55
60
|
},
|
|
56
|
-
"
|
|
57
|
-
"
|
|
61
|
+
"engines": {
|
|
62
|
+
"node": ">=22"
|
|
58
63
|
},
|
|
59
64
|
"scripts": {
|
|
60
|
-
"build": "
|
|
65
|
+
"build": "tsdown",
|
|
61
66
|
"test:unit": "pnpm --filter @chromaui/chromatic-e2e run test:unit --project 'Vitest Unit' --project 'Vitest Browser'",
|
|
62
67
|
"test:vitest": "vitest --config test/vitest.config.e2e.ts"
|
|
63
68
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
@@ -1,368 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
var __require = /* @__PURE__ */ ((x2) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x2, {
|
|
3
|
-
get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
|
|
4
|
-
}) : x2)(function(x2) {
|
|
5
|
-
if (typeof require !== "undefined")
|
|
6
|
-
return require.apply(this, arguments);
|
|
7
|
-
throw Error('Dynamic require of "' + x2 + '" is not supported');
|
|
8
|
-
});
|
|
9
|
-
|
|
10
|
-
// ../shared/src/archive-storybook/index.ts
|
|
11
|
-
import { spawn } from "child_process";
|
|
12
|
-
import { resolve, dirname } from "path";
|
|
13
|
-
import { readFileSync } from "fs";
|
|
14
|
-
import { createRequire } from "module";
|
|
15
|
-
|
|
16
|
-
// ../shared/src/utils/filePaths.ts
|
|
17
|
-
import { existsSync, mkdirSync } from "fs";
|
|
18
|
-
import path from "path";
|
|
19
|
-
function rootDir() {
|
|
20
|
-
return process.cwd();
|
|
21
|
-
}
|
|
22
|
-
function outputDirOverride() {
|
|
23
|
-
const { CHROMATIC_ARCHIVE_LOCATION } = process.env;
|
|
24
|
-
return CHROMATIC_ARCHIVE_LOCATION;
|
|
25
|
-
}
|
|
26
|
-
function archivesDir(defaultOutputDir) {
|
|
27
|
-
const outputDir = outputDirOverride() || defaultOutputDir;
|
|
28
|
-
return path.resolve(rootDir(), outputDir, "chromatic-archives");
|
|
29
|
-
}
|
|
30
|
-
function checkArchivesDirExists(defaultOutputDir) {
|
|
31
|
-
const dir = archivesDir(defaultOutputDir);
|
|
32
|
-
if (!existsSync(dir)) {
|
|
33
|
-
throw new Error(
|
|
34
|
-
`Chromatic archives directory cannot be found: ${dir}
|
|
35
|
-
|
|
36
|
-
Please make sure that you have run your E2E tests, or have set the CHROMATIC_ARCHIVE_LOCATION env var if the output directory for the tests is not in the standard location.`
|
|
37
|
-
);
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
// ../shared/src/archive-storybook/index.ts
|
|
42
|
-
var req = __require.resolve ? __require : createRequire(import.meta.url);
|
|
43
|
-
async function archiveStorybook(processArgs, configDir2, defaultOutputDir, callbacks) {
|
|
44
|
-
assertOutputDirectory(defaultOutputDir, callbacks);
|
|
45
|
-
await runBin([binPath(), "dev", ...processArgs, "-c", configDir2]);
|
|
46
|
-
}
|
|
47
|
-
function assertOutputDirectory(outputDirectory, callbacks) {
|
|
48
|
-
try {
|
|
49
|
-
checkArchivesDirExists(outputDirectory);
|
|
50
|
-
} catch (error) {
|
|
51
|
-
callbacks?.onArchivesCheck(error);
|
|
52
|
-
throw error;
|
|
53
|
-
}
|
|
54
|
-
callbacks?.onArchivesCheck();
|
|
55
|
-
}
|
|
56
|
-
function runBin(args2) {
|
|
57
|
-
return new Promise((resolvePromise, reject) => {
|
|
58
|
-
const child = spawn("node", args2, { stdio: "inherit" });
|
|
59
|
-
child.on("error", reject);
|
|
60
|
-
child.on("close", (code, signal) => {
|
|
61
|
-
if (code === 0 || signal === "SIGINT" || signal === "SIGTERM") {
|
|
62
|
-
resolvePromise();
|
|
63
|
-
} else {
|
|
64
|
-
reject(
|
|
65
|
-
Object.assign(new Error(`Storybook exited with ${signal ?? `code ${code}`}`), {
|
|
66
|
-
status: code
|
|
67
|
-
})
|
|
68
|
-
);
|
|
69
|
-
}
|
|
70
|
-
});
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
function binPath() {
|
|
74
|
-
const filename = req.resolve("storybook/package.json");
|
|
75
|
-
const packageJson = JSON.parse(readFileSync(filename, "utf8"));
|
|
76
|
-
return resolve(dirname(filename), packageJson.bin);
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
// src/bin/archive-storybook.ts
|
|
80
|
-
import path2 from "path";
|
|
81
|
-
|
|
82
|
-
// src/constants.ts
|
|
83
|
-
var DEFAULT_OUTPUT_DIR = ".vitest/chromatic";
|
|
84
|
-
|
|
85
|
-
// src/node/telemetry/constants.ts
|
|
86
|
-
var EVENT_TYPE_PREFIX = "vitest_";
|
|
87
|
-
var TELEMETRY_FETCH_TIMEOUT_MS = 5e3;
|
|
88
|
-
var TELEMETRY_URL = "https://analytics.chromatic.com";
|
|
89
|
-
var TELEMETRY_LOG_FILE = "telemetry.jsonl";
|
|
90
|
-
var TELEMETRY_METADATA_FILE = "telemetry-metadata.json";
|
|
91
|
-
|
|
92
|
-
// src/node/telemetry/env.ts
|
|
93
|
-
import { readFileSync as readFileSync2 } from "node:fs";
|
|
94
|
-
import { resolve as resolve2 } from "node:path";
|
|
95
|
-
import util from "node:util";
|
|
96
|
-
import { env } from "std-env";
|
|
97
|
-
var dotEnv = void 0;
|
|
98
|
-
function getEnv(name) {
|
|
99
|
-
if (dotEnv === void 0) {
|
|
100
|
-
if (typeof util.parseEnv !== "function") {
|
|
101
|
-
dotEnv = {};
|
|
102
|
-
} else {
|
|
103
|
-
try {
|
|
104
|
-
dotEnv = util.parseEnv(readFileSync2(resolve2(process.cwd(), ".env"), "utf8"));
|
|
105
|
-
} catch {
|
|
106
|
-
dotEnv = {};
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
return env[name] ?? dotEnv[name];
|
|
111
|
-
}
|
|
112
|
-
function resolveTelemetryOptions() {
|
|
113
|
-
return {
|
|
114
|
-
// Enabled by default, disabled by env variables
|
|
115
|
-
enabled: isTruthyEnv(getEnv("CHROMATIC_DISABLE_TELEMETRY")) === false && isTruthyEnv(getEnv("DO_NOT_TRACK")) === false,
|
|
116
|
-
// Disabled by default, enabled by env variable
|
|
117
|
-
logToFile: isTruthyEnv(getEnv("CHROMATIC_TELEMETRY_LOG_TO_FILE"))
|
|
118
|
-
};
|
|
119
|
-
}
|
|
120
|
-
function isTruthyEnv(value) {
|
|
121
|
-
return value !== void 0 && value !== "" && value !== "0" && value !== "false";
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
// src/node/telemetry/track.ts
|
|
125
|
-
import { randomUUID as randomUUID2 } from "node:crypto";
|
|
126
|
-
import { appendFile, mkdir } from "node:fs/promises";
|
|
127
|
-
import { resolve as resolve4 } from "node:path";
|
|
128
|
-
import { isCI, nodeVersion } from "std-env";
|
|
129
|
-
|
|
130
|
-
// package.json
|
|
131
|
-
var version = "1.0.1";
|
|
132
|
-
|
|
133
|
-
// src/node/telemetry/metadata.ts
|
|
134
|
-
import { createHash } from "node:crypto";
|
|
135
|
-
import { existsSync as existsSync2 } from "node:fs";
|
|
136
|
-
import { writeFile, readFile } from "node:fs/promises";
|
|
137
|
-
import { createRequire as createRequire2 } from "node:module";
|
|
138
|
-
import { join, resolve as resolve3 } from "node:path";
|
|
139
|
-
import { x } from "tinyexec";
|
|
140
|
-
import { env as env2 } from "std-env";
|
|
141
|
-
var userAgentMatch = env2.npm_config_user_agent?.match(/^([^/\s]+)\/(\S+)/);
|
|
142
|
-
var packageManager = {
|
|
143
|
-
name: userAgentMatch?.[1] || "unknown",
|
|
144
|
-
version: userAgentMatch?.[2] || "unknown"
|
|
145
|
-
};
|
|
146
|
-
async function createProjectId(root) {
|
|
147
|
-
let remote = void 0;
|
|
148
|
-
try {
|
|
149
|
-
const result = await x("git", ["remote", "get-url", "origin"], { nodeOptions: { cwd: root } });
|
|
150
|
-
remote = result.exitCode === 0 ? result.stdout.trim().toLowerCase() : void 0;
|
|
151
|
-
} catch {
|
|
152
|
-
}
|
|
153
|
-
if (!remote) {
|
|
154
|
-
return hash(root);
|
|
155
|
-
}
|
|
156
|
-
const hasProtocol = remote.includes("://");
|
|
157
|
-
remote = remote.replace(/^[a-z+]+:\/\//, "").replace(/^[^@/]+@/, "");
|
|
158
|
-
if (!hasProtocol) {
|
|
159
|
-
remote = remote.replace(":", "/");
|
|
160
|
-
}
|
|
161
|
-
remote = remote.replace(/\.git$/, "").replace(/\/+$/, "");
|
|
162
|
-
return hash(remote);
|
|
163
|
-
}
|
|
164
|
-
function hash(value) {
|
|
165
|
-
return createHash("sha256").update(`chromatic-vitest-telemetry-v1:${value}`).digest("hex");
|
|
166
|
-
}
|
|
167
|
-
function getChromaticVersion(root) {
|
|
168
|
-
try {
|
|
169
|
-
const require2 = createRequire2(join(root, "package.json"));
|
|
170
|
-
return require2("chromatic/package.json").version || "unknown";
|
|
171
|
-
} catch {
|
|
172
|
-
return "unknown";
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
async function writeTelemetryMetadata(outputDirectory, data) {
|
|
176
|
-
await writeFile(
|
|
177
|
-
resolve3(outputDirectory, TELEMETRY_METADATA_FILE),
|
|
178
|
-
JSON.stringify(data, null, 2),
|
|
179
|
-
"utf8"
|
|
180
|
-
);
|
|
181
|
-
}
|
|
182
|
-
async function readTelemetryMetadata(outputDirectory) {
|
|
183
|
-
const defaults = {
|
|
184
|
-
sessionId: "unknown",
|
|
185
|
-
projectId: "unknown",
|
|
186
|
-
chromaticVersion: "unknown",
|
|
187
|
-
vitestVersion: "unknown",
|
|
188
|
-
isVitestProjects: false
|
|
189
|
-
};
|
|
190
|
-
try {
|
|
191
|
-
const filename = resolve3(outputDirectory, TELEMETRY_METADATA_FILE);
|
|
192
|
-
if (!existsSync2(filename)) {
|
|
193
|
-
return defaults;
|
|
194
|
-
}
|
|
195
|
-
const content = await readFile(filename, "utf8");
|
|
196
|
-
const json = JSON.parse(content);
|
|
197
|
-
return { ...defaults, ...json };
|
|
198
|
-
} catch {
|
|
199
|
-
return defaults;
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
// src/node/telemetry/sanitize.ts
|
|
204
|
-
import { sep } from "node:path";
|
|
205
|
-
import { homedir } from "node:os";
|
|
206
|
-
function sanitizeError(error) {
|
|
207
|
-
if (error instanceof Error && error.stack) {
|
|
208
|
-
const raw = error.stack.includes(error.message) ? error.stack : `${error.message}
|
|
209
|
-
Stack: ${error.stack}`;
|
|
210
|
-
return sanitizeString(raw).slice(0, 2e3);
|
|
211
|
-
}
|
|
212
|
-
return sanitizeString(error instanceof Error ? error.message : String(error)).slice(0, 1e3);
|
|
213
|
-
}
|
|
214
|
-
function sanitizeString(value) {
|
|
215
|
-
return value.replaceAll(sep, "/").replace(toPathRegExp(process.cwd()), "<process-cwd>").replace(toPathRegExp(homedir()), "<homedir>");
|
|
216
|
-
}
|
|
217
|
-
function toPathRegExp(path3) {
|
|
218
|
-
const normalized = path3.replaceAll(sep, "/");
|
|
219
|
-
const escaped = normalized.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
220
|
-
return new RegExp(escaped, "gi");
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
// src/node/telemetry/session.ts
|
|
224
|
-
import { randomUUID } from "node:crypto";
|
|
225
|
-
var session = {
|
|
226
|
-
id: randomUUID(),
|
|
227
|
-
projectId: void 0,
|
|
228
|
-
chromaticVersion: void 0,
|
|
229
|
-
/**
|
|
230
|
-
* Directories used by `telemetry.logToFile`.
|
|
231
|
-
* Held in session to avoid race conditions when Vitest projects are used.
|
|
232
|
-
* Multiple projects could try to clean up the same directory while other one is writing there already.
|
|
233
|
-
*/
|
|
234
|
-
cleanedLogFileDirectories: /* @__PURE__ */ new Set(),
|
|
235
|
-
/** Promises to wait before Vitest exists */
|
|
236
|
-
cleanups: /* @__PURE__ */ new Set(),
|
|
237
|
-
/** Whether cleanup hooks were already registered for this session */
|
|
238
|
-
cleanupRegistered: false,
|
|
239
|
-
/** Whether internal `.vitest/chromatic/telemetry-metadata.json` has been written */
|
|
240
|
-
isMetadataWritten: false,
|
|
241
|
-
/** Contents of `.vitest/chromatic/telemetry-metadata.json` */
|
|
242
|
-
telemetryMetadata: void 0
|
|
243
|
-
};
|
|
244
|
-
|
|
245
|
-
// src/node/telemetry/track.ts
|
|
246
|
-
async function trackCliEvent(event, options) {
|
|
247
|
-
const telemetry = resolveTelemetryOptions();
|
|
248
|
-
if (!telemetry.enabled) {
|
|
249
|
-
return;
|
|
250
|
-
}
|
|
251
|
-
let telemetryMetadata = session.telemetryMetadata;
|
|
252
|
-
if (session.telemetryMetadata === void 0) {
|
|
253
|
-
telemetryMetadata = await readTelemetryMetadata(options.outputDirectory);
|
|
254
|
-
session.telemetryMetadata = telemetryMetadata;
|
|
255
|
-
if (!("disabled" in telemetryMetadata)) {
|
|
256
|
-
session.id = telemetryMetadata.sessionId;
|
|
257
|
-
session.projectId = telemetryMetadata.projectId;
|
|
258
|
-
session.chromaticVersion = telemetryMetadata.chromaticVersion;
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
|
-
await _trackEvent(
|
|
262
|
-
event,
|
|
263
|
-
{
|
|
264
|
-
version: telemetryMetadata.vitestVersion,
|
|
265
|
-
config: { root: options.outputDirectory },
|
|
266
|
-
projects: telemetryMetadata.isVitestProjects ? [1, 2] : []
|
|
267
|
-
},
|
|
268
|
-
{
|
|
269
|
-
outputDirectory: options.outputDirectory,
|
|
270
|
-
telemetry
|
|
271
|
-
}
|
|
272
|
-
);
|
|
273
|
-
}
|
|
274
|
-
async function _trackEvent(event, vitest, options) {
|
|
275
|
-
const url = getEnv("CHROMATIC_TELEMETRY_URL") || TELEMETRY_URL;
|
|
276
|
-
const root = vitest.config.root;
|
|
277
|
-
const timestamp = (/* @__PURE__ */ new Date()).toISOString();
|
|
278
|
-
const outputDirectory = resolve4(root, options.outputDirectory);
|
|
279
|
-
session.projectId ||= await createProjectId(root);
|
|
280
|
-
session.chromaticVersion ||= getChromaticVersion(root);
|
|
281
|
-
const wireEvent = {
|
|
282
|
-
id: randomUUID2(),
|
|
283
|
-
sessionId: session.id,
|
|
284
|
-
projectId: session.projectId,
|
|
285
|
-
timestamp,
|
|
286
|
-
eventType: `${EVENT_TYPE_PREFIX}${event.eventType}`,
|
|
287
|
-
level: event.level,
|
|
288
|
-
payload: event.payload,
|
|
289
|
-
metadata: {
|
|
290
|
-
isCI,
|
|
291
|
-
pluginVersion: version,
|
|
292
|
-
nodeVersion: nodeVersion || "unknown",
|
|
293
|
-
vitestVersion: vitest.version,
|
|
294
|
-
isVitestProjects: vitest.projects.length > 1,
|
|
295
|
-
packageManager: packageManager.name,
|
|
296
|
-
packageManagerVersion: packageManager.version,
|
|
297
|
-
chromaticVersion: session.chromaticVersion
|
|
298
|
-
}
|
|
299
|
-
};
|
|
300
|
-
if (wireEvent.level === "error" && "error" in wireEvent.payload) {
|
|
301
|
-
wireEvent.payload.error = sanitizeError(wireEvent.payload.error);
|
|
302
|
-
}
|
|
303
|
-
let error = void 0;
|
|
304
|
-
try {
|
|
305
|
-
await fetch(`${url}/telemetry/v1/vitest/events`, {
|
|
306
|
-
method: "POST",
|
|
307
|
-
headers: { "Content-Type": "application/json" },
|
|
308
|
-
body: JSON.stringify(wireEvent),
|
|
309
|
-
signal: AbortSignal.timeout(TELEMETRY_FETCH_TIMEOUT_MS)
|
|
310
|
-
});
|
|
311
|
-
} catch (err) {
|
|
312
|
-
error = err instanceof Error ? err.message : String(err);
|
|
313
|
-
}
|
|
314
|
-
if (options.telemetry.logToFile) {
|
|
315
|
-
const logFile = resolve4(outputDirectory, TELEMETRY_LOG_FILE);
|
|
316
|
-
await mkdir(outputDirectory, { recursive: true });
|
|
317
|
-
await appendFile(logFile, `${JSON.stringify(wireEvent)}
|
|
318
|
-
`, "utf8");
|
|
319
|
-
if (error) {
|
|
320
|
-
await appendFile(logFile, `${JSON.stringify({ telemetryPostError: error })}
|
|
321
|
-
`, "utf8");
|
|
322
|
-
}
|
|
323
|
-
}
|
|
324
|
-
if (!session.isMetadataWritten) {
|
|
325
|
-
session.isMetadataWritten = true;
|
|
326
|
-
await writeTelemetryMetadata(outputDirectory, {
|
|
327
|
-
...wireEvent.metadata,
|
|
328
|
-
sessionId: wireEvent.sessionId,
|
|
329
|
-
projectId: wireEvent.projectId
|
|
330
|
-
});
|
|
331
|
-
}
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
// src/bin/archive-storybook.ts
|
|
335
|
-
var args = process.argv.slice(2);
|
|
336
|
-
var configDir = path2.resolve(import.meta.dirname, "../storybook-config");
|
|
337
|
-
var queue = Promise.resolve();
|
|
338
|
-
try {
|
|
339
|
-
trackEvent2({ eventType: "storybook_dev_started", level: "info", payload: {} });
|
|
340
|
-
await archiveStorybook(args, configDir, DEFAULT_OUTPUT_DIR, { onArchivesCheck });
|
|
341
|
-
} catch (err) {
|
|
342
|
-
trackEvent2({ eventType: "storybook_dev_failed", level: "error", payload: { error: err } });
|
|
343
|
-
console.error(err.message);
|
|
344
|
-
process.exitCode = 1;
|
|
345
|
-
}
|
|
346
|
-
await queue;
|
|
347
|
-
function trackEvent2(event) {
|
|
348
|
-
queue = queue.then(
|
|
349
|
-
() => trackCliEvent(event, { outputDirectory: path2.dirname(archivesDir(DEFAULT_OUTPUT_DIR)) }).catch(
|
|
350
|
-
() => {
|
|
351
|
-
}
|
|
352
|
-
// Ignore telemetry errors
|
|
353
|
-
)
|
|
354
|
-
);
|
|
355
|
-
}
|
|
356
|
-
function onArchivesCheck(error) {
|
|
357
|
-
trackEvent2({
|
|
358
|
-
eventType: "archives_resolved",
|
|
359
|
-
level: error ? "error" : "info",
|
|
360
|
-
payload: {
|
|
361
|
-
success: error == void 0,
|
|
362
|
-
error,
|
|
363
|
-
isCustomLocation: process.env.CHROMATIC_ARCHIVE_LOCATION != void 0,
|
|
364
|
-
command: "archiveStorybook",
|
|
365
|
-
chromaticProjectId: void 0
|
|
366
|
-
}
|
|
367
|
-
});
|
|
368
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|