Add `profiling` directory for profiling the heap push & pop implementation (related issue #661)

[ericbstie]

Adds a profiling folder so that future profiling is systematic, shared and simplified.

This might not be necessary to merge in really, depending on how much profiling will be done in the future. Your call @ignlg 🤷🏻‍♂️

Summary by CodeRabbit

• New Features
  • Added web-based benchmarks for heap performance, allowing users to test and compare different heap implementations directly in the browser.
• Documentation
  • Introduced a README with instructions for profiling heap operations using browser and command-line tools, including guidance on analyzing performance traces.
• Chores
  • Added new development dependencies to support profiling and benchmarking activities.

[coderabbitai[bot]]

Walkthrough

This update introduces a profiling suite for comparing heap implementations. Two new development dependencies, 0x and heap, are added to the project. A new directory, profiling, is created containing a README with instructions for profiling using both the 0x tool and Chromium's built-in profiler. The directory includes two HTML files for benchmarking the heap and heap-js libraries in the browser, as well as a Node.js script that benchmarks the heap package. The profiling setup is designed for bulk insertion and removal of 100,000 elements to assess performance.

Changes

Files / Paths	Change Summary
package.json	Added 0x and heap as development dependencies.
profiling/0x.mjs	New script for benchmarking the heap package in Node.js by pushing and popping 100,000 elements.
profiling/README.md	New README with instructions for profiling heap implementations using 0x and Chromium tools.
profiling/heap.html, profiling/heap-js.html	Added HTML files for benchmarking heap and heap-js libraries in the browser.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant HeapLib as Heap Library

    User->>Browser: Open heap.html or heap-js.html
    User->>Browser: Click "Run benchmark" button
    Browser->>HeapLib: Create new Heap instance
    loop 100,000 times
        Browser->>HeapLib: Insert random number
    end
    loop 100,000 times
        Browser->>HeapLib: Remove element
    end
    Browser->>User: Log benchmark completion

sequenceDiagram
    participant Developer
    participant NodeJS
    participant HeapPkg as heap package

    Developer->>NodeJS: Run profiling/0x.mjs
    NodeJS->>HeapPkg: Create new Heap instance
    loop 100,000 times
        NodeJS->>HeapPkg: Push integer
    end
    loop 100,000 times
        NodeJS->>HeapPkg: Pop element
    end

Poem

In the warren of code, a new race begins,
With heaps and with numbers, the benchmarking spins.
From browser to Node, we measure and log,
To see which heap's faster—clear through the fog!
With 0x and Chrome, the results we will reap,
Now profiling is easy—just one giant leap!
🐇⏱️

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

[ignlg]

As long as it is not packaged, it is an improvement. Thanks for the initiative.