Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: CI workflow cache issues #7384

Merged
merged 4 commits into from
Nov 13, 2024
Merged

fix: CI workflow cache issues #7384

merged 4 commits into from
Nov 13, 2024

Conversation

krzysu
Copy link
Contributor

@krzysu krzysu commented Nov 13, 2024

Description

Trying to fix CI lint and benchmark workflows, because of failed cache delete, see ie. this build https://github.com/web3/web3.js/actions/runs/11814326177/job/32915706387

A lot of changes are because of prettier formatting the workflow file. You can disable whitespace changes to have better overview of the changes in this PR
Screenshot 2024-11-13 at 14 33 33

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

Copy link

Bundle Stats

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
10 649.08 kB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
web3.min.js 630.33 kB 0%
../lib/commonjs/index.d.ts 8.72 kB 0%
../lib/commonjs/accounts.d.ts 3.06 kB 0%
../lib/commonjs/types.d.ts 2.73 kB 0%
../lib/commonjs/web3.d.ts 1.38 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.28 kB 0%
../lib/commonjs/abi.d.ts 1.06 kB 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 183 B 0%
../lib/commonjs/version.d.ts 60 B 0%

Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.51%. Comparing base (2011192) to head (20b7e1c).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7384   +/-   ##
=======================================
  Coverage   94.51%   94.51%           
=======================================
  Files         218      218           
  Lines        8557     8557           
  Branches     2363     2363           
=======================================
  Hits         8088     8088           
  Misses        469      469           
Flag Coverage Δ
UnitTests 94.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@krzysu krzysu force-pushed the krzysu/fix-ci-cache branch from 2bca297 to 321aabf Compare November 13, 2024 13:15
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Benchmark suite Current: 20b7e1c Previous: 2bca297 Ratio
processingTx 20874 ops/sec (±8.31%) 21322 ops/sec (±6.86%) 1.02
processingContractDeploy 38096 ops/sec (±6.73%) 39487 ops/sec (±7.59%) 1.04
processingContractMethodSend 14621 ops/sec (±9.60%) 16117 ops/sec (±8.11%) 1.10
processingContractMethodCall 25438 ops/sec (±9.42%) 27148 ops/sec (±8.22%) 1.07
abiEncode 40101 ops/sec (±7.34%) 43502 ops/sec (±6.33%) 1.08
abiDecode 29962 ops/sec (±6.55%) 31073 ops/sec (±7.24%) 1.04
sign 1487 ops/sec (±3.70%) 1531 ops/sec (±0.87%) 1.03
verify 361 ops/sec (±0.53%) 360 ops/sec (±2.50%) 1.00

This comment was automatically generated by workflow using github-action-benchmark.

packages/web3-utils/.eslintcache
packages/web3-validator/.eslintcache
tools/web3-plugin-example/.eslintcache
key: ${{ runner.os }}-eslintcache-${{ github.ref_name }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use branch name in the cache key

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Save eslint caches
if: github.event_name == 'push' && github.ref == 'refs/heads/4.x'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After further consideration, I realized this cache setup is unnecessary since the cache is only being deleted and saved on the 4.x branch. By removing this extra logic, we allow actions/cache@v4 to manage the cache automatically—saving it when needed and restoring it if available. Please review the recent builds on this branch for reference.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I finally understand what was happening here. The workflow was set up to store the lint cache for the 4.x branch and restore it for PR branches to lint only the diffs in a PR. The issue was that the 4.x cache didn’t exist, likely due to the cache reaching the 10GB limit, which resulted in older caches being deleted.

@@ -42,7 +42,7 @@ import { ENSRegistryBytecode } from '../fixtures/ens/bytecode/ENSRegistryBytecod
import { NameWrapperBytecode } from '../fixtures/ens/bytecode/NameWrapperBytecode';
import { PublicResolverBytecode } from '../fixtures/ens/bytecode/PublicResolverBytecode';

jest.setTimeout(25000);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these tests are failing regularly on the beforeAll step

@krzysu krzysu merged commit 0915cf4 into 4.x Nov 13, 2024
54 checks passed
@krzysu krzysu deleted the krzysu/fix-ci-cache branch November 13, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants