Lighthouse performance metrics setup #9304
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| name: Performance Testing | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| env: | ||
| NODE_OPTIONS: '--max-old-space-size=6144 --dns-result-order=ipv4first' | ||
| LATEST_VERSION: '2.17.0' | ||
|
|
||
| jobs: | ||
| lighthouse: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Setup Node | ||
| uses: actions/setup-node@v2 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| registry-url: 'https://registry.npmjs.org' | ||
|
|
||
| - name: Setup Yarn | ||
| run: | | ||
| npm uninstall -g yarn | ||
| npm i -g [email protected] | ||
|
|
||
| - name: Run bootstrap | ||
| run: yarn osd bootstrap | ||
|
|
||
| - name: Download OpenSearch | ||
| uses: suisei-cn/[email protected] | ||
| with: | ||
| url: https://artifacts.opensearch.org/releases/bundle/opensearch/${{ env.LATEST_VERSION }}/opensearch-${{ env.LATEST_VERSION }}-linux-x64.tar.gz | ||
|
|
||
| - name: Extract OpenSearch | ||
| run: | | ||
| tar -xzf opensearch-*.tar.gz | ||
| rm -f opensearch-*.tar.gz | ||
| shell: bash | ||
|
|
||
| - name: Remove security plugin | ||
| run: | | ||
| /bin/bash -c "yes | ./opensearch-${{ env.LATEST_VERSION }}/bin/opensearch-plugin remove opensearch-security" | ||
| shell: bash | ||
|
|
||
| - name: Run OpenSearch | ||
| run: | | ||
| /bin/bash -c "./opensearch-${{ env.LATEST_VERSION }}/opensearch-tar-install.sh &" | ||
| sleep 30 | ||
| shell: bash | ||
|
|
||
| - name: Install Lighthouse CI | ||
|
There was a problem hiding this comment. is there not a github action that we can pull from the marketplace and run this? |
||
| 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 | ||
|
|
||
| # - name: Start OpenSearch Dashboards | ||
| # run: | | ||
| # yarn start --no-base-path | ||
|
|
||
| # - name: Start OpenSearch Dashboards | ||
| # run: | | ||
| # yarn wait-on http://localhost:9200 | ||
| # yarn start --no-base-path & yarn wait-on http://localhost:5601 | ||
|
|
||
| # - name: Wait for OpenSearch to be ready | ||
| # run: | | ||
| # until curl -s http://localhost:9200 >/dev/null; do | ||
| # echo "Waiting for OpenSearch..." | ||
| # sleep 10 | ||
| # done | ||
| # echo "OpenSearch is up!" | ||
|
|
||
| # - name: Start OpenSearch Dashboards | ||
| # run: | | ||
| # yarn start --no-base-path & | ||
| # 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: 3.0.0' -H 'osd-xsrf: osd-fetch' | ||
|
|
||
| - name: Run Lighthouse CI | ||
| run: yarn lhci autorun || echo "Lighthouse assertion failed, check results" | ||
|
|
||
| - name: Post Lighthouse Report to PR | ||
| if: always() | ||
| run: | | ||
| echo "🚦 **Lighthouse CI Report**" > comment.txt | ||
| echo "" >> comment.txt | ||
| lhci upload --target=temporary-public-storage | tee lhci_output.txt | ||
| REPORT_URL=$(grep -o 'https://storage.googleapis.com/lighthouse-infrastructure-.*' lhci_output.txt | head -n 1) | ||
| echo "🔗 [View Full Lighthouse Report]($REPORT_URL)" >> comment.txt | ||
| gh pr comment ${{ github.event.pull_request.number }} --body "$(cat comment.txt)" | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| const baseUrl = 'http://localhost:5601'; | ||
|
There was a problem hiding this comment. do we need a license here? (like .eslintrc.js) There was a problem hiding this comment. baseUrl technically doesn't have to be 5601. It can be configurable to be something like 443 |
||
|
|
||
| module.exports = { | ||
| ci: { | ||
| collect: { | ||
| url: [`${baseUrl}`, `${baseUrl}/app/data-explorer/discover`, `${baseUrl}/app/dashboards`], // Add more URLs as needed | ||
|
There was a problem hiding this comment. Something i'm wondering about... Without some specific actions, I don't think any results would be loaded in Is it possible to start with some examples that'll load? perhaps the sample data (but even with that i think we need to modify the URL so we are hitting the correct page. For example
There was a problem hiding this comment. +1, you can actually hit the api or bulk insert saved objects and data There was a problem hiding this comment. yes, have plan to do so, updating mock data |
||
| startServerCommand: 'yarn start --no-base-path', | ||
| numberOfRuns: 3, | ||
| settings: { | ||
| chromePath: require('puppeteer').executablePath(), | ||
| chromeFlags: '--no-sandbox --disable-gpu --headless', | ||
| }, | ||
| }, | ||
| assert: { | ||
| preset: 'lighthouse:recommended', | ||
| assertions: { | ||
| performance: ['error', { minScore: 0.9 }], | ||
|
There was a problem hiding this comment. oof i think we need make the minscore much lower. and it might differ between the different URLs. For example on There was a problem hiding this comment. This is only for testing purpose, would change in final review. |
||
| 'first-contentful-paint': ['warn', { maxNumericValue: 1800 }], | ||
| 'largest-contentful-paint': ['warn', { maxNumericValue: 2500 }], | ||
| interactive: ['warn', { maxNumericValue: 5000 }], | ||
| 'total-blocking-time': ['warn', { maxNumericValue: 300 }], | ||
| }, | ||
| }, | ||
| upload: { | ||
| target: 'temporary-public-storage', // Required for GitHub integration | ||
| }, | ||
| }, | ||
| }; | ||
|
There was a problem hiding this comment. which OS instance does this connect to? There was a problem hiding this comment. for our BE, 9200. This temporary-public-storage , is a public instance of google report . |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need: