feat(sozo): support for feature flags
#2112
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2112 +/- ##
=======================================
Coverage 68.00% 68.00%
=======================================
Files 331 331
Lines 42697 42725 +28
=======================================
+ Hits 29035 29057 +22
- Misses 13662 13668 +6 ☔ View full report in Codecov by Sentry. |
WalkthroughThe changes introduce support for conditional compilation features in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant SozoBuild
participant ScarbBuild
participant Workspace
participant ScarbCompile
User->>SozoBuild: build with --features
SozoBuild->>ScarbBuild: Pass features to scarb build
ScarbBuild->>Workspace: Read workspace
Workspace-->>ScarbBuild: Return workspace info
ScarbBuild->>ScarbCompile: Compile with selected features
ScarbCompile-->>ScarbBuild: Compilation result
SozoBuild-->>User: Build finished
Assessment against linked issues
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
(rebased to main after scarb was updated) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (19)
- bin/sozo/src/commands/build.rs (6 hunks)
- bin/sozo/src/commands/test.rs (3 hunks)
- crates/dojo-lang/src/compiler_test.rs (2 hunks)
- crates/dojo-lang/src/scarb_internal/mod.rs (3 hunks)
- crates/dojo-test-utils/build.rs (2 hunks)
- crates/dojo-test-utils/src/compiler.rs (2 hunks)
- crates/dojo-world/src/manifest/manifest_test.rs (1 hunks)
- examples/spawn-and-move/Scarb.toml (2 hunks)
- examples/spawn-and-move/manifests/dev/deployment/abis/contracts/dojo_examples-actions-40b6994c.json (1 hunks)
- examples/spawn-and-move/manifests/dev/deployment/abis/contracts/dojo_examples-something-71cfad55.json (1 hunks)
- examples/spawn-and-move/manifests/dev/deployment/manifest.json (3 hunks)
- examples/spawn-and-move/manifests/dev/deployment/manifest.toml (2 hunks)
- examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-actions-40b6994c.json (1 hunks)
- examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-something-71cfad55.json (1 hunks)
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-actions-40b6994c.toml (1 hunks)
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-something-71cfad55.toml (1 hunks)
- examples/spawn-and-move/src/actions.cairo (4 hunks)
- examples/spawn-and-move/src/lib.cairo (1 hunks)
- examples/spawn-and-move/src/something.cairo (1 hunks)
Files skipped from review due to trivial changes (3)
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-actions-40b6994c.toml
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-something-71cfad55.toml
- examples/spawn-and-move/src/lib.cairo
Additional comments not posted (40)
examples/spawn-and-move/src/something.cairo (2)
1-4: Trait definition looks good.The
ISomethingtrait is correctly defined with thedojo::interfaceattribute and a single functionsomething.
6-11: Module and contract implementation look good.The
somethingmodule correctly uses thedojo::contractattribute and implements theISomethingtrait. Thesomethingfunction is defined but currently empty.crates/dojo-lang/src/compiler_test.rs (2)
16-17: Workspace reading and package ID collection look good.The workspace is correctly read, and package IDs are collected before the compilation process.
27-27: Updated function call looks good.The
compile_workspacefunction call correctly includes thepackagesparameter.examples/spawn-and-move/Scarb.toml (1)
18-20: Feature sections look good.The
[features]sections are correctly added, allowing conditional compilation based on the specified features.crates/dojo-test-utils/build.rs (2)
56-57: Workspace reading and package ID collection look good.The workspace is correctly read, and package IDs are collected before the compilation process.
67-67: Updated function call looks good.The
compile_workspacefunction call correctly includes thepackagesparameter.examples/spawn-and-move/manifests/dev/deployment/abis/contracts/dojo_examples-something-71cfad55.json (5)
3-6: LGTM! Implementation ofContractImplThe
ContractImplcorrectly implements thedojo::contract::IContractinterface.
8-23: LGTM! Definition ofByteArraystructThe
ByteArraystruct is correctly defined with appropriate members and types.
26-94: LGTM! Definition ofIContractinterfaceThe
IContractinterface is correctly defined with appropriate functions, inputs, outputs, and state mutability.
98-110: LGTM! Implementation ofWorldProviderImpland definition ofIWorldDispatcherstructThe
WorldProviderImplcorrectly implements thedojo::world::IWorldProviderinterface, and theIWorldDispatcherstruct is correctly defined with a contract address member.
130-223: LGTM! Implementations and definitions related todojo_examples::somethingmoduleThe implementations (
ISomethingImpl,IDojoInitImpl, andUpgradableImpl), interfaces, and events are correctly defined with appropriate functions, inputs, outputs, and state mutability.examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-something-71cfad55.json (5)
3-6: LGTM! Implementation ofContractImplThe
ContractImplcorrectly implements thedojo::contract::IContractinterface.
8-23: LGTM! Definition ofByteArraystructThe
ByteArraystruct is correctly defined with appropriate members and types.
26-94: LGTM! Definition ofIContractinterfaceThe
IContractinterface is correctly defined with appropriate functions, inputs, outputs, and state mutability.
98-110: LGTM! Implementation ofWorldProviderImpland definition ofIWorldDispatcherstructThe
WorldProviderImplcorrectly implements thedojo::world::IWorldProviderinterface, and theIWorldDispatcherstruct is correctly defined with a contract address member.
130-223: LGTM! Implementations and definitions related todojo_examples::somethingmoduleThe implementations (
ISomethingImpl,IDojoInitImpl, andUpgradableImpl), interfaces, and events are correctly defined with appropriate functions, inputs, outputs, and state mutability.bin/sozo/src/commands/test.rs (3)
17-19: LGTM! ImportingFeaturesSpecThe import statement for
FeaturesSpecis correctly added.
62-64: LGTM! Addingfeaturesfield toTestArgsstructThe
featuresfield is correctly added to theTestArgsstruct.
76-90: LGTM! Updating compilation unit generation logicThe logic for generating compilation units is correctly updated to consider features.
crates/dojo-lang/src/scarb_internal/mod.rs (3)
18-19: LGTM! ImportingPackageIdThe import statement for
PackageIdis correctly added.
86-90: LGTM! Updatingcompile_workspacefunction signatureThe
compile_workspacefunction signature is correctly updated to include apackagesparameter.
Line range hint
94-108:
LGTM! Updating logic to filter compilation units based on packagesThe logic for filtering compilation units is correctly updated to consider the packages.
examples/spawn-and-move/src/actions.cairo (4)
2-3: Conditional import forContractAddresslooks good.The import statement is correctly conditionally included based on the feature flag
something.
13-14: Conditional functioncall_somethinginIActionstrait looks good.The function is correctly conditionally included based on the feature flag
something.
33-34: Conditional import forISomethingDispatcherandISomethingDispatcherTraitlooks good.The import statement is correctly conditionally included based on the feature flag
something.
133-138: Conditional functioncall_somethinginActionsImplimplementation looks good.The function is correctly conditionally included based on the feature flag
somethingand interacts with theISomethingDispatcher.examples/spawn-and-move/manifests/dev/deployment/manifest.toml (1)
73-86: New contract entry fordojo_examples-somethinglooks good.The entry includes relevant metadata and configuration details.
examples/spawn-and-move/manifests/dev/deployment/abis/contracts/dojo_examples-actions-40b6994c.json (1)
299-310: New functioncall_somethingindojo_examples::actions::IActionsinterface looks good.The function includes the necessary inputs and state mutability.
examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-actions-40b6994c.json (1)
299-310: New functioncall_somethingindojo_examples::actions::IActionsinterface looks good.The function includes the necessary inputs and state mutability.
crates/dojo-test-utils/src/compiler.rs (2)
77-79: Verify workspace reading and package ID collection.The added code reads the workspace and collects package IDs before compilation. Ensure this logic correctly integrates with the rest of the compilation process and handles potential errors.
91-91: Verifycompile_workspacefunction call with new parameter.The
compile_workspacefunction call now includes thepackagesparameter. Ensure this change is correctly handled within the function and verify its impact on the compilation process.bin/sozo/src/commands/build.rs (3)
44-46: Verify newfeaturesfield inBuildArgs.The new
featuresfield is added to theBuildArgsstruct. Ensure this field is correctly defined and integrated, and verify its impact on the build arguments.
87-89: Verifycompile_workspacefunction call withfeaturesparameter.The
compile_workspacefunction call now includes thefeaturesparameter. Ensure this change is correctly handled within the function and verify its impact on the compilation process.
160-173: VerifyDefaultimplementation forBuildArgs.The
Defaultimplementation forBuildArgsnow includes thefeaturesfield. Ensure this implementation correctly initializes the new field and verify its impact on default build arguments.crates/dojo-world/src/manifest/manifest_test.rs (1)
356-359: Verify updated number of elements incontractsfield.The number of elements in the
contractsfield has been updated from 3 to 4. Ensure this change correctly reflects the updated contract specifications and verify its impact on related tests.examples/spawn-and-move/manifests/dev/deployment/manifest.json (4)
1133-1134: New Contract Entry Added.A new
DojoContractentry has been added with the necessary fields and ABI definitions.Ensure that the
address,class_hash, andoriginal_class_hashare correct and match the deployed contract.
1434-1445: New Function Added to IActions Interface.The function
call_somethinghas been added to thedojo_examples::actions::IActionsinterface with the appropriate input parameter and state mutability.Ensure that the function implementation and usage are correctly integrated.
1991-1992: New Contract Entry Added.A new
DojoContractentry has been added with the necessary fields and ABI definitions.Ensure that the
address,class_hash, andoriginal_class_hashare correct and match the deployed contract.
1993-2227: New Contract Entry Added.A new
DojoContractentry has been added with the necessary fields and ABI definitions.Ensure that the
address,class_hash, andoriginal_class_hashare correct and match the deployed contract.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- bin/sozo/tests/test_migrate.rs (1 hunks)
Files skipped from review due to trivial changes (1)
- bin/sozo/tests/test_migrate.rs
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (10)
- bin/sozo/tests/test_migrate.rs (1 hunks)
- examples/spawn-and-move/Scarb.toml (2 hunks)
- examples/spawn-and-move/manifests/dev/base/abis/contracts/dojo_examples-actions-40b6994c.json (1 hunks)
- examples/spawn-and-move/manifests/dev/base/abis/contracts/dojo_examples-something-71cfad55.json (1 hunks)
- examples/spawn-and-move/manifests/dev/base/contracts/dojo_examples-actions-40b6994c.toml (1 hunks)
- examples/spawn-and-move/manifests/dev/base/contracts/dojo_examples-something-71cfad55.toml (1 hunks)
- examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-actions-40b6994c.json (1 hunks)
- examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-something-71cfad55.json (1 hunks)
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-actions-40b6994c.toml (1 hunks)
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-something-71cfad55.toml (1 hunks)
Files skipped from review due to trivial changes (3)
- examples/spawn-and-move/manifests/dev/base/contracts/dojo_examples-actions-40b6994c.toml
- examples/spawn-and-move/manifests/dev/base/contracts/dojo_examples-something-71cfad55.toml
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-something-71cfad55.toml
Files skipped from review as they are similar to previous changes (4)
- bin/sozo/tests/test_migrate.rs
- examples/spawn-and-move/Scarb.toml
- examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-something-71cfad55.json
- examples/spawn-and-move/manifests/release/base/contracts/dojo_examples-actions-40b6994c.toml
Additional comments not posted (3)
examples/spawn-and-move/manifests/dev/base/abis/contracts/dojo_examples-something-71cfad55.json (1)
130-144: New implementation and interface forISomethinglook correct.The new
ISomethingImplandISomethingare consistent with existing structures and naming conventions.examples/spawn-and-move/manifests/dev/base/abis/contracts/dojo_examples-actions-40b6994c.json (1)
301-310: New functioncall_somethinginIActionslooks correct.The new
call_somethingfunction is consistent with existing structures and naming conventions.examples/spawn-and-move/manifests/release/base/abis/contracts/dojo_examples-actions-40b6994c.json (1)
301-310: New functioncall_somethinginIActionslooks correct.The new
call_somethingfunction is consistent with existing structures and naming conventions.
Description
fix: #2010
Tests
Added to documentation?
Checklist
scripts/prettier.sh,scripts/rust_fmt.sh,scripts/cairo_fmt.sh)scripts/clippy.sh,scripts/docs.sh)Summary by CodeRabbit
New Features
Scarb.toml.Improvements
Bug Fixes