@bigbinary/neeto-playwright-reporter 1.0.2 → 1.2.0

package/index.d.ts

@@ -13,7 +13,7 @@ declare class MyReporter implements Reporter {
     constructor(options: ReporterOptionParams);
     onBegin: (config: FullConfig, rootSuite: Suite) => Promise<void>;
     onTestBegin: ({ id, title }: TestCase, { retry }: TestResult) => Promise<void>;
-    onTestEnd: ({ id, title }: TestCase, { status, duration, errors, retry }: TestResult) => Promise<void>;
+    onTestEnd: ({ id, title }: TestCase, { status, duration, errors, retry, attachments }: TestResult) => Promise<void>;
     onEnd: ({ status, duration }: FullResult) => Promise<void>;
 }
 

package/index.js

@@ -1,10 +1,10 @@
+import require$$6 from 'fs';
 import require$$1, { TextEncoder } from 'util';
 import stream, { Readable } from 'stream';
 import require$$1$1 from 'path';
 import require$$3 from 'http';
 import require$$4 from 'https';
 import require$$0$1 from 'url';
-import require$$6 from 'fs';
 import require$$4$1 from 'assert';
 import require$$1$2 from 'tty';
 import require$$0$2 from 'os';
@@ -18439,12 +18439,8 @@ const HEADERS_KEYS = {
 };
 const API_BASE_URL = "/api/v1";
 
