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

feat(signature-collection-api): Expose canSign/info #16061

Merged
merged 4 commits into from
Sep 19, 2024

Conversation

kksteini
Copy link
Member

@kksteini kksteini commented Sep 18, 2024

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 input type for validating signing requests based on national ID.
    • Added GraphQL models to provide detailed reasons for signing permissions.
    • Implemented new query methods to check signing eligibility for users and administrators.
  • Bug Fixes

    • Enhanced validation and error handling for signing operations.
  • Documentation

    • Updated API documentation to reflect new query methods and input types.

@kksteini kksteini requested a review from a team as a code owner September 18, 2024 14:33
Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The changes introduce new GraphQL input and model classes related to signature collection, enhancing the API's functionality. New methods for checking signing eligibility based on a national ID have been added to the resolver classes, along with a corresponding service method to retrieve signing information. These updates include necessary decorators for validation, access control, and auditing, ensuring that the new features integrate seamlessly into the existing architecture.

Changes

File Change Summary
libs/api/domains/signature-collection/src/lib/dto/canSign.input.ts Added SignatureCollectionCanSignInput class for handling input data with a required signeeNationalId field.
libs/api/domains/signature-collection/src/lib/models/canSignInfo.model.ts Introduced CanSignInfo model with an optional reasons field, utilizing the ReasonKey enum for GraphQL.
libs/api/domains/signature-collection/src/lib/signatureCollection.resolver.ts Added signatureCollectionCanSign method to check if a signee can sign based on their national ID.
libs/api/domains/signature-collection/src/lib/signatureCollectionAdmin.resolver.ts Introduced signatureCollectionAdminCanSignInfo method to retrieve signing eligibility information for admins.
libs/api/domains/signature-collection/src/lib/signatureCollectionAdmin.service.ts Added getCanSignInfo method to retrieve signing eligibility based on national ID, updating the service's constructor.

Possibly related PRs

Suggested labels

high priority

Suggested reviewers

  • albinagu
  • juni-haukur

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 795164a and 981b3c6.

Files selected for processing (1)
  • libs/api/domains/signature-collection/src/lib/signatureCollection.resolver.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • libs/api/domains/signature-collection/src/lib/signatureCollection.resolver.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.

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

Outside diff range and nitpick comments (1)
libs/api/domains/signature-collection/src/lib/dto/canSign.input.ts (1)

7-8: Consider adding validation for National ID format

The signeeNationalId field is currently validated as a string, but since National IDs have a specific format, consider adding additional validation to ensure it matches the expected pattern.

Apply this diff to add pattern matching validation:

@Field()
@IsString()
+@Matches(/^\d{10}$/)
signeeNationalId!: string
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ab53cdc and 2640d80.

Files selected for processing (5)
  • libs/api/domains/signature-collection/src/lib/dto/canSign.input.ts (1 hunks)
  • libs/api/domains/signature-collection/src/lib/models/canSignInfo.model.ts (1 hunks)
  • libs/api/domains/signature-collection/src/lib/signatureCollection.resolver.ts (2 hunks)
  • libs/api/domains/signature-collection/src/lib/signatureCollectionAdmin.resolver.ts (2 hunks)
  • libs/api/domains/signature-collection/src/lib/signatureCollectionAdmin.service.ts (3 hunks)
Additional context used
Path-based instructions (5)
libs/api/domains/signature-collection/src/lib/dto/canSign.input.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/api/domains/signature-collection/src/lib/models/canSignInfo.model.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/api/domains/signature-collection/src/lib/signatureCollectionAdmin.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/api/domains/signature-collection/src/lib/signatureCollection.resolver.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/api/domains/signature-collection/src/lib/signatureCollectionAdmin.resolver.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 not posted (1)
libs/api/domains/signature-collection/src/lib/models/canSignInfo.model.ts (1)

1-9: Code changes look good

The CanSignInfo model is correctly defined with the reasons field, and the ReasonKey enum is properly registered with GraphQL.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 18, 2024

Datadog Report

Branch report: feat/signature-collection-api-expose-can-sign-and-info
Commit report: 262080c
Test service: api

✅ 0 Failed, 4 Passed, 0 Skipped, 3.06s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.66%. Comparing base (1cd87ee) to head (981b3c6).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16061      +/-   ##
==========================================
- Coverage   36.66%   36.66%   -0.01%     
==========================================
  Files        6746     6746              
  Lines      138686   138670      -16     
  Branches    39397    39389       -8     
==========================================
- Hits        50852    50840      -12     
+ Misses      87834    87830       -4     
Flag Coverage Δ
api 3.39% <ø> (ø)
api-domains-auth-admin 49.89% <ø> (ø)
api-domains-communications 40.00% <ø> (ø)
application-system-api 41.52% <ø> (ø)
application-template-api-modules 23.45% <ø> (-0.01%) ⬇️
cms 0.43% <ø> (ø)
cms-translations 39.13% <ø> (ø)
content-search-toolkit 8.50% <ø> (ø)
judicial-system-api 18.61% <ø> (ø)
judicial-system-audit-trail 68.78% <ø> (ø)
judicial-system-backend 54.72% <ø> (ø)
judicial-system-web 28.71% <ø> (ø)
services-user-notification 47.17% <ø> (ø)

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

see 5 files with indirect coverage changes


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 1cd87ee...981b3c6. Read the comment docs.

@kksteini kksteini added the automerge Merge this PR as soon as all checks pass label Sep 18, 2024
@kodiakhq kodiakhq bot removed the automerge Merge this PR as soon as all checks pass label Sep 18, 2024
Copy link
Contributor

kodiakhq bot commented Sep 18, 2024

This PR currently has a merge conflict. Please resolve this and then re-add the automerge label.

@kksteini kksteini added the automerge Merge this PR as soon as all checks pass label Sep 19, 2024
@kodiakhq kodiakhq bot removed the automerge Merge this PR as soon as all checks pass label Sep 19, 2024
Copy link
Contributor

kodiakhq bot commented Sep 19, 2024

This PR currently has a merge conflict. Please resolve this and then re-add the automerge label.

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