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

chore(documents-v2): Catch error and log warning #16207

Merged
merged 3 commits into from
Sep 30, 2024

Conversation

thordurhhh
Copy link
Member

@thordurhhh thordurhhh commented Sep 30, 2024

What

Catch error /page and log warning.

Why

Too many errors.
An error here is expected in some cases. It indicates a user error. Return the default of 1 which in most cases would be the number from the service.

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

  • New Features
    • Enhanced error handling for retrieving page numbers, ensuring a default value of 1 is returned in case of an error.
  • Bug Fixes
    • Improved robustness of the getPageNumber method to prevent failures during document retrieval.

@thordurhhh thordurhhh added the automerge Merge this PR as soon as all checks pass label Sep 30, 2024
@thordurhhh thordurhhh requested a review from a team as a code owner September 30, 2024 10:45
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The changes in this pull request focus on enhancing the error handling and default value management within the DocumentServiceV2 class, specifically in the getPageNumber method. A default return value of 1 is now implemented, along with a try-catch block to manage exceptions that may arise during the execution of the method.

Changes

File Path Change Summary
libs/api/domains/documents/src/lib/documentV2.service.ts Updated getPageNumber method to include error handling and a default return value of 1.

Possibly related PRs

Suggested reviewers

  • thorkellmani

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.

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
Member

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

One thing

libs/api/domains/documents/src/lib/documentV2.service.ts Outdated Show resolved Hide resolved
Co-authored-by: Þorkell Máni Þorkelsson <wowthorkell@gmail.com>
Copy link
Member

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

Cool

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

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9f44772 and b2a427d.

📒 Files selected for processing (1)
  • libs/api/domains/documents/src/lib/documentV2.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/api/domains/documents/src/lib/documentV2.service.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.69%. Comparing base (a369d73) to head (2a370d3).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16207   +/-   ##
=======================================
  Coverage   36.69%   36.69%           
=======================================
  Files        6778     6778           
  Lines      139671   139671           
  Branches    39719    39719           
=======================================
  Hits        51247    51247           
  Misses      88424    88424           
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api 3.39% <ø> (ø)
application-api-files 57.65% <ø> (ø)
application-core 71.29% <ø> (ø)
application-system-api 41.63% <ø> (ø)
application-template-api-modules 23.72% <ø> (ø)
application-templates-accident-notification 22.14% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.63% <ø> (ø)
application-templates-driving-license 18.70% <ø> (ø)
application-templates-estate 12.34% <ø> (ø)
application-templates-example-payment 25.41% <ø> (ø)
application-templates-financial-aid 14.34% <ø> (ø)
application-templates-general-petition 23.68% <ø> (ø)
application-templates-health-insurance 26.62% <ø> (ø)
application-templates-inheritance-report 6.45% <ø> (ø)
application-templates-marriage-conditions 15.23% <ø> (ø)
application-templates-mortgage-certificate 43.96% <ø> (ø)
application-templates-parental-leave 30.15% <ø> (ø)
application-types 6.71% <ø> (ø)
application-ui-components 1.28% <ø> (ø)
application-ui-shell 21.29% <ø> (ø)
auth-react 22.80% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
contentful-apps 5.76% <ø> (ø)
financial-aid-backend 56.54% <ø> (ø)
financial-aid-shared 19.03% <ø> (ø)
island-ui-core 28.47% <ø> (ø)
judicial-system-web 28.16% <ø> (ø)
portals-admin-regulations-admin 1.88% <ø> (ø)
portals-core 16.17% <ø> (ø)
services-auth-personal-representative 45.48% <ø> (-0.04%) ⬇️
shared-components 27.68% <ø> (ø)
shared-form-fields 31.61% <ø> (ø)
web 1.83% <ø> (ø)

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


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 a369d73...2a370d3. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 30, 2024

Datadog Report

All test runs bae29e0 🔗

34 Total Test Services: 0 Failed, 33 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.02%), 148 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-web 0 0 0 2 0 8.76s 1 no change Link
api 0 0 0 4 0 2.65s 1 no change Link
application-api-files 0 0 0 12 0 6.42s 1 no change Link
application-core 0 0 0 90 0 20.88s 1 no change Link
application-system-api 0 0 0 111 2 3m 23s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 48.07s 1 no change Link
application-templates-accident-notification 0 0 0 98 0 18.59s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 11.8s 1 no change Link
application-templates-driving-license 0 0 0 13 0 14.59s 1 no change Link
application-templates-example-payment 0 0 0 2 0 10.17s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • services-auth-personal-representative - jest 44.01% (-0.02%) - Details

@kodiakhq kodiakhq bot merged commit 6841e69 into main Sep 30, 2024
120 checks passed
@kodiakhq kodiakhq bot deleted the documents-v2/page-number-catch-error branch September 30, 2024 13:00
thoreyjona pushed a commit that referenced this pull request Oct 2, 2024
* Catch error and log warning

* Update libs/api/domains/documents/src/lib/documentV2.service.ts

Co-authored-by: Þorkell Máni Þorkelsson <wowthorkell@gmail.com>

---------

Co-authored-by: Þorkell Máni Þorkelsson <wowthorkell@gmail.com>
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