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

fix(new-primary-school): mock users dev #17258

Merged
merged 2 commits into from
Dec 16, 2024
Merged

fix(new-primary-school): mock users dev #17258

merged 2 commits into from
Dec 16, 2024

Conversation

helgifr
Copy link
Member

@helgifr helgifr commented Dec 16, 2024

...

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

    • Enhanced logic for retrieving child data based on environment settings, now allowing stubbed data only in the development environment.
    • Added validation for specific national IDs in local environments.
  • Bug Fixes

    • Improved error handling to provide clearer messages when no children are found after filtering.

@helgifr helgifr requested a review from a team as a code owner December 16, 2024 15:11
Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request modifies the NewPrimarySchoolService in the new-primary-school.service.ts file, specifically updating the getChildren method. The changes focus on refining the environment-based logic for returning stubbed child data. The method now uses a more precise environment check, restricting stubbed data retrieval to the development environment only. The core functionality of filtering children based on national ID and living arrangements remains consistent, with maintained error handling for scenarios where no children are found after filtering.

Changes

File Change Summary
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts - Modified getChildren method environment check
- Replaced !isRunningInProduction with isRunningOnEnvironment('dev')
- Added specific national ID validation for local environment
- Retained child filtering logic based on living arrangements and year of birth

Sequence Diagram

sequenceDiagram
    participant Service as NewPrimarySchoolService
    participant Environment as EnvironmentChecker
    participant DataFilter as ChildDataFilter
    
    Service->>Environment: Check if running in dev environment
    alt Dev Environment
        Service->>DataFilter: Apply child filtering
        DataFilter-->>Service: Return filtered children
    else Non-Dev Environment
        Service->>Service: Fetch actual children data
    end
Loading

Possibly related PRs

Suggested reviewers

  • birkirkristmunds
  • baering

📜 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 51170d1 and 8fead2b.

📒 Files selected for processing (1)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1 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 added the deploy-feature Deploys features to dev label Dec 16, 2024
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

🔭 Outside diff range comments (1)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1)

Line range hint 115-142: Refactor filtering logic for better maintainability

The filtering logic combines multiple concerns and could be split into smaller, more focused functions.

+    const VALID_TEST_CHILDREN = [
+      '1111111119',
+      '2222222229',
+      '5555555559',
+      '6666666669',
+    ] as const;
+
+    const isValidTestChild = (nationalId: string) =>
+      isRunningOnEnvironment('local') && VALID_TEST_CHILDREN.includes(nationalId);
+
+    const isChildOfSchoolAge = (nationalId: string) => {
+      const yearOfBirth = kennitala.info(nationalId).birthday.getFullYear();
+      return yearOfBirth >= minYear && yearOfBirth <= maxYear;
+    };
+
     const filteredChildren = children.filter((child) => {
-      const validChildren = [
-        '1111111119',
-        '2222222229',
-        '5555555559',
-        '6666666669',
-      ]
-      if (
-        isRunningOnEnvironment('local') &&
-        validChildren.includes(child.nationalId)
-      ) {
+      if (isValidTestChild(child.nationalId)) {
         return true;
       }

       if (!child.nationalId) {
         return false;
       }

-      const yearOfBirth = kennitala
-        .info(child.nationalId)
-        .birthday.getFullYear()
-
-      return (
-        child.livesWithApplicant &&
-        yearOfBirth >= minYear &&
-        yearOfBirth <= maxYear
-      )
+      return child.livesWithApplicant && isChildOfSchoolAge(child.nationalId);
     })
🧹 Nitpick comments (3)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (3)

Line range hint 13-14: Remove unused import and consider environment constant

The isRunningInProduction import is no longer used after switching to isRunningOnEnvironment('dev'). While the environment check change is an improvement in precision, consider creating a constant for the environment name to avoid magic strings.

-import { isRunningInProduction } from '../parental-leave/constants'
+const DEV_ENVIRONMENT = 'dev' as const;
 
-    if (isRunningOnEnvironment('dev')) {
+    if (isRunningOnEnvironment(DEV_ENVIRONMENT)) {

Also applies to: 42-42


Line range hint 43-93: Document mock data test scenarios

The mock data provides good coverage of different scenarios, but it would be helpful to document what each national ID represents in terms of test cases.

+    // Test scenarios:
+    // 0101303019 - Single child case
+    // 0101302989 - Multiple children with different gender codes
+    // 0101304929 - Single child with specific age case
     if (auth.nationalId === '0101303019') {

Line range hint 1-153: Implementation follows coding guidelines and best practices

The service implementation adheres to the coding guidelines for libs:

  • Properly modular and reusable across NextJS apps
  • Strong TypeScript typing throughout
  • Follows dependency injection patterns

Consider adding integration tests to verify the environment-specific behavior, especially around the mock data scenarios.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 65767dc and 51170d1.

📒 Files selected for processing (1)
  • libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
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."
🔇 Additional comments (1)
libs/application/template-api-modules/src/lib/modules/templates/new-primary-school/new-primary-school.service.ts (1)

Line range hint 144-153: LGTM! Error handling is well implemented

The error handling uses proper error types, externalized messages, and appropriate HTTP status codes.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 16, 2024

Datadog Report

All test runs 527fc54 🔗

3 Total Test Services: 0 Failed, 3 Passed
➡️ Test Sessions change in coverage: 5 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 3.09s 1 no change Link
application-system-api 0 0 0 46 0 2m 6.06s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 26.52s 1 no change Link

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

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

Project coverage is 35.74%. Comparing base (e6a12da) to head (4be2e96).
Report is 1 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   #17258   +/-   ##
=======================================
  Coverage   35.73%   35.74%           
=======================================
  Files        6941     6940    -1     
  Lines      148396   148389    -7     
  Branches    42331    42341   +10     
=======================================
- Hits        53036    53035    -1     
+ Misses      95360    95354    -6     
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.74% <0.00%> (+<0.01%) ⬆️
application-template-api-modules 27.83% <0.00%> (+<0.01%) ⬆️
judicial-system-api 20.21% <ø> (ø)
judicial-system-backend 55.90% <ø> (ø)
judicial-system-formatters 78.47% <ø> (ø)
judicial-system-message 66.48% <ø> (ø)
judicial-system-message-handler 48.16% <ø> (ø)
judicial-system-scheduler 71.08% <ø> (ø)
judicial-system-types 41.66% <ø> (ø)
judicial-system-web 27.89% <ø> (ø)

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 30.18% <0.00%> (-1.30%) ⬇️

... and 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 e6a12da...4be2e96. Read the comment docs.

@helgifr helgifr added the automerge Merge this PR as soon as all checks pass label Dec 16, 2024
Copy link
Member

@ylfahfa ylfahfa left a comment

Choose a reason for hiding this comment

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

lgtm!

@kodiakhq kodiakhq bot merged commit 400f28f into main Dec 16, 2024
51 of 52 checks passed
@kodiakhq kodiakhq bot deleted the fix/mock-users-dev branch December 16, 2024 17:34
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.

2 participants