Add Backward Compatibility layer (#637)

* Add Attributes BC layer

* Add AttributeLimits BC layer

* Add InstrumentationLibrary BC layer

* Add GlobalLoggerHolder BC layer

* Add triggerMethodDeprecationNotice

* Move Clock BC layer

* Add ResourceInfo BC notices

* Add missing return statement

* Add BC class directory to coverage ignore

* Fix code coverage annotations

Author: tidal

composer.json

@@ -56,9 +56,7 @@
         },
         "files": [
             "src/Context/fiber/initialize_fiber_handler.php",
-            "src/SDK/Common/Time/ClockInterface.php",
-            "src/SDK/Common/Time/AbstractClock.php",
-            "src/SDK/Common/Time/SystemClock.php"
+            "src/SDK/Common/Dev/Compatibility/_load.php"
         ]
     },
     "autoload-dev": {

phpunit.xml.dist

@@ -27,6 +27,9 @@
         <include>
             <directory>src</directory>
         </include>
+        <exclude>
+            <directory suffix=".php">src/SDK/Common/Dev/Compatibility/BC</directory>
+        </exclude>
     </coverage>
 
     <php>

src/SDK/Common/Dev/Compatibility/BC/AbstractClock.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Dev\Compatibility\Util;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
+use OpenTelemetry\SDK\Common\Time\ClockInterface;
+use OpenTelemetry\SDK\Common\Time\Util as TimeUtil;
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+abstract class AbstractClock implements ClockInterface
+{
+    public static function getDefault(): ClockInterface
+    {
+        Util::triggerMethodDeprecationNotice(
+            'OpenTelemetry\SDK\AbstractClock::getDefault',
+            'getDefault',
+            ClockFactory::class
+        );
+
+        return ClockFactory::getDefault();
+    }
+
+    public static function setTestClock(?ClockInterface $clock = null): void
+    {
+        Util::triggerMethodDeprecationNotice(
+            'OpenTelemetry\SDK\AbstractClock::setTestClock',
+            'setDefault',
+            ClockFactory::class
+        );
+
+        ClockFactory::setDefault($clock);
+    }
+
+    public static function nanosToMicro(int $nanoseconds): int
+    {
+        Util::triggerMethodDeprecationNotice(
+            'OpenTelemetry\SDK\AbstractClock::nanosToMicro',
+            'nanosToMicros',
+            TimeUtil::class
+        );
+
+        return TimeUtil::nanosToMicros($nanoseconds);
+    }
+
+    public static function nanosToMilli(int $nanoseconds): int
+    {
+        Util::triggerMethodDeprecationNotice(
+            'OpenTelemetry\SDK\AbstractClock::nanosToMilli',
+            'nanosToMillis',
+            TimeUtil::class
+        );
+
+        return TimeUtil::nanosToMillis($nanoseconds);
+    }
+
+    public static function secondsToNanos(int $seconds): int
+    {
+        Util::triggerMethodDeprecationNotice(
+            'OpenTelemetry\SDK\AbstractClock::secondsToNanos',
+            'nanosToMillis',
+            TimeUtil::class
+        );
+
+        return TimeUtil::nanosToMillis($seconds);
+    }
+}
+
+/**
+ * BC class alias
+ * @todo: remove in future release. Also in composer.json autoload/files.
+ */
+class_alias(AbstractClock::class, 'OpenTelemetry\SDK\AbstractClock');

src/SDK/Common/Dev/Compatibility/BC/AttributeLimits.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Attribute\AttributeLimits as Moved;
+use OpenTelemetry\SDK\Common\Dev\Compatibility\Util;
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+const OpenTelemetry_SDK_AttributeLimits = 'OpenTelemetry\SDK\AttributeLimits';
+
+final class AttributeLimits implements AttributeLimitsInterface
+{
+    private Moved $adapted;
+
+    public function __construct(
+        int $attributeCountLimit = AttributeLimitsInterface::DEFAULT_COUNT_LIMIT,
+        int $attributeValueLengthLimit = AttributeLimitsInterface::DEFAULT_VALUE_LENGTH_LIMIT
+    ) {
+        $this->adapted = new Moved(
+            $attributeCountLimit,
+            $attributeValueLengthLimit
+        );
+        Util::triggerClassDeprecationNotice(
+            OpenTelemetry_SDK_AttributeLimits,
+            Moved::class
+        );
+    }
+
+    public function getAttributeCountLimit(): int
+    {
+        return $this->adapted->getAttributeCountLimit();
+    }
+
+    public function getAttributeValueLengthLimit(): int
+    {
+        return $this->adapted->getAttributeValueLengthLimit();
+    }
+}
+
+class_alias(AttributeLimits::class, OpenTelemetry_SDK_AttributeLimits);
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/AttributeLimitsInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Attribute\AttributeLimitsInterface as Moved;
+
+interface AttributeLimitsInterface extends Moved
+{
+}
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+class_alias(AttributeLimitsInterface::class, 'OpenTelemetry\SDK\AttributeLimitsInterface');
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/Attributes.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Attribute\Attributes as Moved;
+use OpenTelemetry\SDK\Common\Dev\Compatibility\Util;
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+const OpenTelemetry_SDK_Attributes = 'OpenTelemetry\SDK\Attributes';
+
+final class Attributes extends Moved implements AttributesInterface
+{
+    public function __construct(iterable $attributes = [], AttributeLimitsInterface $attributeLimits = null)
+    {
+        parent::__construct($attributes, $attributeLimits);
+
+        Util::triggerClassDeprecationNotice(
+            OpenTelemetry_SDK_Attributes,
+            Moved::class
+        );
+    }
+}
+
+class_alias(Attributes::class, OpenTelemetry_SDK_Attributes);
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/AttributesInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Attribute\AttributesInterface as Moved;
+
+interface AttributesInterface extends Moved
+{
+}
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+class_alias(AttributesInterface::class, 'OpenTelemetry\SDK\AttributesInterface');
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/ClockInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Time\ClockInterface as Moved;
+
+interface ClockInterface extends Moved
+{
+}
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+class_alias(ClockInterface::class, 'OpenTelemetry\SDK\ClockInterface');
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/GlobalLoggerHolder.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Dev\Compatibility\Util;
+use OpenTelemetry\SDK\Common\Log\LoggerHolder as Moved;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+const OpenTelemetry_SDK_GlobalLoggerHolder = 'OpenTelemetry\SDK\GlobalLoggerHolder';
+
+class GlobalLoggerHolder
+{
+    public static function get(): LoggerInterface
+    {
+        self::triggerClassDeprecationNotice();
+
+        return Moved::get();
+    }
+
+    public static function set(LoggerInterface $logger): void
+    {
+        self::triggerClassDeprecationNotice();
+
+        Moved::set($logger);
+    }
+
+    public static function isSet(): bool
+    {
+        self::triggerClassDeprecationNotice();
+
+        return Moved::isSet();
+    }
+
+    public static function unset(): void
+    {
+        self::triggerClassDeprecationNotice();
+
+        Moved::unset();
+    }
+
+    public static function disable(): void
+    {
+        self::triggerClassDeprecationNotice();
+
+        Moved::disable();
+    }
+
+    private static function triggerClassDeprecationNotice(): void
+    {
+        Util::triggerClassDeprecationNotice(
+            OpenTelemetry_SDK_GlobalLoggerHolder,
+            Moved::class
+        );
+    }
+}
+
+class_alias(GlobalLoggerHolder::class, OpenTelemetry_SDK_GlobalLoggerHolder);
+/**
+ * @codeCoverageIgnoreEnd
+ */

src/SDK/Common/Dev/Compatibility/BC/InstrumentationLibrary.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Dev\Compatibility\BC;
+
+use OpenTelemetry\SDK\Common\Dev\Compatibility\Util;
+use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationLibrary as Moved;
+
+/**
+ * @codeCoverageIgnoreStart
+ */
+const OpenTelemetry_SDK_InstrumentationLibrary = 'OpenTelemetry\SDK\InstrumentationLibrary';
+
+final class InstrumentationLibrary implements InstrumentationLibraryInterface
+{
+    private Moved $adapted;
+
+    public function __construct(string $name, ?string $version = null, ?string $schemaUrl = null)
+    {
+        $this->adapted = new Moved($name, $version, $schemaUrl);
+
+        Util::triggerClassDeprecationNotice(
+            OpenTelemetry_SDK_InstrumentationLibrary,
+            Moved::class
+        );
+    }
+
+    public function getName(): string
+    {
+        return $this->adapted->getName();
+    }
+
+    public function getVersion(): ?string
+    {
+        return $this->adapted->getVersion();
+    }
+
+    public function getSchemaUrl(): ?string
+    {
+        return $this->adapted->getSchemaUrl();
+    }
+}
+
+class_alias(InstrumentationLibrary::class, OpenTelemetry_SDK_InstrumentationLibrary);
+/**
+ * @codeCoverageIgnoreEnd
+ */