feat(AppFramework): Add full support for date / time / datetime columns

This adds support for all Doctrine supported types, for the column types only the immutable variants needed to be added.
But especially those types are the important ones, as our **Entity** class works by detecting changes through setters.
Meaning if it is mutable, changes like `$entity->date->modfiy()` can not be detected, so the immutable types make more sense here.

Similar the parameter types needed to be added.

`Enity` and `QBMapper` needed to be adjusted so they support (auto map) those types, required when insert or update an entity.

Also added more tests, especially to make sure the mapper really serializes the values correctly.

Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de>
Co-authored-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com>
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

1 files changed, 36 insertions, 31 deletions

diff --git a/tests/lib/AppFramework/Db/QBMapperTest.php b/tests/lib/AppFramework/Db/QBMapperTest.php
index f08beca05ca..5fb46bfd668 100644
--- a/tests/lib/AppFramework/Db/QBMapperTest.php
+++ b/tests/lib/AppFramework/Db/QBMapperTest.php
@@ -10,7 +10,9 @@ use OCP\AppFramework\Db\Entity;
 use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IExpressionBuilder;
 use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\DB\Types;
 use OCP\IDBConnection;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * @method bool getBoolProp()
@@ -23,6 +25,8 @@ use OCP\IDBConnection;
  * @method void setBooleanProp(bool $booleanProp)
  * @method integer getIntegerProp()
  * @method void setIntegerProp(integer $integerProp)
