feat: lighthouse ci pipeline

.github/workflows/lighthouse.yml

@@ -0,0 +1,30 @@
+name: CI
+on: 
+  pull_request: 
+    branches: 
+      - "**"
+jobs:
+  lhci:
+    name: Lighthouse
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - name: Install dependencies
+        run: |
+          npm install
+          npm run build
+      - name: run Lighthouse CI for the Application
+        run: |
+          npm install -g @lhci/[email protected]
+          lhci autorun --config=lighthouserc.json --collect.url="http://localhost:3000" --collect.startServerCommand="npm run start" --upload.outputDir="./lhci-reports/app"
+      - name: run Lighthouse CI for Keploy.io Deployed Website
+        run: |
+          npm install -g @lhci/[email protected]
+          lhci autorun --config=lighthouserc.json --collect.url="https://www.keploy.io" --upload.outputDir="./lhci-reports/keploy.io"
+      - name: Compare Lighthouse Reports
+        run: |
+          node compare-lhci-reports.js

.gitignore

@@ -120,3 +120,5 @@ next-env.d.ts
 
 
 .early.coverage
+
+.lighthouseci

compare-lhci-reports.js

@@ -0,0 +1,54 @@
+const fs = require('fs');
+const path = require('path');
+
+function findReportFile(directory) {
+  if (!fs.existsSync(directory)) {
+    console.error(`Directory not found: ${directory}`);
+    process.exit(1);
+  }
+  const files = fs.readdirSync(directory);
+  const reportFile = files.find(file => file.endsWith('.report.json'));
+  if (!reportFile) {
+    console.error(`No report file found in directory: ${directory}`);
+    process.exit(1);
+  }
+  return path.join(directory, reportFile);
+}
+
+function loadReport(path) {
+  if (!fs.existsSync(path)) {
+    console.error(`Report not found at path: ${path}`);
+    process.exit(1);
+  }
+  const data = fs.readFileSync(path, 'utf8');
+  return JSON.parse(data);
+}
+
+const appReportDirectory = './lhci-reports/app';
+const keployReportDirectory = './lhci-reports/keploy.io';
+
+const appReportPath = findReportFile(appReportDirectory);
+const keployReportPath = findReportFile(keployReportDirectory);
+
+const appReport = loadReport(appReportPath);
+const keployReport = loadReport(keployReportPath);
+
+const categories = ['performance', 'accessibility', 'seo'];
+
+let allPass = true;
+
+categories.forEach(category => {
+  const appScore = appReport.categories[category].score;
+  const keployScore = keployReport.categories[category].score;
+  if (appScore < keployScore) {
+    console.error(`Score for ${category} is lower in the application (${appScore}) than Keploy.io (${keployScore})`);
+    allPass = false;
+  }
+});
+
+if (!allPass) {
+  console.error('Lighthouse scores are lower than the baseline. Failing the CI job.');
+  process.exit(1);
+} else {
+  console.log('All Lighthouse scores are equal or better than the baseline.');
+}

lighthouserc.json

@@ -0,0 +1,19 @@
+{
+  "ci": {
+    "upload": {
+      "target": "filesystem"
+    },
+    "collect": {
+      "numberOfRuns": 10
+    },
+    "assert": {
+      "assertions": {
+        "categories:performance": ["error", {"minScore": 0.1}],
+        "categories:accessibility": ["error", {"minScore": 0.1}],
+        "categories:best-practices": ["error", {"minScore": 0.1}],
+        "categories:seo": ["error", {"minScore": 0.8}],
+        "csp-xss": "warn"
+      }
+    }
+  }
+}