New callouts to be on top

[valentinyanakiev]

new callouts on top

Summary by CodeRabbit

• New Features

  • Improved logic for determining the sort order when creating new callouts.

• Bug Fixes

  • Enhanced error handling to ensure methods only operate on fully initialized collaborations.

• Documentation

  • Minor adjustments made to comments for clarity and consistency.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the CollaborationService class within the collaboration.service.ts file. The createCalloutOnCollaboration method's logic for determining the sortOrder of new callouts has been modified to calculate the minimum sort order instead of adding to the maximum. Additionally, error handling in the getCalloutGroupNames method has been improved to throw an EntityNotInitializedException if necessary data is missing. Minor comment adjustments for clarity were also made, but these do not affect the code's functionality.

Changes

File Path	Change Summary
src/domain/collaboration/collaboration/collaboration.service.ts	- Modified createCalloutOnCollaboration to adjust sortOrder calculation.
	- Updated error handling in getCalloutGroupNames to throw EntityNotInitializedException if data is missing.
	- Minor comment adjustments for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CollaborationService
    participant Callout

    User->>CollaborationService: createCalloutOnCollaboration(calloutData, userID)
    CollaborationService->>Callout: Calculate minimum sort order
    Callout-->>CollaborationService: Return new sort order
    CollaborationService-->>User: Return created callout

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Experiment)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/domain/collaboration/collaboration/collaboration.service.ts (1)

423-426: Consider adding boundaries for sort order values

While the implementation correctly places new callouts at the top, continuously subtracting 1 from the minimum sort order could lead to increasingly negative numbers. Consider implementing boundaries or normalization.

-        Math.min(
-          ...collaboration.callouts.map(callout => callout.sortOrder),
-          0 // Needed in case there are no callouts. In that case the first callout will have sortOrder = 1
-        ) - 1;
+        const MIN_SORT_ORDER = -1000;
+        const currentMin = Math.min(
+          ...collaboration.callouts.map(callout => callout.sortOrder),
+          0
+        );
+        Math.max(MIN_SORT_ORDER, currentMin - 1);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 15c1951 and 3b06c42.

📒 Files selected for processing (1)

• src/domain/collaboration/collaboration/collaboration.service.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/domain/collaboration/collaboration/collaboration.service.ts (1)

Pattern src/**/*.{ts,js}: Review the TypeScript/JavaScript code for NestJS best practices, dependency injection, module structure, and potential bugs.

Context Files (Do Not Review):

• docs/Design.md - Design overview of the project
• docs/Pagination.md - Pagination design overview
• docs/Developing.md - Development setup overview
• docs/graphql-typeorm-usage.md - overview of GraphQL and TypeORM usage and how they are used together with NestJS in the project
• docs/database-definitions.md - guidelines for creating TypeORM entity defnitions
• src/core/error-handling/graphql.exception.filter.ts - GraphQL error handling
• src/core/error-handling/http.exception.filter.ts - HTTP error handling
• src/core/error-handling/rest.error.response.ts - REST error response
• src/core/error-handling/unhandled.exception.filter.ts - Global exception handler

Guidelines:

• Our project uses global exception handlers (UnhandledExceptionFilter), so avoid suggesting additional try/catch blocks unless handling specific cases.
• Use NestJS latest documentation from https://docs.nestjs.com/ for reference on NestJS best practices.
• Use TypeORM latest documentation from https://typeorm.io/ for reference on TypeORM best practices.
• Refer to the design overview in the context files for better understanding.