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(rental-agreement): Project structure & minimal functionality #16214

Open
wants to merge 91 commits into
base: main
Choose a base branch
from

Conversation

addi
Copy link
Contributor

@addi addi commented Sep 30, 2024

Rental-agreement project structure & minimal functionality

This is pretty much just wireframe code around a new application system form.
Locked behind a feature flag created in ConfigCat and added to @island.is/feature-flags package as per instructions in github docs.

Why

We want to get this code in so we can start developing in a better workflow, small PRs, QA and such.

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 application type for rental agreements, enhancing template handling.
    • Added a new library for rental agreement templates, including various form components and internationalized messages.
    • Established new forms for rental housing conditions and fire protections, streamlining the application process.
  • Configuration Updates

    • Updated configuration files for the rental agreement library to support development and testing.
  • Enhancements

    • Expanded application types and configurations to support rental agreements.
    • Introduced new components for landlord and tenant information, improving user experience.
    • Enhanced user interface for fire protection measures in rental properties.
    • Improved localization for messages related to rental agreements and property registration.

hebaulf and others added 21 commits September 13, 2024 11:00
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The changes in this pull request introduce a new application type, RENTAL_AGREEMENT, into the template loading system and establish a new library for rental agreement application templates. This includes adding configuration files, components, and internationalization support for the rental agreement feature. Additionally, new enum values and mappings are created to integrate this functionality into the existing application framework.

Changes

File Path Change Summary
libs/application/template-loader/src/lib/templateLoaders.ts Added new entry ApplicationTypes.RENTAL_AGREEMENT for dynamic import of rental agreement templates.
libs/application/types/src/lib/ApplicationTypes.ts Added new RENTAL_AGREEMENT type and configuration in ApplicationConfigurations.
libs/application/templates/rental-agreement Introduced new library with configuration files, components (e.g., GeneralInfoForm), and internationalized messages for rental agreements.
libs/application/templates/rental-agreement/src/forms/rentalHousingInfo/rentalHousingFireProtections.ts Added new component RentalHousingFireProtections for managing fire protection information in rental applications.
libs/application/templates/rental-agreement/src/forms/rentalHousingInfo/rentalHousingCondition.ts Added new component RentalHousingCondition for managing rental housing condition information.
libs/application/templates/rental-agreement/src/forms/rentalHousingInfo/rentalHousingPropertyInfo.ts Added new component RentalHousingPropertyInfo for capturing detailed property information.
libs/application/templates/rental-agreement/src/lib/constants.ts Introduced new enums and a function for application states and lifecycle management.
libs/application/templates/rental-agreement/src/lib/dataSchema.ts Added new data schema for validating rental agreement data using Zod.
libs/application/templates/rental-agreement/src/lib/messages/housing/housingCondition.ts Defined internationalized messages for housing condition inspections.
libs/application/templates/rental-agreement/src/lib/messages/index.ts Created central export module for various rental agreement components and messages.
libs/application/templates/rental-agreement/src/lib/utils.ts Added utility functions for string manipulation and retrieving application answers.

Suggested labels

automerge

Suggested reviewers

  • Toti91
  • sigruntg
  • Valur

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.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 30, 2024

Datadog Report

All test runs 4f96cfe 🔗

98 Total Test Services: 0 Failed, 90 Passed
❄️ 1 with New Flaky
🔻 Test Sessions change in coverage: 2 decreased, 19 increased, 179 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
services-auth-admin-api 0 0 6 130 0 3m 48.32s 1 no change Link
air-discount-scheme-backend 0 0 0 63 0 24.16s N/A Link
air-discount-scheme-web 0 0 0 2 0 8.28s N/A Link
api 0 0 0 4 0 3.12s N/A Link
api-catalogue-services 0 0 0 23 0 13.84s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 18.72s N/A Link
api-domains-assets 0 0 0 3 0 11.88s N/A Link
api-domains-auth-admin 0 0 0 18 0 12.93s N/A Link
api-domains-communications 0 0 0 5 0 38.41s N/A Link
api-domains-criminal-record 0 0 0 5 0 10.51s N/A Link

