From 65018a8583e2736ca0a99838b40ac191cdaf5fcb Mon Sep 17 00:00:00 2001
From: Steve Huang <shuang@broadinstitute.org>
Date: Thu, 2 May 2024 22:43:30 -0400
Subject: [PATCH] make submissions folder deletion better (#445)

* make submissions folder deletion better
---
 .../Utility/CleanupIntermediate.wdl           | 43 ++++++++++++++++---
 1 file changed, 36 insertions(+), 7 deletions(-)

diff --git a/wdl/pipelines/TechAgnostic/Utility/CleanupIntermediate.wdl b/wdl/pipelines/TechAgnostic/Utility/CleanupIntermediate.wdl
index f369813c3..d662558ee 100644
--- a/wdl/pipelines/TechAgnostic/Utility/CleanupIntermediate.wdl
+++ b/wdl/pipelines/TechAgnostic/Utility/CleanupIntermediate.wdl
@@ -4,41 +4,70 @@ workflow CleanupIntermediate {
     # Ironicaly, this generates intermeidate files too, but they are tiny.
     meta {
         description: "A workflow to clean up intermediate files from running workflows on Terra. Use at your own risk."
+        warn: "This workflow will delete the whole 'folder's corresponding to each of the specified submissions. So make sure nothing in those are useful anymore."
     }
     parameter_meta {
+        bucket_name: "The workspace bucket name, without the 'gs://' prefix"
         submissionIDs: "List of submissions whose intermediate files are to be deleted"
+        keep_logs: "Whether to keep cromwell log files or not; if true, the process is significantly slower. Default is false."
     }
 
     input {
         String workspace_bucket
         Array[String] submissionIDs
+        Boolean keep_logs = false
     }
 
     scatter (sid in submissionIDs) {
-        call CleanupAFolder {
-            input:
-                bucket_name = workspace_bucket,
-                submission_id = sid
+        call CleanupAFolder { input:
+            bucket_name = workspace_bucket,
+            submission_id = sid,
+            keep_logs = keep_logs
         }
     }
 }
 
 task CleanupAFolder {
+    meta {
+        description: "Clean up intermediate files from running workflows on Terra."
+        warn: "This workflow will delete the whole 'folder' corresponding to the specified submission. So make sure nothing in it is useful anymore."
+    }
+    parameter_meta {
+        bucket_name: "The workspace bucket name, without the 'gs://' prefix"
+        submission_id: "The submission ID whose intermediate files are to be deleted. Will error out if empty."
+        keep_logs: "Whether to keep cromwell log files or not; if true, the process is significantly slower. Default is false."
+    }
     input {
         String bucket_name
         String submission_id
+        Boolean keep_logs = false
     }
 
+    Boolean fail = submission_id == ""
     command <<<
-        timeout 23h gsutil -q rm -rf gs://~{bucket_name}/submissions/~{submission_id} || echo "Timed out. Please try again."
+        if ~{fail}; then echo "Please provide a non-empty submission ID" && exit 1; fi
+        if ~{keep_logs}; then
+            # keep some (presumably) lightweight cromwell log files
+            timeout 23h \
+            gcloud -q storage ls --recursive \
+                gs://~{bucket_name}/submissions/~{submission_id} \
+                | grep -v "*log$" | grep -vF '/stderr' | grep -vF '/stdout' | grep -vF '/script' \
+                | gcloud -q storage rm -r -I \
+            || echo "Timed out. Please try again."
+        else
+            timeout 23h \
+            gcloud -q storage rm \
+                -r gs://~{bucket_name}/submissions/~{submission_id} \
+            || echo "Timed out. Please try again."
+        fi
     >>>
 
     runtime {
         cpu: 1
         memory:  "4 GiB"
         disks: "local-disk 10 HDD"
-        preemptible:     1
-        maxRetries:           1
+        preemptible: 5
+        maxRetries:  1
         docker:"us.gcr.io/google.com/cloudsdktool/google-cloud-cli:alpine"
     }
 }