added detail to error message to encourage bug reports to include necessary detail

Author: dave-doty

lib/src/state/app_state.dart

@@ -29,12 +29,7 @@ abstract class AppState implements Built<AppState, AppStateBuilder> {
     if (this.maybe_design != null) {
       return this.maybe_design!;
     } else {
-      throw AssertionError("""\
-You have discovered a bug in scadnano.
-
-Please file a bug report at https://github.com/UC-Davis-molecular-computing/scadnano/issues.
-Include as much detail as possible, including any information currently displayed 
-in the app. Thank you!""");
+      throw AssertionError(util.ASSERTION_ERROR_MESSAGE);
     }
   }
 

lib/src/util.dart

@@ -56,8 +56,12 @@ import 'state/selection_box.dart';
 import 'state/strand.dart';
 import 'actions/actions.dart' as actions;
 
-const ASSERTION_ERROR_MESSAGE = 'You have discovered a bug. Please send this entire error message to\n'
-    '  ${constants.BUG_REPORT_URL}';
+const ASSERTION_ERROR_MESSAGE = '''
+You have discovered a bug. Please file a bug report as a GitHub issue at
+  ${constants.BUG_REPORT_URL}
+Please include as much detail as possible. For instance, it is helpful to upload the design
+you were working on, as well as indicating the steps to reproduce the error. Please also
+into the bug report any additional error information displayed in the app. Thank you!''';
 
 /////////////////////////////////////////////////////////////////////////////
 // interop between Dart and JS
