Update default timezone handling for dates in CiviEntityStorage.php

[nickperkins]

Overview

When handling date values, always use the DateTimeItemInterface::STORAGE_TIMEZONE when converting the data.

Before

When a view is taking a date field from a CIVICRM entity, it uses the site's default timezone when setting the value to be displayed. Given that this is a date field, it does not have a timezone.

After

We check to see if this is a date field or a datetime field. if it is a date field, use DateTimeItemInterface::STORAGE_TIMEZONE to ensure we don't accidentally change the date in the process.

Technical Details

The DateTimeItemInterface::STORAGE_TIMEZONE assumes that all datetime data is stored in UTC, so we must also ensure our default timezone is UTC when dealing with date fields.

Comments

I note that Drupal still shows a time of 12:00 no matter what, but that can be handled via formatting.

[jackrabbithanna]

This fix makes alot of sense. We'll be testing internally and likely to merge soon.

[pradpnayak]

I tested this on our D10 version and the patch seems to have worked.

In Civi record

Before patch in views:

After patch

[jackrabbithanna]

I reran the test in a separate PR, and then on my local .. there is a test fail.

1) Drupal\Tests\civicrm_entity\Kernel\CivicrmStorageGetTest::testLoadContact
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'1982/06/[27](https://github.com/eileenmcnaughton/civicrm_entity/actions/runs/8754115723/job/24025167226?pr=471#step:16:28)'
+'1982/06/28'

Error: /home/runner/drupal/vendor/phpunit/phpunit/src/Framework/Constraint/Equality/IsEqual.php:94
/home/runner/work/civicrm_entity/civicrm_entity/tests/src/Kernel/CivicrmStorageGetTest.php:65
/home/runner/drupal/vendor/phpunit/phpunit/src/Framework/TestResult.php:7[28](https://github.com/eileenmcnaughton/civicrm_entity/actions/runs/8754115723/job/24025167226?pr=471#step:16:29)

[jackrabbithanna]

The test: https://github.com/eileenmcnaughton/civicrm_entity/blob/4.0.x/tests/src/Kernel/CivicrmStorageGetTest.php#L65
$this->assertEquals('1982/06/27', $entity->get('birth_date')->date->format('Y/m/d'));
But the test data looks like https://github.com/eileenmcnaughton/civicrm_entity/blob/4.0.x/tests/src/Kernel/CivicrmEntityTestBase.php#L1696
'birth_date' => '1982-06-28',

Has the test been wrong all this time?

[jackrabbithanna]

With #472 and with this PR
Manual testing on local with custom date field, and contact date field I get right results.

I get passing tests against Drupal 10.2.5 and CiviCRM 5.69 on local:

jackrabbithanna@jackrabbithanna-HP-EliteBook-840-G1:/var/www/web/distro10.skvare.com$ sudo -u www-data -E ./vendor/bin/phpunit -v -c /var/www/web/distro10.skvare.com/phpunit.xml ./web/modules/contrib/civicrm_entity/tests/src/Kernel/CivicrmStorageGetTest.php
PHPUnit 9.6.18 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.1.14
Configuration: /var/www/web/distro10.skvare.com/phpunit.xml

Testing Drupal\Tests\civicrm_entity\Kernel\CivicrmStorageGetTest
......                                                              6 / 6 (100%)

Time: 10:24.006, Memory: 10.00 MB

OK (6 tests, 18 assertions)

Tests in #471 pass, I'll close that one and merge this one.