🧠 add --open option to playground topic consume to dump all topic into a file and open it #6441

Author: vdesabou

scripts/cli/completions.bash

@@ -1177,7 +1177,7 @@ _playground_completions() {
       ;;
 
     *'topic consume'*)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_playground_completions_filter "--grep --help --key-subject --max-characters --max-messages --min-expected-messages --plot-latencies-timestamp-field --tail --timeout --topic --value-subject --verbose -h -t -v")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_playground_completions_filter "--grep --help --key-subject --max-characters --max-messages --min-expected-messages --open --plot-latencies-timestamp-field --tail --timeout --topic --value-subject --verbose -h -o -t -v")" -- "$cur")
       ;;
 
     *'topic produce'*)

scripts/cli/playground

@@ -4784,7 +4784,7 @@ playground_topic_consume_usage() {
     # :flag.usage
     printf "  %s\n" "$(magenta "--tail")"
     printf "    Tail on logs.\n"
-    printf "    %s\n" "Conflicts: --min-expected-messages, --max-messages"
+    printf "    %s\n" "Conflicts: --min-expected-messages, --max-messages, --open"
     echo
 
     # :flag.usage
@@ -4808,6 +4808,12 @@ playground_topic_consume_usage() {
     printf "    %s\n" "Default: 3000"
     echo
 
+    # :flag.usage
+    printf "  %s\n" "$(magenta "--open, -o")"
+    printf "    🔖 Save full dump of topic to a file and open with text editor set with\n    playground config editor <editor> (default is code)\n"
+    printf "    %s\n" "Conflicts: --max-characters, --tail, --min-expected-messages"
+    echo
+
     # :command.usage_fixed_flags
     printf "  %s\n" "$(magenta "--help, -h")"
     printf "    Show this help\n"
@@ -20831,7 +20837,7 @@ playground_container_logs_command() {
 
   if [[ -n "$open" ]]
   then
-    filename="/tmp/${container}-`date '+%Y-%m-%d-%H-%M-%S'`.log"
+    filename="/tmp/${container}-$(date '+%Y-%m-%d-%H-%M-%S').log"
     docker container logs "$container" > "$filename" 2>&1
     if [ $? -eq 0 ]
     then
@@ -21318,6 +21324,7 @@ playground_topic_consume_command() {
   key_subject="${args[--key-subject]}"
   value_subject="${args[--value-subject]}"
   max_characters="${args[--max-characters]}"
+  open="${args[--open]}"
 
   if [[ -n "$key_subject" ]]
   then
@@ -21482,9 +21489,28 @@ playground_topic_consume_command() {
       fi
     fi
 
+    if [[ -n "$open" ]]
+    then
+      filename="/tmp/dump-${topic}-$(date '+%Y-%m-%d-%H-%M-%S').log"
+
+      log "📄 Logging output to $filename"
+      playground topic consume --topic $topic --max-messages -1 > $filename
+      if [ $? -eq 0 ]
+      then
+        playground open --file "${filename}"
+      else
+        logerror "❌ failed to dump topic $topic"
+      fi
+      exit 0
+    fi
+
     if [ -n "$tail" ]
     then
       log "✨ Tailing content of topic $topic"
+    elif [[ -n "$max_messages" ]] && [ $max_messages -eq -1 ] && [[ ! -n "$timestamp_field" ]]
+    then
+      log "✨ --max-messages is set to -1, display content of topic $topic, it contains $nb_messages messages"
+      max_messages=$nb_messages
     elif [[ -n "$max_messages" ]] && [ $nb_messages -ge $max_messages ] && [[ ! -n "$timestamp_field" ]]
     then
       log "✨ Display content of topic $topic, it contains $nb_messages messages, but displaying only --max-messages=$max_messages"
@@ -21502,6 +21528,7 @@ playground_topic_consume_command() {
     then
       log "📈 plotting results.."
     fi
+
     key_type=""
     version=$(curl $sr_security -s "${sr_url}/subjects/${topic}-key/versions/latest" | jq -r .version)
     if [ "$version" != "null" ]
@@ -21695,6 +21722,7 @@ playground_topic_consume_command() {
     first_record=1
     is_base64=0
     export LC_ALL=C
+
     # Loop through each line in the named pipe
     while read -r line
     do
@@ -37519,7 +37547,7 @@ playground_topic_consume_parse_requirements() {
       # :flag.case
       --tail)
         # :flag.conflicts
-        for conflict in --min-expected-messages --max-messages; do
+        for conflict in --min-expected-messages --max-messages --open; do
           if [[ -n "${args[$conflict]:-}" ]]; then
             printf "conflicting options: %s cannot be used with %s\n" "$key" "$conflict" >&2
             exit 1
@@ -37587,6 +37615,21 @@ playground_topic_consume_parse_requirements() {
         fi
         ;;
 
+      # :flag.case
+      --open | -o)
+        # :flag.conflicts
+        for conflict in --max-characters --tail --min-expected-messages; do
+          if [[ -n "${args[$conflict]:-}" ]]; then
+            printf "conflicting options: %s cannot be used with %s\n" "$key" "$conflict" >&2
+            exit 1
+          fi
+        done
+
+        # :flag.case_no_arg
+        args['--open']=1
+        shift
+        ;;
+
       -?*)
         printf "invalid option: %s\n" "$key" >&2
         exit 1

scripts/cli/playground.json

@@ -1940,7 +1940,7 @@
                 "--tail"
               ],
               "argument": "",
-              "description": "Tail on logs.\n\nConflicts with: --min-expected-messages, --max-messages\n"
+              "description": "Tail on logs.\n\nConflicts with: --min-expected-messages, --max-messages, --open\n"
             },
             {
               "names": [
@@ -1969,6 +1969,14 @@
               ],
               "argument": 3000,
               "description": "Max characters per message to display (default is 3000)\n\nDefault value: 3000\n"
+            },
+            {
+              "names": [
+                "--open",
+                "-o"
+              ],
+              "argument": "",
+              "description": "🔖 Save full dump of topic to a file and open with text editor set with playground config editor <editor> (default is code)\n\nConflicts with: --max-characters, --tail, --min-expected-messages\n"
             }
           ]
         },

scripts/cli/playground.yaml

@@ -2091,7 +2091,7 @@ subcommands:
           description: | 
             Tail on logs.
             
-            Conflicts with: --min-expected-messages, --max-messages
+            Conflicts with: --min-expected-messages, --max-messages, --open
             
         - names:
           - --plot-latencies-timestamp-field
@@ -2123,6 +2123,15 @@ subcommands:
             
             Default value: 3000
             
+        - names:
+          - --open
+          - -o
+          argument: ""
+          description: | 
+            🔖 Save full dump of topic to a file and open with text editor set with playground config editor <editor> (default is code)
+            
+            Conflicts with: --max-characters, --tail, --min-expected-messages
+            
       - name: produce
         description: | 
           📤 Produce to a topic

scripts/cli/src/bashly.yml

@@ -2341,7 +2341,7 @@ commands:
         required: false
         help: |-
           Tail on logs.
-        conflicts: [--min-expected-messages, --max-messages]
+        conflicts: [--min-expected-messages, --max-messages, --open]
 
       - long: --plot-latencies-timestamp-field
         required: false
@@ -2377,6 +2377,12 @@ commands:
         help: |-
           Max characters per message to display (default is 3000)
 
+      - long: --open
+        short: -o
+        help: |- 
+          🔖 Save full dump of topic to a file and open with text editor set with playground config editor <editor> (default is code)
+        conflicts: [--max-characters, --tail, --min-expected-messages]
+
     - name: produce
       filters:
       - schema_registry_running

scripts/cli/src/commands/container/logs.sh

@@ -5,7 +5,7 @@ max_wait="${args[--max-wait]}"
 
 if [[ -n "$open" ]]
 then
-  filename="/tmp/${container}-`date '+%Y-%m-%d-%H-%M-%S'`.log"
+  filename="/tmp/${container}-$(date '+%Y-%m-%d-%H-%M-%S').log"
   docker container logs "$container" > "$filename" 2>&1
   if [ $? -eq 0 ]
   then

scripts/cli/src/commands/topic/consume.sh

@@ -9,6 +9,7 @@ timestamp_field="${args[--plot-latencies-timestamp-field]}"
 key_subject="${args[--key-subject]}"
 value_subject="${args[--value-subject]}"
 max_characters="${args[--max-characters]}"
+open="${args[--open]}"
 
 if [[ -n "$key_subject" ]]
 then
@@ -171,9 +172,28 @@ do
     fi
   fi
 
+  if [[ -n "$open" ]]
+  then
+    filename="/tmp/dump-${topic}-$(date '+%Y-%m-%d-%H-%M-%S').log"
+
+    log "📄 dumping topic content to $filename"
+    playground topic consume --topic $topic --max-messages -1 > $filename
+    if [ $? -eq 0 ]
+    then
+      playground open --file "${filename}"
+    else
+      logerror "❌ failed to dump topic $topic"
+    fi
+    exit 0
+  fi
+
   if [ -n "$tail" ]
   then
     log "✨ Tailing content of topic $topic"
+  elif [[ -n "$max_messages" ]] && [ $max_messages -eq -1 ] && [[ ! -n "$timestamp_field" ]]
+  then
+    log "✨ --max-messages is set to -1, display full content of topic $topic, it contains $nb_messages messages"
+    max_messages=$nb_messages
   elif [[ -n "$max_messages" ]] && [ $nb_messages -ge $max_messages ] && [[ ! -n "$timestamp_field" ]]
   then
     log "✨ Display content of topic $topic, it contains $nb_messages messages, but displaying only --max-messages=$max_messages"