Merge pull request #221 from vbihun/audit-logs-and-add-debugLog

Audit logs and add debugLog

Author: vbihun

.eslintrc.js

@@ -53,7 +53,7 @@ module.exports = {
     'react/jsx-filename-extension': 'off',
     'react/require-default-props': 'off',
     'import/prefer-default-export': 'off',
-    'no-console': 'off',
+    'no-console': ['error', { allow: ['warn', 'error'] }],
     'prettier/prettier': [
       'error',
       {

README.md

@@ -75,6 +75,9 @@ app:
 
 Documentation for the Compass GitLab integration can be found [here](https://developer.atlassian.com/cloud/compass/integrations/integrate-Compass-with-Gitlab/). For more information about building integrations on Compass, see [here](https://developer.atlassian.com/cloud/compass/integrations/get-started-integrating-with-Compass/).
 
+### Debugging
+
+To use console.log locally, you should use the debugLog method from the ./src/utils/debugLog.ts and set the forge variable APP_ENV to development
 
 ## Tests
 

src/client/agg.ts

@@ -5,6 +5,7 @@ import { AggOperation } from '../types';
 export const aggQuery = async (request: AggOperation) => {
   const response = await api.asApp().requestGraph(request.query, request.variables);
   const responseBody = await response.json();
+  // eslint-disable-next-line no-console
   console.log({
     message: 'AGG request',
     requestName: request.name,

src/client/compass.ts

@@ -113,7 +113,7 @@ export async function deleteExternalAlias(input: DeleteCompassComponentExternalA
   const { errors } = await graphqlGateway.compass.asApp().deleteExternalAlias(input);
 
   if (errors.length === 1 && errors[0].message === UNKNOWN_EXTERNAL_ALIAS_ERROR_MESSAGE) {
-    console.log('Could not find external alias to delete.');
+    console.warn('Could not find external alias to delete.');
     return;
   }
 

src/client/gitlab.ts

@@ -79,6 +79,7 @@ export const callGitlab = async (
   const startTime = performance.now();
 
   try {
+    // eslint-disable-next-line no-console
     console.log(`Calling gitlab to ${apiOperation}`);
     const resp = await fetch(`${BASE_URL}${path}`, {
       method: config?.method || HttpMethod.GET,
@@ -90,6 +91,7 @@ export const callGitlab = async (
       body,
     });
 
+    // eslint-disable-next-line no-console
     console.log(`Gitlab response status: ${resp.status}`);
 
     if (resp.status === 204) {
@@ -111,6 +113,7 @@ export const callGitlab = async (
   } finally {
     const endTime = performance.now();
     const duration = endTime - startTime;
+    // eslint-disable-next-line no-console
     console.log(`GitLab API call to ${apiOperation} took ${duration.toFixed(2)} ms`);
   }
 };
@@ -133,6 +136,7 @@ export const getGroupsData = async (
 
   const { data } = await callGitlab(`getGroupsData`, `/api/v4/groups?${queryParams}`, groupAccessToken);
 
+  // eslint-disable-next-line no-console
   console.log('Number of groups fetched:', data.length);
 
   return data;
@@ -208,6 +212,7 @@ export const getGroupAccessTokens = async (
     groupToken,
   );
 
+  // eslint-disable-next-line no-console
   console.log('Number of active access tokens fetched:', groupAccessTokenList.length);
 
   return groupAccessTokenList;
@@ -475,6 +480,7 @@ export const getEnvironments = async (
     groupToken,
   );
 
+  // eslint-disable-next-line no-console
   console.log('Number of environments fetched:', data.length);
 
   return data;

src/entry/data-provider/index.ts

@@ -68,7 +68,7 @@ export const dataProvider = async (
     backfillData.metrics.mrCycleTime = mrCycleTime;
     backfillData.metrics.openMergeRequestsCount = openMergeRequestsCount;
   } catch (err) {
-    console.log(`data provider error: ${err.message}`);
+    console.error(`data provider error: ${err.message}`);
     const invocationErrorOptions = { backoffTimeInSeconds: 3600 };
 
     if (err instanceof GitlabHttpMethodError) {

src/entry/extension-points/pre-uninstall.ts

@@ -12,6 +12,7 @@ type PreUninstallPayload = {
 export default async function preUninstall(payload: PreUninstallPayload): Promise<void> {
   const { cloudId } = payload.context;
 
+  // eslint-disable-next-line no-console
   console.log(`Performing preUninstall for site ${cloudId}`);
 
   const forgeAppId = getForgeAppId();

src/entry/find-matching-files/index.ts

@@ -87,17 +87,20 @@ export const findMatchingFiles = async (payload: FindMatchingFilesPayload): Prom
       payload.fileName.equalsOneOf,
     );
     if (matchingTopLevelFiles.length > 0) {
+      // eslint-disable-next-line no-console
       console.log(`Found ${matchingTopLevelFiles.length} matching files in depth level 0`);
       foundMatchingFiles = [...foundMatchingFiles, ...matchingTopLevelFiles];
     }
 
     nextLevelDirectoriesToCheck = getDirectories(allTopLevelFiles);
     for (let i = 0; i < LEVELS_TO_SEARCH - 1; i += 1) {
       let tempNextLevelDirectoriesToCheck: ProjectFile[] = [];
+      // eslint-disable-next-line no-console
       console.log(`Searching ${nextLevelDirectoriesToCheck.length} directories in depth level ${i + 1}`);
 
       for (const directory of nextLevelDirectoriesToCheck) {
         const allProjectFiles = await callListFiles(groupToken, project.id, directory.path);
+        // eslint-disable-next-line no-console
         console.log(`Found ${allProjectFiles.length} project files in depth level ${i + 1}`);
 
         const matchingFiles = getMatchingFiles(
@@ -106,6 +109,7 @@ export const findMatchingFiles = async (payload: FindMatchingFilesPayload): Prom
           payload.fileName.equalsOneOf,
         );
         if (matchingFiles.length > 0) {
+          // eslint-disable-next-line no-console
           console.log(`Found ${matchingFiles.length} matching files in depth level ${i + 1}`);
           foundMatchingFiles = [...foundMatchingFiles, ...matchingFiles];
         }
@@ -126,7 +130,7 @@ export const findMatchingFiles = async (payload: FindMatchingFilesPayload): Prom
       statusCode: 200,
     };
   } catch (e) {
-    console.log('Failed to find matching files', e.message);
+    console.error('Failed to find matching files', e.message);
     return {
       success: false,
       errorMessage: e.message,

src/entry/import-recent-repos/index.ts

@@ -147,6 +147,7 @@ export const importRecentRepos = async ({
     const checkedDataWithExistingComponents = await checkForExistingImports(cloudId, groupToken, recentProjects.data);
     const projectsToImport = filterExistingProjects(recentProjects.data, checkedDataWithExistingComponents);
 
+    // eslint-disable-next-line no-console
     console.log(`Importing ${projectsToImport.length} recent repos that have not been imported yet`);
 
     const importResults = await importReposToCompass(cloudId, projectsToImport, groupToken);

src/entry/scheduled-triggers/data-provider-backfill.ts

@@ -14,12 +14,13 @@ export default async function dataProviderBackfill(req: WebtriggerRequest): Prom
   const queue = new Queue({ key: 'data-provider-backfill' });
 
   if (!isCompassPushEventEnabled()) {
-    console.log('Compass push event is not enabled');
+    console.warn('Compass push event is not enabled');
     return;
   }
 
   const backfillVersion = await getBackfillVersion();
   if (backfillVersion >= CURRENT_BACKFILL_VERSION) {
+    // eslint-disable-next-line no-console
     console.log(`Skipping backfill as it already has the latest version (v${backfillVersion})`);
     return;
   }