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] Update Task undefined array methods #8576

Merged

Conversation

GloireMutaliko21
Copy link
Contributor

@GloireMutaliko21 GloireMutaliko21 commented Dec 6, 2024

PR

Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.


Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling during task updates to prevent issues with undefined member data.
    • Enhanced robustness of member management during task updates.
  • Refactor

    • Updated internal logic for the update, findById, getMyTasks, and getAllTasksByEmployee methods to better handle member-related data.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes in this pull request focus on the TaskService class within task.service.ts, specifically enhancing the update method to improve the handling of task members. The modifications ensure safer access to data.members and taskMembers, using default empty arrays to prevent errors. The filtering logic for removed and new members has been updated to maintain functionality even when these properties are undefined. Other methods in the class remain unchanged, with no alterations to their signatures, indicating that the improvements are localized to member management during task updates.

Changes

File Path Change Summary
packages/core/src/tasks/task.service.ts Modified update method to enhance member management, ensuring safe access to data.members and taskMembers. Updated filtering logic for members to handle undefined cases. Other methods' internal logic updated without signature changes.

Possibly related PRs

  • [Fix]: Activity Log update entities include relations #8508: The changes in this PR involve modifications to the TaskService class, specifically in the update method, which is also a focus of the main PR. Both PRs enhance the handling of task members during updates, indicating a direct relationship in their objectives.
  • [Feat] Subscribe user on assignment / Un-assignment #8574: This PR also modifies the TaskService class, particularly the update method, to manage task member subscriptions. The focus on task member management aligns closely with the changes made in the main PR, establishing a connection between them.

Suggested labels

hold

Suggested reviewers

  • rahul-rocket

Poem

In the meadow where tasks do play,
Members gather both night and day.
With updates fresh, we hop and cheer,
Safe and sound, no need to fear!
A rabbit's joy in code we find,
As tasks unite, our hearts aligned. 🐇✨


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.

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

🧹 Outside diff range and nitpick comments (4)
packages/core/src/tasks/task.service.ts (4)

97-101: LGTM! Good defensive programming to handle undefined arrays.

The changes correctly prevent "undefined array" errors by providing empty array fallbacks. This is a good fix for the issue.

Consider extracting these operations into a helper method for better reusability and cleaner code:

-const memberIdSet = new Set((data.members || []).map(({ id }) => id));
-const existingMemberIdSet = new Set((taskMembers || []).map(({ id }) => id));
-
-const removedMembers = (taskMembers || []).filter((member) => !memberIdSet.has(member.id));
-const newMembers = (data.members || []).filter((member) => !existingMemberIdSet.has(member.id));
+const getMemberDifferences = (newMembers = [], existingMembers = []) => {
+  const newIdSet = new Set(newMembers.map(({ id }) => id));
+  const existingIdSet = new Set(existingMembers.map(({ id }) => id));
+  
+  return {
+    removedMembers: existingMembers.filter((member) => !newIdSet.has(member.id)),
+    newMembers: newMembers.filter((member) => !existingIdSet.has(member.id))
+  };
+};
+
+const { removedMembers, newMembers } = getMemberDifferences(data.members, taskMembers);

Line range hint 192-195: Improve error handling to avoid redundancy and potential security issues.

The current error handling has a few issues:

  1. The error message is logged twice (${error.message} and error.message).
  2. Exposing the raw error object in the response could leak sensitive information.

Consider this improved error handling:

-console.error(`Error while updating task: ${error.message}`, error.message);
-throw new HttpException({ message: error?.message, error }, HttpStatus.BAD_REQUEST);
+console.error('Error while updating task:', error);
+throw new HttpException(
+  { message: 'Failed to update task. Please try again.' },
+  HttpStatus.BAD_REQUEST
+);

Line range hint 156-187: Enhance error handling for subscription operations.

The current implementation silently catches errors during subscription operations, which could lead to inconsistent states where some operations succeed while others fail.

Consider implementing a more robust error handling strategy:

-try {
-  await Promise.all(
-    removedMembers.map(
-      async (member) =>
-        await this._subscriptionService.delete({
-          entity: BaseEntityEnum.Task,
-          entityId: updatedTask.id,
-          userId: member.userId,
-          type: SubscriptionTypeEnum.ASSIGNMENT
-        })
-    )
-  );
-} catch (error) {
-  console.error('Error unsubscribing members from the task:', error);
-}
+const unsubscribeResults = await Promise.allSettled(
+  removedMembers.map((member) =>
+    this._subscriptionService.delete({
+      entity: BaseEntityEnum.Task,
+      entityId: updatedTask.id,
+      userId: member.userId,
+      type: SubscriptionTypeEnum.ASSIGNMENT
+    })
+  )
+);
+
+const failedUnsubscribes = unsubscribeResults
+  .filter((result): result is PromiseRejectedResult => result.status === 'rejected')
+  .map((result) => result.reason);
+
+if (failedUnsubscribes.length > 0) {
+  console.error('Failed to unsubscribe some members:', failedUnsubscribes);
+  // Optionally: Throw an error or handle the partial failure
+}

Similar improvements should be applied to the new member subscription logic.


Line range hint 188-191: Address the TODO comment about actor type determination.

The current implementation hardcodes the actor type as 'User', but the TODO comment indicates a need to support system-initiated actions (e.g., from GitHub integration).

Would you like me to help implement a dynamic actor type determination? This could include:

  1. Creating an enum for different actor sources
  2. Adding a service to determine the actor type based on the request context
  3. Updating the activity logging to use the dynamic actor type
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1abe199 and 7cdfef4.

📒 Files selected for processing (1)
  • packages/core/src/tasks/task.service.ts (1 hunks)

Copy link

nx-cloud bot commented Dec 6, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 7cdfef4. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@rahul-rocket rahul-rocket merged commit 22a241e into develop Dec 6, 2024
15 of 19 checks passed
@rahul-rocket rahul-rocket deleted the fix/coderrabitai-undefined-values-task-update branch December 6, 2024 13:20
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