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(endorsement-system): Store ownername #17248

Merged
merged 11 commits into from
Dec 17, 2024

Conversation

rafnarnason
Copy link
Member

@rafnarnason rafnarnason commented Dec 16, 2024

storing ownername to reduce unnecessary requests to NatReg

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 an optional ownerName field in the endorsement list.
    • Enhanced functionality to fetch the owner's name from the national registry during endorsement list creation.
  • Bug Fixes

    • Improved error handling when retrieving the owner's name.
  • Documentation

    • Updated method signatures to reflect new parameters and properties.

@rafnarnason rafnarnason requested a review from a team as a code owner December 16, 2024 11:57
Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jest > @jest/core > jest-config > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > [email protected]: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning storybook > @storybook/cli > tempy > del > [email protected]: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning storybook > @storybook/cli > jscodeshift > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning react-native > @react-native/codegen > [email protected]: Glob versions prior to v9 are no longer supported
warning react-native > @react-native/community-cli-plugin > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning react-native > @react-native/community-cli-plugin > @react-native/dev-middleware > @rnx-kit/chromium-edge-launcher > [email protected]: Rimraf versions prior to v4 are no longer supported
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-catch-binding instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-logical-assignment-operators instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-numeric-separator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/[email protected]: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning next-auth > [email protected]: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning next-auth > [email protected]: this version is no longer supported
warning next-auth > @next-auth/typeorm-legacy-adapter > typeorm > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > stylus > [email protected]: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > webpack-dev-server > [email protected]: Rimraf versions prior to v4 are no longer supported
warning @nx/next > @nx/webpack > fork-ts-checker-webpack-plugin > [email protected]: this will be v4
warning @nx/next > @nx/webpack > webpack-dev-server > webpack-dev-middleware > [email protected]: this will be v4
warning workspace-aggregator-f80baa6b-6f6d-43cc-96fd-f7ec4d1fff0c > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.

Walkthrough

This pull request introduces a migration script to add an owner_name column to the endorsement_list table. It includes updates to the endorsement list model to incorporate an optional ownerName property and modifications to the endorsement list service to retrieve the owner's name from a national registry. These changes facilitate the storage and management of owner-related information within the endorsement list.

Changes

File Change Summary
apps/services/endorsements/api/migrations/20241216113500-add-ownerName-column.js Added migration script to introduce owner_name column in the endorsement_list table.
apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.model.ts Added optional ownerName property to EndorsementList class.
apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts Implemented fetchOwnerNameFromRegistry method and updated create and getOwnerInfo methods to handle owner name retrieval.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • kksteini

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 52d4d1a and d66a77c.

📒 Files selected for processing (1)
  • apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 0

🧹 Nitpick comments (1)
apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts (1)

961-972: Consider adding retry mechanism for NatReg API calls.

The error handling is good, but NatReg API calls might fail due to transient issues. Consider implementing a retry mechanism with exponential backoff.

Example implementation:

  private async fetchOwnerNameFromRegistry(nationalId: string): Promise<string> {
+   const maxRetries = 3;
+   const baseDelay = 1000; // 1 second
+
+   for (let attempt = 1; attempt <= maxRetries; attempt++) {
      try {
        const person = await this.nationalRegistryApiV3.getName(nationalId)
        return person?.fulltNafn ? person.fulltNafn : ''
      } catch (error) {
+       if (attempt === maxRetries) {
          this.logger.error('Failed to fetch owner name from NationalRegistry', {
            error: error.message,
            nationalId,
+           attempt,
          })
          return ''
+       }
+       
+       const delay = baseDelay * Math.pow(2, attempt - 1);
+       await new Promise(resolve => setTimeout(resolve, delay));
+       
+       this.logger.warn('Retrying NatReg API call', {
+         nationalId,
+         attempt,
+         nextDelay: delay,
+       });
      }
+   }
+   return '';
  }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cfe3d07 and 26c89b5.

📒 Files selected for processing (3)
  • apps/services/endorsements/api/migrations/20241216113500-add-ownerName-column.js (1 hunks)
  • apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.model.ts (1 hunks)
  • apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.model.ts (2)

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

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

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."
apps/services/endorsements/api/migrations/20241216113500-add-ownerName-column.js (2)

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

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

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."
apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts (2)

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

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

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."
🔇 Additional comments (3)
apps/services/endorsements/api/migrations/20241216113500-add-ownerName-column.js (1)

1-12: LGTM! Migration looks good.

The migration correctly adds a nullable ownerName column and includes proper rollback functionality.

apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.model.ts (1)

88-94: LGTM! Model property is well-defined.

The ownerName property is properly decorated for both API documentation and database mapping, with appropriate nullability.

apps/services/endorsements/api/src/app/modules/endorsementList/endorsementList.service.ts (1)

250-254: LGTM! Owner name fetching is properly integrated.

The create method correctly fetches and stores the owner name while maintaining existing functionality.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 16, 2024

Datadog Report

All test runs 0dce6db 🔗

14 Total Test Services: 0 Failed, 11 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.04%), 25 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
api 0 0 0 4 0 2.97s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 13.73s 1 no change Link
application-system-api 0 0 0 46 0 2m 17.99s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 39.36s 1 no change Link
auth-api-lib 0 0 0 20 0 29.15s 1 no change Link
services-auth-admin-api 0 0 0 130 0 3m 47.44s 1 no change Link
services-auth-delegation-api 0 0 0 270 0 3m 22.44s 1 no change Link
services-auth-ids-api 0 0 0 262 0 1m 25.45s 1 no change Link
services-auth-personal-representative 0 0 0 0 0 311.63ms 1 no change Link
services-auth-personal-representative-public 0 0 0 0 0 289.11ms 1 no change Link

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.74%. Comparing base (980afb0) to head (d80641b).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##             main   #17248    +/-   ##
========================================
  Coverage   35.73%   35.74%            
========================================
  Files        6941     6937     -4     
  Lines      148407   148283   -124     
  Branches    42340    42324    -16     
========================================
- Hits        53038    52998    -40     
+ Misses      95369    95285    -84     
Flag Coverage Δ
api 3.33% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
application-system-api 38.74% <ø> (+<0.01%) ⬆️
application-template-api-modules 27.81% <ø> (ø)
services-auth-admin-api 52.55% <ø> (ø)
services-auth-delegation-api 58.53% <ø> (ø)
services-auth-ids-api 52.56% <ø> (ø)
services-auth-public-api 49.40% <ø> (ø)
services-user-notification 46.51% <ø> (-0.03%) ⬇️
services-user-profile 56.94% <ø> (+0.08%) ⬆️

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

Files with missing lines Coverage Δ
...p/modules/endorsementList/endorsementList.model.ts 95.83% <ø> (ø)
...modules/endorsementList/endorsementList.service.ts 29.80% <ø> (-0.24%) ⬇️

... and 30 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 980afb0...d80641b. Read the comment docs.

Copy link
Member

@juni-haukur juni-haukur left a comment

Choose a reason for hiding this comment

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

LGTM

@rafnarnason rafnarnason added the automerge Merge this PR as soon as all checks pass label Dec 17, 2024
@kodiakhq kodiakhq bot merged commit b280879 into main Dec 17, 2024
57 checks passed
@kodiakhq kodiakhq bot deleted the endorsement-system/owner-name-nationalid branch December 17, 2024 13:04
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.

3 participants