feat: remove memory allocation for max_size_vec

[hansieodendaal]

Description

Removed memory allocation for MaxSizeVec

Motivation and Context

Inefficient memory use when loading many blocks - see below memory usage of empty covenants

• tari_core::covenants::covenant::Covenant::from_bytes
• tari_script::script::TariScript::from_bytes

▼ PP 1/1 (2 children) {
    Total:     41,432,753,986 bytes (100%, 69,571,652.29/s) in 108,158,114 blocks (100%, 181,613.29/s), avg size 383.08 bytes, avg lifetime 120,597,513.57 µs (20.25% of program duration)
    At t-gmax: 22,499,253,266 bytes (100%) in 49,275,839 blocks (100%), avg size 456.6 bytes
    At t-end:  282,701 bytes (100%) in 422 blocks (100%), avg size 669.91 bytes
    Allocated at {
      #0: [root]
    }
  }
  ├─▼ PP 1.1/2 (10 children) {
  │     Total:     41,432,474,135 bytes (100%, 69,571,182.38/s) in 108,121,152 blocks (99.97%, 181,551.22/s), avg size 383.2 bytes, avg lifetime 120,638,475.88 µs (20.26% of program duration)
  │     At t-gmax: 22,499,250,494 bytes (100%) in 49,275,795 blocks (100%), avg size 456.6 bytes
  │     At t-end:  279,339 bytes (98.81%) in 375 blocks (88.86%), avg size 744.9 bytes
  │     Allocated at {
  │       #1: 0x7ff6654e0148: <dhat::Alloc as core::alloc::global::GlobalAlloc>::alloc (???:0:0)
  │     }
  │   }
  │   ├─▶ PP 1.1.1/10 (5 children) {
  │   │     Total:     1,150,169,792 bytes (2.78%, 1,931,303.26/s) in 35,942,806 blocks (33.23%, 60,353.23/s), avg size 32 bytes, avg lifetime 144,977,955.4 µs (24.34% of program duration)
  │   │     At t-gmax: 629,866,560 bytes (2.8%) in 19,683,330 blocks (39.95%), avg size 32 bytes
  │   │     At t-end:  0 bytes (0%) in 0 blocks (0%), avg size 0 bytes
  │   │     Allocated at {
  │   │       ^1: 0x7ff6654e0148: <dhat::Alloc as core::alloc::global::GlobalAlloc>::alloc (???:0:0)
  │   │       #2: 0x7ff66563b67f: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_bytes (???:0:0)
  │   │     }
  │   │   }
  │   ├─▶ PP 1.1.2/10 (2 children) {
  │   │     Total:     1,438,330,674 bytes (3.47%, 2,415,167.52/s) in 9,113,613 blocks (8.43%, 15,303.09/s), avg size 157.82 bytes, avg lifetime 142,637,345.13 µs (23.95% of program duration)
  │   │     At t-gmax: 785,612,379 bytes (3.49%) in 4,908,440 blocks (9.96%), avg size 160.05 bytes
  │   │     At t-end:  1,651 bytes (0.58%) in 14 blocks (3.32%), avg size 117.93 bytes
  │   │     Allocated at {
  │   │       ^1: 0x7ff6654e0148: <dhat::Alloc as core::alloc::global::GlobalAlloc>::alloc (???:0:0)
  │   │       #2: 0x7ff6654e8117: alloc::raw_vec::finish_grow (???:0:0)
  │   │     }
  │   │   }
  │   ├── PP 1.1.3/10 {
  │   │     Total:     18,365,476,864 bytes (44.33%, 30,838,321.08/s) in 8,967,518 blocks (8.29%, 15,057.77/s), avg size 2,048 bytes, avg lifetime 144,960,289.92 µs (24.34% of program duration)
  │   │     Max:       10,052,458,496 bytes in 4,908,427 blocks, avg size 2,048 bytes
  │   │     At t-gmax: 10,052,458,496 bytes (44.68%) in 4,908,427 blocks (9.96%), avg size 2,048 bytes
  │   │     At t-end:  0 bytes (0%) in 0 blocks (0%), avg size 0 bytes
  │   │     Allocated at {
  │   │       ^1: 0x7ff6654e0148: <dhat::Alloc as core::alloc::global::GlobalAlloc>::alloc (???:0:0)
  │   │       #2: 0x7ff6659959a6: tari_core::covenants::covenant::Covenant::from_bytes (???:0:0)
  │   │       #3: 0x7ff665639f18: <tari_core::covenants::serde::CovenantVisitor as serde::de::Visitor>::visit_bytes (???:0:0)
  │   │       #4: 0x7ff66563b986: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_bytes (???:0:0)
  │   │       #5: 0x7ff665637075: serde::de::Visitor::visit_i128 (???:0:0)
  │   │       #6: 0x7ff66563e2bf: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_struct (???:0:0)
  │   │       #7: 0x7ff66563aae0: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_seq (???:0:0)
  │   │       #8: 0x7ff6656375c5: serde::de::Visitor::visit_i128 (???:0:0)
  │   │       #9: 0x7ff66563f149: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_struct (???:0:0)
  │   │       #10: 0x7ff665644452: <sha_p2pool::sharechain::lmdb_block_storage::LmdbBlockStorage as sha_p2pool::sharechain::lmdb_block_storage::BlockCache>::all_blocks (???:0:0)
  │   │     }
  │   │   }
  │   ├── PP 1.1.4/10 {
  │   │     Total:     2,080,464,176 bytes (5.02%, 3,493,403.56/s) in 8,967,518 blocks (8.29%, 15,057.77/s), avg size 232 bytes, avg lifetime 144,960,301.43 µs (24.34% of program duration)
  │   │     Max:       1,138,755,064 bytes in 4,908,427 blocks, avg size 232 bytes
  │   │     At t-gmax: 1,138,755,064 bytes (5.06%) in 4,908,427 blocks (9.96%), avg size 232 bytes
  │   │     At t-end:  0 bytes (0%) in 0 blocks (0%), avg size 0 bytes
  │   │     Allocated at {
  │   │       ^1: 0x7ff6654e0148: <dhat::Alloc as core::alloc::global::GlobalAlloc>::alloc (???:0:0)
  │   │       #2: 0x7ff6659bff4d: tari_script::op_codes::Opcode::parse (???:0:0)
  │   │       #3: 0x7ff6659be753: tari_script::script::TariScript::from_bytes (???:0:0)
  │   │       #4: 0x7ff66552d7b9: <tari_script::serde::<impl serde::de::Deserialize for tari_script::script::TariScript>::deserialize::ScriptVisitor as serde::de::Visitor>::visit_bytes (???:0:0)
  │   │       #5: 0x7ff66563bac6: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_bytes (???:0:0)
  │   │       #6: 0x7ff66563e0df: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_struct (???:0:0)
  │   │       #7: 0x7ff66563aae0: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_seq (???:0:0)
  │   │       #8: 0x7ff6656375c5: serde::de::Visitor::visit_i128 (???:0:0)
  │   │       #9: 0x7ff66563f149: <&mut bincode::de::Deserializer<R,O> as serde::de::Deserializer>::deserialize_struct (???:0:0)
  │   │       #10: 0x7ff665644452: <sha_p2pool::sharechain::lmdb_block_storage::LmdbBlockStorage as sha_p2pool::sharechain::lmdb_block_storage::BlockCache>::all_blocks (???:0:0)
  │   │     }
  │   │   }

