@testrevolution/bugbug-cli 12.20.0 → 12.21.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testrevolution/bugbug-cli",
   "description": "BugBug CLI",
-  "version": "12.20.0",
+  "version": "12.21.0",
   "keywords": [
     "automation",
     "cli",
@@ -18,13 +18,13 @@
     "bugbug": "bin/bugbug"
   },
   "dependencies": {
-    "@sentry/node": "^8.55.0",
     "axios": "^1.10.0",
     "console-table-printer": "^2.12.1",
     "dotenv": "^16.4.7",
     "jest-junit": "^16.0.0",
     "junit-xml": "^1.2.0",
     "minimist": "^1.2.8",
+    "nanoid": "^5.1.5",
     "ora": "^5.4.1",
     "path": "^0.12.7",
     "validator": "^13.15.0"
@@ -43,6 +43,7 @@
   "devDependencies": {
     "@babel/eslint-parser": "^7.27.1",
     "@babel/plugin-proposal-throw-expressions": "^7.27.1",
+    "@sentry/node": "^10.1.0",
     "babel-plugin-rewire": "^1.2.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.57.1",

package/src/__mocks__/@sentry/node.js

@@ -0,0 +1,8 @@
+module.exports = {
+  init: jest.fn(),
+  setTag: jest.fn(),
+  setTags: jest.fn(),
+  setContext: jest.fn(),
+  flush: jest.fn(),
+  addBreadcrumb: jest.fn(),
+};

package/src/__mocks__/nanoid.js

@@ -0,0 +1,3 @@
+module.exports = {
+  nanoid: () => 12345,
+};

package/src/commands/remote.js

@@ -5,7 +5,7 @@ const settings = require('../settings');
 const { getSpinner } = require('../utils/spinner');
 const { getConfigValue } = require('../utils/config');
 const {
-  getExitCode, parseVariables, printErrorResponse, getUnknownOptions,
+  getExitCode, parseVariables, handleResponseError, getUnknownOptions,
 } = require('../utils/helper');
 const { apiCall, apiCallPoll } = require('../utils/api');
 const {
@@ -18,6 +18,7 @@ const {
   generateJunitReport,
 } = require('../utils/testReports');
 const help = require('./help');
+const { sentry } = require('../utils/sentry');
 
 const OBJECT_TYPES = [settings.TYPE_TEST, settings.TYPE_SUITE, settings.TYPE_PROFILE];
 
@@ -34,7 +35,7 @@ const getList = async (type, query, extraParams) => {
       return getExitCode(true);
     }
   } catch (error) {
-    await printErrorResponse(spinner, error);
+    await handleResponseError(spinner, error);
   }
   return getExitCode(false);
 };
@@ -53,6 +54,7 @@ const getResult = async (type, id, extraParams) => {
     if (result) {
       switch (reporter) {
         case settings.REPORTER_TYPE.junit: {
+          console.log('Generating JUnit report...');
           await generateJunitReport(type, result.data, outputPath);
           break;
         }
@@ -68,7 +70,7 @@ const getResult = async (type, id, extraParams) => {
       return getExitCode(result.data.status);
     }
   } catch (error) {
-    await printErrorResponse(spinner, error);
+    await handleResponseError(spinner, error);
   }
 
   return getExitCode(false);
@@ -101,7 +103,7 @@ const checkStatus = async (type, id, extraParams) => {
     }
     exitCode = getExitCode(response.data.status);
   } catch (error) {
-    await printErrorResponse(spinner, error);
+    await handleResponseError(spinner, error);
     await getResult(type, id, extraParams);
     exitCode = getExitCode(false);
   }
@@ -123,7 +125,7 @@ const run = async (type, data, extraParams) => {
       return getExitCode(true);
     }
   } catch (error) {
-    await printErrorResponse(spinner, error);
+    await handleResponseError(spinner, error);
   }
   return getExitCode(false);
 };
