Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix deprecated error in PHP 8.1/8.2 #1474

Merged
merged 8 commits into from
Sep 12, 2023
Merged

Fix deprecated error in PHP 8.1/8.2 #1474

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
db2c53b
Add #[\AllowDynamicProperties]
koriym Sep 4, 2023
05c60de
Fix type deprecation
koriym Sep 4, 2023
4650139
Do not set unexpected property
koriym Sep 5, 2023
b4224e0
Update log message: Ignoring unexpected field
koriym Sep 7, 2023
5384875
Revert "Do not set unexpected property"
koriym Sep 9, 2023
c1120fc
Update src/Annotations/AbstractAnnotation.php
koriym Sep 11, 2023
751cbe6
Revert "Revert "Do not set unexpected property""
koriym Sep 11, 2023
a1ac338
Fix expected error log message
koriym Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/Annotations/AbstractAnnotation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,7 @@ public function __set($property, $value)
foreach (static::$_blacklist as $_property) {
unset($fields[$_property]);
}
Logger::notice('Unexpected field "' . $property . '" for ' . $this->identity() . ', expecting "' . implode('", "', array_keys($fields)) . '" in ' . $this->_context);
$this->$property = $value;
Logger::notice('Ignoring unexpected field "' . $property . '" for ' . $this->identity() . ', expecting "' . implode('", "', array_keys($fields)) . '" in ' . $this->_context);
koriym marked this conversation as resolved.
Show resolved Hide resolved
}

/**
Expand Down
1 change: 1 addition & 0 deletions src/Annotations/Get.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
/**
* @Annotation
*/
#[\AllowDynamicProperties]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems unrelated to the warnings documented?

Copy link
Author

@koriym koriym Sep 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without AllowDynamicProperties attribute, This code causes a deprecate error. I thought I did not need this assignment ($this->$property = $value;), but I gave the attribute to minimize the changes for the behavior unchanged at all.

If I can get rid of this code, I don't need the AllowDynamicProperties attribute. (Is this unexpected property?) What should I do?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I have to admit that seem not to be able to reproduce the warnings; that would make everything a bit easier...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am also confused. I suspect my environment and have had others try, but the error is still there. (I would expect the error to occur since the code is dealing with a dynamic propertyn in PHP 8.1.) However, the GH action I performed in another PR did not reproduce the deprecated error...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:) I think you have custom error logging settings. I would have thought this should be default for phpunit 🤷

php -d error_reporting=-1 ./bin/phpunit

... on it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its this test: https://github.com/zircote/swagger-php/blob/2.x/tests/AbstractAnnotationTest.php#L19

Doesn't exist on master any more, otherwise we'd see the same there...

Not quite sure what to do - technically we should probably change the code to throw an exception rather than logging and moving on; just not sure if that is too much of a BC break.
OTOH, this is the first time I've seen this issue, so I would suspect there are not a lot of cases of this happeing out in the wild. On top of that thoses properties are either ignored during serialization or bu any other OpenAPI tools.

I would lean towards not allowing invalid specs to be created, so throwing an exception might be the way forward.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you that it is correct to throw an exception as you think. But in any case, is there any need to set invalid properties? (I pushed a new commit)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we remove this again? When not setting the property this should not be needed.

class Get extends Operation
{
/** @inheritdoc */
Expand Down
3 changes: 2 additions & 1 deletion src/Context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
* @property string $property
* @property Annotations\AbstractAnnotation[] $annotations
*/
#[\AllowDynamicProperties]
class Context
{
/**
Expand Down Expand Up @@ -282,7 +283,7 @@ public function fullyQualifiedName($class)
} else {
$namespace = '\\'; // global namespace
}
if (strcasecmp($class, $this->class) === 0) {
if (strcasecmp((string) $class, (string) $this->class) === 0) {
return $namespace . $this->class;
}
$pos = strpos($class, '\\');
Expand Down