[LLDB][SBProgress] Fix bad optional in sbprogress

[Jlalond]

This fixes the obvious, but untested case of sending None/Null to SBProgress. This was an oversight on my part.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Jacob Lalonde (Jlalond)

Changes

This fixes the obvious, but untested case of sending None/Null to SBProgress. This was an oversight on my part.

---

Full diff: https://github.com/llvm/llvm-project/pull/128971.diff

2 Files Affected:

• (modified) lldb/source/API/SBProgress.cpp (+4-1)
• (modified) lldb/test/API/python_api/sbprogress/TestSBProgress.py (+12)

diff --git a/lldb/source/API/SBProgress.cpp b/lldb/source/API/SBProgress.cpp
index e67e289a60eff..d40e11da973d4 100644
--- a/lldb/source/API/SBProgress.cpp
+++ b/lldb/source/API/SBProgress.cpp
@@ -40,7 +40,10 @@ SBProgress::~SBProgress() = default;
 void SBProgress::Increment(uint64_t amount, const char *description) {
   LLDB_INSTRUMENT_VA(amount, description);
 
-  m_opaque_up->Increment(amount, description);
+  std::optional<std::string> description_opt;
+  if (description && description[0])
+    description_opt = description;
+  m_opaque_up->Increment(amount, description_opt);
 }
 
 lldb_private::Progress &SBProgress::ref() const { return *m_opaque_up; }
diff --git a/lldb/test/API/python_api/sbprogress/TestSBProgress.py b/lldb/test/API/python_api/sbprogress/TestSBProgress.py
index c456247da80c6..5f7820a5bd81e 100644
--- a/lldb/test/API/python_api/sbprogress/TestSBProgress.py
+++ b/lldb/test/API/python_api/sbprogress/TestSBProgress.py
@@ -33,3 +33,15 @@ def test_without_external_bit_set(self):
         expected_string = "Test progress first increment"
         progress.Increment(1, expected_string)
         self.assertFalse(listener.PeekAtNextEvent(event))
+
+    def test_with_external_bit_set(self):
+        """Test SBProgress can handle null events."""
+
+        progress = lldb.SBProgress("Test SBProgress", "Test progress", self.dbg)
+        listener = lldb.SBListener("Test listener")
+        broadcaster = self.dbg.GetBroadcaster()
+        broadcaster.AddListener(listener, lldb.eBroadcastBitExternalProgress)
+        event = lldb.SBEvent()
+
+        progress.Increment(1, None)
+        self.assertTrue(listener.PeekAtNextEvent(event))

[dmpots]

So this only calls increment if there is a non-null and non-empty description. Is that the correct behavior? Or should we still be calling increment with a nullopt in that case?

[Jlalond]

No we only set the value of the description optional if non-null, non-empty description. So Increment(1, NULL/None in Python) will bump the count by one but send no message.

[dmpots]

Ah yeah, I read that wrong. Thanks for confirming.

[dmpots]

Would progress.Increment(1, "") map to the case where description[0] == '\0'? If so seems like a cheap test to add.

[Jlalond]

Good callout, I expanded the test case.

[clayborg]

can we test that we receive these events with the correct data here? (get the start event, the 3 increment events with no detail for the first two and then "Step 3" for the 3rd increment, though right now that might come through as an end event?

[dmpots]

LGTM!

[dmpots]

Ah yeah, I read that wrong. Thanks for confirming.