Performance scripts fix (#9738)

ruchidh · opensearch-changeset-bot[bot] · ananzh · web-flow · commit 60612df46264 · 2025-05-02T14:30:32.000-07:00
* scripts Signed-off-by: Ruchi Sharma <ruchi492@gmail.com> * update limits for bundle Signed-off-by: Ruchi Sharma <ruchi492@gmail.com> * update limits for lighthosue baseline Signed-off-by: Ruchi Sharma <ruchi492@gmail.com> * Changeset file for PR #9738 created/updated * Update lighthouse_baseline.json Signed-off-by: Ruchi Sharma <ruchi492@gmail.com> --------- Signed-off-by: Ruchi Sharma <ruchi492@gmail.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Anan Zhuang <ananzh@amazon.com>
diff --git a/.github/workflows/lighthouse_testing.yml b/.github/workflows/lighthouse_testing.yml
@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+
 permissions:
   contents: read
   pull-requests: write
@@ -19,10 +20,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           registry-url: 'https://registry.npmjs.org'
@@ -60,9 +61,6 @@ jobs:
       - name: Install Lighthouse CI
         run: yarn add --dev @lhci/cli
 
-      - name: Run bootstrap
-        run: yarn osd bootstrap
-
       - name: Build plugins
         run: node scripts/build_opensearch_dashboards_platform_plugins --no-examples --workers 12
 
@@ -72,25 +70,21 @@ jobs:
             echo "Waiting for OpenSearch..."
             sleep 10
           done
-          echo "OpenSearch is up!"
 
       - name: Start OpenSearch Dashboards
         run: |
-          yarn start --no-base-path &
+          yarn start --no-base-path --opensearch.ignoreVersionMismatch=true &
           until curl -s http://localhost:5601 >/dev/null; do
             echo "Waiting for OpenSearch Dashboards..."
             sleep 10
           done
-          echo "OpenSearch Dashboards is up!"
 
       - name: Mock data
         run: |
           curl 'http://localhost:5601/api/sample_data/ecommerce' -X 'POST' -H 'osd-version: ${{ env.VERSION }}' -H 'osd-xsrf: osd-fetch'
 
       - name: Run Lighthouse CI
-        run: |
-          export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
-          yarn lhci autorun --verbose
+        run: yarn lhci autorun --verbose
         continue-on-error: true
 
       - name: Ensure Lighthouse Reports Exist
@@ -101,68 +95,42 @@ jobs:
             echo "[]" > .lighthouseci/assertion-results.json
           fi
 
+      - name: List contents of .lighthouseci
+        run: ls -R .lighthouseci || echo "Directory not found"
+
       - name: Verify Lighthouse Results
+        id: verify_lighthouse
         run: |
-          if [ ! -d ".lighthouseci" ] || [ -z "$(ls -A .lighthouseci)" ]; then
-            echo "❌ Lighthouse CI did not generate reports."
-            exit 1
+          if [ ! -s ".lighthouseci/assertion-results.json" ]; then
+            echo "❌ Lighthouse assertion-results.json is empty. Skipping further steps."
+            echo "should_continue=false" >> $GITHUB_OUTPUT
+          else
+            echo "✅ Valid Lighthouse results found."
+            echo "should_continue=true" >> $GITHUB_OUTPUT
           fi
 
-      - name: Post Lighthouse Results into comment
+      - name: Save Lighthouse Results as Artifact
+        if: steps.verify_lighthouse.outputs.should_continue == 'true'
         run: |
-          # Validate if empty
-          if [ ! -s .lighthouseci/assertion-results.json ]; then
-            echo "❌ No assertion results found. Skipping PR comment."
-            exit 0   #Prevents failure
-          fi
+          mkdir -p artifacts
+          cp .lighthouseci/assertion-results.json artifacts/
+
+      - name: Upload Lighthouse Results Artifact
+        if: steps.verify_lighthouse.outputs.should_continue == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: lighthouse-results
+          path: artifacts/assertion-results.json
 
-          # Ensure JSON is properly formatted
-          if ! jq empty .lighthouseci/assertion-results.json; then
-            echo "❌ Invalid JSON format in Lighthouse assertion results."
-            cat .lighthouseci/assertion-results.json  # Print for debugging
+      - name: Fail CI if Lighthouse assertion results indicate failures
+        if: steps.verify_lighthouse.outputs.should_continue == 'true'
+        run: |
+          if jq -e '[.[] | select(.passed==false)] | length > 0' .lighthouseci/assertion-results.json > /dev/null; then
+            echo "❌ Lighthouse CI detected performance issues. Failing the job."
             exit 1
+          else
+            echo "✅ All Lighthouse metrics passed."
           fi
 
-            BASELINE=$(cat ./baselines/lighthouse_baseline.json)
-
-            FAILURES=$(jq --argjson baseline "$BASELINE" -r '[.[] | select(.passed==false) | {metric: .auditId, expected: ($baseline[(.url | sub("^.*?//[^/]+"; ""))][.auditId] // "N/A"), actual: (if .actual then (.actual | floor) else "N/A" end), url: .url}]' .lighthouseci/assertion-results.json)
-
-            UNIQUE_FAILURE_URLS=$(echo "$FAILURES" | jq '[.[] | .url] | unique')
-
-            if [ ! -f ".lighthouseci/links.json" ]; then
-              echo "⚠️ No .lighthouseci/links.json file found. Creating an empty JSON object..."
-              echo "{}" > .lighthouseci/links.json
-            fi
-
-            # Load the URL to report mapping from links.json
-              URL_REPORT_MAP=$(jq -c '.' .lighthouseci/links.json)
-
-            # Append report URLs to failed assertions
-            FAILURES_WITH_REPORTS=$(jq --argjson url_report_map "$URL_REPORT_MAP" '
-            map(. + {reportUrl: $url_report_map[.url]})
-            ' <<< "$FAILURES")
-
-            # Check if there are failures before posting a comment
-            if [[ "$FAILURES_WITH_REPORTS" == "[]" ]]; then
-            echo "✅ **All Lighthouse metrics passed!** 🎉"
-            exit 0
-            fi
-
-            COMMENT="### ⚡ Lighthouse CI Performance Issues ⚡
-
-            | Metric | Expected Value | Current Value | Page URL | Report |
-            |--------|---------------|--------------|----------|--------|"
-
-            while IFS= read -r line; do
-                COMMENT+="\n| $(echo "$line" | jq -r '.metric') | $(echo "$line" | jq -r '.expected') | $(echo "$line" | jq -r '.actual') | $(echo "$line" | jq -r '.url') | [Report]($(echo "$line" | jq -r '.reportUrl')) |"
-            done <<< "$(echo "$FAILURES_WITH_REPORTS" | jq -c '.[]')"
-
-            echo -e "$COMMENT" > comment.txt
-
-            gh pr comment ${{ github.event.pull_request.number }} --body "$(cat comment.txt)"
-        continue-on-error: true
-        env:
-          GITHUB_TOKEN: ${{  secrets.GITHUB_TOKEN  }}
-
-      - name: Cleanup Lighthouse Reports
-        run: rm -f comment.txt && rm -rf .lighthouseci
+      - name: Cleanup
+        run: rm -rf .lighthouseci
diff --git a/.github/workflows/performance_testing.yml b/.github/workflows/performance_testing.yml
@@ -5,18 +5,17 @@ on:
     branches:
       - main
     paths-ignore:
-      - '**/*.md' # Ignore documentation files
-      - '**/*.test.ts' # Ignore test files (TypeScript)
-      - '**/*.test.js' # Ignore test files (JavaScript)
-      - '**/__tests__/**' # Ignore test directories
-      - '.github/workflows/**' # Ignore GitHub workflow files
-      - 'docs/**' # Ignore entire docs directory
+      - '**/*.md'
+      - '**/*.test.ts'
+      - '**/*.test.js'
+      - '**/__tests__/**'
+      - '.github/workflows/**'
+      - 'docs/**'
 
 permissions:
   contents: read
-  issues: write
   pull-requests: write
-  
+
 jobs:
   bundle-analyzer:
     runs-on: ubuntu-latest
@@ -36,26 +35,34 @@ jobs:
           npm i -g yarn@1.22.10
 
       - name: Run bootstrap
-        # Install dependencies and bootstrap the OpenSearch Dashboards project
         run: yarn osd bootstrap
 
       - name: Build plugins
-        # Build OpenSearch Dashboards platform plugins without examples using 12 workers
         run: node scripts/build_opensearch_dashboards_platform_plugins --no-examples --workers 12
 
       - name: Update Limit and bundle size variation
-        # This command updates the limit and bundle size variation for the OpenSearch Dashboards platform plugins
         run: node scripts/build_opensearch_dashboards_platform_plugins --update-limits
 
-      - name: Read and comment bundle size variations
+      - name: Check and upload bundle size variations
+        id: check_bundle_size
         run: |
           if [ -f packages/osd-optimizer/limits_delta.yml ]; then
-            echo "📊 **Bundle Size crossed 5% for below plugins**" > comment.txt
-            echo "" >> comment.txt
-            cat packages/osd-optimizer/limits_delta.yml >> comment.txt
-            gh pr comment ${{ github.event.pull_request.number }} --body "$(cat comment.txt)"
+            echo "Bundle size changes detected."
+            echo "bundle_size_changed=true" >> $GITHUB_OUTPUT
           else
-            echo "No bundle size variations detected, skipping comment."
+            echo "No bundle size variations detected."
+            echo "bundle_size_changed=false" >> $GITHUB_OUTPUT
           fi
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload limits_delta.yml as artifact
+        if: steps.check_bundle_size.outputs.bundle_size_changed == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: bundle-size-delta
+          path: packages/osd-optimizer/limits_delta.yml
+
+      - name: Fail the CI if bundle size exceeded
+        if: steps.check_bundle_size.outputs.bundle_size_changed == 'true'
+        run: |
+          echo "❌ Bundle size exceeded threshold. Failing the job."
+          exit 1
diff --git a/baselines/lighthouse_baseline.json b/baselines/lighthouse_baseline.json
@@ -1,18 +1,18 @@
 {
   "/app/home": {
-    "first-contentful-paint": 1800,
-    "speed-index": 15000
+    "first-contentful-paint": 2800,
+    "speed-index": 20000
   },
   "/app/data-explorer/discover": {
-    "first-contentful-paint": 1800,
-    "speed-index": 20000
+    "first-contentful-paint": 2200,
+    "speed-index": 26000
   },
   "/app/dashboards": {
-    "first-contentful-paint": 1800,
-    "speed-index": 24000
+    "first-contentful-paint": 2200,
+    "speed-index": 28000
   },
   "/app/visualize": {
-    "first-contentful-paint": 1800,
+    "first-contentful-paint": 2200,
     "speed-index": 22000
   }
 }
diff --git a/changelogs/fragments/9738.yml b/changelogs/fragments/9738.yml
@@ -0,0 +1,2 @@
+fix:
+- Performance script ([#9738](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9738))
diff --git a/packages/osd-optimizer/limits.yml b/packages/osd-optimizer/limits.yml
@@ -1,18 +1,20 @@
 pageLoadAssetSize:
   advancedSettings: 27596
   apmOss: 18996
+  assistantDashboards: 521995
   bfetch: 41874
   charts: 159211
   console: 46235
   contentManagement: 189948
-  core: 989885
+  core: 995264
   dashboard: 694542
   data: 2701242
   dataExplorer: 142726
+  dataImporter: 22156
   dataSource: 24232
   dataSourceManagement: 541476
   devTools: 66175
-  discover: 778790
+  discover: 823326
   embeddable: 242671
   expressions: 224120
   home: 75810
@@ -26,7 +28,7 @@ pageLoadAssetSize:
   opensearchDashboardsLegacy: 107855
   opensearchDashboardsOverview: 56426
   opensearchDashboardsReact: 162353
-  opensearchDashboardsUtils: 227366
+  opensearchDashboardsUtils: 233344
   opensearchUiShared: 326798
   queryEnhancements: 437883
   regionMap: 66098

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+fix:`
	`2`	`+- Performance script ([#9738](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9738))`