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

chore: Enable serialisation for JsonIgnore fields during export flow to avoid adding intermediate fields in DTO #14120

Merged
merged 29 commits into from
Jun 17, 2022

Conversation

abhvsn
Copy link
Contributor

@abhvsn abhvsn commented May 26, 2022

Description

As we have a single DTO to handle the conversion between DB objects and the serialised objects which will be saved in the exported JSON, it becomes difficult to maintain the conversion custom logic in special cases where we want to export the JsonIgnored fields. In such cases today we are writing a custom logic which can be found for fields like pageOrder, invisibleActionFields, mongoEscapedWidgetNames etc. In this PR we are trying to tackle this issue by serializing the complete object which also includes JsonIgnored fields and then sanitising the object needed for export.

Fixes #11701 #14410

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

JUnit testcase
Manual testing

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • 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
  • New and existing unit tests pass locally with my changes

@abhvsn abhvsn self-assigned this May 26, 2022
@vercel
Copy link

vercel bot commented May 26, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
appsmith ✅ Ready (Inspect) Visit Preview Jun 16, 2022 at 5:12PM (UTC)

@abhvsn abhvsn requested a review from AnaghHegde May 31, 2022 10:01
@github-actions github-actions bot added Enhancement New feature or request Git Product Issues related to version control product Import-Export-App Issues related to importing and exporting apps Platform Pod Platform Administration Pod Issues related to platform administration & management labels May 31, 2022
@abhvsn abhvsn marked this pull request as ready for review May 31, 2022 10:02
@github-actions
Copy link

Unable to find test scripts. Please add necessary tests to the PR.

AnaghHegde
AnaghHegde previously approved these changes Jun 15, 2022
@abhvsn
Copy link
Contributor Author

abhvsn commented Jun 16, 2022

/ok-to-test sha=8dea567

@github-actions
Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/2507721480.
Workflow: Appsmith External Integration Test Workflow.
Commit: 8dea567.
PR: 14120.

@abhvsn
Copy link
Contributor Author

abhvsn commented Jun 16, 2022

/ok-to-test sha=27f97d0

@github-actions
Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/2509486738.
Workflow: Appsmith External Integration Test Workflow.
Commit: 27f97d0.
PR: 14120.

@abhvsn
Copy link
Contributor Author

abhvsn commented Jun 16, 2022

/ok-to-test sha=042b61e

@github-actions
Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/2510566337.
Workflow: Appsmith External Integration Test Workflow.
Commit: 042b61e.
PR: 14120.

@github-actions
Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/2510566337.
Workflow: Appsmith External Integration Test Workflow.
Commit: 042b61e.
PR: 14120.

@abhvsn abhvsn requested a review from AnaghHegde June 17, 2022 01:49
@abhvsn abhvsn merged commit ebc4090 into release Jun 17, 2022
@abhvsn abhvsn deleted the export-intermediate-dtos branch June 17, 2022 04:39
@Nikhil-Nandagopal Nikhil-Nandagopal removed the Git Product Issues related to version control product label Aug 6, 2024
@github-actions github-actions bot added Artifact Platform Product Issues related to the application platform Git Platform Pod Issues related to the git & the app platform Git Product Issues related to version control product Verified When issue is retested post its fixed labels Aug 6, 2024
Copy link
Contributor

coderabbitai bot commented Aug 6, 2024

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 43 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 15559d0 and 042b61e.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Artifact Platform Product Issues related to the application platform Enhancement New feature or request Git Platform Pod Issues related to the git & the app platform Git Product Issues related to version control product Import-Export-App Issues related to importing and exporting apps Platform Administration Pod Issues related to platform administration & management skip-changelog Adding this label to a PR prevents it from being listed in the changelog Verified When issue is retested post its fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Implement intermediate DTOs or JsonView for serializing and deserializing DB objects to JSON files
3 participants