Skip to content

Commit cdf1061

Browse files
cschleidencschleiden
committed
Support displaying logs
1 parent c58e847 commit cdf1061

File tree

10 files changed

+270
-52
lines changed

10 files changed

+270
-52
lines changed

‎package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@
6060
"when": "viewItem =~ /run/"
6161
},
6262
{
63-
"command": "workflow.step.logs",
63+
"command": "workflow.logs",
6464
"title": "View logs",
65-
"when": "viewItem =~ /job/ && viewItem =~ /completed/",
65+
"when": "viewItem =~ /job/ || viewItem =~ /step/",
6666
"icon": {
67-
"dark": "resources/icons/dark/add.svg",
68-
"light": "resources/icons/light/add.svg"
67+
"dark": "resources/icons/dark/logs.svg",
68+
"light": "resources/icons/light/logs.svg"
6969
}
7070
},
7171
{
@@ -146,7 +146,7 @@
146146
"when": "viewItem =~ /run/"
147147
},
148148
{
149-
"command": "workflow.step.logs",
149+
"command": "workflow.logs",
150150
"group": "inline",
151151
"when": "viewItem =~ /job/ && viewItem =~ /completed/"
152152
},

‎resources/icons/dark/logs.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎resources/icons/light/logs.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎src/extension.ts‎

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,23 @@ import { getGitHubUrl } from "./git/repository";
55
import { LogScheme } from "./logs/constants";
66
import { WorkflowStepLogProvider } from "./logs/fileProvider";
77
import { WorkflowStepLogFoldingProvider } from "./logs/foldingProvider";
8-
import { Secret, Workflow, WorkflowJob, WorkflowRun } from "./model";
8+
import {
9+
Secret,
10+
Workflow,
11+
WorkflowJob,
12+
WorkflowRun,
13+
WorkflowStep
14+
} from "./model";
915
import { encodeSecret } from "./secrets";
1016
import { initResources } from "./treeViews/icons";
1117
import { SettingsTreeProvider } from "./treeViews/settings";
1218
import { ActionsExplorerProvider as WorkflowsTreeProvider } from "./treeViews/workflows";
1319
import { getWorkflowUri } from "./workflow/workflow";
1420
import Octokit = require("@octokit/rest");
1521
import { buildLogURI } from "./logs/scheme";
22+
import { WorkflowStepLogSymbolProvider } from "./logs/symbolProvider";
23+
import { registerFormatProvider } from "./logs/formatProvider";
24+
import { parseLog } from "./logs/model";
1625

