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 duplicate ATIS subscriber notifications #115

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

justinshannon
Copy link
Contributor

@justinshannon justinshannon commented Feb 4, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved the notifications so that alerts are sent only upon the first update, preventing duplicate notifications and streamlining the alert process for meteorological updates.
    • Enhanced error handling to ensure exceptions are logged and managed appropriately during property updates.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

A modification has been made in the AtisStationViewModel class within the desktop UI. The change adjusts the OnMetarResponseReceived method so that a subscriber is notified only when the initial METAR is received on the first connection. This prevents duplicate notifications on subsequent METAR updates. Additionally, the HandleVoiceRecordAtisCommand method has been updated to remove the null-conditional operator when calling AddOrUpdateBot, and error handling has been improved with try-catch blocks around property updates.

Changes

File(s) Changed Summary
vATIS.Desktop/Ui/…/AtisStationViewModel.cs Updated HandleVoiceRecordAtisCommand to call AddOrUpdateBot directly, and modified OnMetarResponseReceived to notify subscribers only on the first new METAR response, avoiding duplicate notifications. Enhanced error handling with try-catch blocks.

Sequence Diagram(s)

sequenceDiagram
    participant VM as AtisStationViewModel
    participant METAR as METAR Response
    participant Sub as Subscriber

    Note over VM: OnMetarResponseReceived triggered
    METAR->>VM: Receive METAR data
    VM->>VM: Check if initial METAR has been processed
    alt First METAR Response
        VM->>Sub: Send notification
    else Duplicate METAR Response
        VM-->>Sub: Skip notification
    end
Loading

Possibly related PRs

Poem

I’m a coding bunny on the run,
Hopping through the logic, having fun.
The first METAR rings the bell,
No more repeats to tell.
Carrots and clean code – what a day to be done!
🐰🥕


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f5457d and 46bb1cf.

📒 Files selected for processing (1)
  • vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (csharp)

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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

🔭 Outside diff range comments (2)
vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (2)

1102-1116: Add error handling for UI thread property updates.

The UI thread property updates lack error handling, which could lead to a deadlock if an exception occurs during the updates. The TaskCompletionSource would never complete in this case.

Apply this diff to add error handling:

 var propertyUpdates = new TaskCompletionSource();
 Dispatcher.UIThread.Post(() =>
 {
+    try
+    {
         Metar = e.Metar.RawMetar?.ToUpperInvariant();
         Altimeter = e.Metar.Pressure?.Value?.ActualUnit == Value.Unit.HectoPascal
             ? "Q" + e.Metar.Pressure?.Value?.ActualValue.ToString("0000")
             : "A" + e.Metar.Pressure?.Value?.ActualValue.ToString("0000");
         Wind = e.Metar.SurfaceWind?.RawValue;
         ObservationTime = e.Metar.Time.Replace(":", "");
         propertyUpdates.SetResult();
+    }
+    catch (Exception ex)
+    {
+        propertyUpdates.SetException(ex);
+    }
 });

-await propertyUpdates.Task;
+try
+{
+    await propertyUpdates.Task;
+}
+catch (Exception ex)
+{
+    Log.Error(ex, "Failed to update METAR properties");
+    throw;
+}

1489-1493: Fix potential memory leak in voice server connection.

The voice server connection update is not awaited, which could lead to orphaned tasks if cancellation occurs.

Apply this diff to fix the potential memory leak:

 if (voiceAtis.AudioBytes != null && _networkConnection != null)
 {
     var dto = AtisBotUtils.AddBotRequest(voiceAtis.AudioBytes, _atisStation.Frequency,
         _atisStationAirport.Latitude, _atisStationAirport.Longitude, 100);
-    _voiceServerConnection?.AddOrUpdateBot(_networkConnection.Callsign, dto,
-        _cancellationToken.Token);
+    await _voiceServerConnection?.AddOrUpdateBot(_networkConnection.Callsign, dto,
+        _cancellationToken.Token)!;
 }
🧹 Nitpick comments (1)
vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (1)

1157-1164: Improve error handling in task continuation.

The current error handling joins exception messages with commas, which could be hard to read and loses valuable stack trace information.

Apply this diff to improve error handling:

 if (t.IsFaulted)
 {
-    ErrorMessage = string.Join(",",
-        t.Exception.InnerExceptions.Select(exception => exception.Message));
+    var errors = t.Exception.InnerExceptions
+        .Select(ex => $"{ex.GetType().Name}: {ex.Message}")
+        .ToList();
+    ErrorMessage = string.Join(Environment.NewLine, errors);
+    Log.Error(t.Exception, "Failed to update voice ATIS");
     _networkConnection?.Disconnect();
     NativeAudio.EmitSound(SoundType.Error);
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e1f4e2 and 4f5457d.

📒 Files selected for processing (1)
  • vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: build (ubuntu-latest)

@justinshannon justinshannon added this pull request to the merge queue Feb 4, 2025
@justinshannon justinshannon removed this pull request from the merge queue due to a manual request Feb 4, 2025
@justinshannon justinshannon added this pull request to the merge queue Feb 4, 2025
Merged via the queue into main with commit 9a537e1 Feb 4, 2025
7 checks passed
@justinshannon justinshannon deleted the fix/duplicate-subscriber-notifications branch February 4, 2025 04:05
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.

1 participant