Difference between revisions of "Firebug Roadmap"

From FirebugWiki
Jump to: navigation, search
m (Changed issue for Orion Text View)
(Added general strategy)
 
(83 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
* This page is intended to summarize plans and directions for Firebug.next
 
* This page is intended to summarize plans and directions for Firebug.next
 
* This summary should also help [http://groups.google.com/group/firebug-working-group FWG] to prioritize planned steps and features.
 
 
 
* Provide any feedback on Firebug [https://groups.google.com/forum/#!forum/firebug newsgroup]
 
* Provide any feedback on Firebug [https://groups.google.com/forum/#!forum/firebug newsgroup]
  
 +
== Strategy ==
 +
The main goal for the next release of Firebug the will be to integrate it into the Firefox built-in DevTools. Besides this the [[Firebug Working Group]] plans some new features to extend the DevTools with new functionality.
  
== Status ==
+
== Version Numbering ==
Current status of Firebug development.
+
The next planned version number is '''3.0'''.
  
=== Firebug 1.8 ===
+
Development happens on the <code>master</code> branch of the [https://github.com/firebug/firebug.next <code>firebug.next</code>] repository.
Development frozen on this branch.
+
  
=== Firebug 1.9 ===
+
== Schedule ==
[https://addons.mozilla.org/en-US/firefox/addon/firebug/ Firebug 1.9] is the last released version (available on AMO and getfirebug.com) compatible with Firefox 5-11. Selected patches will be back-ported from 1.10.
+
{| class="wikitable" style=""
 
+
=== Firebug 1.10 ===
+
Development happens on [http://getfirebug.com/releases/firebug/1.10/ Firebug 1.10] branch (currently alpha).
+
 
+
 
+
== Goals for Firebug.next ==
+
 
+
* Improve memory footprint & performance
+
* Reuse built-in dev-tools API and components
+
* Innovate features that only Firebug can deliver
+
 
+
 
+
== New Features for 1.10 ==
+
This section lists of all suggested areas FWG should focus on in Firebug 1.10
+
 
+
Regular Tasks:
+
* [http://code.google.com/p/fbug/issues/list?can=2&q=label%3Ablocks-1.10&colspec=ID+Type+Status+Owner+Test+Summary+Reporter&cells=tiles Firebug 1.10 blockers]
+
* Memory leaks ([https://bugzilla.mozilla.org/show_bug.cgi?id=zombiehunter Zombie Hunter] is necessary)
+
** Fixing memory leaks is still the top Firebug priority.
+
 
+
 
+
=== Delayed Firebug Load ===
+
Firebug UI & Logic is mostly running inside an iframe (chrome://firebug/content/firebugFrame.xul). The goal here is to load the content of the iframe on demand at soon as the user needs Firebug the first time.
+
 
+
However there are some pieces that are running within the global Firefox UI (browser.xul) and must be loaded immediately after the browser window is loaded.
+
 
+
* Page context menu (inspector, open with editor)
+
* Firebug global menu (tool, view, web developer, ...)
+
* Firebug start button (Firefox toolbar)
+
* Firebug iframe and a splitter
+
 
+
Firebug iframe content should be automatically loaded when the user presses F12 or uses any command available through an existing menu or a keyboard shortcut. Such functionality requires all global parts to be clearly separated and independent for the Firebug UI itself (the one running in the iframe).
+
 
+
Tasks:
+
* Separate ''Firebug UI'' from ''Global UI'' (create separate directory for global parts)
+
* Create a command dispatcher for global commands that loads Firebug if necessary.
+
* Initialize global UI independently of Firebug availability (e.g. translations)
+
* Adapt to the current
+
 
+
 
+
=== Orion Text View Integration ===
+
The Script panel content (JavaScript text view) should be based on Orion Text View. The goal here is to have syntax coloring and improved performance for huge scripts.
+
 
+
Tasks:
+
* Remove all code related to Script panel content generation (firebug/js/sourceBox module)
+
* Integrate Orion Text View
+
* Create a new Orion breakpoint ruler
+
* Support for tooltips displaying result of and evaluated expressions under the mouse (based on Orion Text Styler)
+
* Part of the integration is also using SourceEditor (Firefox 8+) for multiline console (command editor).
+
 
+
=== Firecookie Integration ===
+
[http://www.softwareishard.com/blog/firecookie/ Firecookie] is a an extension for Firebug that makes possible to view and manage cookies in your browser.
+
 
+
It was required many times to have such functionality included in Firebug by default.
+
 
+
Tasks:
+
* Firecookie code base doesn't support AMD
+
* The code should be divided into more (AMD) modules
+
* Support for backward compatibility can be removed
+
* Blocking [http://code.google.com/p/firecookie/issues/list issues] should be fixed
+
* Firecookie automated tests should be merged into Firebug test list
+
 
+
=== Remote HTTP Monitor ===
+
The Net panel should use [https://wiki.mozilla.org/Remote_Debugging_Protocol Remote Debugging Protocol] (RDP) to communicate with the server side that is performing HTTP monitoring. This should enabled remote HTTP monitoring e.g. for mobile devices.
+
 
+
The server side script should be using the following interfaces (to monitor HTTP):
+
* nsIActivityDistributor
+
* nsIActivityObserver
+
* nsIWebProgressListener (monitors the file:/// protocol)
+
* nsIObserver (monitors ''http-on-*'' events to catch also [http://www.softwareishard.com/blog/firebug/firebug-16-tracking-also-bfcache-reads/ BFCache] responses)
+
* nsITraceableChannel (intercepts response bodies)
+
 
+
Resources:
+
* [http://getfirebug.com/wiki/index.php/Net_Panel_Architecture_Review Net Panel Architecture Review]
+
* [http://getfirebug.com/wiki/index.php/Net_Panel_Remoting Net Panel Remoting]
+
 
+
Tasks:
+
* Define new actors and extend the RDP protocol
+
* Clean separation of the client and server parts
+
* Communication between client and server based on JSON packets
+
* Optimization
+
 
+
 
+
=== Restart-less Firebug Extensions ===
+
There should be a way how to install Firebug and extensions without Firefox restart. Some API related to dynamic registration are already available.
+
 
+
Tasks:
+
* Review API for dynamic adding/removal of panels
+
* Review API for dynamic adding/removal of modules
+
* Review extension example
+
* Update documentation/tutorial
+
 
+
Resources:
+
* http://code.google.com/p/fbug/issues/detail?id=4686
+
 
+
=== JSD2 ===
+
JSD2 (also known as JSDBG2 or JSDBGAPI) represents new API for JS debugging in Firefox.
+
 
+
Jim Blandy and Jason Orendorff are working on a JS implementation of JSD built on top of the JSDBG2 API (a wrapper). This wrapper should be injected into Firebug and make it compatible with JSDBG2. Prototype implementation [http://hg.mozilla.org/users/jblandy_mozilla.com/firebug-on-jsdbg2/ is available] (Firebug 1.9 fork).
+
 
+
Work on this goal depends on how much ready JSD2 is.
+
 
+
TBD
+
 
+
Resources:
+
* [https://wiki.mozilla.org/Debugger Debugger]
+
* [https://wiki.mozilla.org/DevTools/Features/Debugger DevTools Debugger]
+
* [https://wiki.mozilla.org/Remote_Debugging_Protocol Remote Debugging Protocol]
+
 
+
 
+
=== Review Internal File Structure ===
+
If parts break extensions, they will go into 2.0.
+
 
+
Tasks:
+
* Convert last few files into (AMD) modules
+
* Split huge files into more modules
+
* Suggest places/modules that needs refactoring (e.g. TabWatcher)
+
 
+
 
+
=== Style tracing ===
+
The [[CSS Panel]] should offer a different view on CSS properties to allow to find out how a specific value was generated.
+
 
+
Tasks:
+
* Investigate [http://dxr.mozilla.org/mozilla/mozilla-central/browser/devtools/styleinspector/CssLogic.jsm.html built-in CSS API]
+
* Create a new property-based view for the CSS panel using the built-in CSS API
+
** Add option to the CSS panel to toggle between the current view and the property-based view
+
** Add display of assigned properties, which can be expanded to see the trace
+
** Allow disabling of single styles in the trace and the complete style trace
+
 
+
=== New Inspector ===
+
Firebug should reuse the existing built-in Inspector to avoid conflicts with the page styles.
+
 
+
Tasks:
+
* Investigate [http://dxr.mozilla.org/mozilla/mozilla-central/browser/devtools/styleinspector/StyleInspector.jsm.html built-in Inspector API]
+
* Investigate related [http://code.google.com/p/fbug/source/browse/branches/firebug1.10/content/firebug/html/inspector.js Firebug API]
+
* Replace Firebug Inspector
+
 
+
=== Net Panel Improvements ===
+
Proposed Net panel improvements
+
 
+
* Net panel header should not scroll.
+
 
+
 
+
=== HTML entities ===
+
The [[HTML Panel]] needs different options how entities are displayed.
+
 
+
There should be three display options inside the HTML panel's options menu:
+
* Show Entities as Symbols
+
* Show Entities as Names
+
* Show Entities as Unicode
+
 
+
Resources:
+
* [http://code.google.com/p/fbug/issues/detail?id=3159#c23 Undocumented API].
+
 
+
Tasks:
+
* Find out how the API is working exactly
+
* Implement new mapping function in <code>lib/string.js</code> including the API
+
* Implement the new options
+
 
+
 
+
=== Breakpoint Improvements ===
+
Several new features related to breakpoints should be introduced.
+
It should be possible to specify how many times a breakpoint should be hit before it breaks the script execution as well as to create and edit breakpoint conditions in the [[Breakpoints Side Panel]].
+
 
+
Tasks:
+
* Change the Breakpoints side panel to allow inline editing (required for the other tasks)
+
 
+
* Hit count for breakpoints
+
** Implement hit count into debugger
+
** Add hit count to Breakpoints side panel
+
 
+
* Move breakpoint condition editing to the Breakpoints side panel
+
** Add breakpoint condition to Breakpoints side panel
+
** Add context menu to Breakpoint Column containing option to edit the condition
+
 
+
=== Group Console Messages ===
+
Console messages optionally need to be grouped to avoid spamming the [[Console Panel]].
+
 
+
Tasks:
+
* Group error messages
+
* Group messages produced by the 'console' object
+
 
+
 
+
== Implementation ==
+
See the following table that summarizes list of features and dev folks working on them.
+
Append yourself as a developer to features you are interested in to participate.
+
 
+
{| class="wikitable" style="vertical-align:top;"
+
|- bgcolor=lightgrey
+
! style="width:230px" | Feature || style="width:230px" | Developers || Related Issues
+
 
|-  
 
|-  
| Delayed Firebug Load || Honza, Harutyun? || [http://code.google.com/p/fbug/issues/detail?id=4989 Issue 4989]: Separate global UI (browser.xul) from Firebug UI (firebugFrame.xul)
+
! style="width:200px" | Phase || style="width:200px" | Start Date
 
|-  
 
|-  
| Orion Text View || Honza || [http://code.google.com/p/fbug/issues/detail?id=5175 Issue 5175]: Integrate Orion as replacement for the Script panel UI
+
| Alpha || 2014-06-10
 
|-
 
|-
| Firecookie || Honza || TODO
+
| Beta || ?
 
|-
 
|-
| Remote HTTP Monitor || Honza || TODO
+
| Final release || ?
|-
+
| Restart-less Firebug Extensions || Honza || TODO
+
|-
+
| JSD2 || Honza || TODO
+
|-
+
| Review Internal File Structure || Honza, Sebastian || [http://code.google.com/p/fbug/issues/detail?id=4960 Issue 4960]: Review internal file structure
+
|-
+
| Style Tracing || Sebastian || [http://code.google.com/p/fbug/issues/detail?id=2916 Issue 2916]: Trace Styles Feature
+
|-
+
| New Inspector || - || [http://code.google.com/p/fbug/issues/detail?id=4848 Issue 4848]: Create new SVG inspector
+
|-
+
| Net Panel Improvements || - || [http://code.google.com/p/fbug/issues/detail?id=2617 Issue 2617]: Net panel header should be fixed on top instead of scrolling with the content
+
|-
+
| HTML Entities || Sebastian || [http://code.google.com/p/fbug/issues/detail?id=3159 Issue 3159]: Show numeric character reference of MathML
+
|-
+
| Breakpoint Improvements || - || [http://code.google.com/p/fbug/issues/detail?id=4378 Issue 4378]: Move editing of breakpoint conditions to Breakpoints Side Panel
+
[http://code.google.com/p/fbug/issues/detail?id=2817 Issue 2817]: Hit counts for breakpoints
+
|-
+
| Group Console Messages || - || [http://code.google.com/p/fbug/issues/detail?id=4979 Issue 4979]: Group console messages
+
 
|}
 
|}
  
== Further Suggestions ==
+
* The entire release cycle (from the first alpha to the final release) should target 6 months
Please append further suggestions for new 1.10 features in this section so. We'll yet discuss all these suggestions.
+
* The beta phase should be at least 4 weeks
 +
* The new release should introduce 8-10 new features (or significant bug fixes)
  
=== Better user feedback ===
+
== Suggested Features ==
This has been already discussed before. It could be useful to have more feedback from Firebug users and use it for targeted improvements. The feedback should be collected using Testpilot and its related infrustructure and/or through a Firebug extension.
+
Use this section to suggest any feature you'd like to see in Firebug.next.
  
Questions:
+
== Planned Features / Changes ==
* What specific data should be collected?
+
This section summarizes all features that are planned for Firebug.next. Every feature in this section must have an owner.
* What kind of knowledge we can get from the collected data?
+
  
Resources:
+
=== Regular Tasks ===
* [http://code.google.com/p/fbug/issues/detail?id=2633 Issue 2633]: Instrumentation for Firebug aka "Help Improve Firebug"
+
* [https://code.google.com/p/fbug/issues/list?can=2&q=blocks%3D2.0 Firebug 2.0 blockers]
* [http://code.google.com/p/fbug/source/browse/#svn%2Fextensions%2Fbugpilot BugPilot]
+
  
 +
=== Feature Overview ===
 +
{| class="wikitable" style="width: 100%;"
 +
|- bgcolor=lightgrey
 +
! style="width:220px" | Feature || style="width:120px" | Developers || Related Issues || Status
 +
|-
 +
| colspan="4" style="text-align:center;" | TBD
 +
|}
  
=== Mapping of URLs to file system paths ===
+
Feature planning should keep in mind the suggested release schedule above
Firebug currently doesn't have any connection to the server files. Many people don't understand that and they are asking how to achieve that.
+
This change would at least allow mapping between local server URLs and the file system.
+
 
+
Questions:
+
* How is this related to Firediff?
+
  
Resources:
+
=== Feature Description ===
* http://code.google.com/p/fbug/issues/detail?id=5035
+
This section provides detailed description of all planned features.
  
== Open Questions ==
+
== Resources ==
 +
* [[Firebug 2.0 Roadmap]]
  
* Apart from Firecookie integration, are there any other extensions we would like to distribute with Firebug by default? (e.g. EventBug, FireStarter, NetExport, ...).
+
[[Category:Firebug]]
* What further API/Components related to built-in dev tools could be reused by Firebug?
+
[[Category:Firebug Development]]

Latest revision as of 10:27, 6 September 2014

  • This page is intended to summarize plans and directions for Firebug.next
  • Provide any feedback on Firebug newsgroup

Strategy[edit]

The main goal for the next release of Firebug the will be to integrate it into the Firefox built-in DevTools. Besides this the Firebug Working Group plans some new features to extend the DevTools with new functionality.

Version Numbering[edit]

The next planned version number is 3.0.

Development happens on the master branch of the firebug.next repository.

Schedule[edit]

Phase Start Date
Alpha 2014-06-10
Beta  ?
Final release  ?
  • The entire release cycle (from the first alpha to the final release) should target 6 months
  • The beta phase should be at least 4 weeks
  • The new release should introduce 8-10 new features (or significant bug fixes)

Suggested Features[edit]

Use this section to suggest any feature you'd like to see in Firebug.next.

Planned Features / Changes[edit]

This section summarizes all features that are planned for Firebug.next. Every feature in this section must have an owner.

Regular Tasks[edit]

Feature Overview[edit]

Feature Developers Related Issues Status
TBD

Feature planning should keep in mind the suggested release schedule above

Feature Description[edit]

This section provides detailed description of all planned features.

Resources[edit]