feat(permissions): implement email-first workflow with email-to-sub l… #117

jordane · 2025-10-06T20:51:09Z

…ookup

Update project permissions user form to use email-first workflow:

Ask for email first, then show confirmation if user not found
Support manual entry with full user details (name, username, avatar)
Replace EMAIL_TO_USERNAME with EMAIL_TO_SUB NATS subject
Convert writers/auditors from string arrays to UserInfo objects
Clean empty avatar fields before API submission to fix validation
Add user initials fallback when avatar not available
Display full user info (name, email, username, avatar) in table

Changes include:

Add EMAIL_TO_SUB to NatsSubjects enum
Update resolveEmailToUsername to use email_to_sub endpoint
Add getUserInfo method for fetching complete user profile
Modify updateProjectPermissions to handle UserInfo objects
Update user form with conditional field display logic
Add confirmation dialog for user not found scenario
Enhance permissions table with avatar, name, and email columns
Clean up empty avatar strings to prevent API validation errors

🤖 Generated with Claude Code

…ookup Update project permissions user form to use email-first workflow: - Ask for email first, then show confirmation if user not found - Support manual entry with full user details (name, username, avatar) - Replace EMAIL_TO_USERNAME with EMAIL_TO_SUB NATS subject - Convert writers/auditors from string arrays to UserInfo objects - Clean empty avatar fields before API submission to fix validation - Add user initials fallback when avatar not available - Display full user info (name, email, username, avatar) in table Changes include: - Add EMAIL_TO_SUB to NatsSubjects enum - Update resolveEmailToUsername to use email_to_sub endpoint - Add getUserInfo method for fetching complete user profile - Modify updateProjectPermissions to handle UserInfo objects - Update user form with conditional field display logic - Add confirmation dialog for user not found scenario - Enhance permissions table with avatar, name, and email columns - Clean up empty avatar strings to prevent API validation errors 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> Signed-off-by: Jordan Evans <[email protected]>

coderabbitai · 2025-10-06T20:51:19Z

Walkthrough

Introduces email-first user addition with optional manual entry on not-found; updates UI to display avatar/name/email; expands permissions data from usernames to full user objects; adjusts server APIs to accept and propagate manual user info; adds new NATS subjects and user info retrieval; updates shared interfaces and enums accordingly.

Changes

