Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes for using message instead of description #50

Closed
wants to merge 1 commit into from
Closed

Changes for using message instead of description #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions public/output.js
View file
Open in desktop

Large diffs are not rendered by default.

3,275 changes: 3,275 additions & 0 deletions public/output.yaml
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion src/api/report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export interface IssueDto {
ruleset?: string;
rule?: string;
name?: string;
message?: string;
description: string;
category: string;
labels: string[];
Expand All @@ -33,7 +34,7 @@ export interface IssueDto {
export interface IncidentDto {
uri?: string;
file?: string;
message: string;
message?: string;
codeSnip: string;
lineNumber?: number;
line?: number;
Expand Down
1 change: 1 addition & 0 deletions src/models/api-enriched.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface IssueProcessed {
effort: number;
links: LinkDto[];
description: string;
message: string;
totalEffort: number;
totalIncidents: number;
category: IssueCatType;
Expand Down
2 changes: 1 addition & 1 deletion src/models/file.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export const addIncidentToDispersedFile = (df: DispersedFile, incident: Incident
df.ranges = left.concat(toPush).concat(right)
df.codeSnips.push(incident.codeSnip)
const lineNumber: number = incident.lineNumber || incident.line || 0
df.incidentsUnorganized.push({lineNumber, message: incident.message})
df.incidentsUnorganized.push({lineNumber, message: incident.message || ""})
}
}

Expand Down
12 changes: 8 additions & 4 deletions src/queries/mocks/report.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ if (
],
violations: {
"rule-001": {
description: "Test Rule 001\nTest description",
description: "Test Rule 001",
message: "Test description line 1\nTestDescription line 2",
category: ISSUE_CATEGORIES[0],
labels: [
"konveyor.io/source=src-1",
Expand Down Expand Up @@ -51,7 +52,8 @@ if (
],
},
"rule-002": {
description: "Test Rule 002\nTest description",
description: "Test Rule 002",
message: "Test description line 1\nTestDescription line 2",
category: ISSUE_CATEGORIES[1],
labels: [
"konveyor.io/target=tgt-1",
Expand Down Expand Up @@ -95,7 +97,8 @@ if (
],
violations: {
"rule-001": {
description: "Test Rule 001\nTest description",
description: "Test Rule 001",
message: "Test description line 1\nTestDescription line 2",
category: ISSUE_CATEGORIES[0],
labels: [
"konveyor.io/source=src-1",
Expand Down Expand Up @@ -140,7 +143,8 @@ if (
],
},
"rule-002": {
description: "An issue with a really long description that doesn't quite fit in the cell\nTest description",
description: "An issue with a really long description that doesn't quite fit in the cell",
message: "Test description line 1\nTestDescription line 2",
category: ISSUE_CATEGORIES[1],
labels: [
"konveyor.io/target=really-long-target-name",
Expand Down
8 changes: 6 additions & 2 deletions src/queries/report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ const issuesFromRulesetsDto = (appID: string, filesRaw: FileDto, rulesets: Rules
const violation: IssueDto = rs.violations[ruleID];
const totalIncidents: number = violation.incidents.length;
const totalEffort: number = (violation.effort ? violation.effort : 0) * totalIncidents;
const name: string = violation.description?.split("\n")[0];
const name: string = violation.description || "";
const message: string = violation.message || "";
const sourceTechnologies: string[] = filterLabelsWithPrefix(violation.labels, "konveyor.io/source=");
const targetTechnologies: string[] = filterLabelsWithPrefix(violation.labels, "konveyor.io/target=");
const dispersedFiles: { [key: string]: DispersedFile } = violation.incidents.reduce<{ [key: string]: DispersedFile }>((acc, incident) => {
Expand Down Expand Up @@ -85,6 +86,7 @@ const issuesFromRulesetsDto = (appID: string, filesRaw: FileDto, rulesets: Rules
totalIncidents,
sourceTechnologies,
targetTechnologies,
message: message,
id: appID + rs.name + ruleID,
category: violation.category as IssueCatType,
effort: violation.effort ? violation.effort : 0,
Expand All @@ -99,7 +101,8 @@ const issuesFromIssuesDto = (appID: string, issues: IssueDto[]): IssueProcessed[
return issues?.flatMap((issue) => {
const totalIncidents: number = issue.incidents?.length;
const totalEffort: number = (issue.effort ? issue.effort : 0) * totalIncidents;
const name: string = issue.description?.split("\n")[0];
const name: string = issue.description || "";
const message: string = issue.message || "";
const sourceTechnologies: string[] = filterLabelsWithPrefix(issue.labels, "konveyor.io/source=");
const targetTechnologies: string[] = filterLabelsWithPrefix(issue.labels, "konveyor.io/target=");
const dispersedFiles: { [key: string]: DispersedFile } = issue.incidents.reduce<{ [key: string]: DispersedFile }>((acc, incident) => {
Expand All @@ -126,6 +129,7 @@ const issuesFromIssuesDto = (appID: string, issues: IssueDto[]): IssueProcessed[
...issue,
name,
appID,
message,
totalEffort,
totalIncidents,
dispersedFiles,
Expand Down
6 changes: 3 additions & 3 deletions src/shared/components/file-editor/file-editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ export const FileEditor: React.FC<IFileEditorProps> = ({
endLineNumber: absoluteToRelativeLineNum(inc.lineNumber),
startColumn: 0,
endColumn: 1000,
message: issue.description,
message: issue.message,
severity: monaco.MarkerSeverity.Warning,
}
return marker
Expand Down Expand Up @@ -195,10 +195,10 @@ export const FileEditor: React.FC<IFileEditorProps> = ({
</CardTitle>
</CardHeader>
<CardBody>
{issue.description && (
{issue.message && (
<SimpleMarkdown
children={getMarkdown(
issue.description,
issue.message,
issue.links,
)}
/>
Expand Down
2 changes: 1 addition & 1 deletion src/shared/components/violations-table/components/issue-overview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export const IssueOverview: React.FC<IIssueOverviewProps> = ({
</CardHeader>
<CardBody>
<SimpleMarkdown
children={getMarkdown(issue.description || "", issue.links)}
children={getMarkdown(issue.message || "", issue.links)}
/>
</CardBody>
</Card>
Expand Down