Merge pull request #1279 from snyk/fix/abridge-call-graph-error-message

fix: abridge call graph creation error messages in analytics
snyk · Jul 22, 2020 · 6f3ec4f · 6f3ec4f
2 parents c70c657 + 7a68ad3
commit 6f3ec4f
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 2 deletions.
diff --git a/src/lib/error-format.ts b/src/lib/error-format.ts
@@ -0,0 +1,12 @@
+export function abridgeErrorMessage(
+  msg: string,
+  maxLen: number,
+  ellipsis?: string,
+): string {
+  if (msg.length <= maxLen) {
+    return msg;
+  }
+  const e = ellipsis || ' ... ';
+  const toKeep = (maxLen - e.length) / 2;
+  return msg.slice(0, toKeep) + e + msg.slice(msg.length - toKeep, msg.length);
+}
diff --git a/src/lib/monitor/index.ts b/src/lib/monitor/index.ts
@@ -51,9 +51,12 @@ import {
 } from './utils';
 import { countPathsToGraphRoot } from '../utils';
 import * as alerts from '../alerts';
+import { abridgeErrorMessage } from '../error-format';
 
 const debug = Debug('snyk');
 
+const ANALYTICS_PAYLOAD_MAX_LENGTH = 1024;
+
 // TODO(kyegupov): clean up the type, move to snyk-cli-interface repository
 
 interface MonitorBody {
@@ -220,7 +223,13 @@ async function monitorDepTree(
   let callGraphPayload;
   if (options.reachableVulns && scannedProject.callGraph?.innerError) {
     const err = scannedProject.callGraph as CallGraphError;
-    analytics.add('callGraphError', err.innerError.toString());
+    analytics.add(
+      'callGraphError',
+      abridgeErrorMessage(
+        err.innerError.toString(),
+        ANALYTICS_PAYLOAD_MAX_LENGTH,
+      ),
+    );
     alerts.registerAlerts([
       {
         type: 'error',

diff --git a/src/lib/snyk-test/run-test.ts b/src/lib/snyk-test/run-test.ts
@@ -55,9 +55,12 @@ import { assembleIacLocalPayloads, parseIacTestResult } from './run-iac-test';
 import { Payload, PayloadBody, DepTreeFromResolveDeps } from './types';
 import { CallGraphError } from '@snyk/cli-interface/legacy/common';
 import * as alerts from '../alerts';
+import { abridgeErrorMessage } from '../error-format';
 
 const debug = debugModule('snyk');
 
+const ANALYTICS_PAYLOAD_MAX_LENGTH = 1024;
+
 export = runTest;
 
 async function sendAndParseResults(
@@ -520,7 +523,13 @@ async function assembleLocalPayloads(
         (scannedProject.callGraph as CallGraphError).innerError
       ) {
         const err = scannedProject.callGraph as CallGraphError;
-        analytics.add('callGraphError', err.innerError.toString());
+        analytics.add(
+          'callGraphError',
+          abridgeErrorMessage(
+            err.innerError.toString(),
+            ANALYTICS_PAYLOAD_MAX_LENGTH,
+          ),
+        );
         alerts.registerAlerts([
           {
             type: 'error',

diff --git a/test/error-format.test.ts b/test/error-format.test.ts
@@ -0,0 +1,22 @@
+import { test } from 'tap';
+import { abridgeErrorMessage } from '../src/lib/error-format';
+
+test('abridge empty string', async (t) => {
+  t.equal(abridgeErrorMessage('', 10), '');
+});
+
+test('abridge shorter than max length', async (t) => {
+  t.equal(abridgeErrorMessage('hello', 10), 'hello');
+});
+
+test('abridge same length as max length', async (t) => {
+  t.equal(abridgeErrorMessage('hello', 5), 'hello');
+});
+
+test('abridge longer than max length', async (t) => {
+  t.equal(abridgeErrorMessage('hello there', 10), 'he ... ere');
+});
+
+test('abridge longer than max length (custom ellipsis)', async (t) => {
+  t.equal(abridgeErrorMessage('hello there', 10, '--'), 'hell--here');
+});