fixing maxBuffer abort

Author: ansibleguy76

docs/_data/help.yaml

@@ -240,6 +240,14 @@
     description: |
       This is not a single variable but rather an infinite amount of variables.  You can set as many as you want.  The dynamic part is the name of the lib data.  For example `YTT_LIB_DATA_MYLIB=values.yml` results in the contents of `values.yml` to be used by ytt in the `mylib` library.
     version: 5.0.8
+  - name: PROCESS_MAX_BUFFER
+    type: number
+    allowed: a valid number
+    short: Maximum buffer size
+    default: 1024 * 1024
+    description: |
+      The maximum buffer size for the process execution.  If you have large output, you might want to increase this value.
+    version: 5.0.8
   - name: LOG_LEVEL
     type: string
     choices:

server/config/app.config.js

@@ -24,6 +24,7 @@ var app_config = {
   enableBypass: (process.env.ENABLE_BYPASS ?? 0)==1,
   enableDbQueryLogging: (process.env.ENABLE_DB_QUERY_LOGGING ?? 0)==1,
   enableFormsYamlInDatabase: (process.env.ENABLE_FORMS_YAML_IN_DATABASE ?? 0)==1,
+  processMaxBuffer: process.env.PROCESS_MAX_BUFFER || (1024 * 1024),
   adminUsername: process.env.ADMIN_USERNAME || "admin",
   adminPassword: process.env.ADMIN_PASSWORD || "AnsibleForms!123"
 };

server/src/controllers/job.controller.js

@@ -12,9 +12,9 @@ exports.abortJob = function(req, res) {
     res.json(new RestResult("error","You must provide a jobid","",""));
     return false
   }
-    Job.abort(jobid)
-     .then((job)=>{res.json(new RestResult("success","job aborted",null,""))})
-     .catch((err)=>{res.json(new RestResult("error","failed to abort job",null,err.toString()))})
+  Job.abort(jobid)
+    .then((job)=>{res.json(new RestResult("success","job aborted",null,""))})
+    .catch((err)=>{res.json(new RestResult("error","failed to abort job",null,err.toString()))})
 };
 exports.getJob = function(req, res) {
   var user = req.user.user

server/src/models/job.model.js

@@ -50,6 +50,7 @@ Exec.executeCommand = (cmd,jobid,counter) => {
   var hiddenExtravarsFileName = cmd.hiddenExtravarsFileName
   var keepExtravars = cmd.keepExtravars
   var task = cmd.task
+  const ac = new AbortController()
 
   // execute the procces
   return new Promise((resolve,reject)=>{
@@ -69,7 +70,13 @@ Exec.executeCommand = (cmd,jobid,counter) => {
         logger.warning("No filename was given")
       }
 
-      var child = exec(command,{cwd:directory,encoding: "UTF-8"});
+      // adding abort signal
+      var child = exec(command,{cwd:directory,signal:ac.signal,maxBuffer:appConfig.processMaxBuffer,encoding: "UTF-8"});
+
+      // capture the abort event, logging only
+      ac.signal.addEventListener('abort', (event) => {
+        logger.warning("Operator aborted the process")
+      }, { once: true });
 
       // add output eventlistener to the process to save output
       child.stdout.on('data',function(data){
@@ -78,8 +85,8 @@ Exec.executeCommand = (cmd,jobid,counter) => {
           .then((status)=>{
             // if abort request found ; kill the process
             if(status=="abort"){
-              logger.warning("Abort is requested, killing child")
-              process.kill(child.pid,"SIGTERM");
+              logger.warning("Abort is requested, aborting child")
+              ac.abort("Aborted by operator")
             }
           })
           .catch((error)=>{logger.error("Failed to create output : ", error)})
@@ -91,18 +98,27 @@ Exec.executeCommand = (cmd,jobid,counter) => {
           .then((status)=>{
             // if abort request found ; kill the process
             if(status=="abort"){
-              logger.warning("Abort is requested, killing child")
-              process.kill(child.pid,"SIGTERM");
+              logger.warning("Abort is requested, aborting child")
+              ac.abort("Aborted by operator")
             }
           })
           .catch((error)=>{logger.error("Failed to create output: ", error)})
       })
+
+
+
       // add exit eventlistener to the process to handle status update
-      child.on('exit',function(data){
+      child.on('exit',async function(data){
         // if the exit was an actual request ; set aborted
         if(child.signalCode=='SIGTERM'){
-          Job.endJobStatus(jobid,++counter,"stderr","aborted",`${task} was aborted by operator`)
-          reject(`${task} was aborted by operator`)
+          const statusResult = await mysql.do("SELECT status FROM AnsibleForms.`jobs` WHERE id=?;", [jobid])      
+          if(statusResult[0].status=="abort"){    
+            Job.endJobStatus(jobid,++counter,"stderr","aborted",`${task} was aborted by the operator`)
+            reject(`${task} was aborted by the operator`)
+          }else{
+            Job.endJobStatus(jobid,++counter,"stderr","failed",`${task} was aborted by the main process.  Likely some buffer or memory error occured.  Also check the maxBuffer option.`)
+            reject(`${task} was aborted by the main process`)
+          }
         }else{ // if the exit was natural; set the jobstatus (either success or failed)
           if(data!=0){
             jobstatus="failed"