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

Generate and publish code coverage reports in the CI #1947

Merged
merged 7 commits into from
Jun 17, 2024

Conversation

Dentosal
Copy link
Member

@Dentosal Dentosal commented Jun 7, 2024

Fuel-core counterpart for FuelLabs/fuel-vm#750

This PR sets up code coverage reporting. It commits the report to a branch called codecov-pages, which contains a folder for each branch. Branch names are urlsafe-base64-encoded to avoid (security) bugs. Every time a PR workflow runs or the master receives new commits, a CI action pushes updated codecov report there.

Repository setup

The configuration has to be done by someone who has permission to edit the repo settings: set deployment from codecov-pages branch, like this:
Screenshot of the settings page

@Dentosal Dentosal added the no changelog Skip the CI check of the changelog modification label Jun 7, 2024
@Dentosal Dentosal self-assigned this Jun 7, 2024
@Dentosal Dentosal marked this pull request as ready for review June 12, 2024 12:06
@Dentosal Dentosal requested a review from a team June 12, 2024 12:07
CARGO_TERM_COLOR: always
RUST_VERSION: 1.75.0
NIGHTLY_RUST_VERSION: nightly-2023-10-29
RUST_VERSION_FMT: nightly-2023-10-29
RUST_VERSION_COV: nightly-2024-06-05
Copy link
Member

Choose a reason for hiding this comment

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

Why do we use a different version of rust nightly?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't want to touch formatting in this PR. The branch coverage needs.a more recent nightly.

Copy link
Member

Choose a reason for hiding this comment

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

Okay. That makes sense. Do we have any issues for unifying them?

Copy link
Member Author

Choose a reason for hiding this comment

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

In a separate PR, maybe. I don't want to reformat the whole codebase here.

name: Publish code coverage report on GitHub pages branch
runs-on: buildjet-4vcpu-ubuntu-2204
needs:
- cargo-verifications
Copy link
Member

Choose a reason for hiding this comment

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

In the vm pr we have needs: -cargo. What's the difference?

Copy link
Member Author

Choose a reason for hiding this comment

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

This workflow doesn't have cargo job. The closes equivalent is cargo-verifications.

@MitchTurner
Copy link
Member

A lot of the links in the description were left as the fuel-vm links.

Also, when I tried to inspect the generated docs from the code cov branch I got this 404:
Screenshot 2024-06-14 at 11 42 22 AM

@Dentosal
Copy link
Member Author

A lot of the links in the description were left as the fuel-vm links.

Also, when I tried to inspect the generated docs from the code cov branch I got this 404:

Fixed description links. The github pages return 404 because the settings for this repo haven't been updated yet.

@Dentosal Dentosal merged commit 12cb17f into master Jun 17, 2024
34 checks passed
@Dentosal Dentosal deleted the dento/ci-codecov-reporting branch June 17, 2024 15:32
@xgreenx xgreenx mentioned this pull request Jul 5, 2024
xgreenx added a commit that referenced this pull request Jul 5, 2024
## Version v0.31.0

