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

Jump to bottom

CommandFactory: reject named arguments as those are not supported #1508

Open
wants to merge 3 commits into
base: v2.x
Choose a base branch
from
Open

CommandFactory: reject named arguments as those are not supported #1508

wants to merge 3 commits into from

Conversation

janedbal
Copy link
Contributor

@janedbal janedbal commented Feb 11, 2025 •
edited
Loading

Since predis 2.3.0, named arguments are not supported (at least in SET command) due to this change as the value argument does not meet the condition there.

Thus, following code broke our production upon upgrade:

$redis->set('foo', value: null);

At first, I was about to fix this by supporting it inside SET::setArguments, but as all the command calls are implemented via __call, I believe it is safer to rely on the fact that your users are not using named arguments at all.

@janedbal janedbal requested a review from tillkruss as a code owner February 11, 2025 16:12
tillkruss
tillkruss requested changes Feb 11, 2025
View reviewed changes
Copy link
Member

@tillkruss tillkruss left a comment

Choose a reason for hiding this comment

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

Tests failing.

@janedbal
Copy link
Contributor Author

janedbal commented Feb 12, 2025 •
edited
Loading

Tests failing.

Adjusted. The remaining failures are unrelated.

@janedbal janedbal mentioned this pull request Feb 12, 2025
Merged
@janedbal janedbal requested a review from tillkruss February 12, 2025 09:41
@tillkruss tillkruss self-assigned this Feb 12, 2025
@tillkruss
Copy link
Member

tillkruss commented Feb 13, 2025 •
edited
Loading

This feels a bit overkill, especially since we merged #1509? Mainly because we don't advertise named parameters or include them inside of the stubs.

So I assume someone just came up with value:?

@janedbal
Copy link
Contributor Author

This feels a bit overkill, especially since we merged #1509?

@tillkruss Not everybody uses PHPStan, so I think your library should either:

  1. Note BC break in 2.3.0 that named args are no longer supported for SET
  2. Fix the BC break by supporting named args again
  3. Decide to no longer support named args to enable similar changes without a risk of breaking things (this MR)

@tillkruss
Copy link
Member

  1. Note BC break in 2.3.0 that named args are no longer supported for SET

I don't see this as a BC issue, was this feature listed anywhere ever or did it just happen to work?

@janedbal
Copy link
Contributor Author

was this feature listed anywhere ever or did it just happen to work?

I believe users are expecting native PHP features to work.

I don't see this as a BC issue

If my code was working fine before upgrade, but fails hard on ERR syntax error after upgrade, I'd say it is a BC break. Even when unintentional.

@janedbal
Copy link
Contributor Author

janedbal commented Feb 14, 2025 •
edited
Loading

If you dislike this PR, I can send PR fixing the broken support of named args.

@tillkruss
Copy link
Member

My point is it's not a breaking change, because it's not an officially supported feature, nor are there tests for it. It just happened to have worked.

If you want to restore named args support, please do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vladvildanov vladvildanov vladvildanov approved these changes

@tillkruss tillkruss Awaiting requested review from tillkruss tillkruss is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

@tillkruss tillkruss

Labels
needs discussion
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@janedbal @tillkruss @vladvildanov