[lldb/Interpreter] Fix session-save-on-quit when using ^D

[mib]

Summary

Previously, when interpreter.save-session-on-quit was enabled, lldb
would save the session transcript only when running the quit command.

This patch changes that so the transcripts are saved when the debugger
object is destroyed if the setting is enabled.

rdar://72902650

Signed-off-by: Med Ismail Bennani <[e-mail]>

[jingham]

Maybe a test?

[JDevlieghere]

lldb/source/Interpreter/CommandInterpreter.cpp

2977

Why eReturnStatusSuccessContinuingResult and not eReturnStatusSuccessFinishNoResult?

[shafik]

lldb/source/Core/Debugger.cpp

611

/*colors=*/true

[mib]

Address @jingham, @JDevlieghere & @shafik comments.

[jingham]

One nit about the handling of colors.

lldb/source/Core/Debugger.cpp

611

Maybe you should get the setting for colors here? If I turn off colors with the use-colors setting, I would be surprised to find them in the session save file.

[jingham]

Shouldn't have also said accepted yet...

[mib]

Address @jingham comment.

[jingham]

Excellent

lldb/source/Commands/CommandObjectQuit.cpp

if (command.GetArgumentCount() == 1) {
     }
   }
 
   const uint32_t event_type =
       CommandInterpreter::eBroadcastBitQuitCommandReceived;
   m_interpreter.BroadcastEvent(event_type);
   result.SetStatus(eReturnStatusQuit);
 
-  if (m_interpreter.GetSaveSessionOnQuit())
-    m_interpreter.SaveTranscript(result);
-
   return true;
 }

lldb/source/Core/Debugger.cpp

 #include "lldb/DataFormatters/DataVisualization.h"
 #include "lldb/Expression/REPL.h"
 #include "lldb/Host/File.h"
 #include "lldb/Host/FileSystem.h"
 #include "lldb/Host/HostInfo.h"
 #include "lldb/Host/Terminal.h"
 #include "lldb/Host/ThreadLauncher.h"
 #include "lldb/Interpreter/CommandInterpreter.h"
+#include "lldb/Interpreter/CommandReturnObject.h"
 #include "lldb/Interpreter/OptionValue.h"
 #include "lldb/Interpreter/OptionValueProperties.h"
 #include "lldb/Interpreter/OptionValueSInt64.h"
 #include "lldb/Interpreter/OptionValueString.h"
 #include "lldb/Interpreter/Property.h"
 #include "lldb/Interpreter/ScriptInterpreter.h"
 #include "lldb/Symbol/Function.h"
 #include "lldb/Symbol/Symbol.h"
DebuggerSP Debugger::CreateInstance(lldb::LogOutputCallback log_callback,
   debugger_sp->InstanceInitialize();
   return debugger_sp;
 }
 
 void Debugger::Destroy(DebuggerSP &debugger_sp) {
   if (!debugger_sp)
     return;
 
+  CommandInterpreter &cmd_interpreter = debugger_sp->GetCommandInterpreter();
+
+  if (cmd_interpreter.GetSaveSessionOnQuit()) {
+    CommandReturnObject result(debugger_sp->GetUseColor());
+    cmd_interpreter.SaveTranscript(result);
+    if (result.Succeeded())
+      debugger_sp->GetOutputStream() << result.GetOutputData() << '\n';
+    else
+      debugger_sp->GetErrorStream() << result.GetErrorData() << '\n';
+  }
+
   debugger_sp->Clear();
 
   if (g_debugger_list_ptr && g_debugger_list_mutex_ptr) {
     std::lock_guard<std::recursive_mutex> guard(*g_debugger_list_mutex_ptr);
     DebuggerList::iterator pos, end = g_debugger_list_ptr->end();
     for (pos = g_debugger_list_ptr->begin(); pos != end; ++pos) {
       if ((*pos).get() == debugger_sp.get()) {
         g_debugger_list_ptr->erase(pos);

lldb/source/Interpreter/CommandInterpreter.cpp

bool CommandInterpreter::SaveTranscript(
   size_t byte_size = m_transcript_stream.GetSize();
 
   Status error = file->Write(m_transcript_stream.GetData(), byte_size);
 
   if (error.Fail() || byte_size != m_transcript_stream.GetSize())
     return error_out("Unable to write to destination file",
                      "Bytes written do not match transcript size.");
 
+  result.SetStatus(eReturnStatusSuccessFinishNoResult);
   result.AppendMessageWithFormat("Session's transcripts saved to %s\n",
                                  output_file->c_str());
 
   return true;
 }
 
 FileSpec CommandInterpreter::GetCurrentSourceDir() {
   if (m_command_source_dirs.empty())

lldb/test/API/commands/session/save/TestSessionSave.py

 """
 Test the session save feature
 """
 import os
+import tempfile
+
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 
 
 class SessionSaveTestCase(TestBase):
 
def test_session_save(self):
         self.assertTrue(len(raw) != 0)
 
         # Check for error
         cmd = 'session save /root/file'
         interpreter.HandleCommand(cmd, res)
         self.assertFalse(res.Succeeded())
         raw += self.raw_transcript_builder(cmd, res)
 
-        import tempfile
         tf = tempfile.NamedTemporaryFile()
         output_file = tf.name
 
         res = lldb.SBCommandReturnObject()
         interpreter.HandleCommand('session save ' + output_file, res)
         self.assertTrue(res.Succeeded())
         raw += self.raw_transcript_builder(cmd, res)
 
def test_session_save(self):
         raw += self.raw_transcript_builder(cmd, res)
 
         with open(os.path.join(td.name, os.listdir(td.name)[0]), "r") as file:
           content = file.read()
           # Exclude last line, since session won't record it's own output
           lines = raw.splitlines()[:-1]
           for line in lines:
             self.assertIn(line, content)
+
+    @skipIfWindows
+    @skipIfReproducer
+    @no_debug_info_test
+    def test_session_save_on_quit(self):
+        raw = ""
+        interpreter = self.dbg.GetCommandInterpreter()
+
+        td = tempfile.TemporaryDirectory()
+
+        settings = [
+          'settings set interpreter.echo-commands true',
+          'settings set interpreter.echo-comment-commands true',
+          'settings set interpreter.stop-command-source-on-error false',
+          'settings set interpreter.save-session-on-quit true',
+          'settings set interpreter.save-session-directory ' + td.name,
+        ]
+
+        for setting in settings:
+          res = lldb.SBCommandReturnObject()
+          interpreter.HandleCommand(setting, res)
+          raw += self.raw_transcript_builder(setting, res)
+
+        self.dbg.Destroy(self.dbg)
+
+        with open(os.path.join(td.name, os.listdir(td.name)[0]), "r") as file:
+          content = file.read()
+          # Exclude last line, since session won't record it's own output
+          lines = raw.splitlines()[:-1]
+          for line in lines:
+            self.assertIn(line, content)
+
+
+