[Objectarium] 🐛 fix: compression size decrement on forget_object

[bdeneux]

This PR addresses a minor issue identified in security audit #559.

It introduces a necessary decrement operation for the total_compressed_size within the Bucket Stat in addition to the total_size, when the forget_object message is called. This adjustment ensures accurate tracking of the compressed size, thereby rectifying the discrepancy.

Summary by CodeRabbit

• New Features

  • Introduced support for storing object data with compression settings.

• Bug Fixes

  • Adjusted internal logic to correctly handle compressed sizes and total sizes in various scenarios.

• Tests

  • Updated test cases to include expected_compressed_size and adjusted expected values for count and total size to ensure accuracy.

[coderabbitai]

Walkthrough

The recent changes to the contract.rs file introduce handling for compressed object sizes in the execution logic and test cases. Specifically, the code now adjusts the compressed_size attribute when objects are stored or removed. Additionally, multiple test cases have been updated to include expectations for the compressed_size, and a new test case has been added to verify this functionality.

Changes

File Path	Change Summary
contracts/axone-objectarium/src/contract.rs	Added handling for compressed_size in the execute module and updated test cases to reflect this. A new test case was introduced to ensure correct functionality.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Contract
    participant Storage

    User->>Contract: Store Object
    Contract->>Storage: Save object data with compression
    Storage-->>Contract: Acknowledge save
    Contract->>User: Confirm storage

    User->>Contract: Remove Object
    Contract->>Storage: Delete object data
    Storage-->>Contract: Confirm deletion
    Contract->>User: Confirm removal

Loading

Poem

In the land of code, where bytes do compress,
Objects now shrink, in a tidy process.
Tests are updated, to ensure all is right,
Compression's our friend, making data light.
A new test case shines, in the digital night.
🎩🐰✨

---

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?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[bot-anik]

size-limit report 📦

Path	Size
target/wasm32-unknown-unknown/release/axone_objectarium.wasm	395.21 KB (+0.01% 🔺)
target/wasm32-unknown-unknown/release/axone_law_stone.wasm	596.25 KB (0%)
target/wasm32-unknown-unknown/release/axone_cognitarium.wasm	760.48 KB (0%)
target/wasm32-unknown-unknown/release/axone_dataverse.wasm	621.05 KB (0%)

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ed6cdc and 2aaba9f.

Files selected for processing (1)

• contracts/axone-objectarium/src/contract.rs (11 hunks)

Additional comments not posted (3)

contracts/axone-objectarium/src/contract.rs (3)

232-232: Correctly updated the decrement operation for compressed_size in forget_object.

This change ensures that both the total and compressed sizes are accurately updated, aligning with the security audit findings.

---

2204-2204: Updated test cases to reflect new logic for compressed_size.

The modifications in the test cases correctly reflect the changes in logic for handling compressed_size. Ensure that these tests cover all relevant scenarios, including edge cases where the compressed size might be zero or very large.

Also applies to: 2216-2218, 2233-2235, 2245-2247, 2259-2261, 2273-2275, 2292-2294, 2311-2313, 2332-2334

---

2241-2247: Added a new test case for forget_object focusing on compressed_size.

The new test case effectively tests the decrement operation on compressed_size when an object is forgotten. It's important to ensure that this test case includes assertions for both the total_size and compressed_size to fully validate the changes.

[ccamel]

👍 Thx

[amimart]

Great thx :)