fix: Prevent setting null debuggee ID (#2252)

* fix: Prevent setting null debuggee ID * add test coverage, reorder constructor property settings
googleapis · Aug 16, 2019 · d345456 · d345456
1 parent 23c1c8d
commit d345456
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/Debugger/src/Debuggee.php b/Debugger/src/Debuggee.php
@@ -149,18 +149,19 @@ public function __construct(ConnectionInterface $connection, array $info = [])
             'extSourceContexts' => [],
             'uniquifier' => null,
             'description' => null,
-            'labels' => []
+            'labels' => [],
+            'project' => null
         ];
 
         $this->id = $info['id'];
-        $this->project = $info['project'];
-        $this->uniquifier = $info['uniquifier'];
-        $this->description = $info['description'];
-        $this->status = $info['status'];
-        $this->agentVersion = $info['agentVersion'];
         $this->isInactive = $info['isInactive'];
+        $this->agentVersion = $info['agentVersion'];
+        $this->status = $info['status'];
         $this->extSourceContexts = $info['extSourceContexts'];
+        $this->uniquifier = $info['uniquifier'];
+        $this->description = $info['description'];
         $this->labels = $info['labels'];
+        $this->project = $info['project'];
     }
 
     /**
@@ -367,7 +368,6 @@ public function updateBreakpointBatch(array $breakpoints, array $options = [])
     public function info()
     {
         $info = [
-            'id' => $this->id,
             'project' => $this->project,
             'uniquifier' => $this->uniquifier,
             'description' => $this->description,
@@ -384,6 +384,11 @@ public function info()
             }, $this->extSourceContexts)
         ];
 
+        // Do not include the ID unless it is set.
+        if ($this->id) {
+            $info['id'] = $this->id;
+        }
+
         if ($this->status instanceof StatusMessage) {
             $info['status'] = $this->status->info();
         } elseif ($this->status) {

diff --git a/Debugger/tests/Unit/DebuggeeTest.php b/Debugger/tests/Unit/DebuggeeTest.php
@@ -139,7 +139,7 @@ public function testProvidesDeprecatedSourceContext()
     public function testRegisterSetsDebuggeeId()
     {
         $this->connection->registerDebuggee(Argument::that(function ($args) {
-            return $args['debuggee']['id'] == null;
+            return !isset($args['debuggee']['id']);
         }), Argument::any())->willReturn([
             'debuggee' => [
                 'id' => 'debuggee1'
@@ -167,4 +167,15 @@ public function testDebuggeeExtendedSourceContextSerialization()
         $this->assertArrayHasKey('sourceContexts', $info);
         $this->assertCount(1, $info['sourceContexts']);
     }
+
+    public function testDebuggeeOmitsId()
+    {
+        $debuggee = new Debuggee($this->connection->reveal(), []);
+        $this->assertArrayNotHasKey('id', $debuggee->info());
+
+        $debuggee = new Debuggee($this->connection->reveal(), [
+            'id' => 'foo'
+        ]);
+        $this->assertArrayHasKey('id', $debuggee->info());
+    }
 }