creationix / creationix/rx

Add benchmark results in README

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
383
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Hey, the figures in readme sounds interesting, but any claims about figures requires the proofs to make reader consider the figures while decision making.

Let's add the benchmark and publish exact results in readme.

As a potential user of rx I want to know the bootstrap time and to see some measurements against a real use cases.

I propose to measure

  • Initialization time. That is a time needed to convert a file data into a JavaScript object that is ready to use synchronously. It would be nice to have examples with small files (a kilobytes), a middle size files (a few megabytes) and a large files (a few hundred of megabytes).
  • A RAM consumption
  • Access time to an object properties

Also i've just looked at bench.ts, this line looks confusing

https://github.com/creationix/rx/blob/a950102d21a98061ee9335aba9e5f866cb10fe83/bench.ts#L13

It seems the script trying to read the file from a root. I have no user tim on my macbook, so probably the bench will not work for me.
Make sure the benchmark are reproducible. Such slips makes people think the project have been vibe coded by a developer who don't know how thinks does work.

That is very dangerous for credibility, because in case the developer don't know how paths in OS does work, the code may contains the dangerous instructions or even backdoors. Actually because of such slips the DuckDB project is lost all credibility after successfull phishing attack on one of its maintainers.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README and bench.ts, especially the file path referenced at bench.ts line 13, and verify how the benchmark currently locates its input. Define reproducible measurements for initialization, RAM use, and property access across the proposed file sizes, then publish the exact results and usage conditions in README.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, performance
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.