fix: bump PHPStan to level 5, Psalm to level 3 #205

dkarlovi · 2020-11-02T16:28:09Z

This adds fixes which are required to bump static analysis tools to stricter settings, revealing some bugs already.

codecov · 2020-11-02T16:29:01Z

Codecov Report

Merging #205 into master will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##             master     #205      +/-   ##
============================================
+ Coverage     91.78%   91.82%   +0.03%     
- Complexity      319      321       +2     
============================================
  Files            36       36              
  Lines           755      758       +3     
============================================
+ Hits            693      696       +3     
  Misses           62       62

Impacted Files	Coverage Δ	Complexity Δ
contrib/Zipkin/Exporter.php	`100.00% <ø> (ø)`	`18.00 <0.00> (ø)`
sdk/Trace/SpanProcessor/BatchSpanProcessor.php	`97.50% <ø> (ø)`	`18.00 <0.00> (ø)`
contrib/Zipkin/SpanConverter.php	`100.00% <100.00%> (ø)`	`10.00 <0.00> (ø)`
sdk/CorrelationContext.php	`96.00% <100.00%> (+0.16%)`	`12.00 <0.00> (+2.00)`
sdk/Metrics/Meter.php	`100.00% <100.00%> (ø)`	`6.00 <3.00> (ø)`
sdk/Resource/ResourceInfo.php	`100.00% <100.00%> (ø)`	`8.00 <0.00> (ø)`
sdk/Trace/Events.php	`100.00% <100.00%> (ø)`	`3.00 <0.00> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f23a50d...84ed646. Read the comment docs.

dkarlovi

@bobstrecansky mentioned in Gitter

dkarlovi · 2020-11-02T16:29:31Z

contrib/Zipkin/SpanConverter.php

        $row = [
            'id' => $span->getContext()->getSpanId(),
            'traceId' => $span->getContext()->getTraceId(),
-            'parentId' => $span->getParent() ? $span->getParent()->getSpanId() : null,
+            'parentId' => $spanParent ? $spanParent->getSpanId() : null,


You can fix this with what Psalm calls "memoizing simple method calls" setting, but in general you want this form.

Alternatively, making classes immutable, which Psalm also supports.

dkarlovi · 2020-11-02T16:30:07Z

phpstan.neon

Newline, meaning the project is missing .editorconfig

Should we add a .editorconfig?

Don't see why not, it can only help with the consistency of the changes.

@dkarlovi - do you have a particular preference on what should be included in our .editorconfig?

We can start with something very simple and tweak when needed.

Example
https://github.com/flexolabs/reddit-client/blob/master/.editorconfig

Sounds good to me.

@bobstrecansky added in #207

dkarlovi · 2020-11-02T16:30:27Z

sdk/CorrelationContext.php

@@ -59,7 +59,9 @@ private function removeCorrelationHelper(ContextKey $key, ?CorrelationContext $c
            return;
        }

-        $child->setParent($this->parent);
+        if ($child !== null && $this->parent !== null) {


NPE on both the child and the parent.

The complexity increase is because of this additional check, AFAIK?

I find that to be an acceptable tradeoff.

dkarlovi · 2020-11-02T16:30:40Z

sdk/Metrics/Meter.php

@@ -40,23 +40,23 @@ public function getVersion(): string
    /**
     * {@inheritdoc}
     */
-    public function newCounter(string $name, string $description = null): API\Counter
+    public function newCounter(string $name, string $description = ''): API\Counter


These are not nullable.

dkarlovi · 2020-11-02T16:31:16Z

sdk/Trace/Events.php

@@ -15,7 +15,7 @@ public function addEvent(
        ?API\Attributes $attributes = null,
        int $timestamp = null
    ): API\Events {
-        $this->events[] = new Event($name, $timestamp, $attributes);
+        $this->events[] = new Event($name, $timestamp ?? time(), $attributes);


Notice this one, it's probably incorrect, but the type is now correct, it's int, but int|null passed.

Note: even though this was changed, no tests failed, meaning this wasn't tested at all. This should have been caught by Infection. /cc @prondubuisi

According to the spec:

https://github.com/open-telemetry/opentelemetry-specification/blob/06d16d7db88c3e266636f84887de61e3363b5429/specification/trace/api.md#add-events

An Event is structurally defined by the following properties:

Name of the event.

A timestamp for the event. Either the time at which the event was added or a custom timestamp provided by the user.

Zero or more Attributes further describing the event.

Maybe we shouldn't default int $timestamp = null on line 16 and check for the value of $timestamp before passing time() to new Event()

This API takes the name of the event, optional Attributes and an optional Timestamp which can be used to specify the time at which the event occurred
If no custom timestamp is provided by the user, the implementation automatically sets the time at which this API is called on the event.

(emphasis mine)

Since the timestamp is supposed to be optional, it must be nullable so I think that part is correct. Event itself requires the exact timestamp which is also OK, so I guess my solution seems to be close to OK?

Agreed that your solution is okay!

dkarlovi · 2020-11-03T16:23:06Z

Rebased on top master to avoid the conflict.

dkarlovi requested review from beniamin, bobstrecansky and morrisonlevi as code owners November 2, 2020 16:28

dkarlovi commented Nov 2, 2020

View reviewed changes

dkarlovi mentioned this pull request Nov 3, 2020

chore: .editorconfig, .gitattributes #207

Merged

fix: bump PHPStan to level 5, Psalm to level 3

84ed646

dkarlovi force-pushed the fix/add-types branch from 0685375 to 84ed646 Compare November 3, 2020 16:22

dkarlovi mentioned this pull request Nov 3, 2020

chore: add static analysis for tests, examples #208

Merged

bobstrecansky approved these changes Nov 4, 2020

View reviewed changes

bobstrecansky merged commit 2514c45 into open-telemetry:master Nov 4, 2020

dkarlovi deleted the fix/add-types branch November 4, 2020 13:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: bump PHPStan to level 5, Psalm to level 3 #205

fix: bump PHPStan to level 5, Psalm to level 3 #205

dkarlovi commented Nov 2, 2020

codecov bot commented Nov 2, 2020 •

edited

Loading

dkarlovi left a comment

dkarlovi Nov 2, 2020

dkarlovi Nov 2, 2020

dkarlovi Nov 2, 2020

bobstrecansky Nov 2, 2020

dkarlovi Nov 2, 2020

bobstrecansky Nov 2, 2020

dkarlovi Nov 2, 2020

bobstrecansky Nov 2, 2020

dkarlovi Nov 3, 2020

dkarlovi Nov 2, 2020

dkarlovi Nov 2, 2020

bobstrecansky Nov 2, 2020

dkarlovi Nov 2, 2020

dkarlovi Nov 2, 2020

dkarlovi Nov 2, 2020

bobstrecansky Nov 3, 2020

dkarlovi Nov 3, 2020

bobstrecansky Nov 4, 2020

dkarlovi commented Nov 3, 2020

fix: bump PHPStan to level 5, Psalm to level 3 #205

fix: bump PHPStan to level 5, Psalm to level 3 #205

Conversation

dkarlovi commented Nov 2, 2020

codecov bot commented Nov 2, 2020 • edited Loading

Codecov Report

dkarlovi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkarlovi commented Nov 3, 2020

codecov bot commented Nov 2, 2020 •

edited

Loading