feat(core): include audit table in portal upload

code-pushup · May 23, 2024 · 2b4f3e1 · 2b4f3e1
1 parent 76b9772
commit 2b4f3e1
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 12 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "node": ">=18.16"
   },
   "dependencies": {
-    "@code-pushup/portal-client": "^0.6.1",
+    "@code-pushup/portal-client": "^0.7.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "@swc/helpers": "0.5.3",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "@code-pushup/models": "0.43.1",
     "@code-pushup/utils": "0.43.1",
-    "@code-pushup/portal-client": "^0.6.1",
+    "@code-pushup/portal-client": "^0.7.0",
     "chalk": "^5.3.0"
   },
   "type": "commonjs",

diff --git a/packages/core/src/lib/implementation/report-to-gql.ts b/packages/core/src/lib/implementation/report-to-gql.ts
@@ -7,17 +7,23 @@ import {
   IssueSeverity as PortalIssueSeverity,
   IssueSourceType as PortalIssueSourceType,
   type PluginReport as PortalPlugin,
+  type AuditReportTable as PortalTable,
+  TableAlignment as PortalTableAlignment,
+  type AuditReportTableCell as PortalTableCell,
+  type AuditReportTableColumn as PortalTableColumn,
   type SaveReportMutationVariables,
 } from '@code-pushup/portal-client';
-import {
+import type {
   AuditReport,
   CategoryConfig,
   CategoryRef,
-  type Group,
+  Group,
   Issue,
   IssueSeverity,
   PluginReport,
   Report,
+  Table,
+  TableAlignment,
 } from '@code-pushup/models';
 
 export function reportToGQL(
@@ -69,7 +75,7 @@ function auditToGQL(audit: AuditReport): PortalAudit {
     displayValue: formattedValue,
     details,
   } = audit;
-  const { issues /*, table */ } = details ?? {};
+  const { issues, table } = details ?? {};
   return {
     slug,
     title,
@@ -81,8 +87,7 @@ function auditToGQL(audit: AuditReport): PortalAudit {
     ...(details && {
       details: {
         ...(issues && { issues: issues.map(issueToGQL) }),
-        // @TODO add when https://github.com/code-pushup/cli/issues/530 is implemented
-        // ...(table ? {table} : {}),
+        ...(table && { tables: [tableToGQL(table)] }),
       },
     }),
   };
@@ -103,6 +108,32 @@ export function issueToGQL(issue: Issue): PortalIssue {
   };
 }
 
+export function tableToGQL(table: Table): PortalTable {
+  return {
+    ...(table.title && { title: table.title }),
+    ...(table.columns?.length && {
+      columns: table.columns.map(
+        (column): PortalTableColumn =>
+          typeof column === 'string'
+            ? { alignment: tableAlignmentToGQL(column) }
+            : {
+                key: column.key,
+                label: column.label,
+                alignment: column.align && tableAlignmentToGQL(column.align),
+              },
+      ),
+    }),
+    rows: table.rows.map((row): PortalTableCell[] =>
+      Array.isArray(row)
+        ? row.map(content => ({ content: content.toString() }))
+        : Object.entries(row).map(([key, content]) => ({
+            key,
+            content: content.toString(),
+          })),
+    ),
+  };
+}
+
 function categoryToGQL(category: CategoryConfig): PortalCategory {
   return {
     slug: category.slug,
@@ -139,3 +170,14 @@ function issueSeverityToGQL(severity: IssueSeverity): PortalIssueSeverity {
       return PortalIssueSeverity.Warning;
   }
 }
+
+function tableAlignmentToGQL(alignment: TableAlignment): PortalTableAlignment {
+  switch (alignment) {
+    case 'left':
+      return PortalTableAlignment.Left;
+    case 'center':
+      return PortalTableAlignment.Center;
+    case 'right':
+      return PortalTableAlignment.Right;
+  }
+}
diff --git a/packages/core/src/lib/implementation/report-to-gql.unit.test.ts b/packages/core/src/lib/implementation/report-to-gql.unit.test.ts
@@ -1,5 +1,5 @@
 import { describe } from 'vitest';
-import { issueToGQL } from './report-to-gql';
+import { issueToGQL, tableToGQL } from './report-to-gql';
 
 describe('issueToGQL', () => {
   it('transforms issue to GraphQL input type', () => {
@@ -24,3 +24,60 @@ describe('issueToGQL', () => {
     });
   });
 });
+
+describe('tableToGQL', () => {
+  it('should transform primitive table to GraphQL input type', () => {
+    expect(
+      tableToGQL({
+        columns: ['left', 'right'],
+        rows: [
+          ['Script Evaluation', '3,167 ms'],
+          ['Style & Layout', '1,422 ms'],
+          ['Other', '712 ms'],
+        ],
+      }),
+    ).toStrictEqual({
+      columns: [{ alignment: 'Left' }, { alignment: 'Right' }],
+      rows: [
+        [{ content: 'Script Evaluation' }, { content: '3,167 ms' }],
+        [{ content: 'Style & Layout' }, { content: '1,422 ms' }],
+        [{ content: 'Other' }, { content: '712 ms' }],
+      ],
+    });
+  });
+
+  it('should transform object table to GraphQL input type', () => {
+    expect(
+      tableToGQL({
+        columns: [
+          { key: 'category', label: 'Category', align: 'left' },
+          { key: 'timeSpent', label: 'Time Spent', align: 'right' },
+        ],
+        rows: [
+          { category: 'Script Evaluation', timeSpent: '3,167 ms' },
+          { category: 'Style & Layout', timeSpent: '1,422 ms' },
+          { category: 'Other', timeSpent: '712 ms' },
+        ],
+      }),
+    ).toStrictEqual({
+      columns: [
+        { key: 'category', label: 'Category', alignment: 'Left' },
+        { key: 'timeSpent', label: 'Time Spent', alignment: 'Right' },
+      ],
+      rows: [
+        [
+          { key: 'category', content: 'Script Evaluation' },
+          { key: 'timeSpent', content: '3,167 ms' },
+        ],
+        [
+          { key: 'category', content: 'Style & Layout' },
+          { key: 'timeSpent', content: '1,422 ms' },
+        ],
+        [
+          { key: 'category', content: 'Other' },
+          { key: 'timeSpent', content: '712 ms' },
+        ],
+      ],
+    });
+  });
+});