Skip to content

Add labels to conflicting partnership date range errors #3405

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

Merged
merged 1 commit into from
Apr 28, 2025

Conversation

CarsonF
Copy link
Member

@CarsonF CarsonF commented Apr 28, 2025

Left as TODO in a5bf2f9

We can eagerly load the label after we finish gel. I didn't want to bother with neo4j

Copy link

coderabbitai bot commented Apr 28, 2025

📝 Walkthrough

Walkthrough

The changes introduce an explicit export for the asNonEmpty utility function, making it accessible outside its module. In the partnership date override validation handler, the logic is updated to enrich conflict data by loading and attaching organization names to each conflict entry instead of just partnership IDs. This enhancement requires the handler to depend on ResourceLoader and OrganizationLoader. The constructor of the handler is updated to include the new dependency, and the conflict enrichment logic is adjusted to utilize organization data when reporting date override conflicts.

Changes

Files/Paths Change Summary
src/common/exceptions/date-override-conflict.exception.ts Added export to asNonEmpty, making it available for use in other modules.
src/components/partnership/handlers/validate-partnership-date-overrides-on-project-change.handler.ts Updated handler to depend on ResourceLoader, load organizations for conflicting partnerships, and enrich conflict data with organization names instead of partnership IDs. Modified constructor to accept the new dependency.

Possibly related PRs

  • Validate partnership dates #3402: Originally defined asNonEmpty and DateOverrideConflictException, which are directly extended and utilized in the current changes for enriching conflict data with organization labels.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

@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

🧹 Nitpick comments (2)
src/components/partnership/handlers/validate-partnership-date-overrides-on-project-change.handler.ts (2)

40-58: Nice enhancement to add organization names to conflict messages.

The code now loads organization data and enriches the conflict information with more user-friendly organization names instead of just partnership IDs.

One small concern: The error handling for organization loading uses a bare fallback. Consider adding error logging here.

  if (org instanceof Error) {
    // Shouldn't happen
+   // Log the error for debugging purposes
+   console.error(`Failed to load organization for partnership ${conflict.id}:`, org);
    return conflict;
  }

67-67: Non-null assertion is safe but could be handled differently.

Since conflicts is already verified as non-empty (line 39), and conflictsWithLabels is derived from it, the non-null assertion is safe. However, you could make this more explicit:

- asNonEmpty(conflictsWithLabels)!,
+ // conflictsWithLabels is non-empty because conflicts is non-empty
+ asNonEmpty(conflictsWithLabels) as NonEmptyArray<typeof conflictsWithLabels[number]>,
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c4db4ba and ec38c00.

📒 Files selected for processing (2)
  • src/common/exceptions/date-override-conflict.exception.ts (1 hunks)
  • src/components/partnership/handlers/validate-partnership-date-overrides-on-project-change.handler.ts (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: E2E Tests (neo4j 6/6)
  • GitHub Check: E2E Tests (neo4j 5/6)
  • GitHub Check: E2E Tests (neo4j 4/6)
  • GitHub Check: E2E Tests (neo4j 3/6)
  • GitHub Check: E2E Tests (neo4j 2/6)
  • GitHub Check: Unit
  • GitHub Check: Generate (head)
  • GitHub Check: E2E Tests (neo4j 1/6)
  • GitHub Check: Generate (base)
  • GitHub Check: lint
  • GitHub Check: Clean
🔇 Additional comments (4)
src/common/exceptions/date-override-conflict.exception.ts (1)

73-74: Good addition of the exported utility function.

Making asNonEmpty explicitly exportable allows its reuse in other modules, supporting the enhanced conflict reporting in the partnership validation handler.

src/components/partnership/handlers/validate-partnership-date-overrides-on-project-change.handler.ts (3)

1-4: Good import additions for enhanced functionality.

The imports support the new feature of enriching conflict details with organization names.


12-15: Constructor updated with new dependency.

The ResourceLoader dependency is correctly added to access the OrganizationLoader.


34-34: Using partnership ID as temporary label.

This line sets up the initial label with the partnership ID, which will be replaced with organization names later in the code.

@CarsonF CarsonF merged commit 26794e9 into develop Apr 28, 2025
18 checks passed
@CarsonF CarsonF deleted the finish-partnership-date-conflict-labels branch April 28, 2025 23:09
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