@preventive/triage 1.0.0-alpha.51 → 1.0.0-alpha.52

package/common/managed/finding-detail.js

@@ -1,5 +1,6 @@
 import { findingTitle, reportEntries, revalidateKindOf } from '@preventive/report'
 import { managedTeamRevalidationConflicted } from './team-app.js'
+import { liteName } from './lite-name.js'
 
 // A finding's detail: what its popup, the views besides the board and an
 // export read, and the board does not. Its narrative and evidence, the hash
@@ -14,14 +15,10 @@ import { managedTeamRevalidationConflicted } from './team-app.js'
 export const FINDING_DETAIL_FIELDS = Object.freeze([
   'description', 'evidence', 'impact', 'reproduction', 'recommendation', 'confidenceReason', 'revalidateVerdict', 'revalidateRecommendation',
   'fileHash', 'exportName', 'methodName',
-  'commitHash', 'auditedCommit', 'detectedAt', 'committedAt', 'dateCreated', 'status', 'branch', 'pocStatus', 'parent', 'slug', 'reportPath',
+  'severityReason', 'commitHash', 'auditedCommit', 'detectedAt', 'committedAt', 'dateCreated', 'status', 'branch', 'pocStatus', 'parent', 'slug', 'reportPath',
   'category', 'discoveredIn', 'effort', 'exportsMode',
 ])
 const DETAIL = new Set(FINDING_DETAIL_FIELDS)
-// As much of a name as a heading takes (@preventive/report write-md-finding.js
-// HEADING_MAX), about a board card's three lines.
-const NAME_CHARS = 120
-
 // A finding without its detail. One without a title of its own is named by its
 // description's first line (findingTitle), which it keeps as its description,
 // as much of it as a card shows.
@@ -30,7 +27,7 @@ function liteFinding(finding) {
   const lite = Object.fromEntries(Object.entries(finding).filter(([key]) => !DETAIL.has(key)))
   const titled = typeof finding.title === 'string' && finding.title.trim() !== ''
   const title = titled ? '' : findingTitle(finding)
-  if (title) lite.description = title.length > NAME_CHARS ? `${title.slice(0, NAME_CHARS - 1)}…` : title
+  if (title) lite.description = liteName(title)
   return lite
 }
 

package/common/managed/finding-values.d.ts

@@ -0,0 +1,2 @@
+export function findingValueIndex(): { values: unknown[]; index<T>(data: T): T }
+export function expandFindingValues<T>(data: T, values: unknown): T

package/common/managed/finding-values.js

@@ -0,0 +1,44 @@
+// A finding's `package` and `repo`: the same few across a team's many
+// findings. A team's reports are sent with each once, in the response's
+// `values`, and each finding's as its index there
+// (server-managed/team-reports.ts), put back as they are read
+// (client/managed/session.js).
+const FIELDS = ['package', 'repo']
+
+const entriesKey = data => Array.isArray(data?.findings) ? 'findings' : Array.isArray(data?.groups) ? 'groups' : null
+
+// `values`, and `index(data)`: a report's data with its findings' values as
+// their index in it, one value at one index across every report it is given.
+export function findingValueIndex() {
+  const indexes = new Map(), values = []
+  const indexOf = value => {
+    const key = JSON.stringify(value)
+    if (!indexes.has(key)) indexes.set(key, values.push(value) - 1)
+    return indexes.get(key)
+  }
+  const indexed = finding => {
+    if (!finding || typeof finding !== 'object' || !FIELDS.some(field => finding[field] != null)) return finding
+    const copy = { ...finding }
+    for (const field of FIELDS) if (finding[field] != null) copy[field] = indexOf(finding[field])
+    return copy
+  }
+  return {
+    values,
+    index(data) {
+      const key = entriesKey(data)
+      return key ? { ...data, [key]: data[key].map(entry => Array.isArray(entry) ? entry.map(indexed) : indexed(entry)) } : data
+    },
+  }
+}
+
+// A report's data, as read, its findings' values put in place of their index
+// in a response's `values`; one sent without any as it is.
+export function expandFindingValues(data, values) {
+  const key = entriesKey(data)
+  if (!key || !Array.isArray(values)) return data
+  for (const finding of data[key].flat()) {
+    if (!finding || typeof finding !== 'object') continue
+    for (const field of FIELDS) if (Number.isInteger(finding[field])) finding[field] = values[finding[field]]
+  }
+  return data
+}

package/common/managed/lite-name.d.ts

@@ -0,0 +1,2 @@
+export function liteName(name: string): string
+export function readLiteReportData<T>(data: T): T

package/common/managed/lite-name.js

@@ -0,0 +1,20 @@
+import { reportEntries } from '@preventive/report'
+
+// As much of a name as a heading takes (@preventive/report write-md-finding.js
+// HEADING_MAX), about a board card's three lines. A board's copy of a team's
+// reports (finding-detail.js) cuts one longer to end in `CUT`, an ellipsis
+// once read.
+const CUT = '...', NAME_CHARS = 120
+
+export const liteName = name => name.length > NAME_CHARS ? `${name.slice(0, NAME_CHARS - CUT.length)}${CUT}` : name
+
+// A report's data from its board's copy, as read: a name cut ends in an
+// ellipsis. One as long as a cut leaves it and ending in `CUT` is one; one
+// shorter ends as it does.
+export function readLiteReportData(data) {
+  for (const finding of (reportEntries(data) ?? []).flat()) {
+    const name = finding?.description
+    if (typeof name === 'string' && name.length === NAME_CHARS && name.endsWith(CUT)) finding.description = `${name.slice(0, -CUT.length)}…`
+  }
+  return data
+}