feat(new-primary-school): Implement school page

[birkirkristmunds]

TS-947

What

Implement new school page

Screenshots / Gifs

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

  • Added a new section to the primary school application form for selecting school enrollment
  • Introduced option to apply for neighborhood school or another school
  • Enhanced form with dynamic school selection based on application context

• Documentation

  • Added new descriptive messages for school selection process
  • Included clear labels and explanations for school application options

• Data Schema

  • Updated data schema to support school application preferences

[coderabbitai]

Walkthrough

This pull request introduces a new school subsection to the primary school application form. The changes include adding a new module for the school subsection, updating the primary school section to include this new subsection, extending the data schema to capture school application preferences, and adding corresponding message translations. The implementation allows users to choose between applying to their neighborhood school or another school, with dynamic visibility based on the application's context.

Changes

File	Change Summary
libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/index.ts	Added import and inclusion of schoolSubSection in the children array
libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/schoolSubSection.ts	Created new subsection with radio field for school application preference
libs/application/templates/new-primary-school/src/lib/dataSchema.ts	Added school object with applyForNeighbourhoodSchool enum field
libs/application/templates/new-primary-school/src/lib/messages.ts	Added new messages for school subsection, including labels and descriptions

Sequence Diagram

sequenceDiagram
    participant User
    participant Form
    participant SchoolSubSection
    participant DataSchema

    User->>Form: Starts Primary School Application
    Form->>SchoolSubSection: Render School Subsection
    SchoolSubSection->>User: Display School Selection Options
    User->>SchoolSubSection: Choose School Preference
    SchoolSubSection->>DataSchema: Validate School Selection
    DataSchema-->>SchoolSubSection: Validation Result

Loading

Possibly related PRs

• feat(fa): Adding to form children school to fincial-aid  #14796: Adds school-related information to a financial aid form
• fix(new-primary-school): mock users dev #17258: Modifies NewPrimarySchoolService for child data retrieval

Suggested labels

automerge, deploy-feature

Suggested reviewers

• raldur
• Toti91

---

📜 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 029015c and 0b73864.

📒 Files selected for processing (4)

• libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/index.ts (2 hunks)
• libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/schoolSubSection.ts (1 hunks)
• libs/application/templates/new-primary-school/src/lib/dataSchema.ts (1 hunks)
• libs/application/templates/new-primary-school/src/lib/messages.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/index.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/schoolSubSection.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/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/lib/messages.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 (3)

libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/index.ts (1)

Learnt from: birkirkristmunds
PR: island-is/island.is#16096
File: libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/childrenNParentsSection/index.ts:10-10
Timestamp: 2024-11-12T15:15:20.157Z
Learning: The `childrenSubSection` code has been moved and is now used in the `Prerequisites` section.

libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/schoolSubSection.ts (2)

Learnt from: veronikasif
PR: island-is/island.is#16096
File: libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/newSchoolSubSection.ts:81-90
Timestamp: 2024-11-12T15:15:20.157Z
Learning: When checking conditions involving variables like `schoolMunicipality` and `newSchoolHiddenInput`, ensure to verify that `schoolMunicipality` has a value before comparing it to `newSchoolHiddenInput`.

Learnt from: birkirkristmunds
PR: island-is/island.is#16096
File: libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/childrenNParentsSection/index.ts:10-10
Timestamp: 2024-11-12T15:15:26.274Z
Learning: The `childrenSubSection` code has been moved and is now used in the `Prerequisites` section.

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

Learnt from: veronikasif
PR: island-is/island.is#16304
File: libs/application/templates/new-primary-school/src/lib/dataSchema.ts:79-79
Timestamp: 2024-11-12T15:15:20.157Z
Learning: In `libs/application/templates/new-primary-school/src/lib/dataSchema.ts`, for the `reasonForApplication` field, since the options come from the server, we cannot use `z.nativeEnum` or `z.enum`, and should use `z.string()` instead.

Learnt from: veronikasif
PR: island-is/island.is#16304
File: libs/application/templates/new-primary-school/src/lib/dataSchema.ts:103-103
Timestamp: 2024-11-12T15:15:20.157Z
Learning: In `libs/application/templates/new-primary-school/src/lib/dataSchema.ts`, when comparing the `reason` field in `reasonForApplication`, which comes from the server as a string, avoid comparing it directly to `ReasonForApplicationOptions` enum values, as the enum may not include all server-provided values.

🔇 Additional comments (7)

libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/index.ts (2)

5-5: Good addition of the new import.
Bringing in the schoolSubSection from its separate file helps maintain cleaner boundaries and promotes reusability.

---

15-15: Verify sub-section ordering within this array.
By placing schoolSubSection before newSchoolSubSection, ensure that the ordering reflects the correct progression for users. If the sequence of user input is important, confirm whether its placement in the array meets the specified form flow.

libs/application/templates/new-primary-school/src/forms/NewPrimarySchoolForm/primarySchoolSection/schoolSubSection.ts (3)

1-14: Concise import usage and utility functions clarity.
You are accurately building upon core functionalities (buildMultiField, buildRadioField, buildSubSection) and using helper methods (getApplicationAnswers, getCurrentSchoolName). This modular approach fosters clarity and easier test coverage.

---

15-22: Condition check for “Moving abroad.”
This condition ensures the subsection is only shown if the reason is not “Moving abroad.” It enhances user experience by making the form data more dynamic and context-aware.

---

23-63: Radio field structure for school selection.
The dynamic label and subLabel values effectively guide users through their choice of school. The usage of a subLabel for additional context is beneficial for user clarity.

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

121-123: Schema extension for “school” is well-defined.
Adding the applyForNeighbourhoodSchool enum field ensures type-safe management of the user’s selection. Make sure that other code referencing this enum handles fallback cases (e.g., if no value is provided).

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

423-458: Clear and user-friendly school-related messages.
Providing separate labels for confirming or declining neighborhood school enrollment ensures clarity. The use of placeholders, like {currentSchoolName}, allows dynamic substitution, improving personalization. Good job!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.68%. Comparing base (74f5c19) to head (0b73864).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #17384   +/-   ##
=======================================
  Coverage   35.68%   35.68%           
=======================================
  Files        6931     6931           
  Lines      148785   148785           
  Branches    42509    42509           
=======================================
  Hits        53091    53091           
  Misses      95694    95694           

Flag	Coverage Δ
api	3.33% <ø> (ø)
application-system-api	38.72% <ø> (-0.02%)	⬇️
application-template-api-modules	27.65% <ø> (-0.03%)	⬇️
application-ui-shell	22.25% <ø> (ø)

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

Files with missing lines	Coverage Δ
...templates/new-primary-school/src/lib/dataSchema.ts	24.32% <ø> (ø)
...n/templates/new-primary-school/src/lib/messages.ts	100.00% <ø> (ø)

---

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 74f5c19...0b73864. Read the comment docs.

[datadog-island-is]

Datadog Report

All test runs e1fe830 🔗

✅ 4 Total Test Services: 0 Failed, 4 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.11%), 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.63s	1 no change	Link
application-system-api	0	0	0	46	0	2m 18.74s	1 no change	Link
application-template-api-modules	0	0	0	118	0	2m 4.43s	1 no change	Link
application-ui-shell	0	0	0	74	0	30.7s	1 no change	Link

🔻 Code Coverage Decreases vs Default Branch (1)

• application-templates-new-primary-school - jest 26.28% (-0.11%) - Details