search

celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
345 stars 292 forks source link

feat!: add custom build tags to override certain global variables #3897

Closed cmwaters closed 1 month ago

cmwaters commented 1 month ago

Closes: https://github.com/celestiaorg/celestia-app/issues/3603

Technically this uses LD flags not build flags

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The changes involve modifications to the Dockerfile, Makefile, and various Go source files to introduce new build arguments and constants that enhance configurability for parameters like maximum square size and upgrade height delay. These updates affect how the application is built and how certain operational parameters are managed, allowing for more flexible testing and deployment scenarios. ## Changes | File | Change Summary | |---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Dockerfile | Added build arguments `MAX_SQUARE_SIZE` and `UPGRADE_HEIGHT_DELAY` for configurability during image build. | | Makefile | Introduced optional variables `OVERRIDE_MAX_SQUARE_SIZE` and `OVERRIDE_UPGRADE_HEIGHT_DELAY` for overriding binary configuration. Simplified `install` target by removing dependency on `go.sum`. | | app/app.go | Updated `SignalKeeper` instantiation to include `appconsts.UpgradeHeightDelay()` as an argument. | | app/module/configurator_test.go | Modified `TestConfigurator` to instantiate `keeper` with an additional parameter for the new constructor signature. | | app/test/upgrade_test.go | Replaced references to `signal.DefaultUpgradeHeightDelay` with `appconsts.DefaultUpgradeHeightDelay` in `TestAppUpgradeV3`. | | pkg/appconsts/global_consts.go | Introduced `DefaultUpgradeHeightDelay` constant and `UpgradeHeightDelay()` function for configurable upgrade delay logic. | | pkg/appconsts/overrides.go | Added `overrides.go` file with variables for compile-time configuration, including `OverrideSquareSizeUpperBoundStr` and `OverrideUpgradeHeightDelayStr`. | | pkg/appconsts/versioned_consts.go | Added conditional logic in `SquareSizeUpperBound` function to handle `OverrideSquareSizeUpperBoundStr`. | | x/signal/integration_test.go | Modified import statements and updated `TestUpgradeIntegration` to use `appconsts.DefaultUpgradeHeightDelay`. | | x/signal/keeper.go | Removed `DefaultUpgradeHeightDelay` constant, added `upgradeHeightDelayBlocks` field to `Keeper` struct, and updated `NewKeeper` method to accept this new parameter. | | x/signal/keeper_test.go | Updated test cases to instantiate `signal.Keeper` with `appconsts.DefaultUpgradeHeightDelay` as a parameter, ensuring consistency across tests. | ## Assessment against linked issues | Objective | Addressed | Explanation | |------------------------------------------------------------|-----------|--------------------------------------------------| | Support customizable upper bounds to block size with build tags (3603) | ✅ | | ## Possibly related PRs - **#3560**: Introduces a delay between block inclusion and upgrade height, enhancing upgrade timing configurability. - **#3846**: Addresses synchronization issues related to the Mocha testnet, relevant to changes allowing parameter overrides during builds. ## Suggested labels `WS: V2 ✌️` ## Suggested reviewers - staheri14 - evan-forbes

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.