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

Catch errors when getting from browser storage #7001

Merged
merged 3 commits into from
Jan 10, 2025

Conversation

JamesNK
Copy link
Member

@JamesNK JamesNK commented Dec 30, 2024

Description

Getting values from session storage can fail if the user upgrades Aspire version, or starts and stops the standalone container, while leaving the browser open.

Fix is to ignore errors when getting from session/local storage. In this case the session state is lost, but nothing important is saved there.

Fixes #6961

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?
Microsoft Reviewers: Open in CodeFlow

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.

Files not reviewed (1)
  • src/Aspire.Dashboard/Model/BrowserStorage/LocalBrowserStorage.cs: Evaluated as low risk
{
private readonly ProtectedBrowserStorage _protectedBrowserStorage;

protected BrowserStorageBase(ProtectedBrowserStorage protectedBrowserStorage)
protected BrowserStorageBase(ProtectedBrowserStorage protectedBrowserStorage, ILogger<T> logger)
Copy link
Member

Choose a reason for hiding this comment

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

Does this need to be ILogger<T>? If it was just ILogger, then we wouldn't need to use the TSelf inheritance pattern and BrowserStorageBase could remain non-generic.

@JamesNK JamesNK enabled auto-merge (squash) January 9, 2025 23:04
@JamesNK JamesNK merged commit 5f3fc13 into main Jan 10, 2025
9 checks passed
@JamesNK JamesNK deleted the jamesnk/browser-storage-error-handling branch January 10, 2025 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

intermittent CryptographicException while running standalone aspire dashboard makes dashboard unusable
3 participants