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

chore(inao): move applications into inao folder #15967

Merged
merged 6 commits into from
Sep 12, 2024

Conversation

jonnigs
Copy link
Member

@jonnigs jonnigs commented Sep 11, 2024

What

Make inao folder and move applications into it

Why

Encapsulate applications for an organization

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 README document for applications related to the Icelandic National Audit Office, providing an overview and guidance for users.
  • Chores

    • Updated paths in configuration files to reflect a new directory structure for the financial statement modules, ensuring accurate project configuration.
    • Removed unnecessary imports and adjusted component interfaces for improved clarity and functionality.

@jonnigs jonnigs requested review from a team as code owners September 11, 2024 16:44
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

This pull request introduces several changes across various files related to the Applications for the Icelandic National Audit Office (Ríkisendurskoðun). Key modifications include the addition of a README file, updates to ESLint and TypeScript configuration paths, and adjustments to project structure to reflect a new directory organization. These changes aim to enhance clarity and maintainability within the project.

Changes

File Change Summary
libs/application/templates/inao/README.md Added a README document outlining the purpose and usage of applications for the Icelandic National Audit Office.
libs/application/templates/inao/financial-statement-cemetery/.eslintrc.json Updated ESLint "extends" path to reflect new directory structure.
libs/application/templates/inao/financial-statement-cemetery/jest.config.ts Modified Jest preset and coverage directory paths to accommodate new directory structure.
libs/application/templates/inao/financial-statement-cemetery/project.json Updated $schema and sourceRoot paths to align with new project structure.
libs/application/templates/inao/financial-statement-cemetery/tsconfig.lib.json Modified paths for type definition files to accommodate directory changes.
libs/application/templates/inao/financial-statement-cemetery/src/fields/Success/index.tsx Removed userType retrieval from Success component, simplifying its logic.
libs/application/templates/inao/financial-statement-individual-election/.eslintrc.json Updated ESLint "extends" path to reflect new directory structure.
libs/application/templates/inao/financial-statement-individual-election/jest.config.ts Changed to ES module syntax and updated preset and coverage directory paths.
libs/application/templates/inao/financial-statement-individual-election/project.json Updated $schema and sourceRoot paths to align with new project structure.
libs/application/templates/inao/financial-statement-individual-election/src/fields/ElectionInfoFields/index.tsx Modified ElectionsInfoFields component to remove application prop, changing its interface.
libs/application/templates/inao/financial-statement-individual-election/src/forms/applicationForm/clientInfoSection/index.ts Removed ABOUTIDS import from index.ts.
libs/application/templates/inao/financial-statement-individual-election/tsconfig.json Modified "extends" path to reflect new directory structure.
libs/application/templates/inao/financial-statement-individual-election/tsconfig.lib.json Updated paths for type definition files to accommodate directory changes.
libs/application/templates/inao/financial-statement-individual-election/tsconfig.spec.json Modified outDir in compilerOptions to reflect new directory structure.

Possibly related PRs


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0a39e3d and 71dd253.

