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(criminal record): Fix email to Syslumenn #17341

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

johannaagma
Copy link
Member

@johannaagma johannaagma commented Dec 20, 2024

What

Fix email to Syslumenn, is referencing to nationalRegistry in externalDate which does not exist

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

    • Updated email content to reference the applicant's information instead of national registry data for error notifications.
  • New Features

    • Removed outdated message definitions related to the national registry from the application.
  • Chores

    • Cleaned up import statements by removing unnecessary references.

@johannaagma johannaagma marked this pull request as ready for review December 20, 2024 15:09
@johannaagma johannaagma requested a review from a team as a code owner December 20, 2024 15:09
Copy link
Contributor

coderabbitai bot commented Dec 20, 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 > tempy > del > [email protected]: Rimraf versions prior to v4 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-class-properties 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-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-nullish-coalescing-operator 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 > @react-native-community/cli-tools > [email protected]: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
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-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-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-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-278d3c0e-04cb-4e45-9bd7-d7b5c0b46463 > [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.

Walkthrough

The pull request involves modifications to three files related to criminal record submission. Changes include removing Person import from the service file, updating email generation logic to reference application.applicant instead of nationalRegistryData, and deleting two national registry-related message definitions. The modifications appear to streamline data handling and messaging for the criminal record submission process.

Changes

File Change Summary
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/criminal-record-submission.service.ts Removed Person import from @island.is/clients/syslumenn
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.ts Removed nationalRegistryData extraction, updated email body to use application.applicant
libs/application/templates/criminal-record/src/lib/messages.ts Deleted nationalRegistryTitle and nationalRegistrySubTitle message definitions

Possibly related PRs

Suggested labels

automerge, deploy-feature

Suggested reviewers

  • sigruntg
  • Toti91

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

🔭 Outside diff range comments (1)
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.ts (1)

Line range hint 1-35: Add TypeScript type definitions for better type safety.

The file lacks proper TypeScript type definitions which could lead to runtime errors.

Consider adding the following type definitions:

interface ApplicationData {
  applicant: string;
  id: string;
  // Add other relevant fields
}

interface EmailOptions {
  email: {
    sender: string;
    address: string;
  };
}

interface EmailGeneratorProps {
  application: ApplicationData;
  options: EmailOptions;
}

Then update the function signature:

-export const generateSyslumennNotifyErrorEmail: EmailTemplateGenerator = (
-  props,
+export const generateSyslumennNotifyErrorEmail: EmailTemplateGenerator = (
+  props: EmailGeneratorProps,
🧹 Nitpick comments (1)
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.ts (1)

15-16: Consider enhancing the error message with more details.

While the change from nationalRegistryData to application.applicant is correct, the error message could be more informative for better troubleshooting.

Consider including additional context such as:

-      Villa hefur komið upp í samskiptum milli island.is og sýslumanna, vegna kaupa á sakavottorði fyrir ${application.applicant}.
+      Villa hefur komið upp í samskiptum milli island.is og sýslumanna, vegna kaupa á sakavottorði fyrir ${application.applicant}. Umsóknarnúmer: ${application.id}, Tími: ${new Date().toISOString()}.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1826987 and 3f29447.

📒 Files selected for processing (3)
  • libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/criminal-record-submission.service.ts (1 hunks)
  • libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.ts (1 hunks)
  • libs/application/templates/criminal-record/src/lib/messages.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • libs/application/templates/criminal-record/src/lib/messages.ts
🧰 Additional context used
📓 Path-based instructions (2)
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.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/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/criminal-record-submission.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."
🔇 Additional comments (3)
libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/criminal-record-submission.service.ts (3)

5-5: LGTM! Removal of unused import.

The removal of the Person import is correct as the code uses a custom person object structure instead of the imported type.


Line range hint 65-71: Verify email template changes.

Since the PR objectives mention fixing an email issue with "nationalRegistry" reference, let's ensure the email generator has been properly updated.

✅ Verification successful

Let me analyze the email generator implementation further to verify the changes.


Email template implementation is correct and doesn't contain any references to "nationalRegistry"

The email generators for both criminal record and mortgage certificate modules have been reviewed. Neither implementation contains any references to "nationalRegistry". The criminal record email uses application.applicant while the mortgage certificate email uses identityData.nationalId from the identity data source. Both implementations are consistent and properly structured.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify email template changes

# Search for the email generator implementation
rg -A 10 'generateSyslumennNotifyErrorEmail'

# Check for any remaining references to nationalRegistry
rg 'nationalRegistry' --type ts

Length of output: 66298


Script:

#!/bin/bash
# Check the implementation of syslumennNotifyError email generator in both criminal record and mortgage certificate modules
cat libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/emailGenerators/syslumennNotifyError.ts
cat libs/application/template-api-modules/src/lib/modules/templates/mortgage-certificate-submission/emailGenerators/syslumennNotifyError.ts

Length of output: 2175


Line range hint 52-58: Verify the person object structure matches Syslumenn's API requirements.

The person object is correctly using application.applicant instead of national registry data, which aligns with the PR's goal. However, let's verify that all required fields are present and correctly typed.

✅ Verification successful

Person object structure matches Syslumenn's API requirements

The person object in the criminal record submission service contains all the required fields according to the Syslumenn API's Person interface:

  • email (optional): ✓ present
  • signed (required): ✓ present and correctly set to false
  • type (required): ✓ present and correctly set to PersonType.CriminalRecordApplicant

The structure aligns with the API requirements, and the PersonType enum confirms that CriminalRecordApplicant is a valid type.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the person object structure against Syslumenn's API types

# Search for PersonType usage and its interface definition
ast-grep --pattern 'interface $_ {
  $$$
  type: PersonType
  $$$
}'

# Search for actual API calls to verify the structure
rg -A 5 'uploadData\(' 

Length of output: 10715


Script:

#!/bin/bash
# Let's find the Person interface definition and PersonType enum
ast-grep --pattern 'interface Person {
  $$$
}'

ast-grep --pattern 'enum PersonType {
  $$$
}'

# Let's also check the criminal record submission service for any specific person object construction
rg -A 10 'const person = {' libs/application/template-api-modules/src/lib/modules/templates/criminal-record-submission/criminal-record-submission.service.ts

Length of output: 3042

@datadog-island-is
Copy link

Datadog Report

All test runs e866fb7 🔗

10 Total Test Services: 0 Failed, 10 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.01%), 27 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.49s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 10.19s 1 no change Link
application-system-api 0 0 0 46 0 2m 8.8s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 17.03s 1 increased (+0.01%) Link
application-templates-criminal-record 0 0 0 2 0 10.31s 1 no change Link
application-ui-shell 0 0 0 74 0 30.59s 1 no change Link
auth-api-lib 0 0 0 20 0 27.33s 1 no change Link
services-auth-admin-api 0 0 0 130 0 3m 14.87s 1 no change Link
services-auth-delegation-api 0 0 0 270 0 2m 59.7s 1 no change Link
services-auth-ids-api 0 0 0 262 0 1m 19.26s 1 no change Link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants