Use Stackdriver V2 from PR branch (#75)

Author: chingor13

composer.json

@@ -20,10 +20,16 @@
     "require-dev": {
         "phpunit/phpunit": "4.8.*",
         "squizlabs/php_codesniffer": "2.*",
-        "google/cloud-trace": "^0.3",
+        "google/cloud": "dev-trace-v2",
         "twig/twig": "~2.0",
         "symfony/yaml": "~3.3"
     },
+    "repositories": [
+        {
+            "type": "git",
+            "url": "https://github.com/chingor13/google-cloud-php"
+        }
+    ],
     "conflict": {
         "ext-opencensus": ">= 0.1.0"
     },

src/Trace/Exporter/StackdriverExporter.php

@@ -20,9 +20,9 @@
 use Google\Cloud\Core\Batch\BatchRunner;
 use Google\Cloud\Core\Batch\BatchTrait;
 use Google\Cloud\Trace\TraceClient;
-use Google\Cloud\Trace\TraceSpan;
+use Google\Cloud\Trace\Span;
+use Google\Cloud\Trace\Trace;
 use OpenCensus\Trace\Tracer\TracerInterface;
-use OpenCensus\Trace\Span;
 
 /**
  * This implementation of the ExporterInterface use the BatchRunner to provide
@@ -88,7 +88,6 @@ class StackdriverExporter implements ExporterInterface
     const HTTP_URL = '/http/url';
     const HTTP_USER_AGENT = '/http/user_agent';
     const PID = '/pid';
-    const STACKTRACE = '/stacktrace';
     const TID = '/tid';
 
     const GAE_APPLICATION_ERROR = 'g.co/gae/application_error';
@@ -157,16 +156,16 @@ public function __construct(array $options = [])
     public function report(TracerInterface $tracer)
     {
         $this->processSpans($tracer);
-        $spans = $this->convertSpans($tracer);
+        $trace = self::$client->trace(
+            $tracer->spanContext()->traceId()
+        );
+        $spans = $this->convertSpans($tracer, $trace);
 
         if (empty($spans)) {
             return false;
         }
 
         // build a Trace object and assign Spans
-        $trace = self::$client->trace(
-            $tracer->spanContext()->traceId()
-        );
         $trace->setSpans($spans);
 
         try {
@@ -196,53 +195,28 @@ public function processSpans(TracerInterface $tracer, $headers = null)
     /**
      * Convert spans into Zipkin's expected JSON output format.
      *
-     * @param  TracerInterface $tracer
+     * @param TracerInterface $tracer
+     * @param Trace $trace
      * @return array Representation of the collected trace spans ready for serialization
      */
     public function convertSpans(TracerInterface $tracer)
     {
-        // transform OpenCensus Spans to Google\Cloud\Spans
-        return array_map(function ($span) {
-            $attributes = $span->attributes();
-            $attributes[self::STACKTRACE] = $this->formatBacktrace($span->stackTrace());
-            return new TraceSpan([
+        $traceId = $tracer->spanContext()->traceId();
+
+        // transform OpenCensus Spans to Google\Cloud\Trace\Spans
+        return array_map(function ($span) use ($traceId) {
+            return new Span($traceId, [
                 'name' => $span->name(),
                 'startTime' => $span->startTime(),
                 'endTime' => $span->endTime(),
-                'spanId' => hexdec($span->spanId()),
-                'parentSpanId' => $span->parentSpanId() ? hexdec($span->parentSpanId()) : null,
-                'labels' => $attributes
+                'spanId' => $span->spanId(),
+                'parentSpanId' => $span->parentSpanId(),
+                'attributes' => $span->attributes(),
+                'stackTrace' => $span->stackTrace()
             ]);
-            $span->info();
         }, $tracer->spans());
     }
 
-    private function formatBacktrace($st)
-    {
-        return json_encode([
-            'stack_frame' => array_map([$this, 'mapStackframe'], $st)
-        ]);
-    }
-
-    private function mapStackframe($sf)
-    {
-        // file and line should always be set
-        $data = [];
-        if (isset($sf['line'])) {
-            $data['line_number'] = $sf['line'];
-        }
-        if (isset($sf['file'])) {
-            $data['file_name'] = $sf['file'];
-        }
-        if (isset($sf['function'])) {
-            $data['method_name'] = $sf['function'];
-        }
-        if (isset($sf['class'])) {
-            $data['class_name'] = $sf['class'];
-        }
-        return $data;
-    }
-
     /**
      * Returns an array representation of a callback which will be used to write
      * batch items.

tests/unit/Trace/Exporter/StackdriverExporterTest.php

@@ -26,7 +26,7 @@
 use OpenCensus\Trace\Span as OpenCensusSpan;
 use Prophecy\Argument;
 use Google\Cloud\Trace\Trace;
-use Google\Cloud\Trace\TraceSpan;
+use Google\Cloud\Trace\Span;
 use Google\Cloud\Trace\TraceClient;
 
 /**
@@ -55,11 +55,11 @@ public function testFormatsTrace()
 
         $this->assertCount(3, $spans);
         foreach ($spans as $span) {
-            $this->assertInstanceOf(TraceSpan::class, $span);
+            $this->assertInstanceOf(Span::class, $span);
             $this->assertInternalType('string', $span->name());
-            $this->assertInternalType('int', $span->spanId());
-            $this->assertRegExp('/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{9}Z/', $span->info()['startTime']);
-            $this->assertRegExp('/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{9}Z/', $span->info()['endTime']);
+            $this->assertInternalType('string', $span->spanId());
+            $this->assertRegExp('/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{9}Z/', $span->jsonSerialize()['startTime']);
+            $this->assertRegExp('/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{9}Z/', $span->jsonSerialize()['endTime']);
         }
     }
 
@@ -82,23 +82,6 @@ public function testReportWithAnExceptionErrorLog()
         $this->assertFalse($reporter->report($tracer));
     }
 
-    public function testHandlesKind()
-    {
-        $tracer = new ContextTracer(new SpanContext('testtraceid'));
-        $tracer->inSpan(['name' => 'main'], function () use ($tracer) {
-            $tracer->inSpan(['name' => 'span1'], 'usleep', [1]);
-            $tracer->inSpan(['name' => 'span2'], 'usleep', [1]);
-            $tracer->inSpan(['name' => 'span3'], 'usleep', [1]);
-            $tracer->inSpan(['name' => 'span4'], 'usleep', [1]);
-        });
-
-        $reporter = new StackdriverExporter(['client' => $this->client->reveal()]);
-        $spans = $reporter->convertSpans($tracer);
-
-        $this->assertCount(5, $spans);
-        $this->assertEquals(TraceSpan::SPAN_KIND_UNSPECIFIED, $spans[0]->info()['kind']);
-    }
-
     /**
      * @dataProvider attributeHeaders
      */
@@ -131,7 +114,7 @@ public function attributeHeaders()
         ];
     }
 
-    public function testStacktraceAttribute()
+    public function testStacktrace()
     {
         $stackTrace = [
             [
@@ -148,20 +131,7 @@ public function testStacktraceAttribute()
         $reporter = new StackdriverExporter(['client' => $this->client->reveal()]);
         $spans = $reporter->convertSpans($tracer);
 
-        $attributes = $spans[0]->info()['labels'];
-        $this->assertArrayHasKey('/stacktrace', $attributes);
-
-        $expected = [
-            'stack_frame' => [
-                [
-                    'file_name' => '/path/to/file.php',
-                    'line_number' => 1234,
-                    'method_name' => 'asdf',
-                    'class_name' => 'Foo'
-                ]
-            ]
-        ];
-        $data = json_decode($attributes['/stacktrace'], true);
-        $this->assertEquals($expected, $data);
+        $data = $spans[0]->jsonSerialize();
+        $this->assertArrayHasKey('stackTrace', $data);
     }
 }