Files selected for processing (3)
  • libs/application/templates/inao/financial-statement-cemetery/jest.config.ts (1 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/jest.config.ts (2 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/project.json (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • libs/application/templates/inao/financial-statement-cemetery/jest.config.ts
  • libs/application/templates/inao/financial-statement-individual-election/jest.config.ts
  • libs/application/templates/inao/financial-statement-individual-election/project.json

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (1c5dc57) to head (71dd253).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15967      +/-   ##
==========================================
- Coverage   36.84%   36.84%   -0.01%     
==========================================
  Files        6716     6716              
  Lines      137707   137707              
  Branches    39154    39162       +8     
==========================================
- Hits        50744    50742       -2     
- Misses      86963    86965       +2     
Flag Coverage Δ
air-discount-scheme-backend 54.08% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.39% <ø> (ø)
api-catalogue-services 77.85% <ø> (ø)
api-domains-air-discount-scheme 36.88% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 49.89% <ø> (ø)
api-domains-communications 40.43% <ø> (ø)
api-domains-criminal-record 47.81% <ø> (ø)
api-domains-driving-license 44.28% <ø> (ø)
api-domains-education 31.25% <ø> (ø)
api-domains-health-insurance 34.63% <ø> (ø)
api-domains-mortgage-certificate 35.75% <ø> (ø)
api-domains-payment-schedule 41.17% <ø> (ø)
application-api-files 57.48% <ø> (ø)
application-core 72.33% <ø> (+0.08%) ⬆️
application-system-api 41.67% <ø> (ø)
application-template-api-modules 23.48% <ø> (-0.02%) ⬇️
application-templates-accident-notification 22.26% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.96% <ø> (ø)
application-templates-driving-license 18.75% <ø> (ø)
application-templates-estate 12.55% <ø> (ø)
application-templates-example-payment 25.72% <ø> (ø)
application-templates-financial-aid 14.39% <ø> (ø)
application-templates-general-petition 23.95% <ø> (ø)
application-templates-health-insurance 26.88% <ø> (ø)
application-templates-inheritance-report 6.48% <ø> (ø)
application-templates-marriage-conditions 15.35% <ø> (ø)
application-templates-mortgage-certificate 44.15% <ø> (ø)
application-templates-parental-leave 29.31% <ø> (ø)
application-types 6.74% <ø> (ø)
application-ui-components 1.52% <ø> (ø)
application-ui-shell 21.75% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 30.83% <ø> (ø)
auth-react 22.82% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
clients-driving-license 40.61% <ø> (ø)
clients-driving-license-book 43.88% <ø> (ø)
clients-financial-statements-inao 49.13% <ø> (ø)
clients-license-client 1.83% <ø> (ø)
clients-middlewares 72.75% <ø> (+0.25%) ⬆️
clients-regulations 42.58% <ø> (ø)
clients-rsk-company-registry 29.76% <ø> (ø)
clients-rsk-personal-tax-return 38.00% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.77% <ø> (ø)
clients-zendesk 55.65% <ø> (ø)
cms 0.42% <ø> (ø)
cms-translations 39.58% <ø> (ø)
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.50% <ø> (ø)
contentful-apps 6.05% <ø> (ø)
dokobit-signing 62.94% <ø> (ø)
download-service 44.57% <ø> (ø)
email-service 60.73% <ø> (ø)
feature-flags 90.76% <ø> (ø)
file-storage 53.13% <ø> (ø)
financial-aid-backend 56.53% <ø> (ø)
financial-aid-shared 19.03% <ø> (ø)
icelandic-names-registry-backend 54.64% <ø> (ø)
infra-nest-server 48.95% <ø> (ø)
infra-tracing 43.24% <ø> (ø)
island-ui-core 28.59% <ø> (ø)
judicial-system-api 19.35% <ø> (ø)
judicial-system-audit-trail 68.61% <ø> (ø)
judicial-system-backend 55.72% <ø> (ø)
judicial-system-formatters 79.83% <ø> (ø)
judicial-system-message 66.86% <ø> (ø)
judicial-system-message-handler 47.71% <ø> (ø)
judicial-system-scheduler 69.01% <ø> (ø)
judicial-system-types 48.34% <ø> (ø)
judicial-system-web 28.71% <ø> (ø)
license-api 42.77% <ø> (-0.08%) ⬇️
localization 10.15% <ø> (ø)
logging 48.43% <ø> (ø)
message-queue 68.50% <ø> (ø)
nest-audit 68.20% <ø> (ø)
nest-config 78.13% <ø> (ø)
nest-feature-flags 51.97% <ø> (ø)
nest-problem 46.48% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.71% <ø> (ø)
nova-sms 62.28% <ø> (ø)
portals-admin-regulations-admin 1.96% <ø> (ø)
portals-core 16.14% <ø> (ø)
reference-backend 50.57% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-admin-api 52.83% <ø> (+0.02%) ⬆️
services-auth-delegation-api 61.32% <ø> (ø)
services-auth-ids-api 54.03% <ø> (-0.03%) ⬇️
services-auth-personal-representative 47.98% <ø> (ø)
services-auth-personal-representative-public 43.89% <ø> (+0.03%) ⬆️
services-auth-public-api 51.82% <ø> (ø)
services-documents 61.26% <ø> (ø)
services-endorsements-api 54.99% <ø> (ø)
services-sessions 65.75% <ø> (ø)
services-university-gateway 48.52% <ø> (+0.08%) ⬆️
services-user-notification 47.61% <ø> (+0.03%) ⬆️
services-user-profile 62.26% <ø> (ø)
shared-components 27.65% <ø> (ø)
shared-form-fields 31.58% <ø> (ø)
shared-mocking 64.62% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 29.26% <ø> (ø)
skilavottord-ws 24.34% <ø> (ø)
web 1.84% <ø> (ø)

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

see 1 file 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 123c86b...71dd253. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 11, 2024

Datadog Report

All test runs f0f633a 🔗

101 Total Test Services: 0 Failed, 99 Passed
🔻 Test Sessions change in coverage: 2 decreased, 2 increased, 195 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
air-discount-scheme-backend 0 0 0 81 0 25.89s N/A Link
air-discount-scheme-web 0 0 0 2 0 8.32s N/A Link
api 0 0 0 4 0 2.66s N/A Link
api-catalogue-services 0 0 0 23 0 11.12s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 17.52s N/A Link
api-domains-assets 0 0 0 3 0 11.22s N/A Link
api-domains-auth-admin 0 0 0 18 0 11.98s N/A Link
api-domains-communications 0 0 0 5 0 32.39s N/A Link
api-domains-criminal-record 0 0 0 5 0 9.59s N/A Link
api-domains-driving-license 0 0 0 23 0 28.95s N/A Link

🔻 Code Coverage Decreases vs Default Branch (2)

  • license-api - jest 33.87% (-0.02%) - Details
  • application-template-api-modules - jest 25.56% (-0.01%) - Details

Copy link
Member

@saevarma saevarma left a comment

Choose a reason for hiding this comment

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

Core file LGTM

Copy link
Member

@Toti91 Toti91 left a comment

Choose a reason for hiding this comment

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

Do we need to update any references directly to these projects? The sourceRoot in project.json for example?

Also this:
libs/application/templates/financial-statements-inao/codegen.yml

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6bb1c95 and 6b238bf.

Files selected for processing (9)
  • libs/application/templates/inao/README.md (1 hunks)
  • libs/application/templates/inao/financial-statement-cemetery/.eslintrc.json (1 hunks)
  • libs/application/templates/inao/financial-statement-cemetery/project.json (2 hunks)
  • libs/application/templates/inao/financial-statement-cemetery/tsconfig.lib.json (1 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/.eslintrc.json (1 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/project.json (2 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/tsconfig.json (1 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/tsconfig.lib.json (1 hunks)
  • libs/application/templates/inao/financial-statement-individual-election/tsconfig.spec.json (1 hunks)
Files skipped from review due to trivial changes (3)
  • libs/application/templates/inao/README.md
  • libs/application/templates/inao/financial-statement-cemetery/tsconfig.lib.json
  • libs/application/templates/inao/financial-statement-individual-election/tsconfig.lib.json
Additional context used
Path-based instructions (4)
libs/application/templates/inao/financial-statement-individual-election/tsconfig.spec.json (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/templates/inao/financial-statement-individual-election/tsconfig.json (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/templates/inao/financial-statement-individual-election/project.json (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/templates/inao/financial-statement-cemetery/project.json (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 (9)
libs/application/templates/inao/financial-statement-individual-election/tsconfig.spec.json (1)

4-4: LGTM!

The change in the outDir compiler option is minor and does not affect the functionality. It reflects the new directory structure for the output files generated during the TypeScript compilation process for tests.

The change adheres to the additional instructions for files matching the libs/**/* pattern:

  • The configuration file is specific to the financial-statement-individual-election application and is not reusable across different NextJS apps.
  • The file does not contain any TypeScript code for defining props or exporting types.
  • The change does not impact the tree-shaking or bundling practices.
libs/application/templates/inao/financial-statement-cemetery/.eslintrc.json (1)

2-2: LGTM! The change in the relative path is valid.

The modification to the relative path in the "extends" array suggests a change in the directory structure or the location of the base ESLint configuration file. This adjustment can impact how ESLint rules are applied to the project, potentially influencing the linting behavior based on the new configuration hierarchy.

Ensure that the updated relative path correctly points to the intended base ESLint configuration file and that the linting rules are being applied as expected after this change.

libs/application/templates/inao/financial-statement-individual-election/.eslintrc.json (1)

2-2: LGTM!

The change in the relative path for the base ESLint configuration is consistent with the PR objective of moving applications into the "inao" folder. The functionality of the ESLint configuration remains unaffected.

libs/application/templates/inao/financial-statement-individual-election/tsconfig.json (1)

19-19: LGTM!

The change in the extends property correctly updates the path to the base TypeScript configuration file, reflecting the new directory structure. This adjustment ensures that the appropriate compiler options and settings are applied to this project.

libs/application/templates/inao/financial-statement-individual-election/project.json (2)

3-4: LGTM!

The changes to the $schema path and sourceRoot align with the PR objective of moving applications into the inao folder. The new directory structure reflects the reorganization of the project within the application templates.


14-14: LGTM!

Updating the command for the extract-strings target to align with the new source root is necessary to ensure that the localization extraction process continues to function correctly after the project reorganization.

libs/application/templates/inao/financial-statement-cemetery/project.json (3)

4-4: Verify the correctness of the new sourceRoot path.

Please ensure that the updated sourceRoot path "libs/application/templates/inao/financial-statement-cemetery/src" is correct and aligns with the new project directory structure.

Verification successful

The sourceRoot path is correct.

The directory libs/application/templates/inao/financial-statement-cemetery/src exists, confirming that the sourceRoot path in the project.json file is correct and aligns with the project's directory structure.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the correctness of the new `sourceRoot` path.

# Test: Check if the directory exists at the specified path. Expect: Directory exists.
if [ -d "libs/application/templates/inao/financial-statement-cemetery/src" ]; then
  echo "The source root directory exists at the specified path."
else
  echo "The source root directory does not exist at the specified path."
fi

Length of output: 198


22-22: Verify the correctness of the updated Jest configuration path.

Please ensure that the updated Jest configuration path "libs/application/templates/inao/financial-statement-cemetery/jest.config.ts" is correct and accessible within the new project structure.

Verification successful

Jest Configuration Path Verified

The updated Jest configuration path "libs/application/templates/inao/financial-statement-cemetery/jest.config.ts" is correct and accessible within the new project structure. No further action is required.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the correctness of the updated Jest configuration path.

# Test: Check if the `jest.config.ts` file exists at the specified path. Expect: File exists.
if [ -f "libs/application/templates/inao/financial-statement-cemetery/jest.config.ts" ]; then
  echo "The jest.config.ts file exists at the specified path."
else
  echo "The jest.config.ts file does not exist at the specified path."
fi

Length of output: 205


3-3: Verify the correctness of the new $schema path.

Please ensure that the updated $schema path "../../../../../node_modules/nx/schemas/project-schema.json" is correct and accessible within the new project structure.

Copy link
Member

@Toti91 Toti91 left a comment

Choose a reason for hiding this comment

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

LGTM

@jonnigs jonnigs added the automerge Merge this PR as soon as all checks pass label Sep 12, 2024
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.

4 participants