Use libphonenumber-for-php-lite instead of libphonenumber-for-php

[bperel]

This change allows to use giggsey/libphonenumber-for-php-lite instead of giggsey/libphonenumber-for-php.

giggsey/libphonenumber-for-php-lite is only 1.6MB in comparison with 19MB for giggsey/libphonenumber-for-php, allowing for a much smaller package size.

The main caveat is that only version 8.x of the library can be used, since the lite variant was created based on version 8 of the original library.
It is also not possible to pass null as a phone number with the lite version, hence the test that I removed.

[Propaganistas]

Thank you - I wasn't aware of the lite version yet.

I'd rather have this package handle null values properly instead of completely removing support for it. Could you look into that?

[bperel]

I'd rather have this package handle null values properly instead of completely removing support for it. Could you look into that?

The thing is that libphonenumber-for-php-lite itself doesn't support null values, contrary to libphonenumber-for-php: see here

So the only alternative solution to not supporting null values anymore would be to handle null values in the PhoneNumber constructor and replace them with something that libphonenumber-for-php-lite will accept (i.e. any non null value), so these lines would become:

    public function __construct(?string $number, $country = [])
    {
        $this->number = is_null($number) ? '': $number;
        $this->countries = Arr::wrap($country);
    }

In this case the it_returns_empty_string_when_null_is_cast_to_string test passes so we don't need to remove it.

Would that be an acceptable approach?

[Propaganistas]

Looks great. I tend to preserve it like this because empty form input gets converted to null values. Applications might blow up if the phone helper suddenly doesn't support null anymore.

[bperel]

Updated!

[Propaganistas]

Adjusting minimum version to 8.13.1 to make the lowest tests succeed (see giggsey/libphonenumber-for-php-lite#9).

[Propaganistas]

I'm wondering: what if someone actually listed the original giggsey/libphonenumber-for-php in its project dependencies because some method not available in lite is being used?

lite marks the original as a conflicting dependency, so installation of Laravel-Phone would suddenly fail.

https://github.com/giggsey/libphonenumber-for-php-lite/blob/feef98fb9ee2c7bc6c689a007ad38ccc8569486f/composer.json#L79-L81

I think giggsey/libphonenumber-for-php first needs to define that it replaces (composer.json replace) lite if requested elsewhere as a dependency.

[bperel]

I'm wondering: what if someone actually listed the original giggsey/libphonenumber-for-php in its project dependencies because some method not available in lite is being used?

lite marks the original as a conflicting dependency, so installation of Laravel-Phone would suddenly fail.

https://github.com/giggsey/libphonenumber-for-php-lite/blob/feef98fb9ee2c7bc6c689a007ad38ccc8569486f/composer.json#L79-L81

I think giggsey/libphonenumber-for-php first needs to define that it replaces (composer.json replace) lite if requested elsewhere as a dependency.

I don't see any technical solution to that problem apart from indeed using this replace property.
However, I don't think that this situation would occur that frequently though, so maybe writing about it in the release notes would be enough?

[Propaganistas]

Created upstream PRs for that:

giggsey/libphonenumber-for-php#625
giggsey/libphonenumber-for-php-lite#53

[giggsey]

8.13.35 is now released that should cover this for you

[Propaganistas]

Thanks for the heads-up! Merging this now.

[gdebrauwer]

This was a breaking change. I updated to the latest version of this package and suddenly some tests were failing because the code was using features that are not available in the lite version

[Propaganistas]

It should not be breaking in any way for functionality provided by the package itself.

Only in case of a self-defined macro you might have introduced additional features. But as soon as you do that, i.e. directly using features of libphonenumber, you should have listed libphonenumber as a direct project dependency because you're relying on that package in your own code. If libphonenumber was listed, everything should keep working properly because lite is configured to be superseded by libphonenumber whenever already present.

[giggsey]

@gdebrauwer I'd recommend adding something like Composer Require Checker to your CICD. It tells you if you have any indirect dependencies within your project.