Cohort / File(s)	Summary of changes
Frontend: User form flow `apps/lfx-one/src/app/modules/project/settings/components/user-form/user-form.component.html`, `.../user-form/user-form.component.ts`	Switches primary identifier to email with validation; adds confirmation to enable manual fields (name, username, avatar) when email not found; separates edit (role-only) vs add flows; disables immutable fields in edit; adds cancel; appends confirm dialog.
Frontend: Permissions table UI `apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/user-permissions-table.component.html`, `.../user-permissions-table.component.ts`	Adds avatar, name, email columns; renders avatar with initials fallback (`getUserInitials`); updates empty-state colspan and styling.
Frontend: Permissions service mapping `apps/lfx-one/src/app/shared/services/permissions.service.ts`	Maps writers/auditors to objects including name, email, username, avatar instead of username-only.
Server: Controller `apps/lfx-one/src/server/controllers/project.controller.ts`	Builds optional manualUserInfo (name, email, username, avatar) and passes it to service when adding/updating permissions.
Server: Service and NATS integration `apps/lfx-one/src/server/services/project.service.ts`	`updateProjectPermissions` now stores full UserInfo objects; accepts optional manualUserInfo; adds `getUserInfo` (email/username resolution via NATS); introduces EMAIL_TO_SUB and username-to-user-info lookups; filters empty avatars; compares by username on remove.
Shared: NATS subjects `packages/shared/src/enums/nats.enum.ts`	Adds EMAIL_TO_SUB and USERNAME_TO_USER_INFO enum members.
Shared: Permissions interfaces `packages/shared/src/interfaces/permissions.interface.ts`	Extends ProjectPermissionUser with name, email, optional avatar; extends AddUserToProjectRequest with optional name, email, avatar.
Shared: Project interfaces `packages/shared/src/interfaces/project.interface.ts`	Adds UserInfo interface; changes ProjectSettings.writers/auditors from string[] to UserInfo[].

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Admin as Admin (UI)
  participant UF as UserFormComponent
  participant API as ProjectController
  participant SVC as ProjectService
  participant NATS as NATS
  participant Store as ProjectSettings

  Admin->>UF: Submit Add User (email + role)
  alt Manual fields not shown
    UF->>API: POST addUser(email, role)
    alt manualUserInfo provided (edit/manual path)
      API->>SVC: updateProjectPermissions(add/update, username, role, manualUserInfo)
      SVC->>Store: Upsert writers/auditors with manualUserInfo
      Store-->>UF: Success
    else lookup needed
      SVC->>NATS: EMAIL_TO_SUB / USERNAME_TO_USER_INFO
      alt Found user info
        SVC->>Store: Upsert with UserInfo (name,email,username,avatar?)
        Store-->>UF: Success
      else Not found
        SVC-->>API: 404 NOT_FOUND
        API-->>UF: 404
        UF->>Admin: Confirm switch to manual entry
        alt Admin accepts
          UF->>UF: Enable manual fields + validators
        else Admin cancels
          UF-->>Admin: Abort
        end
      end
    end
  else Manual fields shown
    Admin->>UF: Submit Manual Data (name, email, username, avatar?, role)
    UF->>API: POST addUser(...manualUserInfo)
    API->>SVC: updateProjectPermissions(add, username, role, manualUserInfo)
    SVC->>Store: Upsert with manualUserInfo
    Store-->>UF: Success
  end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60–90 minutes

Possibly related PRs

feat(permissions): add email-to-username lookup for users #115 — Also adjusts the user-add flow to support email-based lookup and resolution, touching frontend form and server controller/service paths.
feat(profile): nats-based user profile updates with oidc fields #111 — Modifies shared NatsSubjects enum; overlaps with this PR’s addition of new NATS subjects.
feat(permissions): implement user permissions management system #99 — Changes permissions-related interfaces and ProjectService/Controller APIs; aligns with this PR’s shift to full user objects in project settings.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes Check	⚠️ Warning	In addition to the linked issue’s scope, this pull request introduces a new email-first user lookup workflow with confirmation dialogs and manual entry flows that are beyond the stated objective of simply updating writers and auditors to object types.	These additional features should be split into a separate pull request or the linked issue should be updated to reflect the expanded scope before merging.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title accurately summarizes the core change by highlighting the shift to an email-first workflow and the integration of the email-to-sub lookup, making it clear and concise.
Linked Issues Check	✅ Passed	The changes fully implement the linked issue’s requirement to convert writers and auditors from simple username arrays into objects containing name, email, username, and avatar, and the UI updates correctly display these new fields.
Description Check	✅ Passed	The pull request description clearly outlines the key changes including the email-first workflow, manual entry support, NATS subject updates, data structure conversions, and UI enhancements, all of which directly relate to the contents of the changeset.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch jme/LFXV2-638

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull Request Overview

Implements an email‑first workflow for managing project permissions and enriches permission user records with full profile information (name, email, username, avatar). Key changes replace simple string username arrays with structured UserInfo objects and introduce NATS subjects/endpoints to resolve email → sub and fetch full user info.

