Fix compatibility with main package (#34)

* Fix compatibility with main package

* Use SemConv\ResourceAttributes in AWS tests

* Use correct PHP version in psalm runs

* Use mikey179/vfsstream

* Add AWS tests

* Add .env file

* Use different PHP versions in make

* Add PHP 8.1 to test matrix

* Add PHP 8.1 to test matrix

* Fix filesystem tests

* Fix style

* Use correct PHP version for psalm runs

* Add Integration Tests

* Remove debug output

* Fix typo

Author: tidal

.env.dist

@@ -0,0 +1,2 @@
+PHP_USER=php
+XDEBUG_MODE=debug

.github/workflows/php.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['7.4', '8.0']
+        php-versions: ['7.4', '8.0', '8.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -55,13 +55,16 @@ jobs:
       run: vendor/bin/phan
 
     - name: Run Psalm
-      run: vendor/bin/psalm --output-format=github
+      run: vendor/bin/psalm --output-format=github --php-version=${{ matrix.php-versions }}
 
     - name: Run Phpstan
       run: vendor/bin/phpstan analyse --error-format=github
 
-    - name: Run PHPUnit
+    - name: Run Unit Tests
       run: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 
+    - name: Run Integration tests
+      run: vendor/bin/phpunit --coverage-text tests/Integration
+
     - name: Code Coverage
       run: bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -15,3 +15,4 @@ phpstan.neon
 tests/TraceContext/W3CTestService/test_app
 tests/TraceContext/W3CTestService/trace-context
 
+/.env

Makefile

@@ -1,21 +1,25 @@
+PHP_VERSION ?= 7.4
 DC_RUN_PHP = docker-compose run --rm php
 
+all: update style phan psalm phpstan test
 install:
-	$(DC_RUN_PHP) composer install
+	$(DC_RUN_PHP) env XDEBUG_MODE=off composer install
 update:
-	$(DC_RUN_PHP) composer update
+	$(DC_RUN_PHP) env XDEBUG_MODE=off composer update
 test:
-	$(DC_RUN_PHP) php ./vendor/bin/phpunit --colors=always --coverage-text --testdox --coverage-clover coverage.clover
+	$(DC_RUN_PHP) env XDEBUG_MODE=coverage vendor/bin/phpunit --colors=always --coverage-text --testdox --coverage-clover coverage.clover
+test-coverage:
+	$(DC_RUN_PHP) env XDEBUG_MODE=coverage vendor/bin/phpunit --colors=always --testdox --coverage-html=tests/coverage/html
 phan:
-	$(DC_RUN_PHP) env PHAN_DISABLE_XDEBUG_WARN=1 php ./vendor/bin/phan
+	$(DC_RUN_PHP) env XDEBUG_MODE=off env PHAN_DISABLE_XDEBUG_WARN=1 vendor/bin/phan
 psalm:
-	$(DC_RUN_PHP) php ./vendor/bin/psalm
+	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/psalm --threads=1 --no-cache --php-version=${PHP_VERSION}
 psalm-info:
-	$(DC_RUN_PHP) php ./vendor/bin/psalm --show-info=true
-phpstan: 
-	$(DC_RUN_PHP) php ./vendor/bin/phpstan analyse
+	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/psalm --show-info=true --threads=1
+phpstan:
+	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/phpstan analyse
 bash:
 	$(DC_RUN_PHP) bash
 style:
-	$(DC_RUN_PHP) php ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --using-cache=no -vvv
+	$(DC_RUN_PHP) env XDEBUG_MODE=off vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --using-cache=no -vvv
 FORCE:

README.md

@@ -8,30 +8,13 @@ For more information, please, consult the documentation of the main [OpenTelemet
 ## Installation
 The recommended way to install the library is through [Composer](http://getcomposer.org):
 
-1.)  Install the composer package using [Composer's installation instructions](https://getcomposer.org/doc/00-intromd#installation-linux-unix-macos).
-
-2.)  Add
-```bash
-    "minimum-stability": "dev",
-    "prefer-stable": true,
-    "repositories": [
-        {
-            "type": "vcs",
-            "url": "https://github.com/open-telemetry/opentelemetry-php-contrib"
-        }
-    ],
-```
-
-To your project's `composer.json` file, as this utility has not reached a stable release status yet, 
-and is not yet registered on packagist.org
-
-3.)  Install the dependency with composer:
+Install the package:
 
 ```bash
 $ composer require open-telemetry/opentelemetry-php-contrib
 ```
 
-## Usage/Examples
+## Usage/Examples   
 
 ### AWS
 - You can find examples on how to use the ASW classes in the  [examples directory](/examples/aws/README.md).

composer.json

@@ -11,16 +11,10 @@
     ],
     "minimum-stability": "dev",
     "prefer-stable": true,
-    "repositories": [
-        {
-          "type": "vcs",
-          "url": "https://github.com/open-telemetry/opentelemetry-php"
-        }
-      ],
     "require": {
         "php": "^7.4 || ^8.0",
         "ext-json": "*",
-        "open-telemetry/opentelemetry": "dev-main",
+        "open-telemetry/opentelemetry": "^0.0.4",
         "php-http/message": "^1.12",
         "php-http/discovery": "^1.14"
     },
@@ -41,26 +35,27 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
         "composer/xdebug-handler": "^2.0",
-        "phan/phan": "^4.1",
+        "dg/bypass-finals": "^1.3",
         "friendsofphp/php-cs-fixer": "^3.0",
-        "vimeo/psalm": "^4.0",
-        "phpstan/phpstan": "^0.12.50",
-        "phpstan/phpstan-phpunit": "^0.12.16",
-        "psalm/plugin-phpunit": "^0.13.0",
         "guzzlehttp/guzzle": "^7.3",
         "guzzlehttp/psr7": "^2.0@RC",
-        "symfony/http-client": "^5.3",
+        "kriswallsmith/buzz": "^1.2",
+        "mikey179/vfsstream": "^1.6",
         "nyholm/psr7": "^1.4",
+        "phan/phan": "^4.1",
+        "phpstan/phpstan": "^0.12.50",
+        "phpstan/phpstan-phpunit": "^0.12.16",
+        "phpunit/phpunit": "^9.5",
+        "psalm/plugin-phpunit": "^0.13.0",
         "symfony/config": "^4.4|^5.0|^6.0",
+        "symfony/http-client": "^5.3",
         "symfony/http-kernel": "^4.4|^5.3|^6.0",
+        "symfony/options-resolver": "^4.4|^5.3|^6.0",
         "symfony/polyfill-php80": "^1.16",
-        "symfony/yaml": "^4.4|^5.3|^6.0",
         "symfony/proxy-manager-bridge": "^4.4|^5.3|^6.0",
-        "symfony/options-resolver": "^4.4|^5.3|^6.0",
-        "dg/bypass-finals": "^1.3",
-        "kriswallsmith/buzz": "^1.2"
+        "symfony/yaml": "^4.4|^5.3|^6.0",
+        "vimeo/psalm": "^4.0"
     },
     "suggest": {
         "symfony/config": "Needed to use otel-sdk-bundle",
@@ -74,5 +69,8 @@
         "post-update-cmd": [
             "composer dump-autoload --optimize"
         ]
+    },
+    "config": {
+        "sort-packages": true
     }
 }