🔻 Code Coverage Decreases vs Default Branch (2)

  • license-api - jest 34.1% (-0.02%) - Details
  • services-university-gateway - jest 45.26% (-0.01%) - Details

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 35.67%. Comparing base (37fe92b) to head (1b22da7).

Files with missing lines Patch % Lines
...ication/template-loader/src/lib/templateLoaders.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16214      +/-   ##
==========================================
- Coverage   35.76%   35.67%   -0.10%     
==========================================
  Files        6931     6926       -5     
  Lines      147977   148223     +246     
  Branches    42173    42283     +110     
==========================================
- Hits        52931    52872      -59     
- Misses      95046    95351     +305     
Flag Coverage Δ
air-discount-scheme-backend 48.22% <100.00%> (+0.01%) ⬆️
air-discount-scheme-web 0.00% <ø> (ø)
api 3.33% <ø> (ø)
api-catalogue-services 75.81% <ø> (ø)
api-domains-air-discount-scheme 37.93% <100.00%> (+0.02%) ⬆️
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.43% <100.00%> (+<0.01%) ⬆️
api-domains-criminal-record 47.96% <100.00%> (+0.03%) ⬆️
api-domains-driving-license 44.83% <100.00%> (+0.01%) ⬆️
api-domains-education 31.25% <100.00%> (+0.03%) ⬆️
api-domains-health-insurance 35.38% <100.00%> (+0.04%) ⬆️
api-domains-mortgage-certificate 35.19% <100.00%> (+0.02%) ⬆️
api-domains-payment-schedule 42.06% <100.00%> (+0.02%) ⬆️
application-api-files 61.90% <100.00%> (+0.16%) ⬆️
application-core 76.08% <100.00%> (+0.07%) ⬆️
application-system-api 38.76% <83.33%> (+<0.01%) ⬆️
application-template-api-modules 27.83% <100.00%> (+0.03%) ⬆️
application-templates-accident-notification 28.93% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.78% <ø> (ø)
application-templates-driving-license 18.12% <ø> (ø)
application-templates-estate 13.79% <ø> (ø)
application-templates-example-payment 24.71% <ø> (ø)
application-templates-financial-aid 14.42% <ø> (ø)
application-templates-general-petition 23.13% <ø> (ø)
application-templates-inheritance-report 6.54% <ø> (ø)
application-templates-marriage-conditions 15.11% <ø> (ø)
application-templates-mortgage-certificate 43.67% <100.00%> (+0.11%) ⬆️
application-templates-parental-leave 29.95% <ø> (ø)
application-types 6.51% <0.00%> (-0.06%) ⬇️
application-ui-components 1.24% <ø> (ø)
application-ui-shell 22.47% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 31.52% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 28.35% <ø> (ø)
clients-driving-license 40.83% <100.00%> (+0.03%) ⬆️
clients-driving-license-book 43.86% <100.00%> (+0.02%) ⬆️
clients-financial-statements-inao 49.63% <100.00%> (+0.03%) ⬆️
clients-license-client 1.26% <ø> (ø)
clients-middlewares 73.46% <ø> (+0.32%) ⬆️
clients-regulations 42.91% <100.00%> (+0.04%) ⬆️
clients-rsk-company-registry 31.04% <ø> (ø)
clients-rsk-personal-tax-return 38.32% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.43% <100.00%> (+0.02%) ⬆️
clients-zendesk 50.58% <100.00%> (+0.11%) ⬆️
cms 0.40% <ø> (ø)
cms-translations 38.76% <100.00%> (+<0.01%) ⬆️
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.20% <ø> (ø)
contentful-apps 4.72% <ø> (ø)
dokobit-signing 62.18% <100.00%> (+0.08%) ⬆️
email-service 60.15% <100.00%> (+0.07%) ⬆️
feature-flags 90.83% <100.00%> (+0.07%) ⬆️
file-storage 45.97% <100.00%> (+0.10%) ⬆️
financial-aid-backend 51.42% <100.00%> (+0.01%) ⬆️
financial-aid-shared 17.88% <ø> (ø)
icelandic-names-registry-backend 54.33% <ø> (ø)
infra-nest-server 48.06% <ø> (ø)
infra-tracing 69.63% <ø> (ø)
island-ui-core 30.92% <ø> (ø)
judicial-system-api 20.16% <ø> (ø)
judicial-system-audit-trail 69.02% <100.00%> (+0.08%) ⬆️
judicial-system-formatters 78.28% <ø> (ø)
judicial-system-message 66.54% <100.00%> (+0.06%) ⬆️
judicial-system-message-handler 48.32% <100.00%> (+0.08%) ⬆️
judicial-system-scheduler 70.99% <100.00%> (+0.02%) ⬆️
judicial-system-types 42.22% <ø> (ø)
judicial-system-web 27.89% <ø> (ø)
license-api 42.92% <100.00%> (-0.07%) ⬇️
localization 10.15% <ø> (ø)
logging 58.02% <ø> (ø)
message-queue 67.76% <ø> (ø)
nest-audit 65.78% <ø> (ø)
nest-aws 51.93% <ø> (ø)
nest-config 76.45% <100.00%> (+0.06%) ⬆️
nest-core 53.16% <ø> (ø)
nest-feature-flags 51.06% <100.00%> (+0.06%) ⬆️
nest-problem 45.64% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.13% <ø> (ø)
nova-sms 61.52% <100.00%> (+0.09%) ⬆️
portals-admin-regulations-admin 1.80% <ø> (ø)
portals-core 19.83% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-delegation-api 58.53% <100.00%> (+0.08%) ⬆️
services-sessions 65.32% <100.00%> (-0.03%) ⬇️
services-university-gateway 49.43% <100.00%> (-0.08%) ⬇️
services-user-notification 46.58% <100.00%> (+<0.01%) ⬆️
services-user-profile 56.99% <100.00%> (+0.09%) ⬆️
shared-components 30.06% <ø> (ø)
shared-form-fields 33.88% <ø> (ø)
shared-mocking 58.64% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 27.69% <ø> (ø)
skilavottord-ws 24.31% <ø> (ø)
web 2.43% <ø> (ø)

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