1726
export function activate(context: vscode.ExtensionContext) {
1827
// TODO: Remove
@@ -118,14 +127,43 @@ export function activate(context: vscode.ExtensionContext) {
118127
);
119128

120129
context.subscriptions.push(
121-
vscode.commands.registerCommand("workflow.step.logs", async args => {
130+
vscode.commands.registerCommand("workflow.logs", async args => {
122131
const repo: Protocol = args.repo;
123132
const job: WorkflowJob = args.job;
124-
const uri = buildLogURI(repo.owner, repo.repositoryName, job.id);
133+
const step: WorkflowStep | undefined = args.step;
134+
const uri = buildLogURI(
135+
repo.owner,
136+
repo.repositoryName,
137+
job.id,
138+
step?.name
139+
);
125140
const doc = await vscode.workspace.openTextDocument(uri);
126-
await vscode.window.showTextDocument(doc, {
127-
preview: true
141+
const editor = await vscode.window.showTextDocument(doc, {
142+
preview: false
128143
});
144+
if (step) {
145+
// This parses the log - again - as a future optimization this should be done only once.
146+
const logInfo = parseLog(editor.document.getText());
147+
let matchingSection = logInfo.sections.find(
148+
s => s.name && s.name === step.name
149+
);
150+
if (!matchingSection) {
151+
// If we cannot match by name, see if we can try to match by number
152+
matchingSection = logInfo.sections[step.number - 1];
153+
}
154+
155+
if (matchingSection) {
156+
editor.revealRange(
157+
new vscode.Range(
158+
matchingSection.start,
159+
0,
160+
matchingSection.start,
161+
0
162+
),
163+
vscode.TextEditorRevealType.InCenter
164+
);
165+
}
166+
}
129167
})
130168
);
131169

@@ -266,6 +304,9 @@ export function activate(context: vscode.ExtensionContext) {
266304
})
267305
);
268306

307+
//
308+
// Log providers
309+
//
269310
context.subscriptions.push(
270311
vscode.workspace.registerTextDocumentContentProvider(
271312
LogScheme,
@@ -279,6 +320,17 @@ export function activate(context: vscode.ExtensionContext) {
279320
new WorkflowStepLogFoldingProvider()
280321
)
281322
);
323+
324+
context.subscriptions.push(
325+
vscode.languages.registerDocumentSymbolProvider(
326+
{
327+
scheme: LogScheme
328+
},
329+
new WorkflowStepLogSymbolProvider()
330+
)
331+
);
332+
333+
registerFormatProvider(context);
282334
}
283335

284336
// this method is called when your extension is deactivated

‎src/logs/foldingProvider.ts‎

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import * as vscode from "vscode";
2+
import { parseLog } from "./model";
23

34
export class WorkflowStepLogFoldingProvider
45
implements vscode.FoldingRangeProvider {
@@ -7,42 +8,12 @@ export class WorkflowStepLogFoldingProvider
78
context: vscode.FoldingContext,
89
token: vscode.CancellationToken
910
): vscode.ProviderResult<vscode.FoldingRange[]> {
10-
let firstRange: vscode.FoldingRange | null = new vscode.FoldingRange(
11-
0,
12-
1,
13-
vscode.FoldingRangeKind.Region
14-
);
15-
16-
// Assume there is always the setup range
17-
const ranges: vscode.FoldingRange[] = [firstRange];
18-
19-
let currentRange: vscode.FoldingRange | null = null;
2011
const log = document.getText();
21-
const lines = log.split(/\n|\r/).filter(l => !!l);
22-
lines.forEach((line, idx) => {
23-
if (line.indexOf("##[group]") !== -1) {
24-
// If this is the first group marker we encounter, the previous range was the job setup
25-
if (firstRange) {
26-
firstRange.end = idx - 1;
27-
firstRange = null;
28-
}
12+
const logInfo = parseLog(log);
2913

30-
currentRange = new vscode.FoldingRange(
31-
idx,
32-
idx + 1,
33-
vscode.FoldingRangeKind.Region
34-
);
35-
} else if (line.indexOf("##[endgroup]") !== -1) {
36-
if (!currentRange) {
37-
throw new Error("Found ##[endgroup] marker without group begin");
38-
}
39-
40-
currentRange.end = idx;
41-
ranges.push(currentRange);
42-
currentRange = null;
43-
}
44-
});
45-
46-
return ranges;
14+
return logInfo.sections.map(
15+
s =>
16+
new vscode.FoldingRange(s.start, s.end, vscode.FoldingRangeKind.Region)
17+
);
4718
}
4819
}

‎src/logs/formatProvider.ts‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import * as vscode from "vscode";
2+
import { LogScheme } from "./constants";
3+
4+
const errorDecorationType = vscode.window.createTextEditorDecorationType({
5+
color: new vscode.ThemeColor("editorError.foreground"),
6+
borderColor: new vscode.ThemeColor("editorError.border")
7+
});
8+
9+
const groupDecorationType = vscode.window.createTextEditorDecorationType({
10+
fontWeight: "bold"
11+
});
12+
13+
let activeEditor = vscode.window.activeTextEditor;
14+
let timeout: NodeJS.Timer | undefined = undefined;
15+
16+
function updateDecorations() {
17+
if (!activeEditor) {
18+
return;
19+
}
20+
const regEx = /##\[error\]|##\[group\]/g;
21+
const text = activeEditor.document.getText();
22+
const errors: vscode.DecorationOptions[] = [];
23+
const groups: vscode.DecorationOptions[] = [];
24+
let match;
25+
while ((match = regEx.exec(text))) {
26+
const startPos = activeEditor.document.positionAt(match.index);
27+
const lineRange = activeEditor.document.lineAt(startPos.line).range;
28+
29+
const decorationRange = {
30+
range: lineRange
31+
};
32+
if (match[0].indexOf("error") !== -1) {
33+
errors.push(decorationRange);
34+
} else {
35+
groups.push(decorationRange);
36+
}
37+
}
38+
39+
activeEditor.setDecorations(errorDecorationType, errors);
40+
activeEditor.setDecorations(groupDecorationType, groups);
41+
}
42+
43+
function triggerUpdateDecorations() {
44+
if (timeout) {
45+
clearTimeout(timeout);
46+
timeout = undefined;
47+
}
48+
timeout = setTimeout(updateDecorations, 500);
49+
}
50+
51+
export function registerFormatProvider(context: vscode.ExtensionContext) {
52+
vscode.window.onDidChangeActiveTextEditor(
53+
editor => {
54+
activeEditor = editor;
55+
if (activeEditor && editor?.document.uri.scheme === LogScheme) {
56+
triggerUpdateDecorations();
57+
}
58+
},
59+
null,
60+
context.subscriptions
61+
);
62+
63+
vscode.workspace.onDidChangeTextDocument(
64+
event => {
65+
if (
66+
activeEditor &&
67+
event.document === activeEditor.document &&
68+
event.document.uri.scheme === LogScheme
69+
) {
70+
triggerUpdateDecorations();
71+
}
72+
},
73+
null,
74+
context.subscriptions
75+
);
76+
}

‎src/logs/model.ts‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
export enum Type {
2+
Setup,
3+
Step
4+
}
5+
6+
export interface LogSection {
7+
type: Type;
8+
start: number;
9+
end: number;
10+
name?: string;
11+
}
12+
13+
export interface LogInfo {
14+
sections: LogSection[];
15+
}
16+
17+
export function parseLog(log: string): LogInfo {
18+
let firstSection: LogSection | null = {
19+
name: "Setup",
20+
type: Type.Setup,
21+
start: 0,
22+
end: 1
23+
};
24+
25+
// Assume there is always the setup section
26+
const sections: LogSection[] = [firstSection];
27+
28+
let currentRange: LogSection | null = null;
29+
const lines = log.split(/\n|\r/).filter(l => !!l);
30+
let lineIdx = 0;
31+
32+
const groupMarker = "##[group]";
33+
34+
for (const line of lines) {
35+
const groupMarkerStart = line.indexOf(groupMarker);
36+
if (groupMarkerStart !== -1) {
37+
// If this is the first group marker we encounter, the previous range was the job setup
38+
if (firstSection) {
39+
firstSection.end = lineIdx - 1;
40+
firstSection = null;
41+
}
42+
43+
if (currentRange) {
44+
currentRange.end = lineIdx - 1;
45+
sections.push(currentRange);
46+
}
47+
48+
const name = line.substr(groupMarkerStart + groupMarker.length);
49+
50+
currentRange = {
51+
name,
52+
type: Type.Step,
53+
start: lineIdx,
54+
end: lineIdx + 1
55+
};
56+
}
57+
58+
++lineIdx;
59+
}
60+
61+
if (currentRange) {
62+
currentRange.end = lineIdx - 1;
63+
sections.push(currentRange);
64+
}
65+
66+
return {
67+
sections
68+
};
69+
}

‎src/logs/scheme.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,25 @@ import { LogScheme } from "./constants";
44
export function buildLogURI(
55
owner: string,
66
repo: string,
7-
jobId: number
7+
jobId: number,
8+
stepName?: string
89
): vscode.Uri {
9-
return vscode.Uri.parse(`${LogScheme}://${owner}/${repo}#${jobId}`);
10+
return vscode.Uri.parse(
11+
`${LogScheme}://${owner}/${repo}?${jobId}#${stepName}`
12+
);
1013
}
1114

1215
export function parseUri(
1316
uri: vscode.Uri
14-
): { owner: string; repo: string; jobId: number } {
17+
): { owner: string; repo: string; jobId: number; stepName?: string } {
1518
if (uri.scheme != LogScheme) {
1619
throw new Error("Uri is not of log scheme");
1720
}
1821

1922
return {
2023
owner: uri.authority,
2124
repo: uri.path.replace("/", ""),
22-
jobId: parseInt(uri.fragment, 10)
25+
jobId: parseInt(uri.query, 10),
26+
stepName: uri.fragment
2327
};
2428
}

‎src/logs/symbolProvider.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import * as vscode from "vscode";
2+
import { parseLog } from "./model";
3+
4+
export class WorkflowStepLogSymbolProvider
5+
implements vscode.DocumentSymbolProvider {
6+
provideDocumentSymbols(
7+
document: vscode.TextDocument,
8+
token: vscode.CancellationToken
9+
): vscode.ProviderResult<
10+
vscode.SymbolInformation[] | vscode.DocumentSymbol[]
11+
> {
12+
const log = document.getText();
13+
const logInfo = parseLog(log);
14+
15+
return logInfo.sections.map(
16+
s =>
17+
new vscode.DocumentSymbol(
18+
s.name || "Setup",
19+
"Step",
20+
vscode.SymbolKind.Function,
21+
new vscode.Range(s.start, 0, s.end, 0),
22+
new vscode.Range(s.start, 0, s.end, 0)
23+
)
24+
);
25+
}
26+
}

0 commit comments

Comments
 (0)