test-analytics-reporter 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/reporter.d.ts +3 -0
- package/dist/reporter.js +54 -2
- package/dist/reporter.js.map +1 -1
- package/package.json +2 -2
package/dist/reporter.d.ts
CHANGED
|
@@ -13,6 +13,8 @@ declare class PlaywrightAnalyticsReporter implements Reporter {
|
|
|
13
13
|
private startTime;
|
|
14
14
|
private testRetries;
|
|
15
15
|
private testStartTimes;
|
|
16
|
+
private currentBrowser;
|
|
17
|
+
private playwrightConfig;
|
|
16
18
|
constructor(config: ReporterConfig);
|
|
17
19
|
onBegin(config: FullConfig): Promise<void>;
|
|
18
20
|
onTestBegin(test: TestCase): Promise<void>;
|
|
@@ -20,6 +22,7 @@ declare class PlaywrightAnalyticsReporter implements Reporter {
|
|
|
20
22
|
onEnd(): Promise<void>;
|
|
21
23
|
private sendTestResults;
|
|
22
24
|
private generateTestId;
|
|
25
|
+
private getOSFromBrowser;
|
|
23
26
|
private mapPlaywrightStatus;
|
|
24
27
|
}
|
|
25
28
|
export default PlaywrightAnalyticsReporter;
|
package/dist/reporter.js
CHANGED
|
@@ -5,12 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
const axios_1 = __importDefault(require("axios"));
|
|
7
7
|
const uuid_1 = require("uuid");
|
|
8
|
+
const fs_1 = __importDefault(require("fs"));
|
|
9
|
+
const path_1 = __importDefault(require("path"));
|
|
8
10
|
class PlaywrightAnalyticsReporter {
|
|
9
11
|
constructor(config) {
|
|
10
12
|
this.testResults = [];
|
|
11
13
|
this.startTime = new Date();
|
|
12
14
|
this.testRetries = new Map();
|
|
13
15
|
this.testStartTimes = new Map();
|
|
16
|
+
this.currentBrowser = 'unknown';
|
|
17
|
+
this.playwrightConfig = null;
|
|
14
18
|
this.config = {
|
|
15
19
|
batchSize: 50,
|
|
16
20
|
enabled: true,
|
|
@@ -18,6 +22,7 @@ class PlaywrightAnalyticsReporter {
|
|
|
18
22
|
};
|
|
19
23
|
}
|
|
20
24
|
async onBegin(config) {
|
|
25
|
+
this.playwrightConfig = config;
|
|
21
26
|
if (this.config.enabled) {
|
|
22
27
|
console.log(`[Analytics] Starting test run for project: ${this.config.projectName}`);
|
|
23
28
|
}
|
|
@@ -26,6 +31,11 @@ class PlaywrightAnalyticsReporter {
|
|
|
26
31
|
const testId = this.generateTestId(test);
|
|
27
32
|
this.testStartTimes.set(testId, new Date());
|
|
28
33
|
this.testRetries.set(testId, 0);
|
|
34
|
+
// Capture browser name from test's project (stored in private _project property)
|
|
35
|
+
const projectConfig = test.parent?._project;
|
|
36
|
+
if (projectConfig?.name) {
|
|
37
|
+
this.currentBrowser = projectConfig.name;
|
|
38
|
+
}
|
|
29
39
|
}
|
|
30
40
|
async onTestEnd(test, result) {
|
|
31
41
|
if (!this.config.enabled)
|
|
@@ -38,6 +48,33 @@ class PlaywrightAnalyticsReporter {
|
|
|
38
48
|
this.testRetries.set(testId, retries + 1);
|
|
39
49
|
// Map Playwright status to our status format
|
|
40
50
|
const status = this.mapPlaywrightStatus(result.status);
|
|
51
|
+
// Get browser name from test's project (stored in private _project property)
|
|
52
|
+
const projectConfig = test.parent?._project;
|
|
53
|
+
let browserName = projectConfig?.name || 'unknown';
|
|
54
|
+
// Extract trace file path from attachments (for failed tests)
|
|
55
|
+
let tracePath;
|
|
56
|
+
let traceDataBase64;
|
|
57
|
+
let traceFileName;
|
|
58
|
+
if (result.attachments && result.attachments.length > 0) {
|
|
59
|
+
const traceAttachment = result.attachments.find((a) => a.name === 'trace' && a.path);
|
|
60
|
+
if (traceAttachment?.path) {
|
|
61
|
+
tracePath = traceAttachment.path;
|
|
62
|
+
traceFileName = path_1.default.basename(traceAttachment.path);
|
|
63
|
+
try {
|
|
64
|
+
const stat = fs_1.default.statSync(traceAttachment.path);
|
|
65
|
+
// Keep payload size bounded; large traces can still be opened locally.
|
|
66
|
+
if (stat.size <= 8 * 1024 * 1024) {
|
|
67
|
+
traceDataBase64 = fs_1.default.readFileSync(traceAttachment.path).toString('base64');
|
|
68
|
+
}
|
|
69
|
+
else {
|
|
70
|
+
console.warn(`[Analytics] Trace too large to upload (${stat.size} bytes): ${traceAttachment.path}`);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
catch (traceReadError) {
|
|
74
|
+
console.warn(`[Analytics] Could not read trace file: ${traceAttachment.path}`, traceReadError);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
41
78
|
const testAnalyticsResult = {
|
|
42
79
|
id: (0, uuid_1.v4)(),
|
|
43
80
|
projectId: this.config.projectId,
|
|
@@ -52,13 +89,16 @@ class PlaywrightAnalyticsReporter {
|
|
|
52
89
|
endTime,
|
|
53
90
|
error: result.error?.message || undefined,
|
|
54
91
|
tags: [],
|
|
55
|
-
browser:
|
|
56
|
-
os:
|
|
92
|
+
browser: browserName,
|
|
93
|
+
os: this.getOSFromBrowser(browserName),
|
|
57
94
|
environment: process.env.TEST_ENV || 'unknown',
|
|
58
95
|
buildId: process.env.CI_BUILD_ID || process.env.GITHUB_RUN_ID,
|
|
59
96
|
branchName: process.env.CI_COMMIT_BRANCH || process.env.GITHUB_REF_NAME || 'unknown',
|
|
60
97
|
commitHash: process.env.CI_COMMIT_SHA || process.env.GITHUB_SHA,
|
|
61
98
|
author: process.env.CI_COMMIT_AUTHOR || process.env.GITHUB_ACTOR,
|
|
99
|
+
tracePath,
|
|
100
|
+
traceDataBase64,
|
|
101
|
+
traceFileName,
|
|
62
102
|
};
|
|
63
103
|
this.testResults.push(testAnalyticsResult);
|
|
64
104
|
// Send batch if we've reached batch size
|
|
@@ -102,6 +142,18 @@ class PlaywrightAnalyticsReporter {
|
|
|
102
142
|
generateTestId(test) {
|
|
103
143
|
return `${test.location?.file || 'unknown'}::${test.title}`;
|
|
104
144
|
}
|
|
145
|
+
getOSFromBrowser(browserName) {
|
|
146
|
+
// Infer OS from browser name if possible
|
|
147
|
+
const browserLower = browserName.toLowerCase();
|
|
148
|
+
if (browserLower.includes('webkit') || browserLower.includes('safari')) {
|
|
149
|
+
return 'macOS';
|
|
150
|
+
}
|
|
151
|
+
if (browserLower.includes('firefox')) {
|
|
152
|
+
return 'linux';
|
|
153
|
+
}
|
|
154
|
+
// Chromium runs on any OS, so we set to unknown to let it be platform-agnostic
|
|
155
|
+
return 'unknown';
|
|
156
|
+
}
|
|
105
157
|
mapPlaywrightStatus(status) {
|
|
106
158
|
const statusMap = {
|
|
107
159
|
passed: 'PASSED',
|
package/dist/reporter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";;;;;AACA,kDAA0B;AAC1B,+BAAoC;
|
|
1
|
+
{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";;;;;AACA,kDAA0B;AAC1B,+BAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AAYxB,MAAM,2BAA2B;IAS/B,YAAY,MAAsB;QAP1B,gBAAW,GAA0B,EAAE,CAAC;QACxC,cAAS,GAAS,IAAI,IAAI,EAAE,CAAC;QAC7B,gBAAW,GAAwB,IAAI,GAAG,EAAE,CAAC;QAC7C,mBAAc,GAAsB,IAAI,GAAG,EAAE,CAAC;QAC9C,mBAAc,GAAW,SAAS,CAAC;QACnC,qBAAgB,GAAsB,IAAI,CAAC;QAGjD,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,IAAI;YACb,GAAG,MAAM;SACV,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAkB;QAC9B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,8CAA8C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAc;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEhC,iFAAiF;QACjF,MAAM,aAAa,GAAI,IAAI,CAAC,MAAc,EAAE,QAAQ,CAAC;QACrD,IAAI,aAAa,EAAE,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAc,EAAE,MAAkB;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAEjC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;QAE1C,6CAA6C;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvD,6EAA6E;QAC7E,MAAM,aAAa,GAAI,IAAI,CAAC,MAAc,EAAE,QAAQ,CAAC;QACrD,IAAI,WAAW,GAAG,aAAa,EAAE,IAAI,IAAI,SAAS,CAAC;QAEnD,8DAA8D;QAC9D,IAAI,SAA6B,CAAC;QAClC,IAAI,eAAmC,CAAC;QACxC,IAAI,aAAiC,CAAC;QACtC,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxD,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAC7C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CACpC,CAAC;YACF,IAAI,eAAe,EAAE,IAAI,EAAE,CAAC;gBAC1B,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC;gBACjC,aAAa,GAAG,cAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;gBAEpD,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,YAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;oBAC/C,uEAAuE;oBACvE,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;wBACjC,eAAe,GAAG,YAAE,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC7E,CAAC;yBAAM,CAAC;wBACN,OAAO,CAAC,IAAI,CAAC,0CAA0C,IAAI,CAAC,IAAI,YAAY,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC;oBACtG,CAAC;gBACH,CAAC;gBAAC,OAAO,cAAc,EAAE,CAAC;oBACxB,OAAO,CAAC,IAAI,CAAC,0CAA0C,eAAe,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;gBACjG,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,mBAAmB,GAAwB;YAC/C,EAAE,EAAE,IAAA,SAAM,GAAE;YACZ,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;YAChC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;YACpC,MAAM;YACN,QAAQ,EAAE,IAAI,CAAC,KAAK;YACpB,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,KAAK;YACrB,aAAa,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,SAAS;YACT,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,IAAI,SAAS;YACzC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,WAAW;YACpB,EAAE,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC;YACtC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,SAAS;YAC9C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa;YAC7D,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,SAAS;YACpF,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU;YAC/D,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY;YAChE,SAAS;YACT,eAAe;YACf,aAAa;SACd,CAAC;QAEF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE3C,yCAAyC;QACzC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAEjC,yBAAyB;QACzB,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,mDAAmD,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAE1C,IAAI,CAAC;YACH,MAAM,OAAO,GAA2B;gBACtC,cAAc,EAAE,kBAAkB;aACnC,CAAC;YAEF,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC5D,CAAC;YAED,MAAM,eAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,cAAc,EAAE;gBACxD,OAAO,EAAE,IAAI,CAAC,WAAW;gBACzB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;gBAChC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;gBACpC,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAEhB,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,CAAC;YACxE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;YACjE,8DAA8D;QAChE,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,IAAc;QACnC,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9D,CAAC;IAEO,gBAAgB,CAAC,WAAmB;QAC1C,yCAAyC;QACzC,MAAM,YAAY,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;QAC/C,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvE,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,+EAA+E;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,mBAAmB,CACzB,MAAoE;QAEpE,MAAM,SAAS,GAAkD;YAC/D,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,SAAS;YACnB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,QAAQ;SACtB,CAAC;QACF,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC;IACvC,CAAC;CACF;AAED,kBAAe,2BAA2B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "test-analytics-reporter",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Playwright test reporter for sending results to Test Analytics Dashboard",
|
|
5
5
|
"main": "dist/reporter.js",
|
|
6
6
|
"types": "dist/reporter.d.ts",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"@playwright/test": "^1.40.0",
|
|
39
39
|
"axios": "^1.6.0",
|
|
40
|
-
"test-analytics-shared": "
|
|
40
|
+
"test-analytics-shared": "^1.0.2",
|
|
41
41
|
"uuid": "^9.0.0"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|