Files with missing lines Coverage Δ
libs/application/types/src/lib/ApplicationTypes.ts 100.00% <100.00%> (ø)
...lication/types/src/lib/InstitutionContentfulIds.ts 100.00% <100.00%> (ø)
...ibs/application/types/src/lib/InstitutionMapper.ts 100.00% <ø> (ø)
...pplication/types/src/lib/InstitutionNationalIds.ts 100.00% <100.00%> (ø)
libs/application/types/src/lib/InstitutionTypes.ts 100.00% <100.00%> (ø)
libs/feature-flags/src/lib/features.ts 100.00% <100.00%> (ø)
...ication/template-loader/src/lib/templateLoaders.ts 4.81% <0.00%> (-0.06%) ⬇️

... and 40 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 37fe92b...1b22da7. Read the comment docs.

@addi addi changed the title feat(rental-agreement) Project structure & minimal functionality feat(rental-agreement): Project structure & minimal functionality Oct 1, 2024
addi and others added 30 commits November 12, 2024 15:36
* Add logo. Add summary section and init custom component to form.

* Update summary custom component

* Summary updates

* Add all viable data from fields to summary

* Fix conflict from merge

* Fix lint error for relative import

* Update summary styling

* Update summary component structure

* Update summary. Add Security deposit amount. Add phone fileds with country codes.

* Fix lint errors
* Add logo. Add summary section and init custom component to form.

* Update summary custom component

* Summary updates

* Add all viable data from fields to summary

* Fix conflict from merge

* Fix lint error for relative import

* Update summary styling

* Update summary component structure

* Update summary. Add Security deposit amount. Add phone fileds with country codes.

* Fix lint errors

* Add special groups to summary.

* Update summary
* Add logo. Add summary section and init custom component to form.

* Update summary custom component

* Summary updates

* Add all viable data from fields to summary

* Fix conflict from merge

* Fix lint error for relative import

* Update summary styling

* Update summary component structure

* Update summary. Add Security deposit amount. Add phone fileds with country codes.

* Fix lint errors

* Add special groups to summary.

* Update summary

* Updates from PR comments
…17147)

* Update and validate landlord info inputs.

* NationalId validation update

* Landlord info schema update

* Update landlord details rendering of name and nationalId

* Update validation for landlord and tenant information.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy-feature Deploys features to dev
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants