Merge pull request #2563 from OpenC3/script_states

Fix ScriptRunner handling crashed state

Author: jmthomas

openc3-cosmos-init/plugins/packages/openc3-vue-common/src/tools/scriptrunner/ScriptRunner.vue

@@ -13,7 +13,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -185,7 +185,7 @@
               v-model="stateTimer"
               label="Script State"
               data-test="state"
-              class="shrink ml-2 script-state"
+              :class="['shrink', 'ml-2', 'script-state', stateColorClass]"
               style="max-width: 120px"
               density="compact"
               variant="outlined"
@@ -842,8 +842,30 @@ export default {
       if (this.state === 'waiting' || this.state === 'paused') {
         return `${this.state} ${this.waitingTime}s`
       }
+      // Map completed_errors to completed for display
+      // it will be colored via the stateColorClass
+      if (this.state === 'completed_errors') {
+        return 'completed'
+      }
       return this.state
     },
+    stateColorClass: function () {
+      // All possible states: spawning, init, running, paused, waiting, breakpoint,
+      // error, crashed, stopped, completed, completed_errors, killed
+      if (
+        this.state === 'error' ||
+        this.state === 'crashed' ||
+        this.state === 'killed'
+      ) {
+        return 'script-state-red'
+      } else if (this.state === 'completed_errors') {
+        return 'script-state-orange'
+      } else if (this.state === 'completed') {
+        return 'script-state-green'
+      } else {
+        return ''
+      }
+    },
     // This is the list of files shown in the select dropdown
     fileList: function () {
       // this.files is the list of all files seen while running
@@ -1468,6 +1490,7 @@ export default {
         .then((response) => {
           if (response.data) {
             let state = response.data.state
+            // Check for all the completed states, see is_complete in script_status_model
             if (
               state !== 'completed' &&
               state !== 'completed_errors' &&
@@ -1744,7 +1767,6 @@ export default {
         })
     },
     async scriptComplete() {
-      this.fatal = false
       this.scriptId = null // No current scriptId
       sessionStorage.removeItem('script_runner__script_id')
       this.currentFilename = null // No current file running
@@ -1755,8 +1777,6 @@ export default {
         this.subscription = null
       }
       this.receivedEvents.length = 0 // Clear any unprocessed events
-      // Ensure stopped, if the script has an error we don't get the server stopped message
-      this.state = 'stopped'
 
       await this.reloadFile() // Make sure the right file is shown
       // We may have changed the contents (if there were sub-scripts)
@@ -1847,15 +1867,7 @@ export default {
       }
     },
     stop() {
-      // We previously encountered a fatal error so remove the marker
-      // and cleanup by calling scriptComplete() because the script
-      // is already stopped in the backend
-      if (this.fatal) {
-        this.removeAllMarkers()
-        this.scriptComplete()
-      } else {
-        Api.post(`/script-api/running-script/${this.scriptId}/stop`)
-      }
+      Api.post(`/script-api/running-script/${this.scriptId}/stop`)
     },
     step() {
       Api.post(`/script-api/running-script/${this.scriptId}/step`)
@@ -1914,6 +1926,8 @@ export default {
       this.state = data.state
       const markers = this.editor.session.getMarkers()
       switch (this.state) {
+        // Handle all the script states, see script_status_model for details
+        // spawning, init, running, paused, waiting, breakpoint, error, crashed, stopped, completed, completed_errors, killed
         case 'running':
           this.handleWaiting()
           this.startOrGoDisabled = false
@@ -1930,23 +1944,17 @@ export default {
           this.editor.gotoLine(data.line_no)
           this.files[data.filename].lineNo = data.line_no
           break
-        case 'crashed':
-          this.fatal = true
-        // Deliberate fall through (no break)
         case 'error':
           this.pauseOrRetryButton = RETRY
         // Deliberate fall through (no break)
-        case 'breakpoint':
-        case 'waiting':
+        case 'spawning': // wait for script to be spawned
+        case 'init': // wait for script to initialize
         case 'paused':
+        case 'waiting':
+        case 'breakpoint':
           this.handleWaiting()
-          if (this.state == 'fatal') {
-            this.startOrGoDisabled = true
-            this.pauseOrRetryDisabled = true
-          } else {
-            this.startOrGoDisabled = false
-            this.pauseOrRetryDisabled = false
-          }
+          this.startOrGoDisabled = false
+          this.pauseOrRetryDisabled = false
           this.stopDisabled = false
           let existing = Object.keys(markers).filter(
             (key) => markers[key].clazz === `${this.state}Marker`,
@@ -1966,6 +1974,15 @@ export default {
             }
           }
           break
+        case 'completed':
+        case 'completed_errors':
+        case 'stopped':
+        case 'crashed':
+        case 'killed':
+          this.removeAllMarkers()
+          this.scriptComplete()
+          break
+
         default:
           break
       }
@@ -2016,11 +2033,8 @@ export default {
             this.results.show = true
             break
           case 'complete':
-            // Don't complete on fatal because we just sit there on the fatal line
-            if (!this.fatal) {
-              this.removeAllMarkers()
-              this.scriptComplete()
-            }
+            this.removeAllMarkers()
+            this.scriptComplete()
             break
           case 'step':
             this.showDebug = true
@@ -2323,7 +2337,7 @@ export default {
           {
             okText: 'Continue',
             cancelText: 'Cancel',
-          }
+          },
         )
       }
       return true
@@ -2954,6 +2968,20 @@ hr {
 .script-state :deep(input) {
   text-transform: capitalize;
 }
+
+/* Taken from the various status-symbol-color-fill classes
+   on https://www.astrouxds.com/design-tokens/component/ */
+.script-state-red :deep(input) {
+  color: #ff3838 !important;
+}
+
+.script-state-orange :deep(input) {
+  color: #ffb302 !important;
+}
+
+.script-state-green :deep(input) {
+  color: #56f000 !important;
+}
 </style>
 <style>
 .splitpanes--horizontal > .splitpanes__splitter {
@@ -2998,12 +3026,6 @@ hr {
   z-index: 20;
 }
 
-.fatalMarker {
-  position: absolute;
-  background: rgba(255, 0, 0, 0.5);
-  z-index: 20;
-}
-
 .saving {
   z-index: 20;
   opacity: 0.35;

openc3/lib/openc3/top_level.rb

@@ -26,7 +26,6 @@
 require 'open3'
 require 'openc3/core_ext'
 require 'openc3/version'
-require 'openc3/utilities/logger'
 require 'socket'
 require 'pathname'
 
@@ -107,6 +106,8 @@ def self.add_to_search_path(path, front = true)
     end
   end
 
+  require 'openc3/utilities/logger'
+
   # Creates a marshal file by serializing the given obj
   #
   # @param marshal_filename [String] Name of the marshal file to create