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(application-system): Error on removing uploaded documents #17233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

helgifr
Copy link
Member

@helgifr helgifr commented Dec 13, 2024

When documents are chosen for uploading and then removed right after it was causing an error because of trying to manipulate a read only property

...

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

Screen.Recording.2024-12-22.at.15.04.48.mov

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

  • Bug Fixes

    • Improved handling of file removal in the upload form, ensuring the original answers remain unchanged.
  • Refactor

    • Enhanced state management for file uploads by implementing deep cloning of answers.

When documents are chosen for uploading and then removed right after it was causing an error because of manipulating a read only property
@helgifr helgifr requested a review from a team as a code owner December 13, 2024 15:29
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

warning eslint@8.57.0: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.11.14: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning jest > @jest/core > jest-config > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > jest-runtime > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/reporters > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning jest > @jest/core > @jest/transform > babel-plugin-istanbul > test-exclude > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > rimraf@2.7.1: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > puppeteer-core > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > rimraf@2.6.3: Rimraf versions prior to v4 are no longer supported
warning storybook > @storybook/cli > jscodeshift > temp > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning storybook > @storybook/cli > jscodeshift > @babel/plugin-proposal-class-properties@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning storybook > @storybook/cli > jscodeshift > @babel/plugin-proposal-nullish-coalescing-operator@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning storybook > @storybook/cli > jscodeshift > @babel/plugin-proposal-optional-chaining@7.21.0: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning storybook > @storybook/cli > tempy > del > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning react-native > @react-native/codegen > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning react-native > @react-native/community-cli-plugin > querystring@0.2.1: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning react-native > @react-native/community-cli-plugin > @react-native/dev-middleware > @rnx-kit/chromium-edge-launcher > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-class-properties@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-class-properties instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-optional-chaining@7.21.0: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-chaining instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-nullish-coalescing-operator@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-nullish-coalescing-operator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-object-rest-spread@7.20.7: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-optional-catch-binding@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-optional-catch-binding instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-numeric-separator@7.18.6: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-numeric-separator instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-async-generator-functions@7.20.7: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-async-generator-functions instead.
warning react-native > @react-native/community-cli-plugin > @react-native/metro-babel-transformer > @react-native/babel-preset > @babel/plugin-proposal-logical-assignment-operators@7.20.7: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-logical-assignment-operators instead.
warning next-auth > querystring@0.2.1: The querystring API is considered Legacy. new code should use the URLSearchParams API instead.
warning next-auth > jose@1.28.2: this version is no longer supported
warning next-auth > @next-auth/typeorm-legacy-adapter > typeorm > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > stylus > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning @nx/next > @nx/webpack > webpack-dev-server > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning @nx/next > @nx/webpack > fork-ts-checker-webpack-plugin > memfs@3.6.0: this will be v4
warning @nx/next > @nx/webpack > webpack-dev-server > webpack-dev-middleware > memfs@3.6.0: this will be v4
warning workspace-aggregator-5bf9af64-07db-46e1-b7d6-96ae034c327d > eslint@8.57.0: This version is no longer supported. Please see https://eslint.org/version-support for other options.

Walkthrough

The changes in this pull request involve a modification to the onFileRemoveWhenInAnswers function within the FileUploadFormField component. A new line has been added to create a deep clone of the application.answers object using structuredClone. This ensures that the original application.answers remains unaltered when updating the answers after a file removal, thereby enhancing the immutability of state management related to file uploads.

Changes

File Change Summary
libs/application/ui-fields/src/lib/FileUploadFormField/FileUploadFormField.tsx Modified onFileRemoveWhenInAnswers to include a deep clone of application.answers using structuredClone to prevent mutation of the original object.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • thordurhhh
  • jonnigs

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. (Experiment)
  • @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 changed the title fix(core): Error on removing uploaded documents fix(application-system): Error on removing uploaded documents Dec 13, 2024
@datadog-island-is
Copy link

Datadog Report

All test runs 167a160 🔗

5 Total Test Services: 0 Failed, 5 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.01%), 29 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.44s 1 no change Link
application-system-api 0 0 0 46 0 2m 36.62s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 6.21s 1 no change Link
application-templates-parental-leave 0 0 0 163 0 14.86s 1 no change Link
application-ui-shell 0 0 0 74 0 30.51s 1 decreased (-0.01%) Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-ui-shell - jest 29.4% (-0.01%) - Details

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 and nitpick comments (1)
libs/application/ui-fields/src/lib/FileUploadFormField/FileUploadFormField.tsx (1)

Line range hint 37-43: LGTM! The fix addresses the read-only property mutation issue.

The use of structuredClone effectively prevents mutation of the read-only application.answers object.

Consider adding fallback and error handling.

While the implementation is correct, consider these improvements for robustness:

  1. Add a fallback for browsers that don't support structuredClone
  2. Add error handling for potential structuredClone exceptions
 const onFileRemoveWhenInAnswers = (fileToRemove: UploadFile) => {
-    const answers = structuredClone(application.answers)
+    let answers;
+    try {
+      answers = typeof structuredClone === 'function'
+        ? structuredClone(application.answers)
+        : JSON.parse(JSON.stringify(application.answers));
+    } catch (error) {
+      console.error('Failed to clone answers:', error);
+      return;
+    }
     const updatedAnswers = set(
       answers,
       id,
       currentValue.filter((x: UploadFile) => x.key !== fileToRemove.key),
     )
     answerQuestions?.({
       ...application.answers,
       ...updatedAnswers,
     })
   }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 231b35f and 66c647e.

📒 Files selected for processing (1)
  • libs/application/ui-fields/src/lib/FileUploadFormField/FileUploadFormField.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/application/ui-fields/src/lib/FileUploadFormField/FileUploadFormField.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."
🔇 Additional comments (1)
libs/application/ui-fields/src/lib/FileUploadFormField/FileUploadFormField.tsx (1)

Line range hint 1-89: Coding guidelines compliance confirmed.

The component implementation follows best practices:

  • Properly typed with TypeScript
  • Designed for reusability across NextJS apps
  • Uses named exports for better tree-shaking

Copy link

codecov bot commented Dec 13, 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 (231b35f) to head (66c647e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...rc/lib/FileUploadFormField/FileUploadFormField.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17233      +/-   ##
==========================================
- Coverage   35.74%   35.74%   -0.01%     
==========================================
  Files        6937     6937              
  Lines      148171   148172       +1     
  Branches    42253    42253              
==========================================
  Hits        52969    52969              
- Misses      95202    95203       +1     
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.75% <ø> (ø)
application-template-api-modules 27.83% <ø> (+<0.01%) ⬆️
application-templates-parental-leave 29.94% <ø> (ø)
application-ui-shell 22.50% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...rc/lib/FileUploadFormField/FileUploadFormField.tsx 4.76% <0.00%> (-0.24%) ⬇️

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 231b35f...66c647e. Read the comment docs.

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