fix: remove deprecated upper functionality in `Request::getMethod()` #8186

kenjis · 2023-11-10T01:17:29Z

Description
The strike line is annoying.

remove deprecated upper functionality in getMethod()
fix HTTP verbs case. E.g., get → GET.

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

michalsn

I am a little worried about edge cases that don't conform to the HTTP specification. However, I don't know how common it is... probably very rare.

This is a big change though.

kenjis · 2023-11-10T23:07:49Z

Yes, this is a big change.
But it has been deprecated since v4.0.5 (January 31, 2021):
https://codeigniter4.github.io/CodeIgniter4/installation/upgrade_405.html?highlight=getmethod#message-getheader-s

kenjis · 2023-11-10T23:22:25Z

I found this: JakeChampion/fetch#254
It seems in fetch API only PATCH is not normalized, so patch does not work.

kenjis · 2023-11-10T23:23:58Z

In the routes array, there is still lower case method names.
We need to change them.

michalsn · 2023-11-11T06:14:43Z

I'm more worried about people using

$this->request->getMethod() === 'post'

kenjis · 2023-11-11T07:02:06Z

I understand your concern. But it has been documented for long time.
https://codeigniter4.github.io/CodeIgniter4/incoming/incomingrequest.html#getmethod

We must change the output of getMethod() at once. If it is not changed, almost nothing will change. If we add a feature flag, we will have to prepare more than twice as much test code.

In the end, the question is when to fix this bug. If it is still too early, we can postpone, but what can we do in the meantime?

michalsn · 2023-11-11T08:16:02Z

I get it, believe me. I have no problem with removing depreciated code in general. Most such code is long gone and/or smoothly replaced by alternatives.

Here, for a long time we had no alternatives - until the is() method was implemented. That's why I think this could be a pretty painful change.

However, looking at the amount of removed depreciated code in the upcoming 4.5 - maybe it's the right time.

michalsn

Let's see what others say.

system/HTTP/OutgoingRequest.php

paulbalandan · 2023-11-17T08:45:17Z

system/Filters/Filters.php

+        elseif (array_key_exists(strtolower($method), $this->config->methods)) {
+            $found  = true;
+            $method = strtolower($method);
+        }


Should we trigger an E_USER_DEPRECATED here when this elseif branch is executed so that users will be aware?

I like that

MGatner

This is a big one. While we're doing this a couple of thoughts to consider if there is a case to make this part of something even bigger:

Enums. Should our HTTP verbs be an Enum framework-wide to decrease future issues and make static analysis easier? I could also see a case for class constants.
PSR-7. Is it time to make the few breaking changes necessary to make our HTTP layer compatible with the PSR? Instead of making this one breaking change and then others in the future it might be good to handle it all at once.

MGatner · 2023-11-18T12:18:32Z

system/Test/FeatureTestTrait.php

+                 * @TODO For backward compatibility. Remove strtolower() in the future.
+                 * @deprecated 4.5.0
+                 */
+                $method = strtolower($route[0]);


If you go with @paulbalandan's trigger idea this would be another good place for a conditional warning.

system/HTTP/OutgoingRequest.php

kenjis · 2023-11-19T08:40:34Z

@MGatner The getMethod() returns string, and our input to HTTP methods is all string.
So it seems difficult to use enum. I added a class with constants.

Co-authored-by: MGatner <[email protected]>

MGatner

Thanks, new class looks good. We can revisit PSR-7 as needed before 4.5 goes live.

kenjis added bug Verified issues on the current code behavior or pull requests that will fix them refactor Pull requests that refactor code breaking change Pull requests that may break existing functionalities 4.5 labels Nov 10, 2023

kenjis marked this pull request as draft November 10, 2023 01:17

kenjis force-pushed the fix-HTTP-verb-cases branch from 25f7636 to b38ac61 Compare November 10, 2023 01:23

kenjis marked this pull request as ready for review November 10, 2023 02:48

kenjis marked this pull request as draft November 10, 2023 02:57

kenjis force-pushed the fix-HTTP-verb-cases branch from 4392c3b to 7f0ae5c Compare November 10, 2023 03:46

kenjis marked this pull request as ready for review November 10, 2023 04:19

kenjis marked this pull request as draft November 10, 2023 04:21

kenjis force-pushed the fix-HTTP-verb-cases branch from ee32c4c to 92bab56 Compare November 10, 2023 04:34

kenjis marked this pull request as ready for review November 10, 2023 04:58

michalsn reviewed Nov 10, 2023

View reviewed changes

michalsn approved these changes Nov 12, 2023

View reviewed changes

system/HTTP/OutgoingRequest.php Show resolved Hide resolved

paulbalandan reviewed Nov 17, 2023

View reviewed changes

MGatner requested changes Nov 18, 2023

View reviewed changes

MGatner reviewed Nov 18, 2023

