8.1.7

D8CORE-4693 Invalidate events whose end dates have recently passed (#19)

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Stanford Fields
 
+
+8.x-1.7
+--------------------------------------------------------------------------------
+_Release Date: 2021-10-08_
+
+- D8CORE-4693 Invalidate events whose end dates have recently passed (#19)
+
 8.x-1.5
 --------------------------------------------------------------------------------
 _Release Date: 2021-05-07_

src/Service/FieldCache.php

@@ -73,6 +73,7 @@ public function invalidateDateFieldsCache() {
     }
 
     Cache::invalidateTags(array_unique($cache_tags));
+    $this->state->set('stanford_fields.dates_cleared', time() - 5);
   }
 
   /**
@@ -111,21 +112,38 @@ protected function getExpiredDateCacheTags($entity_type, $field_name, array $bun
 
     // Query all entities for the given date field that is between the last ran
     // time and the current time.
-    $query = $entity_storage->getQuery()
+    $start_query = $entity_storage->getQuery()
       ->accessCheck(FALSE)
-      ->exists($field_name)
+      ->exists($field_name);
+    $end_query = clone $start_query;
+    $condition_group = $start_query->andConditionGroup()
       ->condition($field_name, $now->format($field_date_format), '<=')
       ->condition($field_name, $last_ran->format($field_date_format), '>=');
+    $start_query->condition($condition_group);
 
     // Some entity types don't have bundles, so don't add the condition if not
     // applicable.
     if ($bundle_key) {
-      $query->condition($bundle_key, $bundles, 'IN');
+      $start_query->condition($bundle_key, $bundles, 'IN');
+      $end_query->condition($bundle_key, $bundles, 'IN');
     }
-    $tags = [];
 
+    $field_properties = $field_definition->getPropertyNames();
+    // If the field type has an end value, modify the end query's conditions to
+    // check for those values.
+    if (in_array('end_value', $field_properties)) {
+      $condition_group = $end_query->andConditionGroup()
+        ->condition("$field_name.end_value", $now->format($field_date_format), '<=')
+        ->condition("$field_name.end_value", $last_ran->format($field_date_format), '>=');
+    }
+    $end_query->condition($condition_group);
+
+    // Merge the start query ids with the end query ids.
+    $entity_ids = array_merge($start_query->execute(), $end_query->execute());
+
+    $tags = [];
     // If no entity ids were found, no tags should be invalidated.
-    if ($entity_ids = $query->execute()) {
+    if (!empty($entity_ids)) {
       $entities = $entity_storage->loadMultiple($entity_ids);
       foreach ($entities as $entity) {
         $tags = array_merge($tags, $entity->getCacheTagsToInvalidate());

stanford_fields.info.yml

@@ -3,6 +3,6 @@ type: module
 description: 'Field types, widgets and formatters to enhance Drupal and Contrib.'
 core_version_requirement: ^8 || ^9
 package: Stanford
-version: 8.x-1.6
+version: 8.x-1.7
 dependencies:
  - drupal:field

stanford_fields.module

@@ -41,5 +41,4 @@ function stanford_fields_field_storage_add_validate(&$form, FormStateInterface $
  */
 function stanford_fields_cron() {
   \Drupal::service('stanford_fields.field_cache')->invalidateDateFieldsCache();
-  \Drupal::state()->set('stanford_fields.dates_cleared', time() - 5);
 }

tests/src/Kernel/Service/FieldCacheTest.php

@@ -26,6 +26,7 @@ class FieldCacheTest extends KernelTestBase {
     'node',
     'user',
     'datetime',
+    'datetime_range',
     'field',
   ];
 
@@ -68,6 +69,16 @@ protected function setUp(): void {
       'bundle' => 'page',
       'field_name' => 'field_date',
     ])->save();
+    FieldStorageConfig::create([
+      'entity_type' => 'node',
+      'type' => 'daterange',
+      'field_name' => 'field_daterange',
+    ])->save();
+    FieldConfig::create([
+      'entity_type' => 'node',
+      'bundle' => 'page',
+      'field_name' => 'field_daterange',
+    ])->save();
     \Drupal::getContainer()->set('cache_tags.invalidator', $cache_invalidator);
   }
 
@@ -91,12 +102,29 @@ public function testDateInvalidation() {
       ->invalidateDateFieldsCache();
     $this->assertEmpty($this->invalidatedTags);
 
+    \Drupal::state()
+      ->set('stanford_fields.dates_cleared', time() - 60 * 60 * 24 * 4);
     $node->set('field_date', date($this->dateFieldFormat, time() - 60 * 60 * 24 * 3))
       ->save();
     $this->invalidatedTags = [];
     \Drupal::service('stanford_fields.field_cache')
       ->invalidateDateFieldsCache();
     $this->assertTrue(in_array('node:' . $node->id(), $this->invalidatedTags));
+
+    \Drupal::state()
+      ->set('stanford_fields.dates_cleared', time() - 60 * 60 * 24 * 4);
+    $daterange = [
+      'value' => date($this->dateFieldFormat, time() - 60 * 60 * 24 * 10),
+      'end_value' => date($this->dateFieldFormat, time() - 60 * 60 * 24),
+    ];
+    $node->set('field_date', [])
+      ->set('field_daterange', $daterange)
+      ->save();
+
+    $this->invalidatedTags = [];
+    \Drupal::service('stanford_fields.field_cache')
+      ->invalidateDateFieldsCache();
+    $this->assertTrue(in_array('node:' . $node->id(), $this->invalidatedTags));
   }
 
   /**
@@ -117,4 +145,4 @@ public function invalidateTagsCallback($tags) {
     $this->invalidatedTags = $tags;
   }
 
-}
+}