Og membership state cache context

og.services.yml

@@ -4,6 +4,11 @@ services:
     arguments: ['@entity_type.manager', '@og.access']
     tags:
       - { name: access_check, applies_to: _og_user_access_group }
+  cache_context.og_membership_state:
+    class: 'Drupal\og\Cache\Context\OgMembershipStateCacheContext'
+    arguments: ['@current_user', '@current_route_match', '@og.group_type_manager', '@og.membership_manager']
+    tags:
+      - { name: 'cache.context'}
   og.access:
     class: Drupal\og\OgAccess
     arguments: ['@config.factory', '@current_user', '@module_handler', '@og.group_type_manager', '@og.permission_manager', '@og.membership_manager']

src/Annotation/OgDeleteOrphans.php

@@ -21,18 +21,18 @@ class OgDeleteOrphans extends Plugin {
   /**
    * The human-readable name of the plugin.
    *
-   * @ingroup plugin_translatable
-   *
    * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
    */
   public $label;
 
   /**
    * A short description of the plugin.
    *
-   * @ingroup plugin_translatable
-   *
    * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
    */
   public $description;
 

src/Cache/Context/OgMembershipStateCacheContext.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace Drupal\og\Cache\Context;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Cache\Context\CacheContextInterface;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\og\GroupTypeManager;
+use Drupal\og\MembershipManagerInterface;
+use Drupal\og\OgMembershipInterface;
+
+/**
+ * Defines a cache context service, for "membership state" caching.
+ *
+ * Cache context ID: 'og_membership_state'
+ */
+class OgMembershipStateCacheContext implements CacheContextInterface {
+
+  /**
+   * The string to return when no context is found.
+   */
+  const NO_CONTEXT = 'none';
+
+
+  /**
+   * The group type manager service.
+   *
+   * @var \Drupal\og\GroupTypeManager
+   */
+  protected $groupTypeManager;
+
+
+  /**
+   * The membership manager service.
+   *
+   * @var \Drupal\og\MembershipManagerInterface
+   */
+  protected $membershipManager;
+
+  /**
+   * The route match service.
+   *
+   * @var \Drupal\Core\Routing\RouteMatchInterface
+   */
+  protected $routeMatch;
+
+  /**
+   * The current user.
+   *
+   * @var \Drupal\Core\Session\AccountInterface
+   */
+  protected $user;
+
+  /**
+   * Constructs a new UserCacheContextBase class.
+   *
+   * @param \Drupal\Core\Session\AccountInterface $user
+   *   The current user.
+   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
+   *   The current route match service.
+   * @param \Drupal\og\GroupTypeManager $group_type_manager
+   *   The group type manager service.
+   * @param \Drupal\og\MembershipManagerInterface $membership_manager
+   *   The membership manager service.
+   */
+  public function __construct(AccountInterface $user, RouteMatchInterface $route_match, GroupTypeManager $group_type_manager, MembershipManagerInterface $membership_manager) {
+    $this->user = $user;
+    $this->routeMatch = $route_match;
+    $this->groupTypeManager = $group_type_manager;
+    $this->membershipManager = $membership_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getLabel() {
+    return t('OG membership state');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getContext() {
+    if (!$route_contexts = $this->routeMatch->getRouteObject()->getOption('parameters')) {
+      // No "parameters" defined in the route.
+      return self::NO_CONTEXT;
+    }
+
+    if (!$entity_type_ids = array_keys($this->groupTypeManager->getAllGroupBundles())) {
+      // No group entities.
+      return self::NO_CONTEXT;
+    }
+
+    if (!$entity_type_ids = array_intersect(array_keys($route_contexts), $entity_type_ids)) {
+      // No parameters that match the group entities.
+      return self::NO_CONTEXT;
+    }
+
+    // Take just the first entity type ID.
+    $entity_type_id = reset($entity_type_ids);
+
+    $group = $this->routeMatch->getParameter($entity_type_id);
+    $states = [
+      OgMembershipInterface::STATE_ACTIVE,
+      OgMembershipInterface::STATE_PENDING,
+      OgMembershipInterface::STATE_BLOCKED,
+    ];
+
+    /** @var OgMembershipInterface $membership */
+    $membership = $this->membershipManager->getMembership($group, $this->user, $states);
+    return $membership ? $membership->getState() : self::NO_CONTEXT;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheableMetadata() {
+    return new CacheableMetadata();
+  }
+
+}

src/GroupContentOperationPermission.php

@@ -13,14 +13,14 @@ class GroupContentOperationPermission extends Permission {
   /**
    * The group content entity type ID to which this permission applies.
    *
-   * @var $string
+   * @var string
    */
   protected $entityType;
 
   /**
    * The group content bundle ID to which this permission applies.
    *
-   * @var $string
+   * @var string
    */
   protected $bundle;
 
@@ -29,7 +29,7 @@ class GroupContentOperationPermission extends Permission {
    *
    * Examples: 'create', 'update', 'delete'.
    *
-   * @var $string
+   * @var string
    */
   protected $operation;
 

src/GroupTypeManager.php

@@ -92,6 +92,9 @@ class GroupTypeManager {
    * Do not access this property directly, use $this->getGroupRelationMap()
    * instead.
    *
+   * @var array
+   *   An associative array representing group and group content relations.
+   *
    * This mapping is in the following format:
    * @code
    *   [
@@ -104,9 +107,6 @@ class GroupTypeManager {
    *     ],
    *   ]
    * @endcode
-   *
-   * @var array $groupRelationMap
-   *   An associative array representing group and group content relations.
    */
   protected $groupRelationMap = [];
 

src/OgAccess.php

@@ -119,7 +119,7 @@ public function userAccess(EntityInterface $group, $operation, AccountInterface
     // the minimal caching data.
     $config = $this->configFactory->get('og.settings');
     $cacheable_metadata = (new CacheableMetadata())
-        ->addCacheableDependency($config);
+      ->addCacheableDependency($config);
 
     if (!$this->groupTypeManager->isGroup($group_type_id, $bundle)) {
       // Not a group.

src/OgDeleteOrphansInterface.php

@@ -43,7 +43,7 @@ public function process();
    * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   The current state of the form.
    *
-   * @return array $form
+   * @return array
    *   The renderable form array representing the entire configuration form.
    */
   public function configurationForm(array $form, FormStateInterface $form_state);

src/OgMembershipInterface.php

@@ -82,7 +82,7 @@ public function setUser(AccountInterface $user);
   /**
    * Gets the membership's owner.
    *
-   * @return \Drupal\Core\Session\AccountInterface $user
+   * @return \Drupal\Core\Session\AccountInterface
    *   The user object referenced by the membership.
    */
   public function getUser();
@@ -101,7 +101,7 @@ public function setGroup(EntityInterface $group);
   /**
    * Gets the group associated with the membership.
    *
-   * @return \Drupal\Core\Entity\EntityInterface $group
+   * @return \Drupal\Core\Entity\EntityInterface
    *   The group object which the membership reference to.
    */
   public function getGroup();

src/Plugin/Field/FieldFormatter/GroupSubscribeFormatter.php

@@ -102,10 +102,8 @@ public static function create(ContainerInterface $container, array $configuratio
   public function viewElements(FieldItemListInterface $items, $langcode) {
     $elements = [];
 
-    // We cannot use the field cache, as the formatter changes according to the
-    // user. Furthermore, this is not an expensive check, so we remove the cache
-    // entirely.
-    $elements['#cache']['max-age'] = 0;
+    // Cache by the OG membership state.
+    $elements['#cache']['contexts'] = ['og_membership_state'];
 
     $group = $items->getEntity();
     $entity_type_id = $group->getEntityTypeId();

tests/src/Kernel/Entity/SelectionHandlerTest.php

@@ -21,7 +21,7 @@ class SelectionHandlerTest extends KernelTestBase {
   /**
    * The selection handler.
    *
-   * @var \Drupal\og\Plugin\EntityReferenceSelection\OgSelection.
+   * @var \Drupal\og\Plugin\EntityReferenceSelection\OgSelection
    */
   protected $selectionHandler;
 

tests/src/Unit/OgAdminRoutesControllerTest.php

@@ -206,7 +206,7 @@ public function testRoutesWithAccess() {
    * @param bool $allow_access
    *   Indicate of access to the routes should be given.
    *
-   * @return array The render array.
+   * @return array
    *   The render array.
    */
   protected function getRenderElementResult($allow_access) {