Merge pull request #8071 from stopfstedt/frontend_5635_learner_group_…

…management_extra_info show the learner group ancestry as tooltip and a11y label.
ilios · Aug 16, 2024 · c739176 · c739176
2 parents e7bcc64 + 5b6bed4
commit c739176
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 2 deletions.
diff --git a/packages/frontend/app/components/learner-group/user-manager.hbs b/packages/frontend/app/components/learner-group/user-manager.hbs
@@ -103,11 +103,13 @@
                       {{user.email}}
                     </button>
                   </td>
-                  <td class="text-left" colspan="2">
+                  <td class="text-left" colspan="2" data-test-learnergroup>
                     <LinkTo
                       @route="learner-group"
                       @model={{user.lowestGroupInTree}}
                       @query={{hash isEditing=true sortUsersBy=@sortBy}}
+                      title={{user.lowestGroupInTree.titleWithParentTitles}}
+                      aria-label={{user.lowestGroupInTree.titleWithParentTitles}}
                     >
                       {{user.lowestGroupInTree.title}}
                     </LinkTo>
@@ -230,11 +232,13 @@
                       {{user.email}}
                     </button>
                   </td>
-                  <td class="text-left" colspan="2">
+                  <td class="text-left" colspan="2" data-test-learnergroup>
                     <LinkTo
                       @route="learner-group"
                       @model={{user.lowestGroupInTree}}
                       @query={{hash isEditing=true sortUsersBy=@sortBy}}
+                      title={{user.lowestGroupInTree.titleWithParentTitles}}
+                      aria-label={{user.lowestGroupInTree.titleWithParentTitles}}
                     >
                       {{user.lowestGroupInTree.title}}
                     </LinkTo>

diff --git a/packages/frontend/tests/integration/components/learner-group/user-manager-test.js b/packages/frontend/tests/integration/components/learner-group/user-manager-test.js
@@ -1036,4 +1036,69 @@ module('Integration | Component | learner-group/user-manager', function (hooks)
     await component.usersInCurrentGroup[0].email.click();
     assert.ok(component.usersInCurrentGroup[0].isSelected);
   });
+
+  test('learner-group hierarchy is shown in group-title and aria-label', async function (assert) {
+    const parentGroup = this.server.create('learner-group');
+    const learnerGroup = this.server.create('learner-group', { parent: parentGroup });
+    const childGroup = this.server.create('learner-group', { parent: learnerGroup });
+    const user1 = this.server.create('user', {
+      learnerGroups: [learnerGroup],
+    });
+    const user2 = this.server.create('user', {
+      learnerGroups: [childGroup],
+    });
+    const userModel1 = await this.owner.lookup('service:store').findRecord('user', user1.id);
+    const userModel2 = await this.owner.lookup('service:store').findRecord('user', user2.id);
+    const learnerGroupModel = await this.owner
+      .lookup('service:store')
+      .findRecord('learner-group', learnerGroup.id);
+    const childGroupModel = await this.owner
+      .lookup('service:store')
+      .findRecord('learner-group', childGroup.id);
+    const userModelProxy1 = ObjectProxy.create({
+      content: userModel1,
+      lowestGroupInTree: learnerGroupModel,
+      lowestGroupInTreeTitle: learnerGroupModel.title,
+    });
+    const userModelProxy2 = ObjectProxy.create({
+      content: userModel2,
+      lowestGroupInTree: childGroupModel,
+      lowestGroupInTreeTitle: childGroupModel.title,
+    });
+
+    this.set('users', [userModelProxy1, userModelProxy2]);
+    this.set('learnerGroup', learnerGroupModel);
+    await render(hbs`<LearnerGroup::UserManager
+      @learnerGroupId={{this.learnerGroup.id}}
+      @learnerGroupTitle="this group"
+      @topLevelGroupTitle="top group"
+      @cohortTitle="this cohort"
+      @users={{this.users}}
+      @sortBy="id"
+      @setSortBy={{(noop)}}
+      @addUserToGroup={{(noop)}}
+      @removeUserFromGroup={{(noop)}}
+      @addUsersToGroup={{(noop)}}
+      @removeUsersFromGroup={{(noop)}}
+    />`);
+
+    assert.strictEqual(component.usersInCurrentGroup.length, 1);
+    assert.strictEqual(
+      component.usersInCurrentGroup[0].learnerGroup.linkTitle,
+      'learner group 0 > learner group 1',
+    );
+    assert.strictEqual(
+      component.usersInCurrentGroup[0].learnerGroup.linkAriaLabel,
+      'learner group 0 > learner group 1',
+    );
+    assert.strictEqual(component.usersNotInCurrentGroup.length, 1);
+    assert.strictEqual(
+      component.usersNotInCurrentGroup[0].learnerGroup.linkTitle,
+      'learner group 0 > learner group 1 > learner group 2',
+    );
+    assert.strictEqual(
+      component.usersNotInCurrentGroup[0].learnerGroup.linkAriaLabel,
+      'learner group 0 > learner group 1 > learner group 2',
+    );
+  });
 });
diff --git a/packages/frontend/tests/pages/components/learner-group/user-manager.js b/packages/frontend/tests/pages/components/learner-group/user-manager.js
@@ -1,4 +1,5 @@
 import {
+  attribute,
   clickable,
   collection,
   create,
@@ -46,6 +47,11 @@ const definition = {
       isClickable: isPresent('button'),
       click: clickable('button'),
     },
+    learnerGroup: {
+      scope: '[data-test-learnergroup]',
+      linkTitle: attribute('title', 'a'),
+      linkAriaLabel: attribute('aria-label', 'a'),
+    },
     isDisabled: isPresent('td:nth-of-type(1) [data-test-is-disabled]'),
     remove: clickable('[data-test-remove-user]'),
     canBeRemoved: isPresent('[data-test-remove-user]'),
@@ -70,6 +76,11 @@ const definition = {
       isClickable: isPresent('button'),
       click: clickable('button'),
     },
+    learnerGroup: {
+      scope: '[data-test-learnergroup]',
+      linkTitle: attribute('title', 'a'),
+      linkAriaLabel: attribute('aria-label', 'a'),
+    },
     isDisabled: isPresent('td:nth-of-type(1) [data-test-is-disabled]'),
     add: clickable('[data-test-add-user]'),
     canBeAdded: isPresent('[data-test-add-user]'),

diff --git a/packages/ilios-common/addon/models/learner-group.js b/packages/ilios-common/addon/models/learner-group.js
@@ -473,6 +473,15 @@ export default class LearnerGroup extends Model {
     return parentTitles.join(' > ') + ' > ' + this.title;
   }
 
+  @cached
+  get titleWithParentTitlesData() {
+    return new TrackedAsyncData(this.getTitleWithParentTitles());
+  }
+
+  get titleWithParentTitles() {
+    return this.titleWithParentTitlesData.isResolved ? this.titleWithParentTitlesData.value : '';
+  }
+
   /**
    * Adds a user to a group and then traverses parent groups recursively
    * to add the user to them as well.  Will only modify groups where the