[HelpDot] detect infinite redirect cycles in redirects.csv

.github/scripts/detectRedirectCycle.ts

@@ -0,0 +1,64 @@
+import {parse} from 'csv-parse';
+import fs from 'fs';
+
+const parser = parse();
+const adjacencyList: Record<string, string[]> = {};
+
+function addEdge(source: string, target: string) {
+    if (!adjacencyList[source]) {
+        adjacencyList[source] = [];
+    }
+    adjacencyList[source].push(target);
+}
+
+function isCyclic(currentNode: string, visited: Map<string, boolean>, backEdges: Map<string, boolean>): boolean {
+    visited.set(currentNode, true);
+    backEdges.set(currentNode, true);
+
+    // Do a depth first search for all the neighbours. If a node is found in backedge, a cycle is detected.
+    const neighbours = adjacencyList[currentNode];
+    if (neighbours) {
+        for (const node of neighbours) {
+            if (!visited.has(node)) {
+                if (isCyclic(node, visited, backEdges)) {
+                    return true;
+                }
+            } else if (backEdges.has(node)) {
+                return true;
+            }
+        }
+    }
+
+    backEdges.delete(currentNode);
+
+    return false;
+}
+
+function detectCycle(): boolean {
+    const visited: Map<string, boolean> = new Map<string, boolean>();
+    const backEdges: Map<string, boolean> = new Map<string, boolean>();
+
+    for (const [node] of Object.entries(adjacencyList)) {
+        if (!visited.has(node)) {
+            if (isCyclic(node, visited, backEdges)) {
+                const cycle = Array.from(backEdges.keys());
+                console.log(`Infinite redirect found in the cycle: ${cycle.join(' -> ')} -> ${node}`);
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+fs.createReadStream(`${process.cwd()}/docs/redirects.csv`)
+    .pipe(parser)
+    .on('data', (row) => {
+        // Create a directed graph of sourceURL -> targetURL
+        addEdge(row[0], row[1]);
+    })
+    .on('end', () => {
+        if (detectCycle()) {
+            process.exit(1);
+        }
+        process.exit(0);
+    });

.github/scripts/verifyRedirect.sh

@@ -5,11 +5,22 @@
 
 declare -r REDIRECTS_FILE="docs/redirects.csv"
 
+declare -r RED='\033[0;31m'
+declare -r GREEN='\033[0;32m'
+declare -r NC='\033[0m'
+
 duplicates=$(awk -F, 'a[$1]++{print $1}' $REDIRECTS_FILE)
+if [[ -n "$duplicates" ]]; then
+    echo "${RED}duplicate redirects are not allowed: $duplicates ${NC}"
+    exit 1
+fi
 
-if [[ -z "$duplicates" ]]; then
-    exit 0
+npm run detectRedirectCycle
+DETECT_CYCLE_EXIT_CODE=$?
+if [[ DETECT_CYCLE_EXIT_CODE -eq 1 ]]; then
+    echo -e "${RED}The redirects.csv has a cycle. Please remove the redirect cycle because it will cause an infinite redirect loop ${NC}"
+    exit 1
 fi
 
-echo "duplicate redirects are not allowed: $duplicates"
-exit 1
+echo -e "${GREEN}The redirects.csv is valid!${NC}"
+exit 0

.github/workflows/deployExpensifyHelp.yml

@@ -36,8 +36,8 @@ jobs:
 
       - name: Create docs routes file
         run: ./.github/scripts/createDocsRoutes.sh
-      
-      - name: Check duplicates in redirect.csv
+
+      - name: Check for duplicates and cycles in redirects.csv
         run: ./.github/scripts/verifyRedirect.sh
 
       - name: Build with Jekyll

docs/redirects.csv

@@ -123,7 +123,6 @@ https://help.expensify.com/articles/expensify-classic/billing-and-subscriptions/
 https://help.expensify.com/articles/expensify-classic/billing-and-subscriptions/Tax-Exempt,https://help.expensify.com/articles/expensify-classic/expensify-billing/Tax-Exempt
 https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Approving-Reports,https://help.expensify.com/expensify-classic/hubs/reports/
 https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Invite-Members,https://help.expensify.com/articles/expensify-classic/workspaces/Invite-members-and-assign-roles
-https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Removing-Members,https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Removing-Members
 https://help.expensify.com/articles/expensify-classic/expense-and-report-features/Attendee-Tracking,https://help.expensify.com/articles/expensify-classic/expenses/Track-group-expenses
 https://help.expensify.com/articles/expensify-classic/expense-and-report-features/Currency,https://help.expensify.com/articles/expensify-classic/workspaces/Currency
 https://help.expensify.com/articles/expensify-classic/expense-and-report-features/Expense-Rules,https://help.expensify.com/articles/expensify-classic/expenses/Expense-Rules
@@ -158,3 +157,5 @@ https://help.expensify.com/articles/expensify-classic/workspaces/Budgets,https:/
 https://help.expensify.com/articles/expensify-classic/workspaces/Categories,https://help.expensify.com/articles/expensify-classic/workspaces/Create-categories
 https://help.expensify.com/articles/expensify-classic/workspaces/Tags,https://help.expensify.com/articles/expensify-classic/workspaces/Create-tags
 https://help.expensify.com/expensify-classic/hubs/manage-employees-and-report-approvals,https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Approval-Workflows
+https://help.expensify.com/articles/expensify-classic/reports/Report-Audit-Log-and-Comments,https://help.expensify.com/articles/expensify-classic/reports/Print-or-download-a-report
+https://help.expensify.com/articles/expensify-classic/reports/The-Reports-Page,https://help.expensify.com/articles/expensify-classic/reports/Report-statuses

package.json

@@ -28,6 +28,7 @@
     "desktop-build": "scripts/build-desktop.sh production",
     "desktop-build-staging": "scripts/build-desktop.sh staging",
     "createDocsRoutes": "ts-node .github/scripts/createDocsRoutes.ts",
+    "detectRedirectCycle": "ts-node .github/scripts/detectRedirectCycle.ts",
     "desktop-build-adhoc": "scripts/build-desktop.sh adhoc",
     "ios-build": "fastlane ios build",
     "android-build": "fastlane android build",
@@ -252,6 +253,7 @@
     "concurrently": "^8.2.2",
     "copy-webpack-plugin": "^10.1.0",
     "css-loader": "^6.7.2",
+    "csv-parse": "^5.5.5",
     "diff-so-fancy": "^1.3.0",
     "dotenv": "^16.0.3",
     "electron": "^29.2.0",