docker-compose.yaml

@@ -1,9 +1,13 @@
 version: '3.7'
 services:
   php:
-    image: ghcr.io/open-telemetry/opentelemetry-php/opentelemetry-php-base:latest
+    image: ghcr.io/open-telemetry/opentelemetry-php/opentelemetry-php-base:${PHP_VERSION:-7.4}
     volumes:
     - ./:/usr/src/myapp
+    user: "${PHP_USER}:root"
+    environment:
+      XDEBUG_MODE: ${XDEBUG_MODE:-off}
+      XDEBUG_CONFIG: ${XDEBUG_CONFIG:-''}
   zipkin:
     image: openzipkin/zipkin-slim
     ports:

psalm.xml.dist

@@ -6,10 +6,9 @@
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd">
     <projectFiles>
-        <directory name="."/>
+        <directory name="src"/>
+        <directory name="tests"/>
         <ignoreFiles>
-            <directory name="var"/>
-            <directory name="vendor"/>
             <directory name="examples"/> <!-- TODO: Remove this once examples are updated -->
             <directory name="src/Symfony/OtelSdkBundle/Resources"/>
             <file name="src/Symfony/OtelSdkBundle/DependencyInjection/Configuration.php"/>

src/Aws/Ec2/Detector.php

@@ -21,11 +21,11 @@
 namespace OpenTelemetry\Aws\Ec2;
 
 use GuzzleHttp\Client;
-use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Psr7\Request;
-use OpenTelemetry\SDK\Resource\ResourceConstants;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
 use OpenTelemetry\SDK\Trace\Attributes;
