chore(napi): make mimalloc optional to build #495

Boshen · 2025-05-05T02:57:19Z

Summary by CodeRabbit

Chores
- Updated build scripts to allow optional use of a custom memory allocator, requiring explicit opt-in.
- Adjusted internal configuration to make the memory allocator feature optional by default.

coderabbitai · 2025-05-05T02:57:26Z

Walkthrough

The changes introduce a new feature flag called allocator in the napi crate, making the mimalloc-safe dependency optional and only used when this feature is enabled. The conditional compilation for the global allocator in Rust is updated to require this feature flag in addition to existing target checks. The build scripts in package.json are adjusted to explicitly enable the allocator feature during release builds, and the postbuild script is renamed for clarity.

Changes

File(s)	Change Summary
napi/Cargo.toml	Made `mimalloc-safe` dependency optional; added `[features]` section with `allocator` feature.
napi/src/lib.rs	Updated global allocator setup to require the `allocator` feature flag in addition to target checks.
package.json	Modified build scripts to use the `allocator` feature for release; renamed `postbuild` script.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BuildScript
    participant Cargo
    participant RustCompiler

    User->>BuildScript: Run build script (with or without --features allocator)
    BuildScript->>Cargo: Invoke cargo build (with selected features)
    Cargo->>RustCompiler: Compile with feature flags
    alt allocator feature enabled and target supported
        RustCompiler->>RustCompiler: Set global allocator to mimalloc_safe
    else
        RustCompiler->>RustCompiler: Use default allocator
    end

Poem

In the warren of code, a new flag appears,
"Allocator" hops in, allaying old fears.
With scripts now aware and dependencies light,
The build grows more nimble, the features just right.
A rabbit applauds with a twitch of its nose—
Optional memory, wherever it goes! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63387e5 and e6abf05.

📒 Files selected for processing (3)

napi/Cargo.toml (1 hunks)
napi/src/lib.rs (1 hunks)
package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

napi/src/lib.rs
package.json
napi/Cargo.toml

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Test (windows-latest)

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Boshen · 2025-05-05T02:57:36Z

chore(napi): make mimalloc optional to build #495 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7f3fa3 and 63387e5.

📒 Files selected for processing (4)

napi/Cargo.toml (1 hunks)
napi/index.js (1 hunks)
napi/src/lib.rs (1 hunks)
package.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Test (windows-latest)

🔇 Additional comments (5)

napi/src/lib.rs (1)

1-6: Feature gate added to global allocator configuration

The change correctly adds the feature = "allocator" condition to the global allocator configuration, making mimalloc usage optional based on the new feature flag.

package.json (1)

26-26: Build script updated to include allocator feature

The build script has been modified to use the new allocator feature flag when building for release. This properly aligns with the changes in Cargo.toml that make mimalloc optional.

napi/Cargo.toml (3)

21-21: Made mimalloc-safe dependency optional on non-Linux platforms

This change correctly makes the mimalloc-safe dependency optional, allowing it to be conditionally included.

24-24: Made mimalloc-safe dependency optional on Linux platforms

This change correctly makes the mimalloc-safe dependency optional on Linux platforms, consistent with the change for other platforms.

29-31: Added feature flag for allocator

The new features section with an empty default set and an explicit allocator feature correctly sets up the optional allocator dependency. This allows users to explicitly enable mimalloc when needed.

napi/index.js

package.json

