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(application-system-api-worker): Get template error catch #17186

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

obmagnusson
Copy link
Member

@obmagnusson obmagnusson commented Dec 9, 2024

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling in the application lifecycle notification preparation process, ensuring consistent behavior even in error scenarios.

@obmagnusson obmagnusson requested a review from a team as a code owner December 9, 2024 19:11
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in the ApplicationLifeCycleService class focus on enhancing error handling and control flow within the preparePrunedNotification method. A try-catch block has been introduced to ensure that the application template is successfully retrieved before accessing its properties. If the template is not found, the method returns null, preventing runtime errors. Additionally, the error handling for notification preparation has been refined to log errors and consistently return a value, thereby improving the robustness of the application lifecycle management process.

Changes

File Change Summary
apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts Modified preparePrunedNotification to include error handling with try-catch, ensuring safe access to template properties and consistent return values.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • jonnigs
  • Toti91

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 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.

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

🧹 Outside diff range and nitpick comments (1)
apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts (1)

162-190: Consider extracting notification preparation logic.

While the error handling is appropriate, the nested try-catch and complex logic could be more maintainable if extracted into a separate method.

Consider refactoring like this:

+  private createNotificationFromPruneMessage(
+    pruneMessage: any,
+    application: PruningApplication,
+  ): CreateHnippNotificationDto {
+    return {
+      recipient: application.applicant,
+      templateId: pruneMessage.notificationTemplateId,
+      args: [
+        {
+          key: 'externalBody',
+          value: pruneMessage.externalBody || '',
+        },
+        {
+          key: 'internalBody',
+          value: pruneMessage.internalBody || '',
+        },
+      ],
+    }
+  }

   private async preparePrunedNotification(
     application: PruningApplication,
   ): Promise<CreateHnippNotificationDto | null> {
     try {
       // ... template retrieval code ...
       
       if (lifeCycle && lifeCycle.shouldBePruned && lifeCycle.pruneMessage) {
         try {
           const pruneMessage =
             typeof lifeCycle.pruneMessage === 'function'
               ? lifeCycle.pruneMessage(
                   application as ApplicationWithAttachments,
                 )
               : lifeCycle.pruneMessage
-          const notification = {
-            recipient: application.applicant,
-            templateId: pruneMessage.notificationTemplateId,
-            args: [
-              {
-                key: 'externalBody',
-                value: pruneMessage.externalBody || '',
-              },
-              {
-                key: 'internalBody',
-                value: pruneMessage.internalBody || '',
-              },
-            ],
-          }
-          return notification
+          return this.createNotificationFromPruneMessage(pruneMessage, application)
         } catch (error) {
           // ... error handling ...
         }
       }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aa1e254 and 9aca526.

📒 Files selected for processing (1)
  • apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🪛 Biome (1.9.4)
apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts

[error] 161-161: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (2)
apps/application-system/api/src/app/modules/application/lifecycle/application-lifecycle.service.ts (2)

154-159: LGTM! Robust error handling for template retrieval.

The added try-catch block with early return and proper error logging improves the robustness of the code.


193-198: LGTM! Comprehensive error handling.

The error handling includes proper logging with relevant context and maintains consistent return behavior.

@obmagnusson obmagnusson added the automerge Merge this PR as soon as all checks pass label Dec 9, 2024
Copy link

codecov bot commented Dec 9, 2024

Codecov Report

Attention: Patch coverage is 89.47368% with 2 lines in your changes missing coverage. Please review.

Project coverage is 35.73%. Comparing base (2036feb) to head (c683b01).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ication/lifecycle/application-lifecycle.service.ts 89.47% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17186   +/-   ##
=======================================
  Coverage   35.73%   35.73%           
=======================================
  Files        6928     6928           
  Lines      147806   147811    +5     
  Branches    42124    42125    +1     
=======================================
+ Hits        52814    52816    +2     
- Misses      94992    94995    +3     
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.75% <89.47%> (-0.01%) ⬇️
application-template-api-modules 27.81% <ø> (-0.01%) ⬇️
application-templates-inheritance-report 6.54% <ø> (ø)
application-ui-shell 22.43% <ø> (ø)
judicial-system-backend 55.77% <ø> (ø)
judicial-system-web 27.89% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...ication/lifecycle/application-lifecycle.service.ts 90.00% <89.47%> (-2.95%) ⬇️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2036feb...c683b01. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 9, 2024

Datadog Report

All test runs 41121c3 🔗

4 Total Test Services: 0 Failed, 4 Passed
➡️ Test Sessions change in coverage: 4 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 3.22s 1 no change Link
application-system-api 0 0 0 46 0 2m 58.15s 1 no change Link
judicial-system-backend 0 0 0 18572 0 0s N/A Link
judicial-system-web 0 0 0 332 0 1m 8.68s 1 no change Link

@kodiakhq kodiakhq bot merged commit 5f9b084 into main Dec 9, 2024
46 checks passed
@kodiakhq kodiakhq bot deleted the worker-tempate-error-fix branch December 9, 2024 20:03
thorhildurt pushed a commit that referenced this pull request Dec 11, 2024
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants