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

0286 growth plan upload failure #3328

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Conversation

bryanjnelson
Copy link
Contributor

@bryanjnelson bryanjnelson commented Nov 11, 2024

  • Remove duplicate call to update growth plan
  • Explicitly throw errors when updating files in engagement when expected files do not exist

Monday Story 0286

Copy link

coderabbitai bot commented Nov 11, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the EngagementRepository and EngagementService classes. In the EngagementRepository, error handling in the updateLanguage and updateInternship methods is enhanced by inverting checks for the existence of pnp and growthPlan files, throwing exceptions if they are missing. The EngagementService class sees the removal of the FileService dependency, simplifying the updateInternshipEngagement method by eliminating file update logic. Overall, the changes focus on improving error handling and clarifying the responsibilities of the services.

Changes

File Path Change Summary
src/components/engagement/engagement.repository.ts - Updated error handling in updateLanguage and updateInternship methods to throw exceptions if required files do not exist.
- Minor formatting and comments added.
- Method signatures updated.
src/components/engagement/engagement.service.ts - Removed FileService dependency from constructor.
- Eliminated file update logic from updateInternshipEngagement method.

Possibly related PRs

  • Fix growthPlan hydration with link shape #3320: The changes in this PR also modify the updateInternship method in the EngagementRepository class, specifically related to handling the growthPlan property, which is relevant to the updates made in the main PR regarding error handling and file dependencies.

Suggested reviewers

  • andrewmurraydavid

🐇 In the code, we hop and play,
With files and checks, we pave the way.
If pnp or growthPlan goes astray,
A ServerException will save the day!
No more file fuss in our service bright,
Engagements now shine with clearer light! 🌟


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

@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 (1)
src/components/engagement/engagement.repository.ts (1)

383-396: Consider implementing a common file validation method.

Both updateLanguage and updateInternship methods have similar file validation logic. Consider extracting this into a common private method to improve maintainability and reduce code duplication.

+  private validateFileExists<T extends { id: string }>(
+    file: T | null,
+    fileType: string,
+  ): asserts file is T {
+    if (!file) {
+      throw new ServerException(
+        `Expected ${fileType} file to be created with the engagement`,
+      );
+    }
+  }

   async updateLanguage(
     changes: UpdateLanguageEngagement,
     session: Session,
     changeset?: ID,
   ) {
     const { id, pnp, ...simpleChanges } = changes;
 
     if (pnp) {
       const engagement = await this.readOne(id, session);
-      if (!engagement.pnp) {
-        throw new ServerException(
-          'Expected PnP file to be created with the engagement',
-        );
-      }
+      this.validateFileExists(engagement.pnp, 'PnP');
       await this.files.createFileVersion(
         {
           ...pnp,
           parentId: engagement.pnp.id,
         },
         session,
       );
     }
   }

   async updateInternship(
     changes: UpdateInternshipEngagement,
     session: Session,
     changeset?: ID,
   ) {
     const { id, mentorId, countryOfOriginId, growthPlan, ...simpleChanges } =
       changes;
 
     if (growthPlan) {
       const engagement = await this.readOne(id, session);
-      if (!engagement.growthPlan) {
-        throw new ServerException(
-          'Expected Growth Plan file to be created with the engagement',
-        );
-      }
+      this.validateFileExists(engagement.growthPlan, 'Growth Plan');
       await this.files.createFileVersion(
         {
           ...growthPlan,
           parentId: engagement.growthPlan.id,
         },
         session,
       );
     }
   }

Also applies to: 425-438

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 42bae6f and 7d9d7db.

📒 Files selected for processing (2)
  • src/components/engagement/engagement.repository.ts (2 hunks)
  • src/components/engagement/engagement.service.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • src/components/engagement/engagement.service.ts
🔇 Additional comments (2)
src/components/engagement/engagement.repository.ts (2)

383-396: LGTM! Improved error handling for PnP file updates.

The added validation ensures that the PnP file exists before attempting to create a new version, preventing potential runtime errors. The error message is clear and descriptive.


425-438: LGTM! Improved error handling for Growth Plan file updates.

The added validation ensures that the Growth Plan file exists before attempting to create a new version, preventing potential runtime errors. The error message is clear and descriptive.

Copy link
Member

@CarsonF CarsonF left a comment

Choose a reason for hiding this comment

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

Yes

@CarsonF CarsonF merged commit c1af809 into develop Nov 11, 2024
17 checks passed
@CarsonF CarsonF deleted the 0286-growth-plan-upload-failure branch November 11, 2024 23:09
@coderabbitai coderabbitai bot mentioned this pull request Nov 20, 2024
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