## 🤖 New release * `oxc_resolver`: 8.0.0 -> 9.0.0 (⚠ API breaking changes) * `oxc_napi_resolver`: 8.0.0 ### ⚠ `oxc_resolver` breaking changes ```text --- failure constructible_struct_adds_field: externally-constructible struct adds field --- Description: A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field. ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/constructible_struct_adds_field.ron Failed in: field ResolveOptions.modules in /tmp/.tmpTBvVad/oxc-resolver/src/options.rs:114 --- failure trait_method_added: pub trait method added --- Description: A non-sealed public trait added a new method without a default implementation, which breaks downstream implementations of the trait ref: https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-item-no-default impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/trait_method_added.ron Failed in: trait method oxc_resolver::CachedPath::module_directory in file /tmp/.tmpTBvVad/oxc-resolver/src/cache.rs:69 trait method oxc_resolver::CachedPath::cached_node_modules in file /tmp/.tmpTBvVad/oxc-resolver/src/cache.rs:76 ``` <details><summary>Changelog</summary> ## `oxc_resolver` <blockquote> ## [9.0.0](oxc_resolver-v8.0.0...oxc_resolver-v9.0.0) - 2025-05-09 ### Bug Fixes - hash import does not need to load from node_modules ([#501](#501)) ### Chore - add `--tsconfig` to example ([#505](#505)) - publish `oxc_napi_resolver` ([#496](#496)) </blockquote> ## `oxc_napi_resolver` <blockquote> ## [8.0.0](https://github.com/oxc-project/oxc-resolver/releases/tag/oxc_napi_resolver-v8.0.0) - 2025-05-09 ### Features - *(napi)* add mimalloc ([#423](#423)) - [**breaking**] Rust Edition 2024 ([#402](#402)) - expose `package_json_path` ([#376](#376)) - *(napi)* expose module type info in ResolveResult ([#223](#223)) - *(napi)* add tracing via `OXC_LOG:DEBUG` ([#202](#202)) - *(napi)* add async API ([#191](#191)) - add `imports_fields` option ([#138](#138)) - add more builder functions for options ([#110](#110)) - *(napi)* support wasi target ([#31](#31)) - add file_dependencies and missing_dependencies API ([#50](#50)) - *(napi)* expose cloneWithOptions and clearCache methods ([#40](#40)) - *(napi)* update the doc and type for tsconfig references ([#24](#24)) - *(napi)* add options ([#19](#19)) - *(resolver)* add tracing-subscriber feature ([#904](https://github.com/oxc-project/oxc-resolver/pull/904)) - *(resolver)* tsconfig project references ([#862](https://github.com/oxc-project/oxc-resolver/pull/862)) - *(resolver)* add thiserror ([#847](#847)) - *(resolver)* implement nested alias field ([#795](#795)) - *(resolver)* implement tsconfig-paths ([#750](#750)) - *(resolver)* implement configurable `exports_fields` option ([#733](#733)) - *(resolver)* implement `main_fields` - *(resolver)* implement resolveToContext ([#694](#694)) - *(resolver)* implement restrictions (path only) ([#693](#693)) - *(resolver)* implement fully specified ([#687](#687)) - *(resolver)* imports field ([#681](#681)) - *(resolver)* finish most of exports field ([#674](#674)) - *(resolver)* port the rest of the exports field tests ([#659](#659)) - *(resolver)* implement symlinks ([#582](#582)) - *(resolver)* complete query and fragment parsing ([#579](#579)) - *(resolver)* add preferRelative and preferAbsolute ([#577](#577)) - *(resolver)* implement roots ([#576](#576)) - *(resolver)* implement fallback ([#572](#572)) - *(resolver)* implement enforceExtension ([#566](#566)) - *(resolver)* implement descriptionFiles option ([#565](#565)) - *(resolver)* implement the basics of path alias ([#564](#564)) - *(resolver)* accept different file system implementations ([#562](#562)) - *(resolver)* implement browser field ([#561](#561)) - *(resolver)* implement scoped packages ([#558](#558)) - *(resolver)* port incorrect description file test ([#557](#557)) - *(resolver)* implement extension_alias ([#556](#556)) - *(resolver)* port resolve tests ([#555](#555)) - *(resolver)* resolve extensions ([#549](#549)) - *(resolver)* add resolver test fixtures ([#542](#542)) ### Bug Fixes - hash import does not need to load from node_modules ([#501](#501)) - *(napi)* `new ResolverFactory()` options should be optional ([#256](#256)) - *(napi)* update buggy NAPI-RS versions ([#225](#225)) - canonicalize is not supported on wasi target ([#124](#124)) - resolve "browser" field when "exports" is present ([#59](#59)) ### Refactor - [**breaking**] remove `description_files` option ([#488](#488)) - [**breaking**] remove `modules` options ([#484](#484)) - vitest ([#380](#380)) - apply latest `cargo +nightly fmt` ([#281](#281)) - selectively parse package_json fields instead of parsing everything ([#103](#103)) - *(resolver)* clean up some code and tests - *(resolver)* change internal funcs to non-pub by moving to unit tests ([#682](#682)) ### Chore - publish `oxc_napi_resolver` ([#496](#496)) - *(napi)* make mimalloc optional to build ([#495](#495)) - *(README)* add wasm usage example - *(README)* crates.io badge use recent downloads - *(napi)* auto download wasm binding on webcontainer ([#471](#471)) - use root package.json for napi build ([#469](#469)) - *(deps)* update github-actions ([#444](#444)) - *(deps)* lock file maintenance npm packages ([#436](#436)) - bump napi ([#404](#404)) - *(deps)* lock file maintenance npm packages ([#391](#391)) - *(deps)* lock file maintenance rust crates ([#390](#390)) - *(README)* clarify Rust and node.js usages - add dprint ([#326](#326)) - *(deps)* update napi-rs to 3.0.0-alpha - `cargo upgrade` && `pnpm upgrade` - *(deps)* update napi-rs to 3.0.0-alpha - update napi changes - *(deps)* update rust crate napi-derive to 3.0.0-alpha - *(deps)* update rust crate napi to 3.0.0-alpha - *(deps)* update napi-rs to 2.16.8 - *(napi)* make napi binary smaller with minimal tracing features ([#213](#213)) - *(napi)* remove tokio ([#212](#212)) - document directory is an absolute path for `resolve(directory, specifier)` ([#206](#206)) - re-enable the wasi build ([#193](#193)) - use pnpm workspace ([#182](#182)) - *(deps)* update rust crates ([#176](#176)) - *(napi)* update NAPI-RS cli version and binding template ([#111](#111)) - update project github url - *(deps)* update pnpm to v8.14.1 ([#52](#52)) - *(deps)* update pnpm to v8.14.0 ([#48](#48)) - *(deps)* update pnpm to v8.13.1 ([#42](#42)) - remove FIXME comments - *(napi)* align `*Fields` user options with enhanced-resolve ([#35](#35)) - *(deps)* update pnpm to v8.12.1 ([#21](#21)) - add some doc for napi TsconfigOptions ([#20](#20)) - *(deps)* update pnpm to v8.12.0 ([#18](#18)) - *(README)* adding debugging command from Rspack - *(deps)* update pnpm to v8.11.0 ([#9](#9)) - *(resolver)* remove tracing_subscriber ([#1362](https://github.com/oxc-project/oxc-resolver/pull/1362)) - *(resolver)* improve documentation ([#591](#591)) ### CI - check for napi .d.index changes ([#491](#491)) - *(release-napi)* support `riscv64gc-unknown-linux-gnu` and `s390x-unknown-linux-gnu` ([#451](#451)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

coderabbitai bot reviewed May 5, 2025

View reviewed changes

napi/index.js Outdated Show resolved Hide resolved

chore(napi): make mimalloc optional to build

e6abf05

Boshen force-pushed the 05-05-chore_make_mimalloc_optional_to_build branch from 63387e5 to e6abf05 Compare May 5, 2025 03:26

graphite-app bot reviewed May 5, 2025

View reviewed changes

package.json Show resolved Hide resolved

Boshen merged commit 6667579 into main May 5, 2025
12 checks passed

Boshen deleted the 05-05-chore_make_mimalloc_optional_to_build branch May 5, 2025 03:28

This was referenced May 5, 2025

chore: release #500

Closed

chore: release #506

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore(napi): make mimalloc optional to build #495

chore(napi): make mimalloc optional to build #495

Boshen commented May 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 5, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Boshen commented May 5, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

chore(napi): make mimalloc optional to build #495

chore(napi): make mimalloc optional to build #495

Conversation

Boshen commented May 5, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Boshen commented May 5, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Boshen commented May 5, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)