-const create$2 = (ciBuildId, history_id, payload) => axios.post(`${API_BASE_URL}/reporter/runs/${ciBuildId}/test_entities/${history_id}/attempts`, {
-    attempt: payload,
-});
-const update$1 = (ciBuildId, history_id, id, payload) => axios.put(`${API_BASE_URL}/reporter/runs/${ciBuildId}/test_entities/${history_id}/attempts/${id}`, {
-    attempt: payload,
-});
+const create$2 = (ciBuildId, history_id, payload) => axios.post(`${API_BASE_URL}/reporter/runs/${ciBuildId}/test_entities/${history_id}/attempts`, payload, { headers: { "Content-Type": "multipart/form-data" } });
+const update$1 = (ciBuildId, history_id, id, payload) => axios.put(`${API_BASE_URL}/reporter/runs/${ciBuildId}/test_entities/${history_id}/attempts/${id}`, payload, { headers: { "Content-Type": "multipart/form-data" } });
 const attemptsApi = { create: create$2, update: update$1 };
 
 const ERRORS = {
@@ -18459,23 +18455,32 @@ const ERRORS = {
     onEnd: {
         failedToReportRunStatus: "Failed to report run status",
     },
+    heartbeat: {
+        stopped: "Run was stopped at the reporter",
+    },
 };
 
 const MESSAGES = {
     onBegin: {
-        testStarted: "Test has started reporting to neetoPlaywrightReporter",
+        testStarted: "Run has started reporting to neetoPlaywrightReporter",
         ciBuildId: (currentCiBuildId) => `CI BUILD ID: ${currentCiBuildId}`,
         totalShards: (totalShards) => `Total shards: ${totalShards}`,
         currentShard: (currentShard) => `Current shard: ${currentShard}`,
     },
+    onTestBegin: {
+        startingTest: (titlePath) => `Starting ${titlePath}`,
+    },
+    onTestEnd: {
+        reportedTest: (title) => `Reported ${title} to neetoPlaywrightReporter`,
+    },
 };
 
 const consoleLogFormatted = {
-    bold: (message) => console.log(console.log("\x1b[1m", message, "\x1b[0m")),
-    dim: (message) => console.log(console.log("\x1b[2m", message, "\x1b[0m")),
-    underline: (message) => console.log(console.log("\x1b[4m", message, "\x1b[0m")),
-    invertBackground: (message) => console.log(console.log("\x1b[7m", message, "\x1b[0m")),
-    hidden: (message) => console.log(console.log("\x1b[8m", message, "\x1b[0m")),
+    bold: (message) => console.log("\x1b[1m", message, "\x1b[0m"),
+    dim: (message) => console.log("\x1b[2m", message, "\x1b[0m"),
+    underline: (message) => console.log("\x1b[4m", message, "\x1b[0m"),
+    invertBackground: (message) => console.log("\x1b[7m", message, "\x1b[0m"),
+    hidden: (message) => console.log("\x1b[8m", message, "\x1b[0m"),
     error: (message) => console.log("\u001b[31m", "\x1b[1m", message, "\x1b[0m", "\u001b[0m"),
     warning: (message) => console.log("\u001b[33m", "\x1b[1m", message, "\x1b[0m", "\u001b[0m"),
 };
@@ -18496,6 +18501,16 @@ const executeCommandLine = ({ command, messageOnError, shouldThrowError = false,
 const createShardObject = ({ currentShard = 0, status = "running", duration = null, }) => ({
     [currentShard]: { status, duration },
 });
+const convertBufferToBlob = (buffer, contentType) => new Blob([buffer], { type: contentType });
+
+const create$1 = (payload) => axios.post(`${API_BASE_URL}/reporter/runs`, {
+    run: payload,
+});
+const update = (ciBuildId, payload) => axios.put(`${API_BASE_URL}/reporter/runs/${ciBuildId}`, {
+    run: payload,
+});
+const heartbeat = (ciBuildId) => axios.get(`${API_BASE_URL}/reporter/runs/${ciBuildId}/heartbeat`);
+const runsApi = { create: create$1, update, heartbeat };
 
 const getDescribePath = ({ titlePath, title, project, spec, }) => titlePath.filter((item, index) => index !== 0 && item !== title && item !== project && item !== spec);
 const getCurrentCommitSha = () => executeCommandLine({
@@ -18515,6 +18530,15 @@ const getInitializerData = ({ rootDir }, rootSuite) => rootSuite.allTests().map(
     const describe = getDescribePath({ titlePath, title, spec, project });
     return { title, describe, project, spec, history_id };
 });
+const sendHeartBeatSignal = async (ciBuildId) => {
+    try {
+        await runsApi.heartbeat(ciBuildId);
+    }
+    catch (error) {
+        consoleLogFormatted.error(ERRORS.heartbeat.stopped);
+        process.exit(1);
+    }
+};
 
 const setAuthHeaders = (projectKey) => {
     var _a;
@@ -18531,14 +18555,6 @@ function initializeAxios({ projectKey, baseURL, }) {
     setAuthHeaders(projectKey);
 }
 
-const create$1 = (payload) => axios.post(`${API_BASE_URL}/reporter/runs`, {
-    run: payload,
-});
-const update = (ciBuildId, payload) => axios.put(`${API_BASE_URL}/reporter/runs/${ciBuildId}`, {
-    run: payload,
-});
-const runsApi = { create: create$1, update };
-
 const create = (ciBuildId, payload) => axios.post(`${API_BASE_URL}/reporter/runs/${ciBuildId}/test_entities`, {
     test_entity: payload,
 });
@@ -18562,7 +18578,8 @@ class MyReporter {
                     test_entities: getInitializerData(config, rootSuite),
                 }));
             }
-            catch (_a) {
+            catch (error) {
+                consoleLogFormatted.error(error.message);
                 throw new Error(ERRORS.onBegin.failedToInitializeRun);
             }
             consoleLogFormatted.underline(MESSAGES.onBegin.testStarted);
@@ -18571,33 +18588,51 @@ class MyReporter {
                 consoleLogFormatted.dim(MESSAGES.onBegin.totalShards(shard.total));
                 consoleLogFormatted.dim(MESSAGES.onBegin.currentShard(shard.current));
             }
+            await sendHeartBeatSignal(this.ciBuildId);
+            setInterval(async () => await sendHeartBeatSignal(this.ciBuildId), 60000);
             this.attempts = attempts;
             this.config = config;
             this.currentShard = shard === null || shard === void 0 ? void 0 : shard.current;
         };
         this.onTestBegin = async ({ id, title }, { retry }) => {
+            consoleLogFormatted.invertBackground(MESSAGES.onTestBegin.startingTest(title));
             try {
+                const formData = new FormData();
+                formData.append("attempt[status]", "running");
                 retry === 0 &&
-                    (await attemptsApi.update(this.ciBuildId, id, this.attempts[id], {
-                        status: "running",
-                    }));
+                    (await attemptsApi.update(this.ciBuildId, id, this.attempts[id], formData));
             }
-            catch (_a) {
+            catch (error) {
+                consoleLogFormatted.error(error.message);
                 consoleLogFormatted.error(ERRORS.onTestBegin.failedToReportTest(title, id));
             }
         };
-        this.onTestEnd = async ({ id, title }, { status, duration, errors, retry }) => {
+        this.onTestEnd = async ({ id, title }, { status, duration, errors, retry, attachments }) => {
             try {
                 const testResult = {
                     status,
                     duration,
                     log: errors.map(error => { var _a; return (_a = error.message) !== null && _a !== void 0 ? _a : ""; }).join("\n"),
                 };
+                consoleLogFormatted.underline(title);
+                const formData = new FormData();
+                attachments.map(({ name, path, body, contentType }) => {
+                    consoleLogFormatted.dim(`${name}: ${path}`);
+                    if (["screenshot", "video", "trace"].includes(name)) {
+                        const buffer = path ? require$$6.readFileSync(path) : body;
+                        formData.append(`attempt[${name}s][]`, convertBufferToBlob(buffer, contentType));
+                    }
+                });
+                Object.entries(testResult).map(([resultKey, resultValue]) => {
+                    formData.append(`attempt[${resultKey}]`, resultValue.toString());
+                });
                 retry === 0
-                    ? await attemptsApi.update(this.ciBuildId, id, this.attempts[id], testResult)
-                    : await attemptsApi.create(this.ciBuildId, id, testResult);
+                    ? await attemptsApi.update(this.ciBuildId, id, this.attempts[id], formData)
+                    : await attemptsApi.create(this.ciBuildId, id, formData);
+                consoleLogFormatted.invertBackground(MESSAGES.onTestEnd.reportedTest(title));
             }
-            catch (_a) {
+            catch (error) {
+                consoleLogFormatted.error(error.message);
                 consoleLogFormatted.error(ERRORS.onTestBegin.failedToReportTest(title, id));
             }
         };
@@ -18611,7 +18646,8 @@ class MyReporter {
                     }),
                 });
             }
-            catch (_a) {
+            catch (error) {
+                consoleLogFormatted.error(error.message);
                 throw new Error(ERRORS.onEnd.failedToReportRunStatus);
             }
         };