10000 fix: Fix TokenIssuerCache initialization semaphore by elsand · Pull Request #2325 · Altinn/dialogporten · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: Fix TokenIssuerCache initialization semaphore #2325

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

elsand
Copy link
Member
@elsand elsand commented May 22, 2025

Summary

  • fix semaphore release when returning early from TokenIssuerCache initialization
  • add unit test ensuring concurrent calls don't deadlock

Testing

  • dotnet build tests/Digdir 8000 .Domain.Dialogporten.WebApi.Unit.Tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests.csproj -c Release --verbosity minimal
  • dotnet test tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests.csproj -c Release --no-build --verbosity minimal

@elsand elsand requested a review from a team as a code owner May 22, 2025 10:58
@elsand elsand added the codex label May 22, 2025 — with ChatGPT Connector
Copy link
Contributor
coderabbitai bot commented May 22, 2025
📝 Walkthrough

Walkthrough

The changes update the initialization logic in the TokenIssuerCache class to improve thread safety by adjusting the placement of an initialization check within a semaphore-protected section. Additionally, a new unit test class is introduced to verify that concurrent invocations of the cache's initialization logic do not result in deadlocks.

Changes

File(s) Change Summary
src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/TokenIssuerCache.cs Adjusted the _initialized flag check in EnsureInitializedAsync to occur after acquiring the semaphore, removing a redundant check.
tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests/TokenIssuerCacheTests.cs Added a new unit test class and method to verify that concurrent cache initialization does not deadlock.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@elsand elsand changed the title Fix TokenIssuerCache initialization semaphore fix: Fix TokenIssuerCache initialization semaphore May 22, 2025
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

🧹 Nitpick comments (1)
tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests/TokenIssuerCacheTests.cs (1)

1-37: Good test to verify the deadlock fix.

This test effectively verifies that concurrent calls to GetIssuerForScheme don't cause deadlocks by creating 10 concurrent tasks and ensuring they all complete within a 1-second timeout.

A few suggestions to enhance the test:

  1. Consider using a longer timeout (e.g., 5 seconds) to make the test more robust in CI environments or slower machines.
  2. You might want to add a test that verifies the actual caching functionality with real JWT schemas to ensure the cache is populated correctly.
- var completed = await Task.WhenAny(allTasks, Task.Delay(TimeSpan.FromSeconds(1)));
+ var completed = await Task.WhenAny(allTasks, Task.Delay(TimeSpan.FromSeconds(5)));
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f52f972 and a2607f4.

📒 Files selected for processing (2)
  • src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/TokenIssuerCache.cs (1 hunks)
  • tests/Digdir.Domain.Dialogporten.WebApi.Unit.Tests/TokenIssuerCacheTests.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build / build-and-test
🔇 Additional comments (1)
src/Digdir.Domain.Dialogporten.WebApi/Common/Authentication/TokenIssuerCache.cs (1)

53-56: Good fix: The double-check pattern now properly releases the semaphore.

The updated implementation correctly moves the second initialization check inside the try block, ensuring that the semaphore is always released via the finally block even when returning early. This prevents potential deadlocks when multiple threads attempt to initialize the cache concurrently.

This implementation follows the proper double-checked locking pattern:

  1. First check without the semaphore (line 44) to avoid unnecessary semaphore acquisition
  2. Second check after acquiring the semaphore (line 53) to handle the case where another thread completed initialization between the first check and acquiring the semaphore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0