Fix mandatory keys check fail for value of float 0.0 in a required key in an entity

[bugfolder]

Overview

Fixes https://lab.civicrm.org/dev/core/-/issues/2071.

The mandatory keys check in function civicrm_api3_verify_mandatory() fails erroneously if the key exists but it has the floating-point value of 0.0.

Reproduction steps

Using APIv3, create an entity that contains a required key with the floating-point value of 0.0, for example, line_total in a price field element.

Before

APIv3 throws a Mandatory key(s) missing from params array: exception.

After

Successful creation.

Technical Details

In civicrm/api/v3/utils.php, change line 92 from

if (!array_key_exists($key, $params) || (empty($params[$key]) && $params[$key] !== 0 && $params[$key] !== '0')) {

to

if (!array_key_exists($key, $params) || (empty($params[$key]) && $params[$key] !== 0.0 && $params[$key] !== '0')) {

The second version will match on both integer 0 and float 0.0, while the first only matches on integer 0 but not float 0.0.

[civicrm-builder]

Can one of the admins verify this patch?

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

add to whitelist

[eileenmcnaughton]

@bugfolder - would you feel comfortable adding a unit test for this? I can help you if you want but as it's your first contribution you get to opt out of doing a test this time if it's too big a lift.

However, there is one thing you'll need to do once this is merged - add a PR like this ee8957e - erm but with your details , not Sunil's :-)

[bugfolder]

Looking at the Developer guide for testing, it looks like a pretty big chunk of time and effort to get set up to write and debug unit tests. So maybe I'll wait till I make a PR that's bigger than two characters. ;o) But I will watch for the merge notice and add a PR with the Contributor changes.

[eileenmcnaughton]

@bugfolder looks like you triggered a tonne of test fails - I think you want to add !== 0.0 rather than replace !== 0

[bugfolder]

Hmm, that patch worked on my local (which did not include automated tests — guess I need to at least get testing up to be able to run those before further PRs). But @eileenmcnaughton's suggestion should take care of it. PR updated.

[eileenmcnaughton]

Adding has-test as I have written a test that captures this bug & demonstrates the fix works - I will push up as a follow up PR - merging