removeEmptyPairs(): undocumented behavior change between v6 and v7

[davidrans]

Bug Report

Behavior in version 6.8:

$removeEmptyPairs = function(string $str): ?string {
   $uri = Uri\Http::createFromString($str);         
   $new = UriModifier::removeEmptyPairs($uri);      
   return $new->getQuery();                         
};
echo $removeEmptyPairs('https://a.b/c?d='); // ""
echo $removeEmptyPairs('https://a.b/c?=d'); // ""
echo $removeEmptyPairs('https://a.b/c?='); //  ""

Behavior in 7.4:

echo $removeEmptyPairs('https://a.b/c?d='); // "d="
echo $removeEmptyPairs('https://a.b/c?=d'); // "=d"
echo $removeEmptyPairs('https://a.b/c?='); //  "="

Was this behavior change intentional?

[nyamsprod]

@davidrans thanks for the bug report. It is indeed a bug caused by the re-implementation of the now deprecated class UriModifier.

I used the wrong method while re-implementing the UriModifier class instead of using

    /**
     * Remove empty pairs from the URL query component.
     *
     * A pair is considered empty if it's name is the empty string
     * and its value is either the empty string or the null value
     */
    public static function removeEmptyPairs(Psr7UriInterface|UriInterface $uri): Psr7UriInterface|UriInterface
    {
+ return Modifier::from($uri)->removeEmptyQueryPairs()->getUri();
- return Modifier::from($uri)->removeQueryPairsByKey()->getUri();
    }

the fix will be release ASAP via a patch version. In the meantime I would suggest upgrading the code to use the new way as the behaviour does exists in version 7. People using the new API do not face this bug.

[davidrans]

I appreciate the quick response and fix!