How Has This Been Tested?

Not tested

What process can a PR reviewer use to test or verify this change?

Code review

Breaking Changes

• None
• Requires data directory on base node to be deleted
• Requires hard fork
• Other - Please specify

Summary by CodeRabbit

• Refactor
  • Improved dynamic memory handling to optimize resource utilization as new data is added.

[coderabbitai]

Walkthrough

The changes modify how the internal vector is initialized in the MaxSizeVec<T, MAX_SIZE> structure. The new and from_iter methods now use Vec::new() instead of preallocating space with Vec::with_capacity(MAX_SIZE). These modifications adjust the memory allocation behavior from a fixed upfront capacity to dynamic allocation as elements are added.

Changes

File(s)	Change Summary
infrastructure/.../vec.rs	Updated the new and from_iter methods in MaxSizeVec<T, MAX_SIZE> to initialize with Vec::new() rather than using a pre-allocated capacity with Vec::with_capacity(MAX_SIZE).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as MaxSizeVec
    participant V as Vec

    U->>M: Call new() or from_iter()
    Note right of M: Use Vec::new() for initialization
    M->>V: Create a dynamic vector
    V-->>M: Return empty Vec<T>
    M-->>U: Return new instance of MaxSizeVec

Loading

Poem

I'm a happy rabbit with a code delight,
Hoping new vectors will shine so bright,
No preset capacity, just growth on the fly,
Memory expanding as time goes by,
Here's to fresh beginnings in our coding night!

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

infrastructure/max_size/src/vec.rs (1)

47-53: Update the documentation comment to match the implementation

The documentation comment on line 47 states "Creates a new MaxSizeVec with a capacity of MAX_SIZE", but the implementation now uses Vec::new() which starts with a capacity of 0. This change correctly optimizes memory usage by avoiding unnecessary pre-allocation, but the documentation should be updated to reflect this new behavior.

-    /// Creates a new `MaxSizeVec` with a capacity of `MAX_SIZE`.
+    /// Creates a new empty `MaxSizeVec` that can grow up to `MAX_SIZE` elements.
     pub fn new() -> Self {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f1451f5 and 46db12a.

📒 Files selected for processing (1)

• infrastructure/max_size/src/vec.rs (2 hunks)

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

• GitHub Check: cargo check with stable
• GitHub Check: Cucumber tests / FFI
• GitHub Check: Cucumber tests / Base Layer
• GitHub Check: test (testnet, esmeralda)
• GitHub Check: test (nextnet, nextnet)
• GitHub Check: test (mainnet, stagenet)
• GitHub Check: ci

🔇 Additional comments (1)

infrastructure/max_size/src/vec.rs (1)

179-194: LGTM - Consistent memory optimization in from_iter

The change to use Vec::new() instead of pre-allocating with capacity is consistent with the optimization in the new() method. This will reduce memory usage when processing collections where most instances contain fewer elements than MAX_SIZE, which aligns with the PR objectives to address memory consumption issues.

[github-actions]

Test Results (CI)

    3 files    129 suites   46m 26s ⏱️
1 353 tests 1 353 ✅ 0 💤 0 ❌
4 057 runs  4 057 ✅ 0 💤 0 ❌

Results for commit 46db12a.

[github-actions]

Test Results (Integration tests)

36 tests  +36   36 ✅ +36   15m 56s ⏱️ + 15m 56s
11 suites +11    0 💤 ± 0 
 2 files   + 2    0 ❌ ± 0 

Results for commit 46db12a. ± Comparison against base commit f1451f5.