feat: improve share results error handling

src/cli/commands/test/iac-local-execution/types.ts

@@ -348,6 +348,9 @@ export enum IaCErrorCodes {
 
   // report errors
   UnsupportedReportCommandError = 1120,
+
+  // share results errors
+  FailedToShareResults = 1130,
 }
 
 export interface TestReturnValue {

src/lib/iac/cli-share-results.ts

@@ -2,6 +2,7 @@ import config from '../config';
 import { makeRequest } from '../request';
 import { getAuthHeader } from '../api-token';
 import {
+  IaCErrorCodes,
   IacShareResultsFormat,
   IaCTestFlags,
   ShareResultsOutput,
@@ -14,10 +15,11 @@ import { Contributor } from '../types';
 import * as analytics from '../analytics';
 import { getContributors } from '../monitor/dev-count-analysis';
 import * as Debug from 'debug';
-import { AuthFailedError, ValidationError } from '../errors';
+import { AuthFailedError, CustomError, ValidationError } from '../errors';
 
 const debug = Debug('iac-cli-share-results');
 import { ProjectAttributes, Tag } from '../types';
+import { getErrorStringCode } from '../../cli/commands/test/iac-local-execution/error-utils';
 
 export async function shareResults({
   results,
@@ -47,6 +49,7 @@ export async function shareResults({
       }
     }
   }
+
   const { res, body } = await makeRequest({
     method: 'POST',
     url: `${config.API}/iac-cli-share-results`,
@@ -63,15 +66,25 @@ export async function shareResults({
     },
   });
 
-  if (res.statusCode === 401) {
-    throw AuthFailedError();
+  if (res.statusCode === 200) {
+    return { projectPublicIds: body, gitRemoteUrl: gitTarget?.remoteUrl };
+  } else {
+    if (res.statusCode === 401) {
+      throw AuthFailedError();
+    } else if (res.statusCode === 422 && body.error) {
+      throw new ValidationError(body.error);
+    } else {
+      throw new FailedToShareResults();
+    }
   }
+}
 
-  if (res.statusCode === 422) {
-    throw new ValidationError(
-      res.body.error ?? 'An error occurred, please contact Snyk support',
-    );
+class FailedToShareResults extends CustomError {
+  constructor(message?: string) {
+    super(message || 'Failed to share results');
+    this.code = IaCErrorCodes.FailedToShareResults;
+    this.strCode = getErrorStringCode(this.code);
+    this.userMessage =
+      'An error occurred when trying to share your results, please contact Snyk support (support@snyk.io)';
   }
-
-  return { projectPublicIds: body, gitRemoteUrl: gitTarget?.remoteUrl };
 }

test/acceptance/fake-server.ts

@@ -501,6 +501,10 @@ export const fakeServer = (basePath: string, snykToken: string): FakeServer => {
     res.status(200).send({});
   });
 
+  app.post(basePath + '/iac-cli-share-results', (req, res) => {
+    res.status(200).send({});
+  });
+
   app.post(basePath + '/analytics/cli', (req, res) => {
     res.status(200).send({});
   });

test/jest/unit/iac/cli-share-results.fixtures.ts

@@ -168,6 +168,7 @@ export const expectedEnvelopeFormatterResults = [
   },
 ];
 
+// if the test that is using this expected output fails for version, look at the package.json policy package version and update it accordingly
 export const expectedEnvelopeFormatterResultsWithPolicy = expectedEnvelopeFormatterResults.map(
   (result) => {
     return {

test/jest/unit/iac/cli-share-results.spec.ts

@@ -22,7 +22,10 @@ describe('CLI Share Results', () => {
   beforeEach(() => {
     requestSpy = jest
       .spyOn(request, 'makeRequest')
-      .mockImplementation(async () => ({ res: {} as any, body: {} }));
+      .mockImplementation(async () => ({
+        res: { statusCode: 200 } as any,
+        body: {},
+      }));
     envelopeFormattersSpy = jest.spyOn(
       envelopeFormatters,
       'convertIacResultToScanResult',