+ * @method ?\DateTimeImmutable getDatetimeProp()
+ * @method void setDatetimeProp(?\DateTimeImmutable $datetime)
  */
 class QBTestEntity extends Entity {
 	protected $intProp;
@@ -31,14 +35,16 @@ class QBTestEntity extends Entity {
 	protected $integerProp;
 	protected $booleanProp;
 	protected $jsonProp;
+	protected $datetimeProp;
 
 	public function __construct() {
 		$this->addType('intProp', 'int');
 		$this->addType('boolProp', 'bool');
-		$this->addType('stringProp', 'string');
-		$this->addType('integerProp', 'integer');
-		$this->addType('booleanProp', 'boolean');
-		$this->addType('jsonProp', 'json');
+		$this->addType('stringProp', Types::STRING);
+		$this->addType('integerProp', Types::INTEGER);
+		$this->addType('booleanProp', Types::BOOLEAN);
+		$this->addType('jsonProp', Types::JSON);
+		$this->addType('datetimeProp', Types::DATETIME_IMMUTABLE);
 	}
 }
 
@@ -63,25 +69,11 @@ class QBTestMapper extends QBMapper {
  * @package Test\AppFramework\Db
  */
 class QBMapperTest extends \Test\TestCase {
-	/**
-	 * @var \PHPUnit\Framework\MockObject\MockObject|IDBConnection
-	 */
-	protected $db;
-
-	/**
-	 * @var \PHPUnit\Framework\MockObject\MockObject|IQueryBuilder
-	 */
-	protected $qb;
 
-	/**
-	 * @var \PHPUnit\Framework\MockObject\MockObject|IExpressionBuilder
-	 */
-	protected $expr;
-
-	/**
-	 * @var \Test\AppFramework\Db\QBTestMapper
-	 */
-	protected $mapper;
+	protected IDBConnection&MockObject $db;
+	protected IQueryBuilder&MockObject $qb;
+	protected IExpressionBuilder&MockObject $expr;
+	protected QBTestMapper $mapper;
 
 	/**
 	 * @throws \ReflectionException
@@ -109,36 +101,41 @@ class QBMapperTest extends \Test\TestCase {
 
 	
 	public function testInsertEntityParameterTypeMapping(): void {
+		$datetime = new \DateTimeImmutable();
 		$entity = new QBTestEntity();
 		$entity->setIntProp(123);
 		$entity->setBoolProp(true);
 		$entity->setStringProp('string');
 		$entity->setIntegerProp(456);
 		$entity->setBooleanProp(false);
+		$entity->setDatetimeProp($datetime);
 
 		$intParam = $this->qb->createNamedParameter('int_prop', IQueryBuilder::PARAM_INT);
 		$boolParam = $this->qb->createNamedParameter('bool_prop', IQueryBuilder::PARAM_BOOL);
 		$stringParam = $this->qb->createNamedParameter('string_prop', IQueryBuilder::PARAM_STR);
 		$integerParam = $this->qb->createNamedParameter('integer_prop', IQueryBuilder::PARAM_INT);
 		$booleanParam = $this->qb->createNamedParameter('boolean_prop', IQueryBuilder::PARAM_BOOL);
+		$datetimeParam = $this->qb->createNamedParameter('datetime_prop', IQueryBuilder::PARAM_DATETIME_IMMUTABLE);
 
-		$this->qb->expects($this->exactly(5))
+		$this->qb->expects($this->exactly(6))
 			->method('createNamedParameter')
 			->withConsecutive(
 				[$this->equalTo(123), $this->equalTo(IQueryBuilder::PARAM_INT)],
 				[$this->equalTo(true), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
 				[$this->equalTo('string'), $this->equalTo(IQueryBuilder::PARAM_STR)],
 				[$this->equalTo(456), $this->equalTo(IQueryBuilder::PARAM_INT)],
-				[$this->equalTo(false), $this->equalTo(IQueryBuilder::PARAM_BOOL)]
+				[$this->equalTo(false), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
+				[$this->equalTo($datetime), $this->equalTo(IQueryBuilder::PARAM_DATETIME_IMMUTABLE)],
 			);
-		$this->qb->expects($this->exactly(5))
+		$this->qb->expects($this->exactly(6))
 			->method('setValue')
 			->withConsecutive(
 				[$this->equalTo('int_prop'), $this->equalTo($intParam)],
 				[$this->equalTo('bool_prop'), $this->equalTo($boolParam)],
 				[$this->equalTo('string_prop'), $this->equalTo($stringParam)],
 				[$this->equalTo('integer_prop'), $this->equalTo($integerParam)],
-				[$this->equalTo('boolean_prop'), $this->equalTo($booleanParam)]
+				[$this->equalTo('boolean_prop'), $this->equalTo($booleanParam)],
+				[$this->equalTo('datetime_prop'), $this->equalTo($datetimeParam)],
 			);
 
 		$this->mapper->insert($entity);
@@ -146,6 +143,7 @@ class QBMapperTest extends \Test\TestCase {
 
 	
 	public function testUpdateEntityParameterTypeMapping(): void {
+		$datetime = new \DateTimeImmutable();
 		$entity = new QBTestEntity();
 		$entity->setId(789);
 		$entity->setIntProp(123);
@@ -153,7 +151,8 @@ class QBMapperTest extends \Test\TestCase {
 		$entity->setStringProp('string');
 		$entity->setIntegerProp(456);
 		$entity->setBooleanProp(false);
-		$entity->setJsonProp(['hello' => 'world']);
+		$entity->setJsonProp(["hello" => "world"]);
+		$entity->setDatetimeProp($datetime);
 
 		$idParam = $this->qb->createNamedParameter('id', IQueryBuilder::PARAM_INT);
 		$intParam = $this->qb->createNamedParameter('int_prop', IQueryBuilder::PARAM_INT);
@@ -162,8 +161,9 @@ class QBMapperTest extends \Test\TestCase {
 		$integerParam = $this->qb->createNamedParameter('integer_prop', IQueryBuilder::PARAM_INT);
 		$booleanParam = $this->qb->createNamedParameter('boolean_prop', IQueryBuilder::PARAM_BOOL);
 		$jsonParam = $this->qb->createNamedParameter('json_prop', IQueryBuilder::PARAM_JSON);
+		$datetimeParam = $this->qb->createNamedParameter('datetime_prop', IQueryBuilder::PARAM_DATETIME_IMMUTABLE);
 
-		$this->qb->expects($this->exactly(7))
+		$this->qb->expects($this->exactly(8))
 			->method('createNamedParameter')
 			->withConsecutive(
 				[$this->equalTo(123), $this->equalTo(IQueryBuilder::PARAM_INT)],
@@ -171,11 +171,12 @@ class QBMapperTest extends \Test\TestCase {
 				[$this->equalTo('string'), $this->equalTo(IQueryBuilder::PARAM_STR)],
 				[$this->equalTo(456), $this->equalTo(IQueryBuilder::PARAM_INT)],
 				[$this->equalTo(false), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
-				[$this->equalTo(['hello' => 'world']), $this->equalTo(IQueryBuilder::PARAM_JSON)],
+				[$this->equalTo(["hello" => "world"]), $this->equalTo(IQueryBuilder::PARAM_JSON)],
+				[$this->equalTo($datetime), $this->equalTo(IQueryBuilder::PARAM_DATETIME_IMMUTABLE)],
 				[$this->equalTo(789), $this->equalTo(IQueryBuilder::PARAM_INT)],
 			);
 
-		$this->qb->expects($this->exactly(6))
+		$this->qb->expects($this->exactly(7))
 			->method('set')
 			->withConsecutive(
 				[$this->equalTo('int_prop'), $this->equalTo($intParam)],
@@ -183,7 +184,8 @@ class QBMapperTest extends \Test\TestCase {
 				[$this->equalTo('string_prop'), $this->equalTo($stringParam)],
 				[$this->equalTo('integer_prop'), $this->equalTo($integerParam)],
 				[$this->equalTo('boolean_prop'), $this->equalTo($booleanParam)],
-				[$this->equalTo('json_prop'), $this->equalTo($jsonParam)]
+				[$this->equalTo('json_prop'), $this->equalTo($jsonParam)],
+				[$this->equalTo('datetime_prop'), $this->equalTo($datetimeParam)],
 			);
 
 		$this->expr->expects($this->once())
@@ -216,6 +218,9 @@ class QBMapperTest extends \Test\TestCase {
 		$jsonType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'jsonProp');
 		$this->assertEquals(IQueryBuilder::PARAM_JSON, $jsonType, 'JSON type property mapping incorrect');
 
+		$datetimeType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'datetimeProp');
+		$this->assertEquals(IQueryBuilder::PARAM_DATETIME_IMMUTABLE, $datetimeType, 'DateTimeImmutable type property mapping incorrect');
+
 		$unknownType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'someProp');
 		$this->assertEquals(IQueryBuilder::PARAM_STR, $unknownType, 'Unknown type property mapping incorrect');
 	}