Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(auth-admin): Allow non super users to publish super user fields #17290

Merged
merged 2 commits into from
Dec 20, 2024

Conversation

GunnlaugurG
Copy link
Member

@GunnlaugurG GunnlaugurG commented Dec 19, 2024

What

Remove restrictions where non super users could only publish to another environment with default values for super admin fields

Why

So publish functionality will result in identical client

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced client creation and update processes to accommodate various client types.
    • Improved handling of delegation types with added validation for user roles.
  • Bug Fixes

    • Refined error handling for invalid requests, ensuring appropriate responses for bad requests.
  • Documentation

    • Updated test suite for comprehensive coverage of client scenarios and validation checks.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request introduces modifications to the authentication service's client management functionality. The changes primarily focus on test suite updates for the MeClientsController and adjustments to the AdminClientsService. The modifications enhance client creation and update processes, particularly in handling default values, delegation types, and user role-based permissions. The updates aim to improve the flexibility of client configurations and refine the validation of client-related operations.

Changes

File Change Summary
apps/services/auth/admin-api/src/app/v2/clients/test/me-clients.spec.ts - Updated test cases for client creation and updates
- Enhanced handling of default values for different client types
- Improved validation for invalid requests
- Added checks for super user delegation type modifications
libs/auth-api-lib/src/lib/clients/admin/admin-clients.service.ts - Removed conditional logic for super admin field handling
- Modified formatClient method to convert allowedAcr values to strings
- Simplified client creation process

Sequence Diagram

sequenceDiagram
    participant User
    participant MeClientsController
    participant AdminClientsService
    participant Database

    User->>MeClientsController: Create/Update Client Request
    MeClientsController->>AdminClientsService: Process Client
    AdminClientsService->>AdminClientsService: Validate Client Parameters
    AdminClientsService->>Database: Save/Update Client
    Database-->>AdminClientsService: Confirmation
    AdminClientsService-->>MeClientsController: Client Response
    MeClientsController-->>User: Return Client Details
Loading

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • Herdismaria

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@GunnlaugurG GunnlaugurG marked this pull request as ready for review December 20, 2024 14:08
@GunnlaugurG GunnlaugurG requested review from a team as code owners December 20, 2024 14:08
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
apps/services/auth/admin-api/src/app/v2/clients/test/me-clients.spec.ts (1)

474-476: Duplicate Access Token Lifetime Handling
Similar fallback logic is duplicated but remains consistent with how it's handled above.

Consider extracting this fallback into a helper function to standardize and reduce repetition.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15edb19 and e610e45.

📒 Files selected for processing (2)
  • apps/services/auth/admin-api/src/app/v2/clients/test/me-clients.spec.ts (2 hunks)
  • libs/auth-api-lib/src/lib/clients/admin/admin-clients.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
libs/auth-api-lib/src/lib/clients/admin/admin-clients.service.ts (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
apps/services/auth/admin-api/src/app/v2/clients/test/me-clients.spec.ts (2)

Pattern apps/services/**/*: "Confirm that the code adheres to the following:

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (6)
apps/services/auth/admin-api/src/app/v2/clients/test/me-clients.spec.ts (6)

434-436: Use of Nullish Coalescing Operator for Access Token Lifetime Looks Good
This fallback pattern correctly assigns the property, defaulting to base attributes when custom values are absent.


442-444: Consistent Fallback for requirePkce
Using "??" follows the existing pattern, ensuring a graceful fallback to clientBaseAttributes.


450-450: Appropriate Fallback for customClaims
Defaulting to an empty array helps avoid potential null reference errors.


453-453: Fallback for allowedAcr
The default value "[defaultAcrValue]" ensures allowedAcr is never undefined.


477-479: Inline Fallback for allowOfflineAccess
Maintains code clarity and consistency. No issues observed.


480-481: Same Fallback Pattern for requirePkce
This mirrors the logic used in the earlier segment, ensuring uniform handling.

@GunnlaugurG GunnlaugurG added the automerge Merge this PR as soon as all checks pass label Dec 20, 2024
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.69%. Comparing base (73efe53) to head (404c8b2).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17290   +/-   ##
=======================================
  Coverage   35.69%   35.69%           
=======================================
  Files        6928     6928           
  Lines      148733   148730    -3     
  Branches    42498    42496    -2     
=======================================
  Hits        53087    53087           
+ Misses      95646    95643    -3     
Flag Coverage Δ
api 3.33% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
application-system-api 38.75% <ø> (+0.01%) ⬆️
application-template-api-modules 27.68% <ø> (-0.01%) ⬇️
services-auth-admin-api 52.53% <100.00%> (-0.02%) ⬇️
services-auth-delegation-api 58.54% <0.00%> (+0.01%) ⬆️
services-auth-ids-api 52.57% <0.00%> (+0.03%) ⬆️
services-auth-public-api 49.41% <0.00%> (+<0.01%) ⬆️
services-user-notification 46.53% <ø> (ø)
services-user-profile 56.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...lib/src/lib/clients/admin/admin-clients.service.ts 86.69% <100.00%> (-0.17%) ⬇️

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 73efe53...404c8b2. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs e72aff8 🔗

10 Total Test Services: 0 Failed, 8 Passed
🔻 Test Sessions change in coverage: 2 decreased, 22 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.45s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 10.18s 1 no change Link
application-system-api 0 0 0 46 0 2m 18.69s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 9.73s 1 decreased (-0.01%) Link
auth-api-lib 0 0 0 20 0 22.08s 1 no change Link
services-auth-admin-api 0 0 0 130 0 3m 17.57s 1 decreased (-0.01%) Link
services-auth-delegation-api 0 0 0 270 0 2m 59.21s 1 no change Link
services-auth-ids-api 0 0 0 262 0 1m 17.21s 1 no change Link
services-auth-personal-representative 0 0 0 0 0 270.67ms 1 no change Link
services-auth-personal-representative-public 0 0 0 0 0 264.78ms 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (2)

  • services-auth-admin-api - jest 46.91% (-0.01%) - Details
  • application-template-api-modules - jest 30.08% (-0.01%) - Details

@kodiakhq kodiakhq bot merged commit 1826987 into main Dec 20, 2024
66 checks passed
@kodiakhq kodiakhq bot deleted the feat/allow-publish-none-admin branch December 20, 2024 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants