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): Add mock users for testing application hotfix #17220

Merged
merged 5 commits into from
Dec 16, 2024

Conversation

helgifr
Copy link
Member

@helgifr helgifr commented Dec 12, 2024

Hotfix: Mock users for new primary school application testing

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

  • New Features
    • Introduced mocked user data retrieval for testing in non-production environments.
  • Bug Fixes
    • Maintained existing logic for retrieving children and error handling.

@helgifr helgifr requested review from a team as code owners December 12, 2024 16:07
Copy link
Contributor

coderabbitai bot commented Dec 12, 2024

Walkthrough

The pull request modifies the NewPrimarySchoolService in the new-primary-school.service.ts file by introducing a new conditional block in the getChildren method. When the application is not running in production, the method now returns mocked user data for specific auth.nationalId values. The mocked data includes detailed child information like nationalId, fullName, genderCode, and living arrangements. The existing logic for retrieving children from the national registry remains unchanged.

Changes

File Change Summary
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts - Added import for isRunningInProduction from parental-leave/constants
- Implemented conditional mocking of user data when not in production environment

Sequence Diagram

sequenceDiagram
    participant Service as NewPrimarySchoolService
    participant Environment as Environment Check
    participant NationalRegistry as NationalRegistryService
    participant MockData as Mocked Data Provider

    Service->>Environment: Check if running in production
    alt Not in Production
        Service->>MockData: Retrieve mocked children data
    else In Production
        Service->>NationalRegistry: Fetch children data
    end
Loading

Possibly related PRs

Suggested labels

autoupdate

Suggested reviewers

  • birkirkristmunds

📜 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 bb0ad16 and 0db5122.

📒 Files selected for processing (1)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts

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.

@helgifr helgifr force-pushed the feat/mocked-users-for-new-primary-school branch from 75cfb82 to bb0ad16 Compare December 12, 2024 16:09
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: 3

🧹 Outside diff range and nitpick comments (2)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school-mock-users.ts (2)

16-16: Fix inconsistent naming with trailing spaces

There are trailing spaces in the following names:

  • 'Stúfur Maack '
  • 'Bína Maack '
-      fullName: 'Stúfur Maack ',
+      fullName: 'Stúfur Maack',
-      fullName: 'Bína Maack ',
+      fullName: 'Bína Maack',

Also applies to: 34-34


1-56: Add documentation for test scenarios

Please add JSDoc comments explaining:

  1. The purpose of each mock user
  2. The test scenarios they cover
  3. The significance of different gender codes used (2,3,4)

Example:

/**
 * Mock users for testing new primary school application scenarios.
 * Each key represents a parent's national ID with their associated children.
 * 
 * Test scenarios covered:
 * - Single child with both parents
 * - Multiple children with different custody arrangements
 * - etc.
 */
export const mockedUsers: Record<string, NationalRegistryPerson[]> = {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37fe92b and bb0ad16.

📒 Files selected for processing (3)
  • libs/api/domains/national-registry-x-road/src/index.ts (1 hunks)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school-mock-users.ts (1 hunks)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
libs/api/domains/national-registry-x-road/src/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/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school-mock-users.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/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."
📓 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 (1)
libs/api/domains/national-registry-x-road/src/index.ts (1)

3-3: LGTM! Export follows TypeScript best practices

The export of NationalRegistryPerson model enhances reusability across the application, which aligns with the coding guidelines for library modules.

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 35.72%. Comparing base (3314c57) to head (5e42c9f).
Report is 1 commits behind head on main.

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

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17220      +/-   ##
==========================================
- Coverage   35.73%   35.72%   -0.01%     
==========================================
  Files        6937     6937              
  Lines      148307   148299       -8     
  Branches    42327    42370      +43     
==========================================
- Hits        52998    52983      -15     
- Misses      95309    95316       +7     
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api 3.33% <ø> (ø)
application-api-files 61.87% <ø> (ø)
application-core 75.78% <ø> (ø)
application-system-api 38.74% <12.50%> (+<0.01%) ⬆️
application-template-api-modules 27.82% <0.00%> (-0.01%) ⬇️
application-templates-accident-notification 28.82% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.77% <ø> (ø)
application-templates-driving-license 18.16% <ø> (ø)
application-templates-estate 13.76% <ø> (ø)
application-templates-example-payment 24.72% <ø> (ø)
application-templates-financial-aid 14.46% <ø> (ø)
application-templates-general-petition 23.15% <ø> (ø)
application-templates-inheritance-report 6.59% <ø> (ø)
application-templates-marriage-conditions 15.19% <ø> (ø)
application-templates-mortgage-certificate 43.64% <ø> (ø)
application-templates-parental-leave 29.94% <ø> (ø)
application-types 6.51% <ø> (ø)
application-ui-components 1.22% <ø> (ø)
application-ui-shell 22.45% <ø> (ø)
clients-charge-fjs-v2 28.35% <ø> (ø)
web 2.41% <ø> (ø)

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

Files with missing lines Coverage Δ
...s/new-primary-school/new-primary-school.service.ts 31.48% <12.50%> (-3.31%) ⬇️

... and 6 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 3314c57...5e42c9f. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 12, 2024

Datadog Report

All test runs 2f3ec91 🔗

21 Total Test Services: 0 Failed, 20 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.01%), 92 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-web 0 0 0 2 0 8.24s 1 no change Link
api 0 0 0 4 0 3.06s 1 no change Link
application-api-files 0 0 0 2 0 5.38s 1 no change Link
application-core 0 0 0 97 0 21.31s 1 no change Link
application-system-api 0 0 0 46 0 1m 55.58s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 38.03s 1 decreased (-0.01%) Link
application-templates-accident-notification 0 0 0 148 0 14.57s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 9.64s 1 no change Link
application-templates-driving-license 0 0 0 13 0 16.03s 1 no change Link
application-templates-example-payment 0 0 0 2 0 11.37s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-template-api-modules - jest 30.2% (-0.01%) - Details

@helgifr helgifr added the automerge Merge this PR as soon as all checks pass label Dec 16, 2024
@helgifr helgifr changed the title feat(new-primary-school): Add mock users for testing application feat(new-primary-school): Add mock users for testing application hotfix Dec 16, 2024
Copy link
Member

@birkirkristmunds birkirkristmunds left a comment

Choose a reason for hiding this comment

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

LGTM!

@birkirkristmunds birkirkristmunds added the deploy-feature Deploys features to dev label Dec 16, 2024
@kodiakhq kodiakhq bot merged commit 271e5d2 into main Dec 16, 2024
96 checks passed
@kodiakhq kodiakhq bot deleted the feat/mocked-users-for-new-primary-school branch December 16, 2024 13:44
helgifr added a commit that referenced this pull request Dec 16, 2024
…ix (#17220)

* feat(new-primary-school): Add mock users for testing application

* remove console log

* Removed mock user file

---------

Co-authored-by: hfhelgason <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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 deploy-feature Deploys features to dev
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants