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

chore(app): Temp. disable authorized parties cache #1512

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

oskogstad
Copy link
Collaborator

@oskogstad oskogstad commented Nov 22, 2024

Description

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
    • Resolved issues with the caching mechanism for retrieving authorized parties, now using direct requests to improve reliability.
  • Improvements
    • Enhanced clarity in the claims retrieval process for authorized resources.
    • Maintained robust error handling to ensure integrity in the authorization process.

@oskogstad oskogstad requested a review from a team as a code owner November 22, 2024 10:49
Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough

Walkthrough

The pull request primarily modifies the AltinnAuthorizationClient class in the AltinnAuthorizationClient.cs file. The GetAuthorizedParties method has had its caching mechanism commented out and replaced with a direct call to PerformAuthorizedPartiesRequest. The method GetAuthorizedResourcesForSearch has been updated for clarity in claims retrieval, while the logic in HasListAuthorizationForDialog remains unchanged. Error handling in PerformAuthorizedPartiesRequest continues to throw an exception if no authorized parties are found, maintaining the integrity of the authorization process.

Changes

File Path Change Summary
src/Digdir.Domain.Dialogporten.Infrastructure/.../Altinn/Authorization/AltinnAuthorizationClient.cs - Modified GetAuthorizedParties to bypass cache and call PerformAuthorizedPartiesRequest directly.
- Updated GetAuthorizedResourcesForSearch for clarity in claims retrieval.
- No changes to HasListAuthorizationForDialog logic.
- Error handling in PerformAuthorizedPartiesRequest remains unchanged.

Possibly related PRs


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 (1)
src/Digdir.Domain.Dialogporten.Infrastructure/Altinn/Authorization/AltinnAuthorizationClient.cs (1)

85-86: Add more context about the bug impact.

While the comment references the bug, it would be helpful to add more context about why caching needed to be disabled and what issues it was causing. This helps future maintainers understand the rationale behind this temporary change.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0d4ce7f and e6fe104.

📒 Files selected for processing (1)
  • src/Digdir.Domain.Dialogporten.Infrastructure/Altinn/Authorization/AltinnAuthorizationClient.cs (1 hunks)
🔇 Additional comments (1)
src/Digdir.Domain.Dialogporten.Infrastructure/Altinn/Authorization/AltinnAuthorizationClient.cs (1)

84-89: Add TODO to track cache re-enablement.

The caching is temporarily disabled, but there's no clear indicator for when it should be re-enabled. Consider adding a TODO comment to help track this:

 // Disabled until this bug is fixed: https://github.com/digdir/dialogporten/issues/1226
+// TODO: Re-enable caching once #1226 is fixed. This temporary disable may impact performance as each call will hit the external service.
 // var authorizedParties = await _partiesCache.GetOrSetAsync(authorizedPartiesRequest.GenerateCacheKey(), async token
 // => await PerformAuthorizedPartiesRequest(authorizedPartiesRequest, token), token: cancellationToken);

 var authorizedParties = await PerformAuthorizedPartiesRequest(authorizedPartiesRequest, cancellationToken);

Let's verify the impact of this change by checking for other cache usages and dependencies:

✅ Verification successful

Based on the shell script results, I can now generate the final response as we have sufficient context about caching usage in the codebase.

Add TODO comment to track cache re-enablement and performance impact.

The caching is temporarily disabled due to issue #1226, and the codebase shows extensive use of caching for performance optimization. The suggested comment addition is appropriate as:

  • The codebase has detailed caching configurations with performance considerations
  • The file shows other caches are actively used for authorization and party information
  • The infrastructure setup has specific memory and distributed cache configurations
 // Disabled until this bug is fixed: https://github.com/digdir/dialogporten/issues/1226
+// TODO: Re-enable caching once #1226 is fixed. This temporary disable may impact performance as each call will hit the external service.
 // var authorizedParties = await _partiesCache.GetOrSetAsync(authorizedPartiesRequest.GenerateCacheKey(), async token
 // => await PerformAuthorizedPartiesRequest(authorizedPartiesRequest, token), token: cancellationToken);

 var authorizedParties = await PerformAuthorizedPartiesRequest(authorizedPartiesRequest, cancellationToken);
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other cache usages and dependencies
# Look for other uses of _partiesCache
rg "_partiesCache" -A 5

# Look for other caching patterns
rg "GetOrSetAsync" -A 5

# Look for performance-related comments or TODOs
rg -i "performance|cache|todo" -g "*.cs"

Length of output: 30861

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
D Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

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