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

fix(app): Error details missing when user type is unknown #1493

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

oskogstad
Copy link
Collaborator

@oskogstad oskogstad commented Nov 19, 2024

Description

Errors list is missing in error details when user type is unknown

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of unknown user types in the authentication middleware, ensuring clearer response management.
  • Refactor

    • Enhanced code clarity by separating response retrieval and writing processes in the user type validation logic.

@oskogstad oskogstad requested a review from a team as a code owner November 19, 2024 13:35
Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

📝 Walkthrough

Walkthrough

The UserTypeValidationMiddleware class in the UserTypeValidationMiddleware.cs file has been updated, specifically the InvokeAsync method. The handling of the Unknown user type has been refined by introducing a variable to store the response before writing it as JSON. This adjustment clarifies the process of retrieving and sending the response while maintaining the existing control flow and response behavior for unauthorized users.

Changes

File Path Change Summary
src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/UserTypeValidationMiddleware.cs Modified the InvokeAsync method to store the response in a variable before writing it as JSON, enhancing clarity in the response handling logic.

Possibly related PRs

  • fix: Fix XACML attribute id for system users #1340: The changes in the DecisionRequestHelper class regarding the XACML attribute ID may relate to the user type validation logic in the UserTypeValidationMiddleware, as both involve handling user types and authorization processes within the application.

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 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.

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: 0

🧹 Outside diff range and nitpick comments (2)
src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/UserTypeValidationMiddleware.cs (2)

24-31: LGTM! Consider externalizing the error message.

The changes correctly address the missing error details issue by properly constructing and writing the response. However, the error message is hardcoded which could make maintenance and localization more difficult.

Consider moving the error message to a resource file or constants class:

- "The request was authenticated, but we were unable to determine valid user type (person or system user) in order to authorize the request."
+ ErrorMessages.UnknownUserTypeValidation

24-31: Add tests as mentioned in PR objectives.

The PR objectives mention that automated tests haven't been added. Since this is error handling code, it's important to verify that the error details are correctly included in various scenarios.

Would you like me to help generate unit tests for this middleware? We should cover scenarios like:

  1. Unknown user type returning proper error details
  2. Valid user type passing through to next middleware
  3. Unauthenticated requests passing through
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between da0aa8f and f814db8.

📒 Files selected for processing (1)
  • src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/UserTypeValidationMiddleware.cs (1 hunks)

@oskogstad oskogstad merged commit 9fbd2cf into main Nov 19, 2024
24 of 25 checks passed
@oskogstad oskogstad deleted the fix/error-details-missing-on-403-undetermined-user branch November 19, 2024 13:59
arealmaas pushed a commit that referenced this pull request Nov 19, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.36.0](v1.35.0...v1.36.0)
(2024-11-19)


### Features

* **azure:** create azure monitor workspace
([#1485](#1485))
([da0aa8f](da0aa8f))


### Bug Fixes

* **app:** Error details missing when user type is unknown
([#1493](#1493))
([9fbd2cf](9fbd2cf))
* **azure:** enable public access for azure monitor
([#1496](#1496))
([b0d5794](b0d5794))
* **azure:** ensure monitor workspace is reachable
([#1494](#1494))
([dc7fc1f](dc7fc1f))
* **webapi:** Require base service provider scope on search endpoint
([#1476](#1476))
([8c41f3d](8c41f3d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants