@bigbinary/neeto-playwright-reporter 1.1.0 → 1.2.1

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, attachments }: TestResult) => Promise<void>;
+    onTestEnd: (testCase: TestCase, { status, duration, errors, retry, attachments }: TestResult) => Promise<void>;
     onEnd: ({ status, duration }: FullResult) => Promise<void>;
 }
 

package/index.js

@@ -18446,6 +18446,7 @@ const attemptsApi = { create: create$2, update: update$1 };
 const ERRORS = {
     onBegin: {
         failedToGetCommitSha: "Failed to get current commit SHA.",
+        failedToGetBranch: "Failed to get current branch.",
         failedToGetCommitMessage: "Failed to get current commit message.",
         failedToInitializeRun: "Failed to initialize run in reporter",
     },
@@ -18455,23 +18456,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"),
 };
@@ -18494,6 +18504,15 @@ const createShardObject = ({ currentShard = 0, status = "running", duration = nu
 });
 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({
     command: "git rev-parse HEAD",
@@ -18503,6 +18522,10 @@ const getCurrentCommitMessage = () => executeCommandLine({
     command: "git show-branch --no-name HEAD",
     messageOnError: ERRORS.onBegin.failedToGetCommitMessage,
 });
+const getCurrentBranch = () => executeCommandLine({
+    command: "git branch --show-current",
+    messageOnError: ERRORS.onBegin.failedToGetBranch,
+});
 const getInitializerData = ({ rootDir }, rootSuite) => rootSuite.allTests().map(test => {
     var _a;
     const { title, parent, id: history_id, location: { file }, } = test;
@@ -18512,6 +18535,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;
@@ -18528,14 +18560,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,
 });
@@ -18550,6 +18574,7 @@ class MyReporter {
                 const runDetails = {
                     commit_id: getCurrentCommitSha(),
                     commit_name: getCurrentCommitMessage(),
+                    branch: getCurrentBranch(),
                     ci_build_id: this.ciBuildId,
                     configuration: config,
                     shards: createShardObject({ currentShard: shard === null || shard === void 0 ? void 0 : shard.current }),
@@ -18560,7 +18585,7 @@ class MyReporter {
                 }));
             }
             catch (error) {
-                consoleLogFormatted.error(error);
+                consoleLogFormatted.error(error.message);
                 throw new Error(ERRORS.onBegin.failedToInitializeRun);
             }
             consoleLogFormatted.underline(MESSAGES.onBegin.testStarted);
@@ -18569,25 +18594,32 @@ 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");
+                formData.append("attempt[started_at]", new Date().toString());
                 retry === 0 &&
                     (await attemptsApi.update(this.ciBuildId, id, this.attempts[id], formData));
             }
             catch (error) {
+                consoleLogFormatted.error(error.message);
                 consoleLogFormatted.error(ERRORS.onTestBegin.failedToReportTest(title, id));
-                console.log(error);
             }
         };
-        this.onTestEnd = async ({ id, title }, { status, duration, errors, retry, attachments }) => {
+        this.onTestEnd = async (testCase, { status, duration, errors, retry, attachments }) => {
+            const { id, title, expectedStatus } = testCase;
             try {
                 const testResult = {
+                    outcome: testCase.outcome(),
+                    expected_status: expectedStatus,
                     status,
                     duration,
                     log: errors.map(error => { var _a; return (_a = error.message) !== null && _a !== void 0 ? _a : ""; }).join("\n"),
@@ -18604,13 +18636,16 @@ class MyReporter {
                 Object.entries(testResult).map(([resultKey, resultValue]) => {
                     formData.append(`attempt[${resultKey}]`, resultValue.toString());
                 });
+                retry !== 0 &&
+                    formData.append("attempt[started_at]", new Date().toString());
                 retry === 0
                     ? await attemptsApi.update(this.ciBuildId, id, this.attempts[id], formData)
                     : await attemptsApi.create(this.ciBuildId, id, formData);
+                consoleLogFormatted.invertBackground(MESSAGES.onTestEnd.reportedTest(title));
             }
             catch (error) {
+                consoleLogFormatted.error(error.message);
                 consoleLogFormatted.error(ERRORS.onTestBegin.failedToReportTest(title, id));
-                console.log(error);
             }
         };
         this.onEnd = async ({ status, duration }) => {
@@ -18624,7 +18659,7 @@ class MyReporter {
                 });
             }
             catch (error) {
-                console.log(error);
+                consoleLogFormatted.error(error.message);
                 throw new Error(ERRORS.onEnd.failedToReportRunStatus);
             }
         };