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(new-primary-school): Siblings relation column removal #17450

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

Conversation

helgifr
Copy link
Member

@helgifr helgifr commented Jan 8, 2025

Removed relation column and also remove mock users for dev since we are getting them from Þjóðskrá

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

Summary by CodeRabbit

Release Notes

  • Feature Modification

    • Removed sibling relation options from the application form.
    • Simplified siblings information display by excluding relation labels.
    • Updated data schema to eliminate the sibling relation field.
  • User Impact

    • Siblings section now shows only full names and national IDs.
    • No longer requires specifying sibling relationship types.
    • Streamlined form submission process for sibling information.

@helgifr helgifr requested a review from a team as a code owner January 8, 2025 16:36
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request involves the removal of sibling relation-related functionality across multiple files in the new primary school application template. The changes primarily focus on eliminating the relation field and associated logic for siblings, simplifying the data structure. In the service layer, hardcoded child data for the 'dev' environment has been removed, and the environment filtering logic has been slightly modified to include both 'local' and 'dev' environments.

Changes

File Change Summary
libs/application/template-api-modules/.../new-primary-school.service.ts Removed hardcoded child data for 'dev' environment in getChildren method, updated environment filtering logic.
libs/application/templates/new-primary-school/src/fields/Review/review-groups/Siblings.tsx Removed sibling relation label from display and imports, updated table header.
libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.ts Removed SiblingRelationOptions import and relation field from form.
libs/application/templates/new-primary-school/src/lib/dataSchema.ts Removed relation field from siblings schema and related import.
libs/application/templates/new-primary-school/src/lib/constants.ts Removed SiblingRelationOptions enum.
libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts Removed functions related to sibling relations and corresponding import statements.
libs/application/templates/new-primary-school/src/types.ts Updated relation property type in SiblingsRow interface from SiblingRelationOptions to string, removed import statement.

Possibly related PRs

Suggested labels

automerge, deploy-feature

Suggested reviewers

  • birkirkristmunds
  • Toti91
  • sigruntg

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 (2)
libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.ts (1)

7-9: Consider removing unused imports.

The changes look good, but there might be additional imports that can be removed if they were only used for the relation field functionality.

Run this script to verify unused imports:

#!/bin/bash
# Check for potentially unused imports
rg -l "import.*from.*constants'" | xargs ast-grep --pattern 'import { $_ } from "./constants"' -A 3
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1)

58-58: Consider extracting environment check to a constant.

While the change is correct, consider improving readability by extracting the environment check to a named constant.

-        (isRunningOnEnvironment('local') || isRunningOnEnvironment('dev')) &&
+        const isTestEnvironment = isRunningOnEnvironment('local') || isRunningOnEnvironment('dev');
+        isTestEnvironment &&
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b744840 and 17f36a0.

📒 Files selected for processing (4)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1 hunks)
  • libs/application/templates/new-primary-school/src/fields/Review/review-groups/Siblings.tsx (2 hunks)
  • libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.ts (1 hunks)
  • libs/application/templates/new-primary-school/src/lib/dataSchema.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.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/application/templates/new-primary-school/src/fields/Review/review-groups/Siblings.tsx (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/new-primary-school/src/lib/dataSchema.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/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.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."
📓 Learnings (1)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1)
Learnt from: birkirkristmunds
PR: island-is/island.is#16096
File: libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts:0-0
Timestamp: 2024-11-12T15:15:11.835Z
Learning: In the TypeScript service `NewPrimarySchoolService` in `libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts`, the `validChildren` array in the `getChildren` method is used for developing and testing purposes.
🔇 Additional comments (2)
libs/application/templates/new-primary-school/src/fields/Review/review-groups/Siblings.tsx (1)

20-20: LGTM! Row data structure correctly simplified.

The changes align with the PR objective, correctly simplifying the sibling information to include only the full name and national ID.

libs/application/templates/new-primary-school/src/lib/dataSchema.ts (1)

5-5: LGTM! Schema updates correctly reflect sibling data structure changes.

The removal of the relation field from the siblings schema maintains type safety while aligning with the PR objective.

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 8, 2025