### Added
- [#2014](#2014): Added a
separate thread for the block importer.
- [#2013](#2013): Added a
separate thread to process P2P database lookups.
- [#2004](#2004): Added new
CLI argument `continue-services-on-error` to control internal flow of
services.
- [#2004](#2004): Added
handling of incorrect shutdown of the off-chain GraphQL worker by using
state rewind feature.
- [#2007](#2007): Improved
metrics:
  - Added database metrics per column.
  - Added statistic about commit time of each database.
- Refactored how metrics are registered: Now, we use only one register
shared between all metrics. This global register is used to encode all
metrics.
- [#1996](#1996): Added
support for rollback command when state rewind feature is enabled. The
command allows the rollback of the state of the blockchain several
blocks behind until the end of the historical window. The default
historical window it 7 days.
- [#1996](#1996): Added
support for the state rewind feature. The feature allows the execution
of the blocks in the past and the same execution results to be received.
Together with forkless upgrades, execution of any block from the past is
possible if historical data exist for the target block height.
- [#1994](#1994): Added the
actual implementation for the `AtomicView::latest_view`.
- [#1972](#1972): Implement
`AlgorithmUpdater` for `GasPriceService`
- [#1948](#1948): Add new
`AlgorithmV1` and `AlgorithmUpdaterV1` for the gas price. Include tools
for analysis
- [#1676](#1676): Added new
CLI arguments:
    - `graphql-max-depth`
    - `graphql-max-complexity`
    - `graphql-max-recursive-depth`

### Changed
- [#2015](#2015): Small fixes
for the database:
- Fixed the name for historical columns - Metrics was working
incorrectly for historical columns.
- Added recommended setting for the RocksDB - The source of
recommendation is official documentation
https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning#other-general-options.
- Removed repairing since it could corrupt the database if fails -
Several users reported about the corrupted state of the database after
having a "Too many descriptors" error where in logs, repairing of the
database also failed with this error creating a `lost` folder.
- [#2010](#2010): Updated the
block importer to allow more blocks to be in the queue. It improves
synchronization speed and mitigate the impact of other services on
synchronization speed.
- [#2006](#2006): Process
block importer events first under P2P pressure.
- [#2002](#2002): Adapted the
block producer to react to checked transactions that were using another
version of consensus parameters during validation in the TxPool. After
an upgrade of the consensus parameters of the network, TxPool could
store invalid `Checked` transactions. This change fixes that by tracking
the version that was used to validate the transactions.
- [#1999](#1999): Minimize the
number of panics in the codebase.
- [#1990](#1990): Use latest
view for mutate GraphQL queries after modification of the node.
- [#1992](#1992): Parse
multiple relayer contracts, `RELAYER-V2-LISTENING-CONTRACTS` env
variable using a `,` delimiter.
- [#1980](#1980): Add
`Transaction` to relayer 's event filter

#### Breaking
- [#2012](#2012): Bumped the
`fuel-vm` to `0.55.0` release. More about the change
[here](https://github.com/FuelLabs/fuel-vm/releases/tag/v0.55.0).
- [#2001](#2001): Prevent
GraphQL query body to be huge and cause OOM. The default body size is
`1MB`. The limit can be changed by the
`graphql-request-body-bytes-limit` CLI argument.
- [#1991](#1991): Prepare the
database to use different types than `Database` for atomic view.
- [#1989](#1989): Extract
`HistoricalView` trait from the `AtomicView`.
- [#1676](#1676): New
`fuel-core-client` is incompatible with the old `fuel-core` because of
two requested new fields.
- [#1676](#1676): Changed
default value for `api-request-timeout` to be `30s`.
- [#1676](#1676): Now, GraphQL
API has complexity and depth limitations on the queries. The default
complexity limit is `20000`. It is ~50 blocks per request with
transaction IDs and ~2-5 full blocks.

### Fixed
- [#2000](#2000): Use correct
query name in metrics for aliased queries.

## What's Changed
* Generate and publish code coverage reports in the CI by @Dentosal in
#1947
* Gas Price Algorithm by @MitchTurner in
#1948
* Use companies fork of the `publish-crates` action by @xgreenx in
#1986
* Weekly `cargo update` by @github-actions in
#1985
* Implement gas price updater for service by @MitchTurner in
#1972
* Extract `HistoricalView` trait from the `AtomicView` by @xgreenx in
#1989
* Use fresh `ReadView` for mutate queries by @xgreenx in
#1990
* Prevent api spam with GQL complexity limits by @Voxelot in
#1676
* Enable parsing multiple relayer listening contract addresses from
environment variables by @Jurshsmith in
#1992
* Prepare the database to use different types than `Database` for atomic
view by @xgreenx in #1991
* Added the actual implementation for the `AtomicView::latest_view` by
@xgreenx in #1994
* Weekly `cargo update` by @github-actions in
#1998
* Minimize the number of panics in the codebase by @xgreenx in
#1999
* feat: include Transaction events in topic0 filter for download_logs by
@DefiCake in #1980
* Use correct query name for metrics by @xgreenx in
#2000
* Prevent GraphQL query body to be huge and cause OOM by @xgreenx in
#2001
* Adapted the block producer to react on the outdated transactions from
the TxPool by @xgreenx in
#2002
* Process block importer events first under P2P pressure by @xgreenx in
#2006
* Implementation of the state rewind feature for the RocksDB by @xgreenx
in #1996
* Upgraded `fuel-vm` to `0.55.0` by @xgreenx in
#2012
* Improved metrics for the database by @xgreenx in
#2007
* Updated block importer to allow more blocks to be queue by @xgreenx in
#2010
* Added handling of incorrect shutdown of the off-chain GraphQL worker
by @xgreenx in #2004
* Moved P2P database lookups into a separate thread by @xgreenx in
#2013
* Use dedicated thread for the block importer by @xgreenx in
#2014
* Small fixes for the database by @xgreenx in
#2015

## New Contributors
* @Jurshsmith made their first contribution in
#1992
* @DefiCake made their first contribution in
#1980

**Full Changelog**:
v0.30.0...v0.31.0
GoldenPath1109 added a commit to GoldenPath1109/fuel-core that referenced this pull request Sep 7, 2024
## Version v0.31.0

### Added
- [#2014](FuelLabs/fuel-core#2014): Added a
separate thread for the block importer.
- [#2013](FuelLabs/fuel-core#2013): Added a
separate thread to process P2P database lookups.
- [#2004](FuelLabs/fuel-core#2004): Added new
CLI argument `continue-services-on-error` to control internal flow of
services.
- [#2004](FuelLabs/fuel-core#2004): Added
handling of incorrect shutdown of the off-chain GraphQL worker by using
state rewind feature.
- [#2007](FuelLabs/fuel-core#2007): Improved
metrics:
  - Added database metrics per column.
  - Added statistic about commit time of each database.
- Refactored how metrics are registered: Now, we use only one register
shared between all metrics. This global register is used to encode all
metrics.
- [#1996](FuelLabs/fuel-core#1996): Added
support for rollback command when state rewind feature is enabled. The
command allows the rollback of the state of the blockchain several
blocks behind until the end of the historical window. The default
historical window it 7 days.
- [#1996](FuelLabs/fuel-core#1996): Added
support for the state rewind feature. The feature allows the execution
of the blocks in the past and the same execution results to be received.
Together with forkless upgrades, execution of any block from the past is
possible if historical data exist for the target block height.
- [#1994](FuelLabs/fuel-core#1994): Added the
actual implementation for the `AtomicView::latest_view`.
- [#1972](FuelLabs/fuel-core#1972): Implement
`AlgorithmUpdater` for `GasPriceService`
- [#1948](FuelLabs/fuel-core#1948): Add new
`AlgorithmV1` and `AlgorithmUpdaterV1` for the gas price. Include tools
for analysis
- [#1676](FuelLabs/fuel-core#1676): Added new
CLI arguments:
    - `graphql-max-depth`
    - `graphql-max-complexity`
    - `graphql-max-recursive-depth`

### Changed
- [#2015](FuelLabs/fuel-core#2015): Small fixes
for the database:
- Fixed the name for historical columns - Metrics was working
incorrectly for historical columns.
- Added recommended setting for the RocksDB - The source of
recommendation is official documentation
https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning#other-general-options.
- Removed repairing since it could corrupt the database if fails -
Several users reported about the corrupted state of the database after
having a "Too many descriptors" error where in logs, repairing of the
database also failed with this error creating a `lost` folder.
- [#2010](FuelLabs/fuel-core#2010): Updated the
block importer to allow more blocks to be in the queue. It improves
synchronization speed and mitigate the impact of other services on
synchronization speed.
- [#2006](FuelLabs/fuel-core#2006): Process
block importer events first under P2P pressure.
- [#2002](FuelLabs/fuel-core#2002): Adapted the
block producer to react to checked transactions that were using another
version of consensus parameters during validation in the TxPool. After
an upgrade of the consensus parameters of the network, TxPool could
store invalid `Checked` transactions. This change fixes that by tracking
the version that was used to validate the transactions.
- [#1999](FuelLabs/fuel-core#1999): Minimize the
number of panics in the codebase.
- [#1990](FuelLabs/fuel-core#1990): Use latest
view for mutate GraphQL queries after modification of the node.
- [#1992](FuelLabs/fuel-core#1992): Parse
multiple relayer contracts, `RELAYER-V2-LISTENING-CONTRACTS` env
variable using a `,` delimiter.
- [#1980](FuelLabs/fuel-core#1980): Add
`Transaction` to relayer 's event filter

#### Breaking
- [#2012](FuelLabs/fuel-core#2012): Bumped the
`fuel-vm` to `0.55.0` release. More about the change
[here](https://github.com/FuelLabs/fuel-vm/releases/tag/v0.55.0).
- [#2001](FuelLabs/fuel-core#2001): Prevent
GraphQL query body to be huge and cause OOM. The default body size is
`1MB`. The limit can be changed by the
`graphql-request-body-bytes-limit` CLI argument.
- [#1991](FuelLabs/fuel-core#1991): Prepare the
database to use different types than `Database` for atomic view.
- [#1989](FuelLabs/fuel-core#1989): Extract
`HistoricalView` trait from the `AtomicView`.
- [#1676](FuelLabs/fuel-core#1676): New
`fuel-core-client` is incompatible with the old `fuel-core` because of
two requested new fields.
- [#1676](FuelLabs/fuel-core#1676): Changed
default value for `api-request-timeout` to be `30s`.
- [#1676](FuelLabs/fuel-core#1676): Now, GraphQL
API has complexity and depth limitations on the queries. The default
complexity limit is `20000`. It is ~50 blocks per request with
transaction IDs and ~2-5 full blocks.

### Fixed
- [#2000](FuelLabs/fuel-core#2000): Use correct
query name in metrics for aliased queries.

## What's Changed
* Generate and publish code coverage reports in the CI by @Dentosal in
FuelLabs/fuel-core#1947
* Gas Price Algorithm by @MitchTurner in
FuelLabs/fuel-core#1948
* Use companies fork of the `publish-crates` action by @xgreenx in
FuelLabs/fuel-core#1986
* Weekly `cargo update` by @github-actions in
FuelLabs/fuel-core#1985
* Implement gas price updater for service by @MitchTurner in
FuelLabs/fuel-core#1972
* Extract `HistoricalView` trait from the `AtomicView` by @xgreenx in
FuelLabs/fuel-core#1989
* Use fresh `ReadView` for mutate queries by @xgreenx in
FuelLabs/fuel-core#1990
* Prevent api spam with GQL complexity limits by @Voxelot in
FuelLabs/fuel-core#1676
* Enable parsing multiple relayer listening contract addresses from
environment variables by @Jurshsmith in
FuelLabs/fuel-core#1992
* Prepare the database to use different types than `Database` for atomic
view by @xgreenx in FuelLabs/fuel-core#1991
* Added the actual implementation for the `AtomicView::latest_view` by
@xgreenx in FuelLabs/fuel-core#1994
* Weekly `cargo update` by @github-actions in
FuelLabs/fuel-core#1998
* Minimize the number of panics in the codebase by @xgreenx in
FuelLabs/fuel-core#1999
* feat: include Transaction events in topic0 filter for download_logs by
@DefiCake in FuelLabs/fuel-core#1980
* Use correct query name for metrics by @xgreenx in
FuelLabs/fuel-core#2000
* Prevent GraphQL query body to be huge and cause OOM by @xgreenx in
FuelLabs/fuel-core#2001
* Adapted the block producer to react on the outdated transactions from
the TxPool by @xgreenx in
FuelLabs/fuel-core#2002
* Process block importer events first under P2P pressure by @xgreenx in
FuelLabs/fuel-core#2006
* Implementation of the state rewind feature for the RocksDB by @xgreenx
in FuelLabs/fuel-core#1996
* Upgraded `fuel-vm` to `0.55.0` by @xgreenx in
FuelLabs/fuel-core#2012
* Improved metrics for the database by @xgreenx in
FuelLabs/fuel-core#2007
* Updated block importer to allow more blocks to be queue by @xgreenx in
FuelLabs/fuel-core#2010
* Added handling of incorrect shutdown of the off-chain GraphQL worker
by @xgreenx in FuelLabs/fuel-core#2004
* Moved P2P database lookups into a separate thread by @xgreenx in
FuelLabs/fuel-core#2013
* Use dedicated thread for the block importer by @xgreenx in
FuelLabs/fuel-core#2014
* Small fixes for the database by @xgreenx in
FuelLabs/fuel-core#2015

## New Contributors
* @Jurshsmith made their first contribution in
FuelLabs/fuel-core#1992
* @DefiCake made their first contribution in
FuelLabs/fuel-core#1980

**Full Changelog**:
FuelLabs/fuel-core@v0.30.0...v0.31.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Skip the CI check of the changelog modification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants