Skip to content

fix(secondary school): Add check for applicationDataHasBeenPruned #18968

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

Conversation

johannaagma
Copy link
Member

@johannaagma johannaagma commented May 9, 2025

...

Note: We can revert all this stuff when the applications for this term can actually be pruned

What

Display some information if application that has been submitted, but all the data has been accidentally pruned

Why

12 applications were accidentally pruned in end of april 2025

Screenshots / Gifs

If state = submitted :
image

If state = inReview:
image

If state = completed:
image

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

    • Overview content and alert messages now adjust based on the pruning status of application data.
    • Added localized messages to inform users about pruned application data during different application stages.
    • Submit actions are disabled when application data has been pruned.
  • Bug Fixes

    • Enhanced alert and UI behavior to accurately reflect the pruning state of application data.

@johannaagma johannaagma requested a review from a team as a code owner May 9, 2025 13:15
Copy link
Contributor

coderabbitai bot commented May 9, 2025

Walkthrough

A new utility function, applicationDataHasBeenPruned, was introduced and integrated into the overview component and the submitted form logic. Conditional rendering and UI gating now depend on whether application data has been pruned. Additionally, new localized messages for pruned data states were added to the message definitions.

Changes

File(s) Change Summary
libs/application/templates/secondary-school/src/fields/overview/index.tsx Modified Overview to conditionally render content based on whether application data has been pruned, using applicationDataHasBeenPruned and new localized messages for pruned states.
libs/application/templates/secondary-school/src/forms/submittedForm.ts Updated form logic to include applicationDataHasBeenPruned in conditions for showing alerts and enabling the submit action, gating UI elements based on pruned data status.
libs/application/templates/secondary-school/src/lib/messages/overview.ts Added a new message group applicationDataHasBeenPruned with messages for submitted, inReview, and completed states to the overview export for use when application data has been pruned.
libs/application/templates/secondary-school/src/utils/helperFunctions/index.ts Added and exported the utility function applicationDataHasBeenPruned, which checks if application data has been pruned by evaluating the approveExternalData value in the answers object.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OverviewComponent
    participant HelperFunctions
    participant Messages

    User->>OverviewComponent: Render Overview
    OverviewComponent->>HelperFunctions: applicationDataHasBeenPruned(answers)
    HelperFunctions-->>OverviewComponent: true/false
    alt Data has been pruned
        OverviewComponent->>Messages: Get pruned state message (by application state)
        Messages-->>OverviewComponent: Localized message
        OverviewComponent-->>User: Show pruned message
    else Data not pruned
        OverviewComponent-->>User: Show detailed overview components
    end
Loading
sequenceDiagram
    participant User
    participant SubmittedForm
    participant HelperFunctions

    User->>SubmittedForm: Interact with form
    SubmittedForm->>HelperFunctions: applicationDataHasBeenPruned(answers)
    HelperFunctions-->>SubmittedForm: true/false
    alt Data has been pruned
        SubmittedForm-->>User: Hide alerts, disable submit
    else Data not pruned
        SubmittedForm-->>User: Show alerts (if applicable), enable submit
    end
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 78f3315 and a4fdd0f.

📒 Files selected for processing (1)
  • libs/application/templates/secondary-school/src/lib/messages/overview.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • libs/application/templates/secondary-school/src/lib/messages/overview.ts
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

nx-cloud bot commented May 9, 2025

View your CI Pipeline Execution ↗ for commit a4fdd0f.

Command Status Duration Result
nx run-many --projects application-system-api -... ✅ Succeeded 8m 53s View ↗
nx run-many --target=build --projects=api --par... ✅ Succeeded 7m View ↗
nx run-many --projects application-system-form,... ✅ Succeeded 5m 23s View ↗
nx run-many --target=build --projects=applicati... ✅ Succeeded 4m 38s View ↗
nx run-many --target=build --projects=applicati... ✅ Succeeded 1m 41s View ↗
nx run-many --projects api,api-domains-applicat... ✅ Succeeded 6s View ↗
nx run-many -t lint --output-style=static --pro... ✅ Succeeded 1s View ↗
nx run-many --target=codegen/frontend-client --... ✅ Succeeded 14s View ↗
Additional runs (3) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-05-09 13:45:10 UTC

@johannaagma johannaagma enabled auto-merge May 9, 2025 13:22
coderabbitai[bot]
coderabbitai bot previously requested changes May 9, 2025
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

🧹 Nitpick comments (5)
libs/application/templates/secondary-school/src/utils/helperFunctions/index.ts (1)

13-15: Add JSDoc comments to explain this new utility function.

This function seems to be checking whether an application's data has been pruned by checking if approveExternalData is falsy. Adding a JSDoc comment would help other developers understand the reasoning behind this implementation.