Introduce UserInfo model and migrate writers/auditors from string[] to UserInfo[]
Add new NATS subjects (EMAIL_TO_SUB, USERNAME_TO_USER_INFO) and related service methods (email resolution + user info lookup)
Update UI (forms + table) to support email-first lookup, manual fallback, and display avatars/name/email

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/shared/src/interfaces/project.interface.ts	Adds UserInfo interface and changes writers/auditors to structured arrays
packages/shared/src/interfaces/permissions.interface.ts	Extends permission-related request/response shapes with full user profile fields
packages/shared/src/enums/nats.enum.ts	Adds new NATS subjects for email→sub and username→user info lookups
apps/lfx-one/src/server/services/project.service.ts	Adapts permission update logic to UserInfo objects; adds email→sub resolution and user info retrieval
apps/lfx-one/src/server/controllers/project.controller.ts	Passes optional manual user info to service on add
apps/lfx-one/src/app/shared/services/permissions.service.ts	Normalizes server ProjectSettings into ProjectPermissionUser objects with full profile data
apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/*	Enhances table to show avatar, name, email and adds initials fallback
apps/lfx-one/src/app/modules/project/settings/components/user-form/*	Implements email-first add flow, manual entry confirmation, and extended form fields

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

packages/shared/src/interfaces/project.interface.ts

apps/lfx-one/src/server/services/project.service.ts

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (3)

apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/user-permissions-table.component.ts (1)
94-103: Improve edge case handling in getUserInitials.

The method has a few edge cases that could be handled better:

Empty/whitespace-only names: Line 95 checks !name but doesn't catch whitespace-only strings. After trim() on line 97, a whitespace-only name becomes an empty string, leading to charAt(0) returning an empty string instead of '?'.

Multiple consecutive spaces: Line 97's split(' ') can create empty string elements if there are multiple spaces between name parts. This could affect the "last part" logic on line 102.

Apply this diff to handle edge cases:
 protected getUserInitials(name: string): string {
-  if (!name) return '?';
+  if (!name || !name.trim()) return '?';

-  const parts = name.trim().split(' ');
+  const parts = name.trim().split(/\s+/).filter(p => p);
   if (parts.length === 1) {
     return parts[0].charAt(0).toUpperCase();
   }

   return (parts[0].charAt(0) + parts[parts.length - 1].charAt(0)).toUpperCase();
 }
apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/user-permissions-table.component.html (1)
26-36: Consider adding data-testid attributes to header columns.

While the implementation is correct, consider adding data-testid attributes to the header column cells for more reliable test targeting, following the [section]-[component]-[element] convention mentioned in the coding guidelines.

Example:
<th class="w-16" data-testid="permissions-table-header-avatar">
  <span class="text-sm font-sans text-gray-500">Avatar</span>
</th>
<th data-testid="permissions-table-header-name">
  <span class="text-sm font-sans text-gray-500">Name</span>
</th>
As per coding guidelines.
apps/lfx-one/src/app/modules/project/settings/components/user-form/user-form.component.html (1)

30-76: Consider UX guidance for manual username entry.

When showManualFields() is true, both the email field (line 13, control="email") and the username field (line 54, control="username") are required. Users might be confused about what to enter for username, especially if they've already entered an email.

Consider adding:

Helper text explaining the username field (e.g., "Enter a unique username for this user")

Auto-populating the username field with a suggestion (e.g., the local part of the email)

Making it clear that username and email serve different purposes

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between dfa7510 and d139130.

📒 Files selected for processing (10)

apps/lfx-one/src/app/modules/project/settings/components/user-form/user-form.component.html (2 hunks)
apps/lfx-one/src/app/modules/project/settings/components/user-form/user-form.component.ts (4 hunks)
apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/user-permissions-table.component.html (3 hunks)
apps/lfx-one/src/app/modules/project/settings/components/user-permissions-table/user-permissions-table.component.ts (1 hunks)
apps/lfx-one/src/app/shared/services/permissions.service.ts (2 hunks)
apps/lfx-one/src/server/controllers/project.controller.ts (1 hunks)
apps/lfx-one/src/server/services/project.service.ts (7 hunks)
packages/shared/src/enums/nats.enum.ts (1 hunks)
packages/shared/src/interfaces/permissions.interface.ts (1 hunks)
packages/shared/src/interfaces/project.interface.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

packages/shared/src/interfaces/**/*.ts