Run and attempt tooltip, use run number

elbrenn · elbrenn · commit 4f2c8643acf8 · 2023-01-18T11:59:34.000-05:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -377,6 +377,7 @@
   "devDependencies": {
     "@types/js-yaml": "^3.12.1",
     "@types/libsodium-wrappers": "^0.7.10",
+    "@types/moment-duration-format": "^2.2.3",
     "@types/node": "^14.14.32",
     "@types/uuid": "^3.4.6",
     "@types/vscode": "^1.72.0",
@@ -405,6 +406,8 @@
     "abab": "^2.0.5",
     "crypto-browserify": "^3.12.0",
     "libsodium-wrappers": "^0.7.10",
+    "moment": "^2.29.4",
+    "moment-duration-format": "^2.3.2",
     "ssh-config": "^3.0.0",
     "stream-browserify": "^3.0.0",
     "timers-browserify": "^2.0.12",
diff --git a/src/store/workflowRun.ts b/src/store/workflowRun.ts
@@ -22,6 +22,16 @@ abstract class WorkflowRunBase {
     return (this.run.run_attempt || 1) > 1;
   }
 
+  duration(): number {
+    if (this.run.run_started_at) {
+      const started_at = new Date(this.run.run_started_at);
+
+      const updated_at = new Date(this.run.updated_at);
+      return updated_at.getTime() - started_at.getTime();
+    }
+    return 0;
+  }
+
   updateRun(run: model.WorkflowRun) {
     if (this._run.updated_at !== run.updated_at) {
       // Run has changed, reset jobs. Note: this doesn't work in all cases, there might be race conditions
diff --git a/src/treeViews/icons.ts b/src/treeViews/icons.ts
@@ -37,6 +37,7 @@ function _getIconForWorkflowrun(
           return getAbsoluteIconPath("conclusions/failure.svg");
 
         case "cancelled":
+        case "skipped":
           return getAbsoluteIconPath("conclusions/cancelled.svg");
       }
       break;
@@ -72,6 +73,7 @@ export function getCodIconForWorkflowrun(runOrJob?: IStatusAndConclusion): strin
           return "error";
 
         case "cancelled":
+        case "skipped":
           return "circle-slash";
       }
       break;
diff --git a/src/treeViews/shared/attemptNode.ts b/src/treeViews/shared/attemptNode.ts
@@ -2,14 +2,25 @@ import * as vscode from "vscode";
 import {GitHubRepoContext} from "../../git/repository";
 import {WorkflowRunAttempt} from "../../store/workflowRun";
 import {getIconForWorkflowRun} from "../icons";
+import {getEventString, getStatusString} from "./runTooltipHelper";
 import {WorkflowJobNode} from "./workflowJobNode";
 
 export class AttemptNode extends vscode.TreeItem {
   constructor(private gitHubRepoContext: GitHubRepoContext, private attempt: WorkflowRunAttempt) {
     super(`Attempt #${attempt.attempt}`, vscode.TreeItemCollapsibleState.Collapsed);
 
     this.iconPath = getIconForWorkflowRun(this.attempt.run);
-    this.tooltip = `#${this.attempt.attempt}: ${this.attempt.run.status || ""} ${this.attempt.run.conclusion || ""}`;
+    this.tooltip = this.getTooltip();
+  }
+
+  getTooltip(): vscode.MarkdownString {
+    let markdownString = `#${this.attempt.attempt}: `;
+
+    markdownString += getStatusString(this.attempt);
+    markdownString += `\n\n`;
+    markdownString += getEventString(this.attempt);
+
+    return new vscode.MarkdownString(markdownString);
   }
 
   async getJobs(): Promise<WorkflowJobNode[]> {
diff --git a/src/treeViews/shared/runTooltipHelper.ts b/src/treeViews/shared/runTooltipHelper.ts
@@ -0,0 +1,65 @@
+import moment from "moment";
+import "moment-duration-format";
+import {WorkflowRun} from "../../store/workflowRun";
+import {WorkflowRunAttempt} from "../../store/workflowRun";
+
+// Reutrns a string like "**Succeeded** in **1m 2s**"
+// For use in markdown tooltip
+export function getStatusString(item: WorkflowRun | WorkflowRunAttempt, capitalize: boolean = false): string {
+  let statusText = item.run.conclusion || item.run.status || "";
+  switch (statusText) {
+    case "success":
+      statusText = "succeeded";
+      break;
+    case "failure":
+      statusText = "failed";
+      break;
+  }
+
+  statusText = statusText.replace("_", " ");
+
+  if (capitalize) {
+    statusText = statusText.charAt(0).toUpperCase() + statusText.slice(1);
+  }
+
+  statusText = `**${statusText}**`;
+
+  if (item.run.conclusion && item.run.conclusion !== "skipped") {
+    const duration = moment.duration(item.duration());
+    statusText += ` in **${duration.format("D[d] h[h] m[m] s[s]")}**`;
+  }
+
+  return statusText;
+}
+
+// Reutrns a string like "Manually run by [user](user_url) 4 minutes ago *(December 31, 1969 7:00 PM)*"
+// For use in markdown tooltip
+export function getEventString(item: WorkflowRun | WorkflowRunAttempt): string {
+  let eventString = "Triggered";
+  if (item.hasPreviousAttempts) {
+    eventString = "Re-run";
+  } else {
+    const event = item.run.event;
+    if (event) {
+      switch (event) {
+        case "workflow_dispatch":
+          eventString = "Manually triggered";
+          break;
+        case "dynamic":
+          eventString = "Triggered";
+          break;
+        default:
+          eventString = "Triggered via " + event.replace("_", " ");
+      }
+    }
+  }
+
+  if (item.run.triggering_actor) {
+    eventString += ` by [${item.run.triggering_actor.login}](${item.run.triggering_actor.html_url})`;
+  }
+
+  let started_at = moment(item.run.run_started_at);
+  eventString += ` ${started_at.fromNow()} *(${started_at.format("LLL")})*`;
+
+  return eventString;
+}
diff --git a/src/treeViews/shared/workflowRunNode.ts b/src/treeViews/shared/workflowRunNode.ts
@@ -4,6 +4,7 @@ import {GitHubRepoContext} from "../../git/repository";
 import {RunStore} from "../../store/store";
 import {WorkflowRun} from "../../store/workflowRun";
 import {getIconForWorkflowRun} from "../icons";
+import {getEventString, getStatusString} from "./runTooltipHelper";
 import {NoWorkflowJobsNode} from "./noWorkflowJobsNode";
 import {PreviousAttemptsNode} from "./previousAttemptsNode";
 import {WorkflowJobNode} from "./workflowJobNode";
@@ -33,7 +34,7 @@ export class WorkflowRunNode extends vscode.TreeItem {
     }
 
     this.iconPath = getIconForWorkflowRun(this.run.run);
-    this.tooltip = `${this.run.run.status || ""} ${this.run.run.conclusion || ""}`;
+    this.tooltip = this.getTooltip();
   }
 
   async getJobs(): Promise<(WorkflowJobNode | NoWorkflowJobsNode | PreviousAttemptsNode)[]> {
@@ -50,7 +51,21 @@ export class WorkflowRunNode extends vscode.TreeItem {
     return children;
   }
 
+  getTooltip(): vscode.MarkdownString {
+    let markdownString = "";
+
+    if (this.run.hasPreviousAttempts) {
+      markdownString += `Attempt #${this.run.run.run_attempt} `;
+    }
+
+    markdownString += getStatusString(this.run, markdownString.length == 0);
+    markdownString += `\n\n`;
+    markdownString += getEventString(this.run);
+
+    return new vscode.MarkdownString(markdownString);
+  }
+
   private static _getLabel(run: WorkflowRun, workflowName?: string): string {
-    return `${workflowName ? workflowName + " " : ""}#${run.run.id}`;
+    return `${workflowName ? workflowName + " " : ""}#${run.run.run_number}`;
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ function _getIconForWorkflowrun(`
`37`	`37`	`return getAbsoluteIconPath("conclusions/failure.svg");`
`38`	`38`
`39`	`39`	`case "cancelled":`
	`40`	`+ case "skipped":`
`40`	`41`	`return getAbsoluteIconPath("conclusions/cancelled.svg");`
`41`	`42`	`}`
`42`	`43`	`break;`
`@@ -72,6 +73,7 @@ export function getCodIconForWorkflowrun(runOrJob?: IStatusAndConclusion): strin`
`72`	`73`	`return "error";`
`73`	`74`
`74`	`75`	`case "cancelled":`
	`76`	`+ case "skipped":`
`75`	`77`	`return "circle-slash";`
`76`	`78`	`}`
`77`	`79`	`break;`