feat: enable no_opt_arch flag for mimalloc-safe on linux-aarch64
#98
Conversation
WalkthroughThis set of changes updates various aspects of the project across workflow configuration, benchmarking, dependency management, test structure, and scripting. The release workflow is modified to trigger on pull requests to the main branch and to always run the build job. The benchmarking code renames a resolver function for clarity. Dependency versions and conditional compilation expressions for the Changes
Sequence Diagram(s)sequenceDiagram
participant TestRunner as Node.js Test Runner
participant Resolver as unrs_resolver
participant FS as File System
TestRunner->>Resolver: create resolver instance
TestRunner->>Resolver: resolve deeply nested package.json (recursive symlink)
Resolver->>FS: follow symlinks, resolve path
FS-->>Resolver: resolved real path
Resolver-->>TestRunner: return resolved path
TestRunner->>TestRunner: assert resolved path matches expected
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (7)
🚧 Files skipped from review as they are similar to previous changes (7)
⏰ Context from checks skipped due to timeout of 90000ms (6)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR enables mimalloc on Linux/aarch64 by introducing the "no_opt_arch" flag and updating the dependency configurations accordingly. Other changes include refactoring test and benchmark paths to use newly defined directories and renaming resolver helper functions for clarity.
- Updated directory resolution in tests for more reliable path joins.
- Modified mimalloc-safe cfg attributes and dependency conditions in Cargo.toml.
- Renamed resolver function calls in benchmarks for consistency.
- Adjusted GitHub workflow triggers.
Reviewed Changes
Copilot reviewed 6 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| napi/tests/resolver.test.mjs | Refactored directory path variables to improve fixture location resolution. |
| napi/src/lib.rs | Updated #[cfg] attribute to enable mimalloc on Linux/aarch64 with new flag. |
| napi/Cargo.toml | Adjusted dependency conditions and updated mimalloc-safe version/features. |
| benches/resolver.rs | Renamed resolver function calls from oxc_resolver to unrs_resolver. |
| .github/workflows/release-napi.yml | Added a pull_request trigger on main and commented out a conditional build step. |
Files not reviewed (3)
- justfile: Language not supported
- npm/package.json: Language not supported
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
napi/src/lib.rs:1
- The top comment in lib.rs still indicates that mimalloc is disabled for Linux/aarch64, but the configuration now enables it via the no_opt_arch flag. Please update the comment to accurately reflect the current behavior.
// Disable mimalloc on ARM, FreeBSD, WASM, and Linux/aarch64 due to known allocator issues (see #64).
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
no_opt_arch flag for mimalloc-safe with linux-aarch64no_opt_arch flag for mimalloc-safe on linux-aarch64
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #98 +/- ##
=======================================
Coverage 93.40% 93.40%
=======================================
Files 13 13
Lines 2865 2865
=======================================
Hits 2676 2676
Misses 189 189 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #98 will not alter performanceComparing Summary
|
There was a problem hiding this comment.
Caution
Changes requested ❌
Reviewed everything up to bf6a63d in 2 minutes and 23 seconds. Click for details.
- Reviewed
270lines of code in8files - Skipped
1files when reviewing. - Skipped posting
12draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. benches/resolver.rs:104
- Draft comment:
Renamed resolver function to unrs_resolver for consistency. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is purely informative, stating that a function was renamed for consistency. It does not provide any actionable feedback or suggestions for improvement.
2. napi/Cargo.toml:25
- Draft comment:
Updated mimalloc-safe version and cfg conditions for linux-aarch64 to include 'no_opt_arch'. Ensure this change has been well tested on Linux ARM64. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to ensure that the change has been well tested, which violates the rule against asking for confirmation or testing. It does not provide a specific suggestion or point out a specific issue with the code.
3. napi/src/lib.rs:2
- Draft comment:
Removed linux-aarch64 exclusion in the global allocator attribute. Confirm allocator stability on linux-aarch64 as referenced in Illegal instruction error - Raspberry PI 4 aarch64 #64. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to confirm allocator stability on linux-aarch64, which violates the rule against asking the author to confirm or ensure behavior. It does not provide a specific code suggestion or ask for a specific test to be written.
4. napi/tests/resolver.test.mjs:16
- Draft comment:
Path variables (like fixturesDir and pnpmDir) are now explicitly defined for test clarity; verify that these paths correctly align with project structure. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to verify that the paths align with the project structure, which is a form of asking for confirmation or verification. This violates the rule against asking the PR author to confirm or ensure things. The comment does not provide a specific suggestion or point out a clear issue, so it should be removed.
5. npm/package.json:51
- Draft comment:
Bumped napi-postinstall version to ^0.1.6; ensure version bump is intentional for compatibility. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is about a version bump of a dependency, which is not allowed according to the rules. The comment asks the author to ensure the version bump is intentional, which is also not allowed.
6. napi/src/lib.rs:1
- Draft comment:
Comment outdated: The header still mentions disabling mimalloc on Linux/aarch64, but now the build enables it using no_opt_arch. Please update the comment accordingly. - Reason this comment was not posted:
Marked as duplicate.
7. napi/Cargo.toml:25
- Draft comment:
Good update: The targets for Linux now correctly separate aarch64 with the additional 'no_opt_arch' flag. Verify that these cfg expressions match intended platforms. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
8. benches/resolver.rs:10
- Draft comment:
Renamed resolver helper from 'oxc_resolver' to 'unrs_resolver' consistently. Ensure all related tooling/tests correctly reference the new name. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
9. justfile:12
- Draft comment:
Initialization script updated. Verify that the reordering of cargo binstall dependencies doesn’t affect tool installation order. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
10. npm/package.json:48
- Draft comment:
napi-postinstall version bump to ^0.1.6 looks appropriate; please ensure compatibility with the latest resolver binary. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
11. napi/tests/resolver.test.mjs:266
- Draft comment:
Consider renaming the test title from 'resolve recursive symbol link' to 'resolve recursive symlink' for clarity and consistency with common terminology. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% While the suggestion is technically correct (symlink is the proper term), this is a very minor naming issue that doesn't affect functionality. The current name is still understandable. The comment is about changed code (new test), but it's more of a nitpick than a substantial improvement. Test names are primarily for developer readability and documentation. The change would make the code slightly more accurate and professional. Test names are important for documentation and maintainability. However, the current name is still clear enough to understand the test's purpose, and this kind of minor terminology correction doesn't warrant a review comment. While technically correct, this comment is too minor and doesn't meet the bar for "clearly a code change required." The existing test name is functional and clear enough.
12. npm/package.json:44
- Draft comment:
Typo detected in the target platform name on line 44: 'wasm32-wasip1-threads'. It likely should be 'wasm32-wasi-threads' (if this is what you intended). Please review this entry. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_A0eSzyHxjSmkB9vy
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
napi/src/lib.rs (1)
1-2: Update the comment to match the implementation.The comment on line 1 includes "Linux/aarch64" as a platform where mimalloc is disabled, but the updated code on line 2 no longer disables mimalloc on Linux/aarch64. The comment should be updated to match the implementation.
-// Disable mimalloc on ARM, FreeBSD, WASM, and Linux/aarch64 due to known allocator issues (see #64). +// Disable mimalloc on ARM, FreeBSD, and WASM due to known allocator issues (see #64).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
Cargo.lockis excluded by!**/*.lockpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (7)
.github/workflows/release-napi.yml(2 hunks)benches/resolver.rs(4 hunks)justfile(2 hunks)napi/Cargo.toml(1 hunks)napi/src/lib.rs(1 hunks)napi/tests/resolver.test.mjs(3 hunks)npm/package.json(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
napi/tests/resolver.test.mjs (1)
Learnt from: JounQin
PR: unrs/unrs-resolver#40
File: src/tests/resolve.rs:121-136
Timestamp: 2025-03-29T04:14:03.715Z
Learning: For tests involving npm/yarn package resolution in the unrs-resolver project, dependencies must be installed first using the appropriate package manager commands (pnpm i, yarn) in both the root directory and fixture directories like fixtures/pnp and fixtures/misc/nested-package-json.
⏰ Context from checks skipped due to timeout of 90000ms (18)
- GitHub Check: Upload coverage file
- GitHub Check: Package x86_64-apple-darwin
- GitHub Check: Package wasm32-wasip1-threads
- GitHub Check: Package aarch64-apple-darwin
- GitHub Check: Package riscv64gc-unknown-linux-musl
- GitHub Check: Package s390x-unknown-linux-gnu
- GitHub Check: Package riscv64gc-unknown-linux-gnu
- GitHub Check: Package aarch64-unknown-linux-musl
- GitHub Check: Package powerpc64le-unknown-linux-gnu
- GitHub Check: Package armv7-unknown-linux-musleabihf
- GitHub Check: Package x86_64-unknown-linux-musl
- GitHub Check: Package aarch64-pc-windows-msvc
- GitHub Check: Package x86_64-pc-windows-msvc
- GitHub Check: Package i686-pc-windows-msvc
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Test (windows-latest)
- GitHub Check: zizmor
- GitHub Check: Benchmark
🔇 Additional comments (14)
npm/package.json (1)
52-52: Dependency version update looks good.The update to
napi-postinstallfrom^0.1.5to^0.1.6aligns with changes in the release workflow that you've made in.github/workflows/release-napi.yml.justfile (2)
13-13: Tool installation order change looks fine.Reordering the tools in the
initcommand to installcargo-shearfirst doesn't affect functionality.
55-55: Good addition to test command.Adding
pnpm testto run JavaScript/Node tests alongside the existing Rust tests makes the test suite more comprehensive. This ensures both Rust and Node.js aspects of the project are properly tested..github/workflows/release-napi.yml (2)
12-14: Enhancement to workflow triggers.Adding pull requests targeting the
mainbranch as a trigger is a good practice. This allows you to catch build issues earlier in the development process, before changes are merged into the main branch.
48-48: Verify if unconditional build is intentional.You've commented out the conditional check that previously only ran the build job if the version changed. This means the build job will now run unconditionally on all workflow triggers, which could increase CI usage. Is this intentional?
Note that the
build-freebsdjob at line 141 still has the conditional check.benches/resolver.rs (2)
104-104: Function rename for consistency.Renaming from
oxc_resolvertounrs_resolverimproves consistency with the project name.
151-151: Consistently updated all function references.All references to the renamed function have been properly updated throughout the benchmark code.
Also applies to: 160-161, 168-169, 177-178, 189-190, 193-194
napi/tests/resolver.test.mjs (4)
18-21: Good refactoring of directory paths!I like the introduction of
rootDirandfixturesDirconstants to improve code maintainability and reduce duplication. This makes path management more consistent throughout the test file.
236-237: Well-defined PNPM directory constantThe addition of
pnpmDirconstant helps standardize references to the.pnpmdirectory across test assertions. This makes the code more maintainable and easier to update if directory structures change.
266-279: Good addition of recursive symlink resolution testThis new test case is valuable as it verifies the resolver can correctly handle recursive symbolic links in a monorepo setup, which is a common pattern in PNPM workspaces. The test aligns well with the path refactoring changes.
However, I'm curious about the relationship between this test and the PR objective of enabling the
no_opt_archflag formimalloc-safewithlinux-aarch64. Could you clarify if this test is meant to verify functionality on that platform or if it's an unrelated improvement?
248-249: Consistent path references using the new constantsThe path references in assertions have been correctly updated to use the new
pnpmDirconstant, maintaining consistency throughout the test file. This change improves maintainability.Also applies to: 255-257, 262-263
napi/src/lib.rs (1)
2-4:❓ Verification inconclusive
Allocator configuration change looks good.
This change enables the MiMalloc allocator for Linux/aarch64 platform which aligns with the PR's objective to use mimalloc-safe with the
no_opt_archflag on this platform.To verify that mimalloc is correctly enabled for Linux/aarch64 and all other platforms are configured as expected:
🏁 Script executed:
#!/bin/bash echo "Checking conditional compilation for global allocator in lib.rs" rg "#\[cfg\(not\(any\(target_arch = \"arm\", target_os = \"freebsd\", target_family = \"wasm\"\)\)\)\]" napi/src/lib.rs -A 2 echo -e "\nChecking current target platform to see if it's affected:" rustc --version --verbose | grep hostLength of output: 697
Allocator is correctly configured with
mimalloc_safe
I’ve confirmed thatnapi/src/lib.rscontains the expected conditional compilation and global allocator:#[cfg(not(any(target_arch = "arm", target_os = "freebsd", target_family = "wasm")))] #[global_allocator] static ALLOC: mimalloc_safe::MiMalloc = mimalloc_safe::MiMalloc;This matches the PR’s intent to enable MiMalloc on supported platforms. Since
rustcisn’t available in this environment, please verify locally that your host triple (fromrustc --version --verbose | grep host) falls under this cfg (e.g.x86_64-unknown-linux-gnuoraarch64-unknown-linux-gnu).napi/Cargo.toml (2)
19-20: Improved target configuration expression.The target configuration has been simplified by using
not(any(...))instead of multiple nested conditions, which is more readable. The update to the mimalloc-safe version from 0.1.50 to 0.1.51 is also appropriate.
22-26:✅ Verification successful
Correctly implemented platform-specific configurations.
The changes split the Linux target configuration into two parts:
- Linux on non-ARM, non-aarch64 platforms with standard features
- Linux on aarch64 with the additional
no_opt_archfeatureThis change aligns with the PR objective to enable
no_opt_archflag for mimalloc-safe specifically on Linux/aarch64 platforms.Let's verify the versions and features of the mimalloc-safe crate:
🏁 Script executed:
#!/bin/bash echo "Checking mimalloc-safe version and features:" cargo metadata --format-version 1 | jq '.packages[] | select(.name == "mimalloc-safe") | {version: .version, features: .features}' echo -e "\nVerifying the no_opt_arch feature is available in mimalloc-safe:" rg -A 3 "feature.*no_opt_arch" $(cargo metadata --format-version 1 | jq -r '.packages[] | select(.name == "mimalloc-safe") | .manifest_path') || echo "Feature not found in manifest" echo -e "\nChecking issue #64 to understand the allocator issues:" gh issue view 64 --json title,body,comments --repo unrs/unrs-resolverLength of output: 4318
🏁 Script executed:
#!/usr/bin/env bash echo "Fetching mimalloc-safe 0.1.51 features from crates.io API..." curl -s https://crates.io/api/v1/crates/mimalloc-safe/0.1.51 | jq '.version.features' echo -e "\nChecking if \"no_opt_arch\" is a valid feature key..." curl -s https://crates.io/api/v1/crates/mimalloc-safe/0.1.51 | jq '.version.features | has("no_opt_arch")'Length of output: 923
Approved: mimalloc-safe platform configurations validated
- Linux (non-ARM, non-aarch64): uses
skip_collect_on_exit,local_dynamic_tls- Linux/aarch64: additionally enables
no_opt_arch- Confirmed on crates.io that
mimalloc-safev0.1.51 defines and exposes theno_opt_archfeature
bf6a63d to
cf87758
Compare
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed cf87758 in 1 minute and 59 seconds. Click for details.
- Reviewed
270lines of code in8files - Skipped
1files when reviewing. - Skipped posting
16draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. .github/workflows/release-napi.yml:48
- Draft comment:
Commented-out condition for version change: verify if build should always run now. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is asking the PR author to verify if the build should always run due to a commented-out condition for a version change. This falls under asking the author to confirm or verify something, which is against the rules.
2. Cargo.lock:575
- Draft comment:
Dependency versions are bumped; ensure backward compatibility with consumers. - Reason this comment was not posted:
Confidence changes required:30%<= threshold50%None
3. benches/resolver.rs:104
- Draft comment:
Renamed oxc_resolver() to unrs_resolver() for consistency; consider reusing a single resolver instance across benchmarks if state is immutable. - Reason this comment was not posted:
Comment looked like it was already resolved.
4. justfile:13
- Draft comment:
Tool installation order updated; verify that cargo-shear and others are correctly installed. - Reason this comment was not posted:
Confidence changes required:20%<= threshold50%None
5. napi/Cargo.toml:25
- Draft comment:
mimalloc-safe condition updated: note the new aarch64 flag 'no_opt_arch' for Linux. Verify that this resolves known issues. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%The comment is purely informative, mentioning a new flag and asking to verify if it resolves known issues. It doesn't provide a specific code suggestion or ask for a specific test to be written. It violates the rule against asking the PR author to verify or ensure behavior.
6. napi/src/lib.rs:1
- Draft comment:
Global allocator cfg modified (linux-aarch64 now allowed); double-check that allocation issues are resolved with new mimalloc-safe features. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is asking the PR author to double-check allocation issues, which violates the rule against asking for confirmation or double-checking. It doesn't provide a specific suggestion or point out a specific issue.
7. napi/tests/resolver.test.mjs:242
- Draft comment:
Test case for pnpm package updated to use new directory paths. Confirm expected paths match updated pnpm structure. - Reason this comment was not posted:
Confidence changes required:50%<= threshold50%None
8. npm/package.json:49
- Draft comment:
napi-postinstall dependency updated to ^0.1.6; ensure postinstall script remains compatible. - Reason this comment was not posted:
Confidence changes required:30%<= threshold50%None
9. Cargo.lock:575
- Draft comment:
Bump versions for libmimalloc-sys2 and mimalloc-safe. Verify compatibility with the new no_opt_arch flag and ensure tests pass. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
10. benches/resolver.rs:101
- Draft comment:
Rename function from 'oxc_resolver' to 'unrs_resolver' for consistency with package naming; all references have been updated. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
11. justfile:12
- Draft comment:
Updated tool installation order and added a Yarn command in the install step. Confirm that the new order doesn’t break any dependency prerequisites. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
12. napi/Cargo.toml:25
- Draft comment:
Updated mimalloc-safe dependency configuration to enable the 'no_opt_arch' flag for Linux/aarch64. Verify that this resolves allocator issues on that target. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
13. napi/src/lib.rs:1
- Draft comment:
Global allocator is now enabled on Linux/aarch64 by removing it from the exclusion list. Ensure mimalloc-safe’s behavior with the new flag is stable on this target. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
14. napi/tests/resolver.test.mjs:16
- Draft comment:
Adjusted fixture paths and added a new test for resolving recursive symlink links. Verify that PNPM package resolution paths match the expected structure. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
15. npm/package.json:48
- Draft comment:
Upgrade napi-postinstall dependency to ^0.1.6. Confirm that the new postinstall script behavior is as expected. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%None
16. napi/tests/resolver.test.mjs:266
- Draft comment:
Minor typographical suggestion: In the test description 'resolve recursive symbol link', consider using 'resolve recursive symbolic link' for better clarity and to align with standard terminology. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While "symbolic link" is indeed the more correct technical term, this is a very minor terminology issue in a test description. The current term "symbol link" is still understandable and doesn't affect the functionality. Test descriptions are primarily for developer readability and don't impact the code behavior. The comment is technically correct - "symbolic link" is the proper term. Poor terminology in tests could confuse future developers. However, this is an extremely minor issue that doesn't affect functionality or significantly impact understanding. The rules state not to make purely informative comments or obvious/unimportant suggestions. Delete this comment as it's too minor and purely informative, not suggesting any meaningful code changes.
Workflow ID: wflow_JdaAXirqPILkj1Tz
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
|
related #64
Important
Enable
no_opt_archflag formimalloc-safeonlinux-aarch64and update dependencies and tests.no_opt_archflag formimalloc-safeonlinux-aarch64inCargo.tomlandlib.rs.resolver.test.mjs.oxc_resolver()tounrs_resolver()inresolver.rs.resolver.test.mjs.mimalloc-safeto version0.1.51andnapi-postinstallto0.1.6inCargo.lockandpackage.json.release-napi.ymlto run on pull requests targeting the main branch.justfileto include JavaScript/Node tests.This description was created by
for cf87758. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Chores
mimalloc-safeandnapi-postinstallto newer versions.