rustwasm/wee_alloc

Add ability to log allocations/frees for easily reporting bugs

Open

#8 opened on Feb 2, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (46 forks)github user discovery
assignedhelp wantedmentored

Repository metrics

Stars
 (711 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Summary

We would write all allocations and frees into a buffer that we periodically flush to a file. When people report a bug, they could enable this feature, and provide their log.

Motivation

Easier to file bugs. Easier to reproduce bugs. Therefore, easier to fix bugs.

Details

  • Behind a cargo feature.

  • I guess we could use std::io::BufWriter, and say that this feature requires std

  • Ideally this would use the same operation definitions in ./test, so we could trivially turn them into regression tests. Also, shrink them to get reduced test cases.

Contributor guide

Research direction
Study the existing test operations in the 'test' directory and implement a buffered logging mechanism behind a cargo feature.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75