Changes between Version 12 and Version 13 of APP_BUG_REPORT_FORM_R0


Ignore:
Timestamp:
05/20/09 16:24:48 (16 years ago)
Author:
mitex
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • APP_BUG_REPORT_FORM_R0

    v12 v13  
    1010 * A log containing information useful for debugging. This field is read only. 
    1111 * A custom text field containing user explanation on what happened. This is not a required field. 
     12 * A text field for the user's e-mail address. 
    1213 * A warning that user information such as working path and filenames will be sent. 
    1314Behavior: 
    1415 * The bug report form appears automatically when an expected error occurs (exceptions, etc). 
    1516 * The bug report form may be forced by the user using "Help->Send an error report" 
     17The goal of this revision is to provide the client side of bug reporting. (I.e. the bug report couldn't be sent automatically, but can be saved as a file). 
    1618== Task requirements == 
    17  * Define where and how the reports will be sent 
    1819 * Create an extension for the "Send an error report" item for the Help menu. 
    1920 * Implement invoking the Application bug report form automatically on catching an exceptions. 
    … …  
    2223  * Titlebar 
    2324  * Text fields 
    24   * Report and cancel buttons 
    25  * Depending on edition, the report should contain corresponding log file. 
     25   * The content of the e-mail field should be saved in a config file. First time the form is opened, the user enters his/her e-mail address. Next time the field displays the same address. 
     26  * Report button - in next revision 
     27  * Save-as-file button - saves the report as a plain text file (a file dialog is opened and the user selects a path for the file) 
     28  * Cancel button - closes the form without saving or sending the report 
     29 * Bug report contents (in this order): 
     30  * Exception's stack trace if the form is invoked automatically on error. 
     31  * Sophie's log file (currently it is not in distrib directory). 
     32  * System properties such as operating system version, version of Java, ... 
     33  * User's e-mail address. 
     34  * User's explanation (which can be empty). 
    2635 * Titlebar must contain Bug number or exception description. 
    2736== Task result == 
    2837Code. 
    2938== Implementation idea == 
    30 This is a draft diagram. For now, the checkbox is obsolete as it is hard to implement and not much useful. [[BR]] 
     39 * This is a draft diagram. For now, the checkbox is obsolete as it is hard to implement and not much useful. Instead, there is a text field for the e-mail address. [[BR]] 
    3140[[Image(source:trunk/sophie2-platform/doc/spec-diagrams/BugReport.png, 50%)]] 
     41 
     42 * Create a handler for unhandled exceptions. Use {{{Thread.setDefaultUncaughtExceptionHandler}}}. 
     43 
     44 * Save the e-mail address in a config file in distrib directory. In next revisions save it in application's configuration file. 
     45 
     46 * Get the contents of Java system properties like "os.name", "os.arch", "os.version", etc. 
     47 
    3248== Related == 
    3349 
    … …  
    3753== How to demo == 
    3854 * Open Sophie 2. 
    39  * Perform an action that throws an error. 
    40  * Send an error report. 
    41  * Show where the error reports are stored. 
     55 * Perform an action that throws an error (if you don't know such, manually invoke the form by the Help menu). 
     56 * Enter something in the explanation text field. 
     57 * Save the error report in a file. 
     58 * Open the file to show the collected information. 
    4259= Design = 
    4360