Add open step logs command

Author: lrotschy

package.json

@@ -147,6 +147,16 @@
           "light": "resources/icons/light/logs.svg"
         }
       },
+      {
+        "command": "github-actions.step.logs",
+        "category": "GitHub Actions",
+        "title": "View logs",
+        "when": "viewItem =~ /step/",
+        "icon": {
+          "dark": "resources/icons/dark/logs.svg",
+          "light": "resources/icons/light/logs.svg"
+        }
+      },
       {
         "command": "github-actions.workflow.run.rerun",
         "category": "GitHub Actions",
@@ -363,6 +373,11 @@
           "group": "inline",
           "when": "viewItem =~ /job/ && viewItem =~ /completed/"
         },
+        {
+          "command": "github-actions.step.logs",
+          "group": "inline",
+          "when": "viewItem =~ /step/ && viewItem =~ /completed/"
+        },
         {
           "command": "github-actions.workflow.run.cancel",
           "when": "viewItem =~ /run/ && viewItem =~ /cancelable/"
@@ -438,6 +453,10 @@
           "command": "github-actions.workflow.logs",
           "when": "false"
         },
+        {
+          "command": "github-actions.step.logs",
+          "when": "false"
+        },
         {
           "command": "github-actions.workflow.run.rerun",
           "when": "false"

src/commands/openWorkflowStepLogs.ts

@@ -0,0 +1,55 @@
+import * as vscode from "vscode";
+import {GitHubRepoContext} from "../git/repository";
+import {updateDecorations} from "../logs/formatProvider";
+import {getLogInfo} from "../logs/logInfo";
+import {buildLogURI} from "../logs/scheme";
+import {WorkflowJob} from "../store/WorkflowJob";
+import { WorkflowStep } from "../model";
+
+export interface OpenWorkflowStepLogsCommandArgs {
+  gitHubRepoContext: GitHubRepoContext;
+  job: WorkflowJob;
+  step: WorkflowStep;
+}
+
+export function registerOpenWorkflowStepLogs(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand("github-actions.step.logs", async (args: OpenWorkflowStepLogsCommandArgs) => {
+      const gitHubRepoContext = args.gitHubRepoContext;
+      const job = args.job;
+      const step = args.step;
+
+      const uri = buildLogURI(
+        `%23${job.job.run_id} - ${job.job.name}`,
+        gitHubRepoContext.owner,
+        gitHubRepoContext.name,
+        job.job.id
+      );
+
+      const doc = await vscode.workspace.openTextDocument(uri);
+      const editor = await vscode.window.showTextDocument(doc, {
+        preview: false
+      });
+
+      const logInfo = getLogInfo(uri);
+      if (!logInfo) {
+        throw new Error("Could not get log info");
+      }
+
+      const section = logInfo.sections.find(s => s.name === step.name);
+      const startLine = section ? section.start : 0;
+      const endLine = section ? section.end : 0;
+
+
+      const stepInfo = {
+        updatedLogLines: logInfo["updatedLogLines"].slice(startLine, endLine),
+        sections: logInfo["sections"].filter(s => s.name === step.name),
+        styleFormats: logInfo["styleFormats"].filter(s => s.line >= startLine && s.line <= endLine)
+      };
+
+
+      // Custom formatting after the editor has been opened
+      updateDecorations(editor, stepInfo);
+    })
+  );
+}

src/extension.ts

@@ -5,6 +5,7 @@ import {getSession} from "./auth/auth";
 import {registerCancelWorkflowRun} from "./commands/cancelWorkflowRun";
 import {registerOpenWorkflowFile} from "./commands/openWorkflowFile";
 import {registerOpenWorkflowJobLogs} from "./commands/openWorkflowJobLogs";
+import {registerOpenWorkflowStepLogs} from "./commands/openWorkflowStepLogs";
 import {registerOpenWorkflowRun} from "./commands/openWorkflowRun";
 import {registerPinWorkflow} from "./commands/pinWorkflow";
 import {registerReRunWorkflowRun} from "./commands/rerunWorkflowRun";
@@ -71,6 +72,7 @@ export async function activate(context: vscode.ExtensionContext) {
   registerOpenWorkflowRun(context);
   registerOpenWorkflowFile(context);
   registerOpenWorkflowJobLogs(context);
+  registerOpenWorkflowStepLogs(context);
   registerTriggerWorkflowRun(context);
   registerReRunWorkflowRun(context);
   registerCancelWorkflowRun(context);