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/fe-be/notifications #1079

Merged
merged 1 commit into from
Oct 29, 2024
Merged

fix/fe-be/notifications #1079

merged 1 commit into from
Oct 29, 2024

Conversation

ajhollid
Copy link
Collaborator

There was a concurrency error in way in which notificaitons were being added to monitors on the back end. This PR rectifies that issue.

  • Properly update monitor with notifications
  • Uncomment out notification code in pagespeed redux slice

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes in this pull request focus on the getMonitorById function within the monitorModule.js file. The primary modification involves replacing the previous method of updating monitor notifications with a more efficient approach using Monitor.findByIdAndUpdate. This method directly updates the monitor in the database, streamlining the process and reducing the number of database operations. No alterations were made to the signatures of exported functions or the overall structure of other methods.

Changes

File Change Summary
Server/db/mongo/modules/monitorModule.js Updated getMonitorById to use Monitor.findByIdAndUpdate for more efficient notification updates.

Possibly related PRs

Suggested reviewers

  • danielcj2
  • Skorpios604

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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

@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 and nitpick comments (1)
Server/db/mongo/modules/monitorModule.js (1)

Line range hint 292-307: Yo! Let's beef up that error handling! 🍝

The error handling could use some love for notification-specific failures. Also, we should validate the notification data before updating the monitor.

Consider adding specific error handling:

 try {
   const monitor = await Monitor.findById(monitorId);
   if (monitor === null || monitor === undefined) {
     const error = new Error(errorMessages.DB_FIND_MONITOR_BY_ID(monitorId));
     error.status = 404;
     throw error;
   }
   // Get notifications
+  let notifications;
+  try {
     notifications = await Notification.find({
       monitorId: monitorId,
     });
+  } catch (notificationError) {
+    const error = new Error(`Failed to fetch notifications: ${notificationError.message}`);
+    error.status = 500;
+    throw error;
+  }
+
+  // Validate notifications
+  if (!Array.isArray(notifications)) {
+    const error = new Error('Invalid notifications data structure');
+    error.status = 500;
+    throw error;
+  }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 86ab22d and 8730ee9.

📒 Files selected for processing (1)
  • Server/db/mongo/modules/monitorModule.js (1 hunks)

Comment on lines +299 to +303
const updatedMonitor = await Monitor.findByIdAndUpdate(
monitorId,
{ notifications },
{ new: true }
).populate("notifications");
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Yo! The current implementation might still have concurrency issues, dawg! 🍝

The separate find and findByIdAndUpdate operations create a potential race condition. If notifications are modified between these operations, the monitor could end up with stale data.

Consider using MongoDB's aggregation pipeline for atomic operations:

-const notifications = await Notification.find({
-  monitorId: monitorId,
-});
-const updatedMonitor = await Monitor.findByIdAndUpdate(
-  monitorId,
-  { notifications },
-  { new: true }
-).populate("notifications");
+const updatedMonitor = await Monitor.aggregate([
+  { $match: { _id: monitorId } },
+  {
+    $lookup: {
+      from: "notifications",
+      localField: "_id",
+      foreignField: "monitorId",
+      as: "notifications"
+    }
+  },
+  { $limit: 1 }
+]).exec();
+
+if (!updatedMonitor[0]) {
+  const error = new Error(errorMessages.DB_FIND_MONITOR_BY_ID(monitorId));
+  error.status = 404;
+  throw error;
+}
+
+return updatedMonitor[0];

Alternatively, if you need to stick with the current approach, wrap it in a transaction:

const session = await Monitor.startSession();
session.startTransaction();
try {
  const notifications = await Notification.find({ monitorId }).session(session);
  const updatedMonitor = await Monitor.findByIdAndUpdate(
    monitorId,
    { notifications },
    { new: true, session }
  ).populate("notifications");
  await session.commitTransaction();
  return updatedMonitor;
} catch (error) {
  await session.abortTransaction();
  throw error;
} finally {
  session.endSession();
}

@ajhollid ajhollid merged commit a6214f4 into develop Oct 29, 2024
3 checks passed
@ajhollid ajhollid deleted the fix/fe-be/notifications branch October 29, 2024 02:53
@coderabbitai coderabbitai bot mentioned this pull request Oct 29, 2024
8 tasks
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