Datadog Report

All test runs 92e0120 🔗

4 Total Test Services: 0 Failed, 4 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.07%), 7 no change

Test 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.45s 1 no change Link
application-system-api 0 0 0 46 0 2m 12.54s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 5.47s 1 no change Link
application-ui-shell 0 0 0 74 0 31.5s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-templates-new-primary-school - jest 26% (-0.07%) - Details

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

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

Project coverage is 35.65%. Comparing base (4dbc264) to head (9b9bd06).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
...s/new-primary-school/new-primary-school.service.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17450      +/-   ##
==========================================
- Coverage   35.66%   35.65%   -0.01%     
==========================================
  Files        6977     6977              
  Lines      149705   149686      -19     
  Branches    42784    42777       -7     
==========================================
- Hits        53390    53371      -19     
  Misses      96315    96315              
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.75% <50.00%> (-0.01%) ⬇️
application-template-api-modules 27.54% <0.00%> (+<0.01%) ⬆️
application-ui-shell 22.19% <ø> (ø)

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

Files with missing lines Coverage Δ
...tes/new-primary-school/new-primary-school.utils.ts 12.50% <ø> (ø)
.../templates/new-primary-school/src/lib/constants.ts 100.00% <ø> (ø)
...templates/new-primary-school/src/lib/dataSchema.ts 24.32% <100.00%> (ø)
...ew-primary-school/src/lib/newPrimarySchoolUtils.ts 11.53% <ø> (-3.76%) ⬇️
...s/new-primary-school/new-primary-school.service.ts 34.78% <0.00%> (+4.59%) ⬆️

... and 7 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 4dbc264...9b9bd06. Read the comment docs.

@helgifr helgifr force-pushed the feat/mms-siblings-page-relation-removal branch from 17f36a0 to d4f6a2a Compare January 9, 2025 19:19
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)
libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts (1)

Line range hint 23-122: Consider enhancing type safety in utility functions

While the implementation is solid, consider these improvements for better type safety:

  1. Replace type assertions (as string) with runtime type checks
  2. Add explicit return types to functions
  3. Consider using TypeScript's nullish coalescing operator (??) for default values

Example for getApplicationAnswers:

export const getApplicationAnswers = (
  answers: Application['answers']
): ApplicationAnswers => {
  const childNationalId = getValueViaPath(answers, 'childNationalId') ?? '';
  // ... rest of the implementation
}

type ApplicationAnswers = {
  childNationalId: string;
  // ... other return types
};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4f6a2a and 9b9bd06.

📒 Files selected for processing (5)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.utils.ts (1 hunks)
  • libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.ts (1 hunks)
  • libs/application/templates/new-primary-school/src/lib/constants.ts (0 hunks)
  • libs/application/templates/new-primary-school/src/lib/dataSchema.ts (1 hunks)
  • libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • libs/application/templates/new-primary-school/src/lib/constants.ts
🚧 Files skipped from review as they are similar to previous changes (3)
  • libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/siblingsSubSection.ts
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.utils.ts
  • libs/application/templates/new-primary-school/src/lib/dataSchema.ts
🧰 Additional context used
📓 Path-based instructions (1)
libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.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."
📓 Learnings (1)
libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts (1)
Learnt from: veronikasif
PR: island-is/island.is#16096
File: libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts:12-18
Timestamp: 2024-11-12T15:15:20.157Z
Learning: Be cautious when suggesting removal of imports; ensure all imports are thoroughly checked to confirm whether they are unused.
🔇 Additional comments (2)
libs/application/templates/new-primary-school/src/lib/newPrimarySchoolUtils.ts (2)

Line range hint 1-20: Well-structured TypeScript implementation!

The imports and type definitions are well-organized, promoting proper tree-shaking and type safety. The explicit type imports and their usage in function signatures enhance code maintainability and reusability across NextJS apps.


Line range hint 183-238: Clean and robust helper functions implementation!

The helper functions demonstrate:

  • Proper null safety with optional chaining
  • Clean localization handling
  • Pure function implementation promoting reusability

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.

1 participant