@@ -149,7 +151,7 @@ const stop = async (type, { id }, extraParams) => {
     if (error.response?.status === 404) {
       spinner.fail(`No ${type}Run with id ${id} found.`);
     } else {
-      await printErrorResponse(spinner, error);
+      await handleResponseError(spinner, error);
     }
   }
   return getExitCode(false);
@@ -178,6 +180,7 @@ const checkTokenConfig = async () => {
     }
   } catch (err) {
     console.error(err);
+    sentry.captureException(err);
   }
 };
 
@@ -242,6 +245,18 @@ module.exports = async (args) => {
     subCmd, objectType, id, variables, extraParams,
   } = await parseArgs(args);
 
+  sentry.setTags({
+    Command: 'remote',
+    'Sub command': subCmd,
+    'Command object type': objectType,
+    'Triggered by': extraParams.triggeredBy,
+    Reporter: extraParams.reporter,
+  });
+  sentry.addBreadcrumb({
+    message: `Run "${subCmd}" remote command`,
+    category: 'Command',
+  });
+
   let exitCode;
   await checkTokenConfig();
   switch (subCmd) {

package/src/index.js

@@ -1,18 +1,19 @@
 const path = require('path');
 const minimist = require('minimist');
-const api = require('./utils/api');
-const sentry = require('./utils/sentry');
-const commands = require('./commands');
+const { nanoid } = require('nanoid');
+const { sentry, init: initSentry } = require('./utils/sentry');
 const settings = require('./settings');
-const config = require('./utils/config');
-const helper = require('./utils/helper');
-
 require('dotenv').config();
 require('dotenv').config({
   path: path.resolve(process.cwd(), `.env.${settings.NODE_ENV}`),
 });
+// Initialize Sentry first
+initSentry();
 
-sentry.init();
+const api = require('./utils/api');
+const commands = require('./commands');
+const config = require('./utils/config');
+const helper = require('./utils/helper');
 
 module.exports = async () => {
   await config.initConfigDir();
@@ -21,7 +22,13 @@ module.exports = async () => {
   let exitCode;
 
   await helper.overrideSettings(args);
-  api.mountAxiosInterceptors(`${args.debug}` === 'true');
+  const processId = nanoid(8);
+  api.mountAxiosInterceptors({
+    processId,
+    debug: `${args.debug}` === 'true',
+  });
+
+  sentry.setTag('ProcessId', processId);
 
   switch (cmd) {
     case 'config':

package/src/utils/api.js

@@ -4,8 +4,13 @@ const config = require('./config');
 const print = require('./print');
 const { getSpinner } = require('./spinner');
 
-const interceptRequest = (isDebugEnabled) => (request) => {
-  if (isDebugEnabled) {
+const interceptRequest = ({ processId, debug }) => (request) => {
+  request.params = {
+    ...(request.params || {}),
+    reqId: processId,
+  };
+
+  if (debug) {
     print.printObject({
       url: request.url,
       headers: request.headers,
@@ -26,16 +31,16 @@ const printResponseData = (response) => {
   });
 };
 
-const interceptResponseSuccess = (isDebugEnabled = false) => (response) => {
-  if (isDebugEnabled) {
+const interceptResponseSuccess = ({ debug }) => (response) => {
+  if (debug) {
     printResponseData(response);
   }
   return response;
 };
 
-const interceptResponseError = (spinner, isDebugEnabled = false) => (error) => {
+const interceptResponseError = (spinner, { debug }) => (error) => {
   const { response } = error;
-  if (response && isDebugEnabled) {
+  if (response && debug) {
     printResponseData(response);
   }
   if (response && response.status === 400) {
@@ -66,13 +71,13 @@ const interceptResponseError = (spinner, isDebugEnabled = false) => (error) => {
   return Promise.reject(error);
 };
 
-const mountAxiosInterceptors = (printRawResponse) => {
+const mountAxiosInterceptors = ({ processId, debug }) => {
   const spinner = getSpinner(false);
   axios.defaults.headers.common['Content-Type'] = 'application/json';
-  axios.interceptors.request.use(interceptRequest(printRawResponse));
+  axios.interceptors.request.use(interceptRequest({ processId, debug }));
   axios.interceptors.response.use(
-    interceptResponseSuccess(printRawResponse),
-    interceptResponseError(spinner, printRawResponse),
+    interceptResponseSuccess({ debug }),
+    interceptResponseError(spinner, { debug }),
   );
 };
 

package/src/utils/helper.js

@@ -1,7 +1,14 @@
+const { nanoid } = require('nanoid');
 const settings = require('../settings');
+const { sentry } = require('./sentry');
 
 const getExitCode = async (status) => {
   const exitCode = settings.EXIT_CODES[status];
+
+  // We need to flush the sentry buffer
+  // to ensure the error is sent to Sentry before the process exits
+  await sentry.flush(2000);
+
   return exitCode === undefined ? 1 : exitCode;
 };
 
@@ -25,14 +32,17 @@ const getUnknownOptions = async (args, knownKeys) => {
   return unknownKeys;
 };
 
-const printErrorResponse = async (spinner, error) => {
-  if (
-    error.response?.status === 400
-        && error.response?.data[0]?.message) {
-    spinner.fail(error.response.data[0].message);
-  } else {
-    spinner.fail(error.toString());
+const handleResponseError = async (spinner, error) => {
+  const returnedMessage = error.response?.data[0]?.message;
+  const errorId = error.request?.params?.reqId ?? nanoid(8);
+
+  if (returnedMessage) {
+    spinner.fail(returnedMessage);
+    return;
   }
+
+  sentry.captureException(error);
+  spinner.fail(`Unexpected error occurred (id: ${errorId})`);
 };
 
 const overrideSettings = async (args) => {
@@ -76,5 +86,5 @@ module.exports = {
   overrideSettings,
   parseTimeFromDuration,
   parseVariables,
-  printErrorResponse,
+  handleResponseError,
 };

package/src/utils/sentry.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies, node/no-unpublished-require
 const Sentry = require('@sentry/node');
 const pkgJson = require('../../package.json');
 
@@ -7,9 +8,11 @@ const init = () => {
     environment: process.env.ENV,
     release: `${pkgJson.version}-${process.env.ENV}`,
     normalizeDepth: 8,
+    sendDefaultPii: true,
   });
 };
 
 module.exports = {
   init,
+  sentry: Sentry,
 };

package/src/utils/testReports.js

@@ -6,18 +6,20 @@ const settings = require('../settings');
 const { getSecondsFromDuration } = require('./helper');
 
 const getTestInJunitFormat = (testRun) => {
-  const errorDetails = testRun.errorCode ? {
-    message: `Error ${testRun.errorCode} occurred in step: ${testRun.details[0].step.type} (${testRun.details[0].step.id})`,
-    stack: testRun.errorCode,
-  } : undefined;
+  const errorCode = testRun.errorCode ?? 'MISSING_ERROR_CODE';
+  const errorDetails = {
+    message: `Error ${errorCode} occurred in step: ${testRun.details[0].step.type} (${testRun.details[0].step.id})`,
+    stack: errorCode,
+  };
+  const errorsList = errorDetails ? [errorDetails] : [];
 
   return {
     id: testRun.id,
     name: testRun.name,
     time: getSecondsFromDuration(testRun.duration),
     classname: null,
-    errors: testRun.status === settings.STATUS_ERROR ? [errorDetails] : [],
-    failures: testRun.status === settings.STATUS_FAILED ? [errorDetails] : [],
+    errors: testRun.status === settings.STATUS_ERROR ? errorsList : [],
+    failures: testRun.status === settings.STATUS_FAILED ? errorsList : [],
   };
 };