+/**
+ * Checks if the application data has been pruned.
+ * @param answers The application form values
+ * @returns True if the application data has been pruned (when approveExternalData is false/undefined)
+ */
export const applicationDataHasBeenPruned = (answers: FormValue) => {
  return !getValueViaPath<boolean>(answers, 'approveExternalData')
}
libs/application/templates/secondary-school/src/fields/overview/index.tsx (1)

15-24: Consider extracting the message rendering logic into a helper component.

The conditional rendering block could be extracted into a separate component for better readability and maintainability, especially if this pattern might be reused elsewhere.

+const PrunedDataMessage = ({ state }: { state: string }) => {
+  const { formatMessage } = useLocale()
+  
+  if (state === States.SUBMITTED) {
+    return <>{formatMessage(overview.applicationDataHasBeenPruned.submitted)}</>
+  }
+  
+  if (state === States.IN_REVIEW) {
+    return <>{formatMessage(overview.applicationDataHasBeenPruned.inReview)}</>
+  }
+  
+  if (state === States.COMPLETED) {
+    return <>{formatMessage(overview.applicationDataHasBeenPruned.completed)}</>
+  }
+  
+  return null
+}

export const Overview: FC<FieldBaseProps> = (props) => {
  const { formatMessage } = useLocale()

  return applicationDataHasBeenPruned(props.application.answers) ? (
    <Box>
-      {props.application.state === States.SUBMITTED &&
-        formatMessage(overview.applicationDataHasBeenPruned.submitted)}
-      {props.application.state === States.IN_REVIEW &&
-        formatMessage(overview.applicationDataHasBeenPruned.inReview)}
-      {props.application.state === States.COMPLETED &&
-        formatMessage(overview.applicationDataHasBeenPruned.completed)}
+      <PrunedDataMessage state={props.application.state} />
    </Box>
  ) : (
libs/application/templates/secondary-school/src/forms/submittedForm.ts (3)

37-41: Improve readability with a descriptive variable name.

The condition logic is duplicated in multiple places. Consider creating a descriptive helper function or variable to make the intent more clear.

condition: (answers) => {
+  const isDataAvailableForDisplay = !applicationDataHasBeenPruned(answers);
  return (
-    !applicationDataHasBeenPruned(answers) &&
+    isDataAvailableForDisplay &&
    checkIsFreshman(answers)
  )
},

49-53: Improve readability with a descriptive variable name.

Similar to the previous comment, use a descriptive variable to improve readability.

condition: (answers) => {
+  const isDataAvailableForDisplay = !applicationDataHasBeenPruned(answers);
  return (
-    !applicationDataHasBeenPruned(answers) &&
+    isDataAvailableForDisplay &&
    !checkIsFreshman(answers)
  )
},

70-70: Consistency with other conditions.

For consistency with other conditions in this file, consider using the same descriptive variable approach here as well.

-condition: (answers) => !applicationDataHasBeenPruned(answers),
+condition: (answers) => {
+  const isDataAvailableForDisplay = !applicationDataHasBeenPruned(answers);
+  return isDataAvailableForDisplay;
+},
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5558b52 and 78f3315.

📒 Files selected for processing (4)
  • libs/application/templates/secondary-school/src/fields/overview/index.tsx (1 hunks)
  • libs/application/templates/secondary-school/src/forms/submittedForm.ts (4 hunks)
  • libs/application/templates/secondary-school/src/lib/messages/overview.ts (1 hunks)
  • libs/application/templates/secondary-school/src/utils/helperFunctions/index.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`libs/**/*`: "Confirm that the code adheres to the following: - Reusability of components and hooks across different NextJS apps. - TypeScript usage for defining props and exportin...

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/secondary-school/src/utils/helperFunctions/index.ts
  • libs/application/templates/secondary-school/src/forms/submittedForm.ts
  • libs/application/templates/secondary-school/src/fields/overview/index.tsx
  • libs/application/templates/secondary-school/src/lib/messages/overview.ts
🧬 Code Graph Analysis (1)
libs/application/templates/secondary-school/src/forms/submittedForm.ts (1)
libs/application/templates/secondary-school/src/utils/helperFunctions/index.ts (1)
  • applicationDataHasBeenPruned (13-15)

@datadog-island-is
Copy link

datadog-island-is bot commented May 9, 2025

Datadog Report

All test runs 4f74947 🔗

4 Total Test Services: 0 Failed, 4 Passed

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Test Service View
api 0 0 0 4 0 2.71s Link
application-system-api 0 0 0 46 0 8m 48.74s Link
application-template-api-modules 0 0 0 23 0 5m 12.55s Link
application-ui-shell 0 0 0 74 0 1m 8.73s Link

@johannaagma johannaagma added this pull request to the merge queue May 9, 2025
Merged via the queue into main with commit a74165a May 9, 2025
35 checks passed
@johannaagma johannaagma deleted the fix/secondary-shcool-handle-if-submitted-application-was-pruned-once branch May 9, 2025 14:09
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.

2 participants