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(signature-collection): try catch not found #16447

Merged
merged 3 commits into from
Oct 17, 2024
Merged

Conversation

alexdiljar
Copy link
Member

@alexdiljar alexdiljar commented Oct 17, 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

  • New Features

    • Introduced a new notFound reason in the signature collection, enhancing the clarity of error messages related to missing entities.
  • Bug Fixes

    • Improved error handling in the Parliamentary List Signing Service for better clarity and maintainability.

@alexdiljar alexdiljar requested a review from a team as a code owner October 17, 2024 11:59
Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The pull request introduces significant modifications to the ParliamentaryListSigningService class, particularly in the canSign method. Key changes include moving the signee variable to a broader scope, simplifying error handling by directly throwing a TemplateApiError, and restructuring the logic for processing the signee response. Additionally, a new enum value notFound has been added to the ReasonKey enum in the signature-collection.types.ts file, enhancing the error handling capabilities within the application.

Changes

File Change Summary
libs/application/template-api-modules/src/lib/modules/templates/... Modified ParliamentaryListSigningService to adjust the canSign method's variable scope, simplify error handling, and restructure signee processing logic.
libs/clients/signature-collection/src/lib/signature-collection.types.ts Added new enum value notFound to ReasonKey enum for enhanced error handling scenarios.

Possibly related PRs

Suggested labels

high priority

Suggested reviewers

  • juni-haukur
  • albinagu

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 67396d4 and 41adb1e.

📒 Files selected for processing (1)
  • libs/application/template-api-modules/src/lib/modules/templates/signature-collection/parliamentary-list-signing/parliamentary-list-signing.service.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libs/application/template-api-modules/src/lib/modules/templates/signature-collection/parliamentary-list-signing/parliamentary-list-signing.service.ts

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.

@alexdiljar alexdiljar added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Oct 17, 2024
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: 2

🧹 Outside diff range and nitpick comments (1)
libs/application/template-api-modules/src/lib/modules/templates/signature-collection/parliamentary-list-signing/parliamentary-list-signing.service.ts (1)

51-51: Correct variable name in comment for clarity

The comment refers to canCreateInfo, but the variable used is canSignInfo. To avoid confusion, please update the comment to use the correct variable name.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0b6981a and 67396d4.

📒 Files selected for processing (2)
  • libs/application/template-api-modules/src/lib/modules/templates/signature-collection/parliamentary-list-signing/parliamentary-list-signing.service.ts (1 hunks)
  • libs/clients/signature-collection/src/lib/signature-collection.types.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
libs/application/template-api-modules/src/lib/modules/templates/signature-collection/parliamentary-list-signing/parliamentary-list-signing.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."
libs/clients/signature-collection/src/lib/signature-collection.types.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."
🔇 Additional comments (2)
libs/clients/signature-collection/src/lib/signature-collection.types.ts (2)

Line range hint 1-109: File adheres to library coding guidelines.

This change introduces a new enum value notFound to the ReasonKey enum, enhancing error handling capabilities. The file continues to adhere to the coding guidelines for library files:

  • It uses TypeScript for defining types and enums.
  • The types and enums are exported, ensuring reusability across different NextJS apps.
  • The file structure supports effective tree-shaking and bundling.

109-109: LGTM! Verify usage of the new enum value.

The addition of notFound to the ReasonKey enum is appropriate and consistent with the existing pattern. It enhances the error handling capabilities of the signature collection process.

To ensure proper integration, please verify the usage of this new enum value:

✅ Verification successful

Re-running the search with the correct file type.

The previous search command used an incorrect file type. Updated the --type to ts for TypeScript files.


Verified usage of ReasonKey.notFound.

The enum value is used only in parliamentary-list-signing.service.ts as expected. No other usages found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for usages of ReasonKey.notFound in the codebase

# Test: Look for direct usage of ReasonKey.notFound
echo "Searching for direct usage of ReasonKey.notFound:"
rg --type typescript "ReasonKey\.notFound"

# Test: Look for string literal 'notFound' in switch statements or conditionals
echo "Searching for 'notFound' string in switch statements or conditionals:"
rg --type typescript "case\s+['\"]notFound['\"]|['\"]notFound['\"]\s*[:=]"

Length of output: 463


Script:

#!/bin/bash
# Description: Search for usages of ReasonKey.notFound in the codebase

# Test: Look for direct usage of ReasonKey.notFound
echo "Searching for direct usage of ReasonKey.notFound:"
rg --type ts "ReasonKey\.notFound"

# Test: Look for string literal 'notFound' in switch statements or conditionals
echo "Searching for 'notFound' string in switch statements or conditionals:"
rg --type ts "case\s+['\"]notFound['\"]|['\"]notFound['\"]\s*[:=]"

Length of output: 560

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 17, 2024

Datadog Report

All test runs 127a6c6 🔗

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

Test 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.79s 1 no change Link
api 0 0 0 4 0 2.83s 1 no change Link

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

Attention: Patch coverage is 3.84615% with 25 lines in your changes missing coverage. Please review.

Project coverage is 36.75%. Comparing base (342c2d8) to head (41adb1e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...list-signing/parliamentary-list-signing.service.ts 0.00% 25 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16447   +/-   ##
=======================================
  Coverage   36.75%   36.75%           
=======================================
  Files        6835     6835           
  Lines      141320   141321    +1     
  Branches    40235    40235           
=======================================
+ Hits        51939    51940    +1     
  Misses      89381    89381           
Flag Coverage Δ
api 3.37% <ø> (ø)
application-system-api 41.37% <3.84%> (+<0.01%) ⬆️
application-template-api-modules 27.84% <0.00%> (+<0.01%) ⬆️
application-ui-shell 21.37% <ø> (ø)

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

Files with missing lines Coverage Δ
...e-collection/src/lib/signature-collection.types.ts 100.00% <100.00%> (ø)
...list-signing/parliamentary-list-signing.service.ts 14.51% <0.00%> (ø)

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 342c2d8...41adb1e. Read the comment docs.

@kodiakhq kodiakhq bot merged commit 17e1369 into main Oct 17, 2024
39 checks passed
@kodiakhq kodiakhq bot deleted the fix/errorInapplication branch October 17, 2024 12:49
kksteini pushed a commit that referenced this pull request Oct 17, 2024
* fix: error in application

* chore: nx format:write update dirty files

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Co-authored-by: andes-it <[email protected]>
kodiakhq bot added a commit that referenced this pull request Oct 17, 2024
* feat(signature-collection): send email to lks and skra (#16445)

* feat: send email to lks and skra

* chore: nx format:write update dirty files

---------

Co-authored-by: andes-it <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

* fix(signature-collection): try catch not found (#16447)

* fix: error in application

* chore: nx format:write update dirty files

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Co-authored-by: andes-it <[email protected]>

---------

Co-authored-by: Alex Diljar Birkisbur Hellsing <[email protected]>
Co-authored-by: andes-it <[email protected]>
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
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants