Added endpoint to mark users as stale, added cronjob to call once weekly, setting in admin panel to set as stale, updated team member search to omit stale users, updated tests

Author: RyanBirtch-aot

app/frontend/src/components/admin/AdministerUser.vue

@@ -1,6 +1,6 @@
 <script setup>
 import { storeToRefs } from 'pinia';
-import { onMounted } from 'vue';
+import { onMounted, ref } from 'vue';
 import { useI18n } from 'vue-i18n';
 
 import { useAdminStore } from '~/store/admin';
@@ -17,16 +17,35 @@ const properties = defineProps({
 const adminStore = useAdminStore();
 
 const { user } = storeToRefs(adminStore);
+const updatingStale = ref(false);
 
 onMounted(async () => {
   await adminStore.readUser(properties.userId);
 });
+
+async function updateStale(stale) {
+  updatingStale.value = true;
+  try {
+    await adminStore.updateUser(properties.userId, { stale });
+  } finally {
+    updatingStale.value = false;
+  }
+}
 </script>
 
 <template>
   <div>
     <h3>{{ user.fullName }}</h3>
     <h4 :lang="locale">{{ $t('trans.administerUser.userDetails') }}</h4>
+    <v-switch
+      data-test="stale-user-switch"
+      color="warning"
+      :disabled="updatingStale"
+      label="Mark as Stale"
+      :loading="updatingStale"
+      :model-value="Boolean(user.stale)"
+      @update:model-value="updateStale"
+    />
     <pre>{{ user }}</pre>
   </div>
 </template>

app/frontend/src/components/forms/manage/AddTeamMember.vue

@@ -126,6 +126,7 @@ async function searchUsers(input) {
   isLoading.value = true;
   try {
     let params = {};
+    params.stale = false;
     params.idpCode = selectedIdp.value;
     let teamMembershipConfig = idpStore.teamMembershipSearch(selectedIdp.value);
     if (teamMembershipConfig) {

app/frontend/src/services/adminService.js

@@ -143,6 +143,19 @@ export default {
     return appAxios().get(`${ApiRoutes.ADMIN}${ApiRoutes.USERS}/${userId}`);
   },
 
+  /**
+   * Update a user's administrable fields.
+   * @param {string} userId The user GUID
+   * @param {{stale: boolean}} data The user fields to update
+   * @returns {Promise} An axios response
+   */
+  updateUser(userId, data) {
+    return appAxios().patch(
+      `${ApiRoutes.ADMIN}${ApiRoutes.USERS}/${userId}`,
+      data
+    );
+  },
+
   //
   // External API calls
   //

app/frontend/src/store/admin.js

@@ -208,6 +208,21 @@ export const useAdminStore = defineStore('admin', {
         });
       }
     },
+    async updateUser(userId, data) {
+      try {
+        const response = await adminService.updateUser(userId, data);
+        this.user = response.data;
+      } catch (error) {
+        const notificationStore = useNotificationStore();
+        notificationStore.addNotification({
+          text: i18n.t('trans.store.admin.getUserErrMsg'),
+          consoleError: i18n.t('trans.store.admin.getUserConsErrMsg', {
+            userId: userId,
+            error: error,
+          }),
+        });
+      }
+    },
 
     //
     // External APIs

app/frontend/tests/unit/components/admin/AdministerUser.spec.js

@@ -44,4 +44,31 @@ describe('AdministerUser.vue', () => {
     await flushPromises();
     expect(wrapper.text()).toContain('alice');
   });
+
+  it('updates the stale status', async () => {
+    adminStore.readUser.mockImplementation(() => {});
+    adminStore.updateUser.mockResolvedValue();
+    adminStore.user = {
+      fullName: 'alice',
+      keycloakId: '1',
+      stale: false,
+    };
+    const wrapper = mount(AdministerUser, {
+      props: {
+        userId: 'me',
+      },
+      global: {
+        plugins: [pinia],
+        stubs: {},
+      },
+    });
+
+    await flushPromises();
+    wrapper
+      .findComponent({ name: 'VSwitch' })
+      .vm.$emit('update:modelValue', true);
+    await flushPromises();
+
+    expect(adminStore.updateUser).toHaveBeenCalledWith('me', { stale: true });
+  });
 });

app/frontend/tests/unit/services/adminService.spec.js

@@ -131,6 +131,15 @@ describe('Admin Service', () => {
       expect(result).toBeTruthy();
       expect(mockAxios.history.get).toHaveLength(1);
     });
+
+    it('calls patch endpoint', async () => {
+      mockAxios.onPatch(endpoint).reply(200);
+
+      const result = await adminService.updateUser(zeroUuid, { stale: true });
+      expect(result).toBeTruthy();
+      expect(mockAxios.history.patch).toHaveLength(1);
+      expect(JSON.parse(mockAxios.history.patch[0].data)).toEqual({ stale: true });
+    });
   });
 
   //

app/frontend/tests/unit/store/modules/admin.actions.spec.js

@@ -244,6 +244,16 @@ describe('admin actions', () => {
       });
     });
 
+    it('updateUser should replace the current user', async () => {
+      const updatedUser = { id: 'userId', stale: true };
+      adminService.updateUser.mockResolvedValue({ data: updatedUser });
+
+      await mockStore.updateUser('userId', { stale: true });
+
+      expect(adminService.updateUser).toHaveBeenCalledWith('userId', { stale: true });
+      expect(mockStore.user).toEqual(updatedUser);
+
+    });
     it('addFCProactiveHelp should commit to SET_FCPROACTIVEHELP', async () => {
       mockStore.fcProactiveHelp = undefined;
       adminService.addFCProactiveHelp.mockResolvedValue({ data: {} });

app/src/components/idpService.js

@@ -215,6 +215,7 @@ class IdpService {
       .modify('filterFirstName', params.firstName)
       .modify('filterLastName', params.lastName)
       .modify('filterEmail', params.email, false, false)
+      .modify('filterStale', params.stale)
       .modify('filterSearch', params.search)
       .modify('orderLastFirstAscending');
   }

app/src/db/migrations/20260821203642_add_stale_to_user.js

@@ -0,0 +1,11 @@
+exports.up = async function (knex) {
+  await knex.schema.alterTable('user', (table) => {
+    table.boolean('stale').notNullable().defaultTo(false).comment('Whether the user has been identified as stale.');
+  });
+};
+
+exports.down = async function (knex) {
+  await knex.schema.alterTable('user', (table) => {
+    table.dropColumn('stale');
+  });
+};

app/src/forms/admin/routes.js

@@ -67,6 +67,10 @@ routes.get('/users/:userId', async (req, res, next) => {
   await userController.read(req, res, next);
 });
 
+routes.patch('/users/:userId', async (req, res, next) => {
+  await userController.update(req, res, next);
+});
+
 //
 // External APIs
 //