@@ -1238,7 +1242,9 @@ String stack_trace_message_bug_report(stack_trace) {
       '\n**********************************************************************************'
       '\n* If you believe this is due to a bug in scadnano, please file a bug report at   *'
       '\n*   ${constants.BUG_REPORT_URL}${' ' * (77 - constants.BUG_REPORT_URL.length)}*'
-      '\n* Include this entire message in the email.                                      *'
+      '\n* Include this entire message in the email, as well as any detail that may help  *'
+      '\n* us, including uploading the scadnano design, as well as indicating steps to    *'
+      '\n* help us to reproduce the error.                                                *'
       '\n**********************************************************************************'
       '\n\nstack trace:'
       '\n${stack_trace}';

lib/src/view/design_main_error_boundary.dart

@@ -7,6 +7,7 @@ import 'package:over_react/src/component/error_boundary_recoverable.dart';
 import '../app.dart';
 import '../constants.dart' as constants;
 import '../actions/actions.dart' as actions;
+import '../util.dart' as util;
 
 part 'design_main_error_boundary.over_react.g.dart';
 
@@ -61,11 +62,9 @@ class DesignMainErrorBoundaryComponent<T extends DesignMainErrorBoundaryProps,
     if (state.hasError) {
       var error = state.error;
 //      var escaper = HtmlEscape();
-      var escaped_error_message = 'You have discovered a bug in scadnano.  '
-          'Please file a bug report as a GitHub issue at\n'
-          '  ${constants.BUG_REPORT_URL}\n'
-          'and include the following information:\n\n'
-          '${error.toString()}\n\nstack trace:\n${error.stackTrace}' //escaper.convert(
+      var escaped_error_message = util.ASSERTION_ERROR_MESSAGE +
+              '\n\n' +
+              '${error.toString()}\n\nstack trace:\n${error.stackTrace}' //escaper.convert(
           //  )
           ;
 

pubspec.lock

@@ -5,23 +5,23 @@ packages:
     dependency: transitive
     description:
       name: _fe_analyzer_shared
-      sha256: "16e298750b6d0af7ce8a3ba7c18c69c3785d11b15ec83f6dcd0ad2a0009b3cab"
+      sha256: "45cfa8471b89fb6643fe9bf51bd7931a76b8f5ec2d65de4fb176dba8d4f22c77"
       url: "https://pub.dev"
     source: hosted
-    version: "76.0.0"
+    version: "73.0.0"
   _macros:
     dependency: transitive
     description: dart
     source: sdk
-    version: "0.3.3"
+    version: "0.3.2"
   analyzer:
     dependency: "direct main"
     description:
       name: analyzer
-      sha256: "1f14db053a8c23e260789e9b0980fa27f2680dd640932cae5e1137cce0e46e1e"
+      sha256: "4959fec185fe70cce007c57e9ab6983101dbe593d2bf8bbfb4453aaec0cf470a"
       url: "https://pub.dev"
     source: hosted
-    version: "6.11.0"
+    version: "6.8.0"
   archive:
     dependency: transitive
     description:
@@ -66,74 +66,74 @@ packages:
     dependency: transitive
     description:
       name: build
-      sha256: cef23f1eda9b57566c81e2133d196f8e3df48f244b317368d65c5943d91148f0
+      sha256: "80184af8b6cb3e5c1c4ec6d8544d27711700bc3e6d2efad04238c7b5290889f0"
       url: "https://pub.dev"
     source: hosted
-    version: "2.4.2"
+    version: "2.4.1"
   build_config:
     dependency: transitive
     description:
       name: build_config
-      sha256: "4ae2de3e1e67ea270081eaee972e1bd8f027d459f249e0f1186730784c2e7e33"
+      sha256: bf80fcfb46a29945b423bd9aad884590fb1dc69b330a4d4700cac476af1708d1
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.2"
+    version: "1.1.1"
   build_daemon:
     dependency: transitive
     description:
       name: build_daemon
-      sha256: "294a2edaf4814a378725bfe6358210196f5ea37af89ecd81bfa32960113d4948"
+      sha256: "79b2aef6ac2ed00046867ed354c88778c9c0f029df8a20fe10b5436826721ef9"
       url: "https://pub.dev"
     source: hosted
-    version: "4.0.3"
+    version: "4.0.2"
   build_modules:
     dependency: transitive
     description:
       name: build_modules
-      sha256: "5d95f6a500e3cb27eebfb5d264c683ca658fcb39ef73ee403595d7a2b2955a44"
+      sha256: "403ba034d94f1a0f26362fe14fd83e9ff33644f5cbe879982920e3d209650b43"
       url: "https://pub.dev"
     source: hosted
-    version: "5.0.10"
+    version: "5.0.9"
   build_resolvers:
     dependency: transitive
     description:
       name: build_resolvers
-      sha256: "99d3980049739a985cf9b21f30881f46db3ebc62c5b8d5e60e27440876b1ba1e"
+      sha256: "339086358431fa15d7eca8b6a36e5d783728cf025e559b834f4609a1fcfb7b0a"
       url: "https://pub.dev"
     source: hosted
-    version: "2.4.3"
+    version: "2.4.2"
   build_runner:
     dependency: "direct dev"
     description:
       name: build_runner
-      sha256: "74691599a5bc750dc96a6b4bfd48f7d9d66453eab04c7f4063134800d6a5c573"
+      sha256: "028819cfb90051c6b5440c7e574d1896f8037e3c96cf17aaeb054c9311cfbf4d"
       url: "https://pub.dev"
     source: hosted
-    version: "2.4.14"
+    version: "2.4.13"
   build_runner_core:
     dependency: transitive
     description:
       name: build_runner_core
-      sha256: "22e3aa1c80e0ada3722fe5b63fd43d9c8990759d0a2cf489c8c5d7b2bdebc021"
+      sha256: f8126682b87a7282a339b871298cc12009cb67109cfa1614d6436fb0289193e0
       url: "https://pub.dev"
     source: hosted
-    version: "8.0.0"
+    version: "7.3.2"
   build_test:
     dependency: "direct dev"
     description:
       name: build_test
-      sha256: a580c76c28440d0006b75c6746bbbb3c1648959ba9e1afae2c2b0f2c26acdf3d
+      sha256: "260dbba934f41b0a42935e9cae1f5731b94f0c3e489dc97bcf8e281265aaa5ae"
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.3"
+    version: "2.2.2"
   build_web_compilers:
     dependency: "direct dev"
     description:
       name: build_web_compilers
-      sha256: "75a3ce1cd97d2bb13bc0d7321570c390ef795304ca3c6a635716fd9902587a68"
+      sha256: e8d818410cc8b4dc96c4960ce0ab84fe3f2b0ca6576cc130fd7277b56eba9d68
       url: "https://pub.dev"
     source: hosted
-    version: "4.1.0"
+    version: "4.0.11"
   built_collection:
     dependency: "direct main"
     description:
@@ -154,10 +154,10 @@ packages:
     dependency: "direct dev"
     description:
       name: built_value_generator
-      sha256: "6ba3effca656e7f88102142e7d62b71373504d654132ca2895896b3a7013e567"
+      sha256: bb06c5e9dbdbd35ed6de21520e2e5112582c964fa584e2a4bb59887fc7a169b0
       url: "https://pub.dev"
     source: hosted
-    version: "8.9.3"
+    version: "8.9.2"
   checked_yaml:
     dependency: transitive
     description:
@@ -370,10 +370,10 @@ packages:
     dependency: transitive
     description:
       name: macros
-      sha256: "1d9e801cd66f7ea3663c45fc708450db1fa57f988142c64289142c9b7ee80656"
+      sha256: "0acaed5d6b7eab89f63350bccd82119e6c602df0f391260d0e32b5e23db79536"
       url: "https://pub.dev"
     source: hosted
-    version: "0.1.3-main.0"
+    version: "0.1.2-main.4"
   matcher:
     dependency: transitive
     description:
@@ -799,4 +799,4 @@ packages:
     source: hosted
     version: "3.1.3"
 sdks:
-  dart: ">=3.6.0 <3.7.0-z"
+  dart: ">=3.5.0 <3.7.0"