Use DateTime::createFromFormat (#168)

Author: chingor13

src/Trace/DateFormatTrait.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright 2018 OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace OpenCensus\Trace;
+
+/**
+ * Trait which provides helper methods for converting DateTime input formats.
+ */
+trait DateFormatTrait
+{
+    /**
+     * Handles parsing a \DateTimeInterface object from a provided timestamp.
+     *
+     * @param  \DateTimeInterface|int|float $when [optional] The end time of this span.
+     *         **Defaults to** now. If provided as an int or float, it is expected to be a Unix timestamp.
+     * @return \DateTimeInterface
+     * @throws \InvalidArgumentException
+     */
+    private function formatDate($when = null)
+    {
+        if (!$when) {
+            // now
+            $when = $this->formatFloatTimeToDate(microtime(true));
+        } elseif (is_numeric($when)) {
+            $when = $this->formatFloatTimeToDate($when);
+        } elseif (!$when instanceof \DateTimeInterface) {
+            throw new \InvalidArgumentException('Invalid date format. Must be a \DateTimeInterface or numeric.');
+        }
+        $when->setTimezone(new \DateTimeZone('UTC'));
+        return $when;
+    }
+
+    /**
+     * Converts a float timestamp into a \DateTimeInterface object.
+     *
+     * @param float $when The Unix timestamp to be converted.
+     * @return \DateTimeInterface
+     */
+    private function formatFloatTimeToDate($when)
+    {
+        return \DateTime::createFromFormat('U.u', number_format($when, 6, '.', ''));
+    }
+}

src/Trace/Span.php

@@ -27,6 +27,7 @@
 class Span
 {
     use AttributeTrait;
+    use DateFormatTrait;
 
     // See https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/HTTP.md#attributes
     const ATTRIBUTE_HOST = 'http.host';
@@ -331,40 +332,6 @@ public function setStatus($code, $message)
         $this->status = new Status($code, $message);
     }
 
-    /**
-     * Handles parsing a \DateTimeInterface object from a provided timestamp.
-     *
-     * @param  \DateTimeInterface|int|float $when [optional] The end time of this span.
-     *         **Defaults to** now. If provided as an int or float, it is expected to be a Unix timestamp.
-     * @return \DateTimeInterface
-     */
-    private function formatDate($when = null)
-    {
-        if (!$when) {
-            // now
-            $when = $this->formatFloatTimeToDate(microtime(true));
-        } elseif (is_numeric($when)) {
-            $when = $this->formatFloatTimeToDate($when);
-        } elseif (!$when instanceof \DateTimeInterface) {
-            throw new \InvalidArgumentException('Invalid date format. Must be a \DateTimeInterface or numeric.');
-        }
-        $when->setTimezone(new \DateTimeZone('UTC'));
-        return $when;
-    }
-
-    /**
-     * Converts a float timestamp into a \DateTimeInterface object.
-     *
-     * @param float $when The Unix timestamp to be converted.
-     * @return \DateTimeInterface
-     */
-    private function formatFloatTimeToDate($when)
-    {
-        $sec = floor($when);
-        $micro = sprintf("%06d", ($when - $sec) * 1000000);
-        return new \DateTime(date('Y-m-d H:i:s.'. $micro, $sec));
-    }
-
     /**
      * Generate a random ID for this span. Must be unique per trace,
      * but does not need to be globally unique.

src/Trace/TimeEvent.php

@@ -22,6 +22,8 @@
  */
 abstract class TimeEvent
 {
+    use DateFormatTrait;
+
     /**
      * @var \DateTimeInterface The time of this event
      */
@@ -59,16 +61,6 @@ public function time()
      */
     public function setTime($time = null)
     {
-        if (!$time) {
-            list($usec, $sec) = explode(' ', microtime());
-            $micro = sprintf("%06d", $usec * 1000000);
-            $time = new \DateTime(date('Y-m-d H:i:s.' . $micro));
-        } elseif (is_numeric($time)) {
-            // Expect that this is a timestamp
-            $micro = sprintf("%06d", ($time - floor($time)) * 1000000);
-            $time = new \DateTime(date('Y-m-d H:i:s.'. $micro, (int) $time));
-        }
-        $time->setTimezone(new \DateTimeZone('UTC'));
-        $this->time = $time;
+        $this->time = $this->formatDate($time);
     }
 }

tests/unit/Trace/SpanTest.php

@@ -181,9 +181,9 @@ public function timestampFields()
     {
         return [
             ['startTime', 1490737410, '2017-03-28T21:43:30.000000000Z'],
-            ['startTime', 1490737450.4843, '2017-03-28T21:44:10.484299000Z'],
+            ['startTime', 1490737450.484299, '2017-03-28T21:44:10.484299000Z'],
             ['endTime', 1490737410, '2017-03-28T21:43:30.000000000Z'],
-            ['endTime', 1490737450.4843, '2017-03-28T21:44:10.484299000Z'],
+            ['endTime', 1490737450.484299, '2017-03-28T21:44:10.484299000Z'],
         ];
     }
 }