Changeset 728 for trunk/gui/scripts/bugreport.tcl

Timestamp:

May 11, 2007, 1:06:36 PM (17 years ago)

Author:

mmc

Message:

Fixed the automatic bug reporting system to avoid reporting bugs caught
in a workspace, or in a tool with an explicit <reportJobFailures> set
to 0. We use this for tools like Spice3F4, where we expect lots of
pilot error.

File:

• trunk/gui/scripts/bugreport.tcl (modified) (4 diffs)

trunk/gui/scripts/bugreport.tcl

@@ -25 +25 @@
     -*-helvetica-bold-r-normal-*-12-* startupFile
 
-namespace eval Rappture::bugreport { # forward declaration }
+namespace eval Rappture::bugreport {
+    # assume that if there's a problem launching a job, we should know it
+    variable reportJobFailures 1
+}
 
 # ----------------------------------------------------------------------
@@ -63 +66 @@
     .bugreport.details.info.text configure -state disabled
 
-    if {[info exists env(RAPPTURE_VERSION)]
-          && $env(RAPPTURE_VERSION) == "current"} {
+    if {[shouldReport for oops]} {
         pack forget .bugreport.details
         pack forget .bugreport.expl
@@ -195 +197 @@
 proc Rappture::bugreport::register {stackTrace} {
     global env tcl_platform
-
-    # if this is a test version, do nothing
-    if {![info exists env(RAPPTURE_VERSION)]
-          || $env(RAPPTURE_VERSION) != "current"} {
-        return
-    }
 
     package require http
@@ -256 +252 @@
 
 # ----------------------------------------------------------------------
+# USAGE: shouldReport jobfailures <boolean>
+# USAGE: shouldReport for ?oops|jobs?
+#
+# Used internally to determine whether or not this system should
+# automatically report errors back to the hosting hub.  Returns 1
+# if the tool should, and 0 otherwise.  The decision is made based
+# on whether this is a current tool in production, whether it is
+# being tested in a workspace, and whether the tool commonly generates
+# problems (by pilot error in its input deck).
+# ----------------------------------------------------------------------
+proc Rappture::bugreport::shouldReport {option value} {
+    global env
+
+    switch -- $option {
+        jobfailures {
+            variable reportJobFailures
+            if {![string is boolean $value]} {
+                error "bad value \"$value\": should be boolean"
+            }
+            set reportJobFailures $value
+        }
+        for {
+            # is this a tool in production?
+            if {![info exists env(RAPPTURE_VERSION)]
+                  || $env(RAPPTURE_VERSION) != "current"} {
+                return 0
+            }
+
+            # is it being run within a workspace?
+            set appname [Rappture::Tool::resources -appname]
+            if {[string match {[Ww]orkspace*} $appname]} {
+                return 0
+            }
+
+            # if this is a problem launching a job and the tool
+            # expects this, then don't bother with automatic reports.
+            variable reportJobFailures
+            if {"jobs" == $value && !$reportJobFailures} {
+                return 0
+            }
+
+            # this is a real problem -- report it!
+            return 1
+        }
+        default {
+            error "bad option \"$option\": should be jobfailures or for"
+        }
+    }
+}
+
+# ----------------------------------------------------------------------
 # Build the bug reporting dialog
 # ----------------------------------------------------------------------