feat: Add --release flag to wasm_builder
#5209
Conversation
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
aoyako
requested review from
s8sato,
mversic,
SamHSmith,
0x009922 and
dima74
as code owners
aoyako
changed the title
--release flag to wasm_builder--release flag to wasm_builder
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
| *) | ||
| echo "error: arg must be 'libs', 'samples', or empty to build both" | ||
| exit 1 |
There was a problem hiding this comment.
Let's reject invalid args so that we don't type e.g. --releas lib and get unintended results
There was a problem hiding this comment.
Changed to --profile={deploy, profiling} and --target={samples, libs}
There was a problem hiding this comment.
Regarding whether named or position-based, either is acceptable but I personally prefer the shorter one
| "--release", | ||
| if self.release { "--release" } else { "" }, |
There was a problem hiding this comment.
I think some CI workflows should keep --release build, at least iroha2-release.yml and maybe iroha2-custom-image.yml @BAStos525 ?
There was a problem hiding this comment.
- it should definitely be
releaseforiroha2-release.yml - for the custom image it should use the
PROFILEvariable
There was a problem hiding this comment.
In iroha2-release.yml we use the tag taken from github.ref_name - it's the tag name. Should any changes be introduced?
There was a problem hiding this comment.
Only *.wasm quality is discussed here, which would only affect e.g. this line
There was a problem hiding this comment.
CI will use release due to the need for additional resources (memory, fuel) and adjusted timeouts. Nevertheless, the debug flag can be set when building WASM.
There was a problem hiding this comment.
CI will use
releasedue to the need for additional resources (memory, fuel) and adjusted timeouts. Nevertheless, the debug flag can be set when building WASM.
I would like CI to use test when testing things and release (or deploy) when deploying. Yes, this will require you to adjust timeouts and limits in the test_network (don't modify parameters in genesis.json)
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
Signed-off-by: Lohachov Mykhailo <[email protected]>
| @@ -51,7 +51,7 @@ jobs: | |||
| with: | |||
| ref: ${{ github.event.inputs.CHECKOUT_REF }} | |||
| - name: Build wasm libs | |||
| run: ./scripts/build_wasm.sh --profile=${{ env.IROHA2_PROFILE }} --target=libs | |||
| run: ./scripts/build_wasm.sh --target=libs | |||
There was a problem hiding this comment.
this was good as it was, why change?
There was a problem hiding this comment.
likewise for other files in CI
There was a problem hiding this comment.
--target=libsis easier to validate since only named arguments are used inbuild_wasm.sh--profile=${{ env.IROHA2_PROFILE }}works fordeploy, but forPROFILE=profiling, it will require changes in memory, fuel, and timeouts. I thinkdeployshould be used everywhere by default.
There was a problem hiding this comment.
- ok, but how is someone to build a custom image with profile
profilingnow?
| @@ -15,7 +16,7 @@ jobs: | |||
| steps: | |||
| - uses: actions/checkout@v4 | |||
| - name: Build wasm libs | |||
| run: ./scripts/build_wasm.sh libs | |||
| run: ./scripts/build_wasm.sh --target=libs | |||
There was a problem hiding this comment.
why change to named argument instead of position based
There was a problem hiding this comment.
It was easier to validate when all arguments were named. I can revert if these must be position-based.
| @@ -22,6 +22,7 @@ env: | |||
| WASM_TARGET_DIR: wasm/target/prebuilt | |||
| TEST_NETWORK_TMP_DIR: /tmp | |||
| NEXTEST_PROFILE: ci | |||
| PROFILE: profiling | |||
There was a problem hiding this comment.
why is this not dev or test?
There was a problem hiding this comment.
also, it seems unused. you should use it to install iroha
There was a problem hiding this comment.
IMO you should use it for cargo install iroha. And you should set it to PROFILE: test
There was a problem hiding this comment.
you will discover then that you need to increase limits because tests will get flaky
There was a problem hiding this comment.
I have no strong opinions on this
There was a problem hiding this comment.
I'm of the opinion that whenever we're running tests we should run the test build
There was a problem hiding this comment.
but on the other hand tests will run slower. We should take that into consideration
There was a problem hiding this comment.
I don't have a very strong opinion on this too.
Speaking of the profile of irohad used by iroha_test_network, since the goal was to have a black-boxed environment close to what final users will have, it could be a point towards using release profile.
Context
Resolves #5202
Problem
The current version of
iroha_wasm_builderhas a--releaseflag set by default for its output.The input
--optimizeflag can be set that will apply-O -Os.Still, it cannot produce a build in
debugmode.Solution
Changes in
iroha_wasm_builderThis PR introduces a single flag
--releasethat:--release -O -Osto the build.Changes in
build_wasm.shNow,
build_wasm.shproduces adebugbuild by default. Flag--releasecan be added to build in optimized mode.Checklist
CONTRIBUTING.md.