+use OpenTelemetry\SemConv\ResourceAttributes;
+use Throwable;
 
 /**
  * The AwsEc2Detector can be used to detect if a process is running in AWS EC2
@@ -58,10 +58,14 @@ public function __construct(Client $guzzle)
      * if the connection or parsing of the identity document fails.
      *
      */
-    public function detect()
+    public function detect(): ResourceInfo
     {
         try {
             $token = $this->fetchToken();
+
+            if ($token === null) {
+                return ResourceInfo::emptyResource();
+            }
 
             $hostName = $this->fetchHostname($token);
 
@@ -76,34 +80,34 @@ public function detect()
             foreach ($identitiesJson as $key => $value) {
                 switch ($key) {
                     case 'instanceId':
-                        $attributes->setAttribute(ResourceConstants::HOST_ID, $value);
+                        $attributes->setAttribute(ResourceAttributes::HOST_ID, $value);
 
                         break;
                     case 'availabilityZone':
-                        $attributes->setAttribute(ResourceConstants::CLOUD_ZONE, $value);
+                        $attributes->setAttribute(ResourceAttributes::CLOUD_AVAILABILITY_ZONE, $value);
 
                         break;
                     case 'instanceType':
-                        $attributes->setAttribute(ResourceConstants::HOST_TYPE, $value);
+                        $attributes->setAttribute(ResourceAttributes::HOST_TYPE, $value);
 
                         break;
                     case 'imageId':
-                        $attributes->setAttribute(ResourceConstants::HOST_IMAGE_ID, $value);
+                        $attributes->setAttribute(ResourceAttributes::HOST_IMAGE_ID, $value);
 
                         break;
                     case 'accountId':
-                        $attributes->setAttribute(ResourceConstants::CLOUD_ACCOUNT_ID, $value);
+                        $attributes->setAttribute(ResourceAttributes::CLOUD_ACCOUNT_ID, $value);
 
                         break;
                     case 'region':
-                        $attributes->setAttribute(ResourceConstants::CLOUD_REGION, $value);
+                        $attributes->setAttribute(ResourceAttributes::CLOUD_REGION, $value);
 
                         break;
                 }
             }
 
-            $attributes->setAttribute(ResourceConstants::HOST_HOSTNAME, $hostName);
-            $attributes->setAttribute(ResourceConstants::CLOUD_PROVIDER, self::CLOUD_PROVIDER);
+            $attributes->setAttribute(ResourceAttributes::HOST_NAME, $hostName);
+            $attributes->setAttribute(ResourceAttributes::CLOUD_PROVIDER, self::CLOUD_PROVIDER);
 
             return ResourceInfo::create($attributes);
         } catch (\Throwable $e) {
@@ -112,7 +116,7 @@ public function detect()
         }
     }
 
-    private function fetchToken()
+    private function fetchToken(): ?string
     {
         return $this->request(
             'PUT',
@@ -121,24 +125,26 @@ private function fetchToken()
         );
     }
 
-    private function fetchIdentity(String $token)
+    private function fetchIdentity(String $token): ?array
     {
         $body = $this->request(
             'GET',
             self::AWS_INSTANCE_IDENTITY_DOCUMENT_PATH,
             [self::AWS_METADATA_TOKEN_HEADER => $token]
         );
 
-        $json = json_decode($body, true);
-
-        if (isset($json)) {
-            return $json;
+        if (empty($body)) {
+            return null;
         }
 
-        return null;
+        try {
+            return json_decode($body, true, 512, JSON_THROW_ON_ERROR);
+        } catch (Throwable $t) {
+            return null;
+        }
     }
 
-    private function fetchHostname(String $token)
+    private function fetchHostname(String $token): ?string
     {
         return $this->request(
             'GET',
@@ -151,7 +157,7 @@ private function fetchHostname(String $token)
      * Function to create a request for any of the given
      * fetch functions.
      */
-    private function request($method, $path, $header)
+    private function request($method, $path, $header): ?string
     {
         $client = $this->guzzle;
 
@@ -173,7 +179,7 @@ private function request($method, $path, $header)
             }
 
             return null;
-        } catch (RequestException $e) {
+        } catch (Throwable $e) {
             // TODO: add log for exception. The code below
             // provides the exception thrown:
             // echo Psr7\Message::toString($e->getRequest());

src/Aws/Ecs/DataProvider.php

@@ -13,7 +13,7 @@ class DataProvider
      * This would be the os the container is running on,
      * i.e. the platform on which it is deployed
      */
-    public function getHostName()
+    public function getHostName(): ?string
     {
         return php_uname('n');
     }