Weekly (#107)

* added weekly summary feature

* added readme updates

* added notes for install and report generation

Author: petermsouzajr

README.md

@@ -3,7 +3,10 @@ import chalk from 'chalk';
 import { isProjectConfigured } from './scripts/configuredStatus.js';
 import { main } from './src/index.js';
 import { handleDailyReport } from './src/sharedMethods/dailyReportHandler.js';
-import { handleSummary } from './src/sharedMethods/summaryHandler.js';
+import {
+  handleSummary,
+  handleWeeklySummary,
+} from './src/sharedMethods/summaryHandler.js';
 import { spawn } from 'child_process';
 import { GOOGLE_KEYFILE_PATH, GOOGLE_SHEET_ID } from './constants.js';
 import path from 'path';
@@ -34,7 +37,7 @@ const resolvePostInstallScript = () => {
 async function run() {
   const args = process.argv.slice(2);
   const commands = args.filter((arg) =>
-    ['todays-report', 'monthly-summary'].includes(arg)
+    ['todays-report', 'monthly-summary', 'weekly-summary'].includes(arg)
   );
 
   const command = commands[0] || ''; // Select the first command if multiple, though typically there should only be one
@@ -47,9 +50,13 @@ async function run() {
   const framework = frameworkArg || ''; // Ensure the framework is correctly specified
   const isCypress = framework === 'cypress' || framework === 'cy';
   const isPlaywright = framework === 'playwright' || framework === 'pw';
-  const unsupportedCsvForMonthly = isCSV && command.includes('monthly-summary');
-  const unsupportedDuplicateCsvForMonthly =
-    isCSV && isDuplicate && command.includes('monthly-summary');
+  const unsupportedCsvForSummary =
+    isCSV &&
+    (command.includes('monthly-summary') || command.includes('weekly-summary'));
+  const unsupportedDuplicateCsvForSummary =
+    isCSV &&
+    isDuplicate &&
+    (command.includes('monthly-summary') || command.includes('weekly-summary'));
   const optionsPayload = {
     csv: isCSV,
     duplicate: isDuplicate,
@@ -68,6 +75,7 @@ async function run() {
     Commands (Optional):
       todays-report               Only generate today's report.
       monthly-summary             Only generate previous months summary.
+      weekly-summary              Only generate previous weeks summary.
 
     Options (Optional):
       --csv                       Output the report in CSV format.
@@ -80,7 +88,7 @@ async function run() {
       Generate today's report for Playwright in CSV format:
         qa-shadow-report playwright todays-report --csv
 
-      Generate a daily report and monthly summary when necessary, in google sheets, for cypress:
+      Generate a daily report, and/or summaries as configured, in google sheets, for cypress:
         qa-shadow-report cypress
 
     Shortcuts:
@@ -136,10 +144,10 @@ async function run() {
       chalk.green('playwright')
     );
     process.exit(1);
-  } else if (unsupportedCsvForMonthly || unsupportedDuplicateCsvForMonthly) {
+  } else if (unsupportedCsvForSummary || unsupportedDuplicateCsvForSummary) {
     console.info(
       chalk.yellow(
-        'Error: CSV output for "monthly-summary" with or without duplication is not supported.'
+        'Error: CSV output for summaries with or without duplication is not supported.'
       )
     );
     process.exit(1);
@@ -152,6 +160,9 @@ async function run() {
         case 'monthly-summary':
           await handleSummary({ ...optionsPayload });
           break;
+        case 'weekly-summary':
+          await handleWeeklySummary({ ...optionsPayload });
+          break;
         default:
           await main({ ...optionsPayload });
           break;

cli.js

@@ -365,6 +365,24 @@ export const TEST_CATEGORIES_AVAILABLE = () => {
   });
 };
 
+export const WEEK_START = () => {
+  return getCachedOrCompute('startDay', () => {
+    return shadowConfigDetails.weeklySummaryStartDay;
+  });
+};
+
+export const WEEKLY_SUMMARY_ENABLED = () => {
+  return getCachedOrCompute('active', () => {
+    const weeklySummaryActive =
+      shadowConfigDetails && shadowConfigDetails.weeklySummaryStartDay;
+    if (weeklySummaryActive) {
+      return true;
+    } else {
+      return false;
+    }
+  });
+};
+
 export const DEFAULT_HEADER_METRICS = [
   '# passed tests',
   '# failed tests',
@@ -404,3 +422,38 @@ export const ALL_TEAM_NAMES = () => {
     }
   });
 };
+
+export const DAYS = {
+  Sunday: 0,
+  Monday: 1,
+  Tuesday: 2,
+  Wednesday: 3,
+  Thursday: 4,
+  Friday: 5,
+  Saturday: 6,
+};
+
+export const SHORT_DAYS = {
+  Monday: 'Mon',
+  Tuesday: 'Tue',
+  Wednesday: 'Wed',
+  Thursday: 'Thu',
+  Friday: 'Fri',
+  Saturday: 'Sat',
+  Sunday: 'Sun',
+};
+
+export const MONTHS = [
+  'Jan',
+  'Feb',
+  'Mar',
+  'Apr',
+  'May',
+  'Jun',
+  'Jul',
+  'Aug',
+  'Sep',
+  'Oct',
+  'Nov',
+  'Dec',
+];

constants.js

@@ -1,6 +1,6 @@
 {
   "name": "qa-shadow-report",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "bin": {
     "qa-shadow-report": "./cli.js",
     "qasr": "./cli.js",

images/dailyReport.png

@@ -146,13 +146,17 @@ const createConfigFile = () => {
       // googleSpreadsheetUrl: 'your-google-spreadsheet-url' OR googleSpreadsheetUrl: process.env.GOOGLE_SHEET_URL,
 
       // Path to Google credentials file (service account JSON file): Replace with the file path or use an environment variable.
-      // googleKeyFilePath: 'googleCredentials.json' OR googleKeyFilePath: process.env.GOOGLE_KEY_FILE_PATH,
+      // googleKeyFilePath: './googleCredentials.json' OR googleKeyFilePath: process.env.GOOGLE_KEY_FILE_PATH,
 
       // Path to test data results file in the format generated by your test runner. Replace with the path or use an environment variable.
       // testData: './path-to-test-results/output.json' OR testData: process.env.TEST_DATA,
 
       // Directory for saving CSV downloads (optional). Uncomment and replace with your preferred path or use an environment variable.
-      // csvDownloadsPath: 'downloads' OR csvDownloadsPath: process.env.CSV_DOWNLOADS_PATH,
+      // csvDownloadsPath: './downloads' OR csvDownloadsPath: process.env.CSV_DOWNLOADS_PATH,
+
+     // Weekly summary settings (optional). To activate, set weekly summary sart date, summary will includes the start date and the following 7 days.
+     // weeklySummaryStartDay: 'Monday' OR process.env.WEEKLY_SUMMARY_START_DAY
+    },
     };
     `;
     fs.writeFileSync(configFilePath, defaultConfigContent, {

images/weeklySummary.png

@@ -1,13 +1,6 @@
-// Utility functions imports
 import { formatDuration } from '../sharedMethods/dateFormatting.js';
-
-// Data extraction and reporting imports
 import * as dataExtraction from './extraction/dataExtractionUtilities.js';
-
-// Shared methods imports
 import { enforceMaxLength } from './utilities/cellMaxLength.js';
-
-// Configuration and constants imports
 import * as constants from '../../constants.js';
 
 /**

package.json

@@ -27,7 +27,7 @@ export const extractAreaFromFullFile = async (fullFile, testTypesAvailable) => {
     .filter((segment) => !testTypesAvailable.includes(segment))
     .join('/');
 
-  return area; // The function only returns the area
+  return area;
 };
 
 /**

scripts/postInstall.js

@@ -30,37 +30,24 @@ export const buildDailyPayload = async (dataSet, playwright) => {
       throw new Error('Invalid columnsAvailable: Expected an array.');
     }
 
-    // Initialize the structure for daily payload
     let fullDailyPayload = initializeDailyPayload();
-
-    // Process test suites to construct payload entries
     const payloadEntries = await processTestSuites(dataSet, playwright);
     fullDailyPayload.bodyPayload = payloadEntries;
 
-    // Sort the structured data
     sortPayload(fullDailyPayload);
-
-    // Map object values to body payload
     fullDailyPayload.bodyPayload = fullDailyPayload.bodyPayload.map(
       Object.values
     );
-
-    // Construct and assign report headers
     fullDailyPayload.headerPayload = await constructHeaderReport(
       fullDailyPayload.bodyPayload
     );
-
-    // Append state reports to the header payload
     appendStateReportsToHeader(
       fullDailyPayload.headerPayload,
       DEFAULT_HEADER_METRICS,
       playwright
     );
-
-    // Append available columns and save to configuration
     fullDailyPayload.headerPayload.push(columnsAvailable);
 
-    // Append the end row to the footer payload
     const headerRowIndex = findHeaderRowIndex(fullDailyPayload.headerPayload);
     const headerRow = fullDailyPayload.headerPayload[headerRowIndex - 1];
     const statusTargetIndex = headerRow.indexOf('state');
@@ -71,6 +58,6 @@ export const buildDailyPayload = async (dataSet, playwright) => {
     return fullDailyPayload;
   } catch (error) {
     console.error('Error building daily payload:', error);
-    throw error; // Rethrow to allow further error handling from the caller
+    throw error;
   }
 };

src/dailyReportMethods/buildReport.js

@@ -25,7 +25,6 @@ export const combineReports = (allReportEntries, placeholders) => {
   let combinedReports = [];
 
   try {
-    // Determine the maximum count of type entries across all reports
     const maxTypeCount = Math.max(
       ...allReportEntries.map((report) => {
         if (!Array.isArray(report)) {
@@ -35,7 +34,6 @@ export const combineReports = (allReportEntries, placeholders) => {
       })
     );
 
-    // Iterate over each type count index
     for (let i = 0; i < maxTypeCount; i++) {
       let combinedRowTests = [];
       let combinedRowPassed = [];
@@ -46,7 +44,6 @@ export const combineReports = (allReportEntries, placeholders) => {
         combinedRowPassed.push(...(report[2 * i + 1] || placeholders[1]));
       });
 
-      // Add the combined rows to the main array
       combinedReports.push(combinedRowTests, combinedRowPassed);
     }
 

src/dailyReportMethods/extraction/dataExtractionUtilities.js

@@ -32,10 +32,8 @@ export const constructHeaderReport = async (payload) => {
       { types: teamNames, index: 5 },
     ];
 
-    // Initialize an array to store all report entries
     const allReportEntries = [];
 
-    // Loop through each type structure to generate report entries
     for (const typeData of typeArrays) {
       if (!Array.isArray(typeData.types)) {
         throw new Error(
@@ -51,13 +49,9 @@ export const constructHeaderReport = async (payload) => {
       allReportEntries.push(reportEntry);
     }
 
-    // Calculate the maximum number of types across all categories
     const maxTypes = Math.max(...typeArrays.map((t) => t.types.length));
-
-    // Generate placeholders for the report
     const placeholders = generatePlaceholders(maxTypes);
 
-    // Combine all report entries and placeholders into one report
     return combineReports(allReportEntries, placeholders);
   } catch (error) {
     console.error('Error constructing header report:', error);

src/dailyReportMethods/reportGeneration/buildDailyPayload.js

@@ -275,7 +275,6 @@ export const buildFormulas = (
   const templates = constants.FORMULA_TEMPLATES;
   const keys = constants.FORMULA_KEYS;
 
-  // Generate actual formula strings by filling in the templates
   const filledFormulas = templates.map(fillTemplate);
 
   const combinedObject = keys.reduce((obj, key, index) => {
@@ -405,7 +404,6 @@ export const createMergeQueries = (data, headerRowIndex, sheetId) => {
     throw new Error('Sheet ID must be a non-negative integer.');
   }
 
-  // Helper function to create a single merge query object
   const createMergeQuery = (start, end, startColumn, endColumn) => ({
     sheetId,
     startRowIndex: start,
@@ -414,7 +412,6 @@ export const createMergeQueries = (data, headerRowIndex, sheetId) => {
     endColumnIndex: endColumn,
   });
 
-  // Processes merges for a single column
   const processColumn = (columnIndex) => {
     const merges = [];
     let startMergeIndex = headerRowIndex;
@@ -439,10 +436,7 @@ export const createMergeQueries = (data, headerRowIndex, sheetId) => {
     return merges;
   };
 
-  // Combine merge queries for both columns
   const merges = [...processColumn(0), ...processColumn(1)];
-
-  // Construct the requestBody for the batch update
   const requestBody = {
     requests: merges.map((merge) => ({
       mergeCells: {

src/dailyReportMethods/reportGeneration/combineReports.js

@@ -15,10 +15,8 @@ export const enforceMaxLength = (str, maxLength) => {
   }
 
   try {
-    // Convert the input to a string if it's a number
     const result =
       typeof str === 'number' || typeof str === 'string' ? String(str) : '';
-    // Return the truncated string
     return result.substring(0, maxLength);
   } catch (error) {
     console.error('Error in enforceMaxLength:', error);

src/dailyReportMethods/reportGeneration/constructHeaderReport.js

@@ -1,6 +1,7 @@
 import { dataObjects } from '../../index.js';
 import { sheets, auth, spreadsheetId } from '../auth.js';
 import { createSummaryTitle } from '../sheetDataMethods/createTabNames.js';
+import { createWeeklySummaryTitle } from '../../sharedMethods/summaryHandler.js';
 
 export const createNewTab = async (
   sheetName,
@@ -36,3 +37,38 @@ export const createNewTab = async (
     throw error;
   }
 };
+
+export const createNewWeeklyTab = async (
+  sheetName,
+  // mockBatchUpdate, // Mock function for testing
+  createSummaryTitleFn = createWeeklySummaryTitle, // Default to actual function
+  dataObjectsRef = dataObjects, // Default to actual dataObjects
+  sheetsInstance // Injected dependency for testing
+) => {
+  // Use the injected sheetsInstance or fall back to the actual sheets object
+  const sheetsAPI = sheetsInstance || sheets;
+  const authToUse = (sheetsInstance && sheetsInstance.auth) || auth;
+  const spreadsheetIdToUse =
+    (sheetsInstance && sheetsInstance.spreadsheetId) || spreadsheetId;
+
+  try {
+    const response = await sheetsAPI.spreadsheets.batchUpdate({
+      auth: authToUse,
+      spreadsheetId: spreadsheetIdToUse,
+      requestBody: {
+        requests: [{ addSheet: { properties: { title: sheetName } } }],
+      },
+    });
+
+    const summaryTitle = createSummaryTitleFn();
+    if (sheetName.includes(summaryTitle)) {
+      dataObjectsRef.weeklySummaryTabData = response;
+    } else {
+      dataObjectsRef.todaysReportData = response;
+    }
+    return response;
+  } catch (error) {
+    console.error('"createNewTab": Error creating new sheet:', error);
+    throw error;
+  }
+};

src/dailyReportMethods/reportGeneration/reportGenerationHelpers.js

@@ -23,7 +23,7 @@ export const writeToSheet = async (sheetTitle, values, sheetsInstance) => {
     });
   } catch (error) {
     console.error(`Error writing to sheet "${sheetTitle}":`, error);
-    throw error; // Ensure errors are thrown for test catching
+    throw error;
   }
 };
 
@@ -49,6 +49,6 @@ export const batchUpdateMasterSheet = async (payload, sheetsInstance) => {
     });
   } catch (error) {
     console.error('Error applying batch update:', error);
-    throw error; // Ensure errors are thrown for test catching
+    throw error;
   }
 };