View reviewed changes

system/HTTP/OutgoingRequest.php Outdated Show resolved Hide resolved

kenjis force-pushed the fix-HTTP-verb-cases branch 2 times, most recently from 42d89a2 to fdb1d81 Compare November 19, 2023 10:15

kenjis added 3 commits November 19, 2023 20:03

refactor!: remove $upper functionality in Request::getMethod()

88c89d0

refactor: remove strtoupper()/strtolower() for $request->getMethod()

5bd6cbb

chore: update phpstan-baseline.php

111d73b

kenjis and others added 17 commits November 19, 2023 20:03

refactor: remove feature flag

aca22d1

docs: change Filters::$methods keys to uppercase

0b6a273

test: change Filters::$methods keys to uppercase

f54e420

docs: add changelog and upgrade

d397154

test: fix $routes->match() HTTP verbs

905c3d1

test: fix $request->setMethod() HTTP verbs

a09e750

docs: fix $routes->match() HTTP verbs

b4a70bb

docs: fix $client->request() HTTP verbs

1c50d82

docs: add about CURLRequest::request() HTTP verbs

303eaa1

refactor: fix HTTP verbs for FeatureTestTrait::withRoutes()

6aff805

docs: add deprecated features that accept lowercase HTTP methods

399367e

docs: add section "Core Class Changes"

ad3bb95

docs: add about lowercase HTTP method name

8680872

feat: add HTTP\Method class

8d92882

docs: add doc comment

a394ac0

Co-authored-by: MGatner <[email protected]>

refactor: use HTTP\Method constants

7149fa5

test: use HTTP\Method constants

cb35ef7

kenjis force-pushed the fix-HTTP-verb-cases branch from fdb1d81 to 4dd4218 Compare November 19, 2023 11:03

kenjis marked this pull request as draft November 19, 2023 11:57

feat: add trigger_error E_USER_DEPRECATED

375c340

kenjis force-pushed the fix-HTTP-verb-cases branch from 4dd4218 to 375c340 Compare November 19, 2023 12:05

test: replace 'get' with 'GET'

fe6babf

kenjis force-pushed the fix-HTTP-verb-cases branch from e9e22a7 to fe6babf Compare November 19, 2023 12:15

MGatner approved these changes Nov 19, 2023

View reviewed changes

kenjis marked this pull request as ready for review November 19, 2023 12:51

kenjis merged commit 4a5cb90 into codeigniter4:4.5 Nov 19, 2023
46 checks passed

kenjis deleted the fix-HTTP-verb-cases branch November 19, 2023 21:04

This was referenced Nov 20, 2023

fix: route key lowercase HTTP verbs #8235

Merged

feat: spark filter:check shows "Required Filters" #8236

Merged

feat: spark routes shows "Required Filters" #8237

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: remove deprecated upper functionality in `Request::getMethod()` #8186

fix: remove deprecated upper functionality in `Request::getMethod()` #8186

kenjis commented Nov 10, 2023 •

edited

Loading

michalsn left a comment

kenjis commented Nov 10, 2023

kenjis commented Nov 10, 2023

kenjis commented Nov 10, 2023

michalsn commented Nov 11, 2023

kenjis commented Nov 11, 2023

michalsn commented Nov 11, 2023

michalsn left a comment

paulbalandan Nov 17, 2023

MGatner Nov 18, 2023

kenjis Nov 19, 2023

MGatner left a comment

MGatner Nov 18, 2023

kenjis Nov 19, 2023

kenjis commented Nov 19, 2023

MGatner left a comment

fix: remove deprecated upper functionality in Request::getMethod() #8186

fix: remove deprecated upper functionality in Request::getMethod() #8186

Conversation

kenjis commented Nov 10, 2023 • edited Loading

michalsn left a comment

Choose a reason for hiding this comment

kenjis commented Nov 10, 2023

kenjis commented Nov 10, 2023

kenjis commented Nov 10, 2023

michalsn commented Nov 11, 2023

kenjis commented Nov 11, 2023

michalsn commented Nov 11, 2023

michalsn left a comment

Choose a reason for hiding this comment

paulbalandan Nov 17, 2023

Choose a reason for hiding this comment

MGatner Nov 18, 2023

Choose a reason for hiding this comment

kenjis Nov 19, 2023

Choose a reason for hiding this comment

MGatner left a comment

Choose a reason for hiding this comment

MGatner Nov 18, 2023

Choose a reason for hiding this comment

kenjis Nov 19, 2023

Choose a reason for hiding this comment

kenjis commented Nov 19, 2023

MGatner left a comment

Choose a reason for hiding this comment

fix: remove deprecated upper functionality in `Request::getMethod()` #8186

fix: remove deprecated upper functionality in `Request::getMethod()` #8186

kenjis commented Nov 10, 2023 •

edited

Loading