Merge pull request #774 from CDLUC3/feature/281/JS-create-editable-user-profile-page

Updates for the Admin User Profile page

Author: jupiter007

CHANGELOG.md

@@ -3,6 +3,10 @@
 ## v1.1.0
 
 ### Added
+- Added `isArchived` field to the `users` table to help us filter those users out when returned in `users` response [#281]
+- Added `findByProjectIdWithPagination` method to the `PlanSearchResult` model for the `plans` resolver [#281]
+- Added `userProjects` query to return all projects for a specified user, with search term and pagination [#281]
+- Added `updateUserRole` mutation for admins to change a user's role, `updateUserInfo` mutation for super admins to update a specified user's profile, and an `archiveUser` mutation to archive a user[#281]
 - Added a default researc h output table question to the default template
 - Added data migration to add `displayAbbreviation` and `displayDomain` to the `affiliations` table
 - Added data migration to backfill those new DB fields
@@ -102,6 +106,8 @@
 - added data-migration to fix question JSON so that `"selected": 0` is now `"selected": false` (and `1` -> `true`).
 
 ### Updated
+- Updated `plans` resolver to have pagination for a specified `userId` with optional `search term`, and added a chained resolver for `PlanSearchResult` for `templateOwnerAffiliationName` [#281]
+- Updated `PlanSearchResult` model to include `createdById` and `templateOwnerAffiliationName` for the Admin Users page [#281]
 - Update local migration to add RO question to default template
 - Updated `users` resolver to include `role` and `affiliationId` [#240]
 - Added `findByAffiliationId` and `search` to pass in `role` as optional [#240]

data-migrations/2026-06-25-0919-add-isArchived-field-to-users.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `users`
+ADD COLUMN `isArchived` tinyint(1) NOT NULL DEFAULT '0' AFTER `active`;

src/models/Plan.ts

@@ -13,6 +13,14 @@ import { PlanGuidance } from "./Guidance";
 import { VersionedTemplate } from "./VersionedTemplate";
 import { Project } from "./Project";
 import { Tag } from "./Tag";
+import {
+  PaginatedQueryResults,
+  PaginationOptions,
+  PaginationOptionsForCursors,
+  PaginationOptionsForOffsets,
+  PaginationType
+} from '../types/general';
+import { prepareObjectForLogs } from '../logger';
 
 export const DEFAULT_TEMPORARY_DMP_ID_PREFIX = 'temp-dmpId-';
 
@@ -52,6 +60,7 @@ export class PlanSearchResult {
   public id: number;
   public createdBy: string;
   public created: string;
+  public createdById: number;
   public modifiedBy: string;
   public modified: string;
   public title: string;
@@ -62,6 +71,7 @@ export class PlanSearchResult {
   public members: string;
   public templateTitle: string;
   public versionedTemplateId: number;
+  public templateOwnerAffiliationName: string;
 
   // The following fields will only be set when the plan is published!
   public dmpId: string;
@@ -72,6 +82,7 @@ export class PlanSearchResult {
     this.id = options.id;
     this.createdBy = options.createdBy;
     this.created = options.created;
+    this.createdById = options.createdById;
     this.modifiedBy = options.modifiedBy;
     this.modified = options.modified;
     this.title = options.title;
@@ -80,23 +91,24 @@ export class PlanSearchResult {
     this.featured = options.featured ?? false;
     this.funding = options.funding;
     this.members = options.members;
-    this.templateTitle = options.title;
+    this.templateTitle = options.templateTitle;
     this.versionedTemplateId = options.versionedTemplateId;
+    this.templateOwnerAffiliationName = options.templateOwnerAffiliationName;
 
     this.dmpId = options.dmpId;
     this.registeredBy = options.registeredBy;
     this.registered = options.registered;
   }
 
   /**
-   * Find high-level details about the plans for a project. This information is
-   * meant to supply an overview of the plans.
-   *
-   * @param reference The caller's reference string for logging purposes'
-   * @param context The Apollo context object
-   * @param projectId The ID of the project to return plans for
-   * @returns An array of PlanSearchResult objects
-   */
+ * Find high-level details about the plans for a project. This information is
+ * meant to supply an overview of the plans.
+ *
+ * @param reference The caller's reference string for logging purposes'
+ * @param context The Apollo context object
+ * @param projectId The ID of the project to return plans for
+ * @returns An array of PlanSearchResult objects
+ */
   static async findByProjectId(reference: string, context: MyContext, projectId: number): Promise<PlanSearchResult[]> {
     const sql = 'SELECT p.id, ' +
       'CONCAT(cu.givenName, CONCAT(\' \', cu.surName)) createdBy, p.created, ' +
@@ -125,6 +137,97 @@ export class PlanSearchResult {
     const results = await Plan.query(context, sql, [projectId?.toString()], reference);
     return Array.isArray(results) ? results.map((entry) => new PlanSearchResult(entry)) : [];
   }
+
+  /**
+   * Find projects/plans for a specified userId, with pagination and optional search term filtering. 
+   * This method returns a paginated list of PlanSearchResult objects that match the search criteria.
+   *
+   * @param reference The caller's reference string for logging purposes'
+   * @param context The Apollo context object
+   * @param userId The ID of the user to return projects for
+   * @param options Pagination options for the query
+   * @param term Optional search term to filter the results
+   * @returns An array of PlanSearchResult objects
+   */
+  static async findByUserIdWithPagination(
+    reference: string,
+    context: MyContext,
+    userId: number,
+    options: PaginationOptions = Plan.getDefaultPaginationOptions(),
+    term?: string,
+  ): Promise<PaginatedQueryResults<PlanSearchResult>> {
+    const whereFilters = ['p.createdById = ?'];
+    const values = [userId.toString()];
+
+    // Handle the incoming search term
+    const searchTerm = (term ?? '').toLowerCase().trim();
+    if (searchTerm) {
+      whereFilters.push(`(
+      LOWER(p.title) LIKE ? OR
+      LOWER(vt.name) LIKE ?
+    )`);
+      values.push(`%${searchTerm}%`, `%${searchTerm}%`);
+    }
+
+    const sqlStatement = `
+    SELECT p.id, p.createdById,
+      CONCAT(cu.givenName, ' ', cu.surName) createdBy, p.created,
+      CONCAT(cm.givenName, ' ', cm.surName) modifiedBy, p.modified,
+      p.versionedTemplateId, p.title, p.status, p.visibility, p.dmpId,
+      vt.name AS templateTitle,
+      CONCAT(cr.givenName, ' ', cr.surName) registeredBy, p.registered, p.featured,
+      GROUP_CONCAT(DISTINCT CONCAT(prc.givenName, ' ', prc.surName, ' (', r.label, ')')) members,
+      GROUP_CONCAT(DISTINCT fundings.name) funding
+    FROM plans p
+    LEFT JOIN users cu ON cu.id = p.createdById
+    LEFT JOIN users cm ON cm.id = p.modifiedById
+    LEFT JOIN users cr ON cr.id = p.registeredById
+    LEFT JOIN versionedTemplates vt ON vt.id = p.versionedTemplateId
+    LEFT JOIN planMembers plc ON plc.planId = p.id
+    LEFT JOIN projectMembers prc ON prc.id = plc.projectMemberId
+    LEFT JOIN planMemberRoles plcr ON plc.id = plcr.planMemberId
+    LEFT JOIN memberRoles r ON plcr.memberRoleId = r.id
+    LEFT JOIN planFundings ON planFundings.planId = p.id
+    LEFT JOIN projectFundings ON projectFundings.id = planFundings.projectFundingId
+    LEFT JOIN affiliations fundings ON projectFundings.affiliationId = fundings.uri
+  `;
+
+    const groupBy = `
+    GROUP BY p.id, p.createdById,cu.givenName, cu.surName, cm.givenName, cm.surName,
+    p.title, p.status, p.visibility,
+    p.dmpId, cr.givenName, cr.surName, p.registered, p.featured, vt.name
+  `;
+
+    let opts;
+    if (options.type === PaginationType.OFFSET) {
+      opts = {
+        ...options,
+        availableSortFields: ['p.title', 'p.status', 'p.created', 'p.modified', 'p.registered', 'p.visibility'],
+      } as PaginationOptionsForOffsets;
+    } else {
+      opts = {
+        ...options,
+        cursorField: 'CONCAT(p.title, p.id)',
+      } as PaginationOptionsForCursors;
+    }
+
+    if (isNullOrUndefined(opts.sortField)) opts.sortField = 'p.created';
+    if (isNullOrUndefined(opts.sortDir)) opts.sortDir = 'DESC';
+    opts.countField = 'p.id';
+
+    const response: PaginatedQueryResults<PlanSearchResult> = await Plan.queryWithPagination(
+      context,
+      sqlStatement,
+      whereFilters,
+      groupBy,
+      values,
+      opts,
+      reference,
+    );
+
+    context.logger.debug(prepareObjectForLogs({ options, response }), reference);
+    return response;
+  }
 }
 
 export enum PlanSectionType {

src/models/User.ts

@@ -56,6 +56,7 @@ export class User extends MySqlModel {
 
   public locked?: boolean;
   public active?: boolean;
+  public isArchived?: boolean;
 
   public tableName = 'users';
 
@@ -81,6 +82,7 @@ export class User extends MySqlModel {
     this.notify_on_feedback_complete = options.notify_on_feedback_complete ?? true;
     this.notify_on_plan_shared = options.notify_on_plan_shared ?? true;
     this.notify_on_plan_visibility_change = options.notify_on_plan_visibility_change ?? true;
+    this.isArchived = options.isArchived ?? false;
 
     this.prepForSave();
   }
@@ -218,6 +220,8 @@ export class User extends MySqlModel {
     const whereFilters = ['u.affiliationId = ?'];
     const values = [affiliationId];
 
+    whereFilters.push('u.isArchived = 0');
+
     if (!isNullOrUndefined(role)) {
       whereFilters.push('u.role = ?');
       values.push(role);
@@ -288,6 +292,8 @@ export class User extends MySqlModel {
     const whereFilters: string[] = [];
     const values: string[] = [];
 
+    whereFilters.push('u.isArchived = 0');
+
     // Handle the incoming search term
     const searchTerm = (term ?? '').toLowerCase().trim();
     if (!isNullOrUndefined(searchTerm)) {

src/models/__mocks__/Plan.ts

@@ -54,6 +54,7 @@ const planToPlanSearchResult = (plan: Plan): PlanSearchResult => {
   return {
     id: plan.id,
     createdBy: casual.full_name,
+    createdById: plan.createdById,
     created: plan.created,
     modifiedBy: casual.full_name,
     modified: plan.modified,
@@ -68,6 +69,7 @@ const planToPlanSearchResult = (plan: Plan): PlanSearchResult => {
     members: casual.full_name,
     templateTitle: casual.title,
     versionedTemplateId: plan.versionedTemplateId,
+    templateOwnerAffiliationName: casual.company_name,
   }
 }