README.md

perf.html development docs

This project is a client for reading profiles from the Gecko Profiler and potentially other sources in the future. It is written using JavaScript and Flow types using React for the UI components and Redux for the state management. The perf.html client interacts with Firefox using the Gecko Profiler add-on. This add-on is the glue between the HTML client of perf.html, and the internal profiler interface in Gecko.

The Docs

• Project architecture docs in /src
  • Redux action creators - /src/actions
  • React components - /src/components
  • Manipulating and processing profiles - /src/profile-logic
  • Redux reducers and selectors - /src/reducers
  • Testing - /src/test
    • React component testing
    • Redux store testing
    • Unit testing
  • Flow types - /src/types
  • Utility files - /src/utils
• Gecko profile format
• Loading in profiles from various sources
• Processed profile format
• Markers
• Upgrading profiles
• Potential performance data sources in Gecko
• Call tree
• Frames, funcs, stacks and CallNodes in C++