Commit eb8a71db authored by Michael Stenta's avatar Michael Stenta
Browse files

Issue #3259245: Change getGroupMembers to return an array of assets keyed by their ID

parents 884bb1e8 216f4cb2

CHANGELOG.md

+4 −0
Original line number Diff line number Diff line
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 


## [Unreleased]



### Changed



- [Issue #3259245: Change getGroupMembers to return an array of assets keyed by their ID](https://www.drupal.org/project/farm/issues/3259245)



### Fixed



- [Issue #3260645: CSV Export in Quantities not functioning](https://www.drupal.org/project/farm/issues/3260645)

modules/asset/group/src/GroupMembership.php

+2 −1
Original line number Diff line number Diff line
@@ -216,7 +216,8 @@ class GroupMembership implements GroupMembershipInterface { 
      $groups = array_filter($assets, function (AssetInterface $asset) {

        return $asset->bundle() === 'group';

      });

      $assets = array_merge($assets, $this->getGroupMembers($groups));

      // Use array_replace so that numeric keys are preserved.

      $assets = array_replace($assets, $this->getGroupMembers($groups));

    }

    return $assets;

  }

modules/asset/group/src/GroupMembershipInterface.php

+1 −1
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ interface GroupMembershipInterface { 
   *   Defaults to TRUE.

   *

   * @return \Drupal\asset\Entity\AssetInterface[]

   *   Returns an array of assets.

   *   An array of asset objects indexed by their IDs.

   */

  public function getGroupMembers(array $groups, bool $recurse = TRUE): array;

modules/asset/group/tests/src/Kernel/GroupTest.php

+84 −0
Original line number Diff line number Diff line
@@ -246,6 +246,90 @@ class GroupTest extends KernelTestBase { 
    $this->assertEquals($first_group->id(), $this->groupMembership->getGroup($second_animal)[0]->id(), 'The second animal is in the first group.');

    $group_members = $this->groupMembership->getGroupMembers([$first_group, $second_group]);

    $this->assertEquals(2, count($group_members), 'Group members from multiple groups can be queried together.');



    // Test that asset IDs are preserved as the array keys.

    $this->assertTrue(in_array($animal->id(), array_keys($group_members)), 'The ID of the first animal is preserved.');

    $this->assertTrue(in_array($second_animal->id(), array_keys($group_members)), 'The ID of the second animal is preserved.');

  }



  /**

   * Test recursive asset group membership.

   */

  public function testRecursiveGroupMembership() {



    // Create an animal asset.

    /** @var \Drupal\asset\Entity\AssetInterface $animal */

    $animal = Asset::create([

      'type' => 'animal',

      'name' => $this->randomMachineName(),

      'status' => 'active',

    ]);

    $animal->save();



    // Create group assets.

    /** @var \Drupal\asset\Entity\AssetInterface $first_group */

    $first_group = Asset::create([

      'type' => 'group',

      'name' => $this->randomMachineName(),

      'status' => 'active',

    ]);

    $first_group->save();

    /** @var \Drupal\asset\Entity\AssetInterface $second_group */

    $second_group = Asset::create([

      'type' => 'group',

      'name' => $this->randomMachineName(),

      'status' => 'active',

    ]);

    $second_group->save();



    // Create a "done" log to assign the animal to the second group.

    /** @var \Drupal\log\Entity\LogInterface $first_log */

    $first_log = Log::create([

      'type' => 'test',

      'status' => 'done',

      'is_group_assignment' => TRUE,

      'group' => ['target_id' => $second_group->id()],

      'asset' => ['target_id' => $animal->id()],

    ]);

    $first_log->save();



    // Create a "pending" log to assign the second group to the first group.

    /** @var \Drupal\log\Entity\LogInterface $second_log */

    $second_log = Log::create([

      'type' => 'test',

      'status' => 'pending',

      'is_group_assignment' => TRUE,

      'group' => ['target_id' => $first_group->id()],

      'asset' => ['target_id' => $second_group->id()],

    ]);

    $second_log->save();



    // Assert that the second group has no group and a single member.

    $this->assertFalse($this->groupMembership->hasGroup($second_group), 'The second group does not have a group.');

    $this->assertEquals(1, count($this->groupMembership->getGroupMembers([$second_group])), 'The second group has one member.');



    // Assert that the first group has no members.

    $this->assertEmpty($this->groupMembership->getGroupMembers([$first_group], FALSE), 'The first group has no members.');

    $this->assertEmpty($this->groupMembership->getGroupMembers([$first_group], TRUE), 'The first group has no recursive members.');



    // Save the second log to create the nested group membership.

    $second_log->status = 'done';

    $second_log->save();



    // Assert that the second group has a group and a single member.

    $this->assertTrue($this->groupMembership->hasGroup($second_group), 'The second group has a group.');

    $this->assertEquals(1, count($this->groupMembership->getGroupMembers([$second_group])), 'The second group has one member.');



    // Assert that the first group has a single direct member.

    $first_group_members = $this->groupMembership->getGroupMembers([$first_group], FALSE);

    $this->assertEquals(1, count($first_group_members, FALSE), 'The first group has one direct member.');

    $this->assertTrue(in_array($second_group->id(), array_keys($first_group_members)), 'The ID of the second group is preserved.');



    // Assert that the first group has two recursive members.

    $first_group_recursive_members = $this->groupMembership->getGroupMembers([$first_group], TRUE);

    $this->assertEquals(2, count($first_group_recursive_members), 'The first group has two recursive members.');

    $this->assertTrue(in_array($second_group->id(), array_keys($first_group_recursive_members)), 'The ID of the second group is preserved.');

    $this->assertTrue(in_array($animal->id(), array_keys($first_group_recursive_members)), 'The ID of the animal is preserved.');

  }



  /**