fixing CI complaints (#1666)

* fixing psalm complaints
use rector (and psalm) to add Override attributes, and add symfony polyfill to
provide Override in earlier php versions

* fixing more psalm complaints

* more fixes

* adding stubs for deptrac
there are some things in our code that deptrac doesn't understand or are missing
for some php versions. stub them to quieten all those violation warnings

* why not cache invalid :(

* display tools versions

* fix tools cache key

* changing cache key

* dont complain about unused psalm suppressions

* suppress invalid attribute

* quieten phpstan php8.5 complaints

* revert previous commit...now other php versions complain about an unused ignore :(

* revert typecasting in metrics aggregators

* Update src/Contrib/Otlp/ProtobufSerializer.php

Co-authored-by: Chris Lightfoot-Wild <[email protected]>

* remove override stub and use the polyfill from deptrac

---------

Co-authored-by: Chris Lightfoot-Wild <[email protected]>

Author: brettmc

.github/workflows/php.yml

@@ -87,57 +87,71 @@ jobs:
       uses: actions/cache@v4
       with:
         path: vendor
-        key: ${{ runner.os }}-${{ matrix.php-version }}-php-${{ hashFiles('**/composer.json') }}
+        key: ${{ runner.os }}-${{ matrix.php-version }}-vendor-${{ hashFiles('composer.json') }}
         restore-keys: |
-          ${{ runner.os }}-${{ matrix.php-version }}-php-
+          ${{ runner.os }}-${{ matrix.php-version }}-vendor-
     - name: Cache test tools
       id: test-tools-cache
       uses: actions/cache@v4
       with:
         path: vendor-bin
-        key: ${{ runner.os }}-${{ matrix.php-version }}-php-${{ hashFiles('**/composer.json') }}
+        key: ${{ runner.os }}-${{ matrix.php-version }}-vendor-bin-${{ hashFiles('vendor-bin/*/composer.json') }}
         restore-keys: |
-          ${{ runner.os }}-${{ matrix.php-version }}-php-
+          ${{ runner.os }}-${{ matrix.php-version }}-vendor-bin-
 
     - name: Install dependencies
       id: composer
       if: steps.composer-cache.outputs.cache-hit != 'true'
-      run: composer install --prefer-dist --no-progress ${{ matrix.composer_args }}
+      run: |
+        composer --version
+        composer install --prefer-dist --no-progress ${{ matrix.composer_args }}
 
     - name: Check Style
       id: style
       continue-on-error: ${{ matrix.experimental }}
       env:
         PHP_CS_FIXER_IGNORE_ENV: 1
-      run: vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --stop-on-violation --using-cache=no -vvv
+      run: |
+        vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer --version
+        vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --stop-on-violation --using-cache=no -vvv
 
     - name: Check Dependencies
       id: deps
       continue-on-error: ${{ matrix.experimental }}
-      run: vendor-bin/deptrac/vendor/bin/deptrac --formatter=github-actions --report-uncovered
+      run: |
+        vendor-bin/deptrac/vendor/bin/deptrac --version
+        vendor-bin/deptrac/vendor/bin/deptrac --formatter=github-actions --report-uncovered
 
     - name: Run Phan
       id: phan
       continue-on-error: ${{ matrix.experimental }}
       env:
         XDEBUG_MODE: off
         PHAN_DISABLE_XDEBUG_WARN: 1
-      run: vendor-bin/phan/vendor/bin/phan
+      run: |
+        vendor-bin/phan/vendor/bin/phan --version
+        vendor-bin/phan/vendor/bin/phan
 
     - name: Run Psalm
       id: psalm
       continue-on-error: ${{ matrix.experimental }}
-      run: vendor-bin/psalm/vendor/bin/psalm --output-format=github
+      run: |
+        vendor-bin/psalm/vendor/bin/psalm --version
+        vendor-bin/psalm/vendor/bin/psalm --output-format=github
 
     - name: Run Phpstan
       id: phpstan
       continue-on-error: ${{ matrix.experimental }}
-      run: vendor/bin/phpstan analyse --error-format=github
+      run: |
+        vendor/bin/phpstan --version
+        vendor/bin/phpstan analyse --error-format=github
 
     - name: Run PHPUnit (unit tests)
       id: unit
       continue-on-error: ${{ matrix.experimental }}
-      run: php -dzend.assertions=1 vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover --testsuite unit
+      run: |
+        vendor/bin/phpunit --version
+        php -dzend.assertions=1 vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover --testsuite unit
 
     - name: Run PHPUnit (integration tests)
       id: integration

.phan/config.php

@@ -286,6 +286,7 @@
         'PhanAccessPropertyInternal',
         'PhanTypeMismatchPropertyReal',
         'PhanTemplateTypeNotUsedInFunctionReturn',
+        'PhanUndeclaredClassAttribute',
     ],
 
     // A regular expression to match files to be excluded

Makefile

@@ -5,6 +5,7 @@ DOCKER_COMPOSE ?= docker compose
 DC_RUN_PHP = $(DOCKER_COMPOSE) run --rm php
 
 .DEFAULT_GOAL : help
+.PHONY: deptrac
 
 help: ## Show this help
 	@printf "\033[33m%s:\033[0m\n" 'Available commands'

composer.json

@@ -20,6 +20,8 @@
         "symfony/config": "^5.4 || ^6.4 || ^7.0",
         "symfony/polyfill-mbstring": "^1.23",
         "symfony/polyfill-php82": "^1.26",
+        "symfony/polyfill-php83": "^1.32",
+        "symfony/polyfill-php84": "^1.32",
         "tbachert/spi": "^1.0.1"
     },
     "config": {
@@ -98,7 +100,7 @@
         "open-telemetry/dev-tools": "dev-main",
         "php-http/mock-client": "^1.5",
         "phpdocumentor/reflection-docblock": "^5.3",
-        "phpspec/prophecy": "^1.17.0",
+        "phpspec/prophecy": "^1.22",
         "phpspec/prophecy-phpunit": "^2",
         "phpstan/phpstan": "^1.10.13",
         "phpstan/phpstan-mockery": "^1.1",

deptrac.yaml

@@ -14,6 +14,8 @@ deptrac:
         - ./src
         - ./proto
         - ./tests
+        - ./deptrac/polyfills
+        - ./vendor/symfony/polyfill-php83/Resources/stubs
     exclude_files:
         - '#.*test.*#'
     layers:
@@ -109,10 +111,17 @@ deptrac:
           collectors:
               - type: className
                 regex: ^Nyholm\\Psr7Server\\*
+      -   name: Polyfills
+          collectors:
+              - type: directory
+                value: deptrac/polyfills/.*
+              - type: directory
+                value: vendor/symfony/polyfill-php83
 
     ruleset:
       Context:
           - FFI
+          - Polyfills
       SemConv: ~
       ConfigSDK:
           - SymfonyConfig
@@ -124,10 +133,12 @@ deptrac:
           - Context
           - Contrib
           - Extension
+          - Polyfills
       API:
           - Context
           - PsrLog
           - SPI
+          - Polyfills
       SDK:
           - +API
           - ConfigSDK

deptrac/polyfills/ComponentPlugin.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace OpenTelemetry\Config\SDK\Configuration;
+
+class ComponentPlugin {}

deptrac/polyfills/ComponentProvider.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace OpenTelemetry\Config\SDK\Configuration;
+
+class ComponentProvider {}

deptrac/polyfills/ComponentProviderRegistry.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace OpenTelemetry\Config\SDK\Configuration;
+
+class ComponentProviderRegistry {}

deptrac/polyfills/Context.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace OpenTelemetry\Config\SDK\Configuration;
+
+class Context {}

deptrac/polyfills/README.md

@@ -0,0 +1,3 @@
+Polyfills for deptrac, which represent classes missing from some PHP versions, or classes
+that deptrac does not understand.
+We also use some symfony polyfills for deptrac, under `vendor/symfony/polyfill-*`.