fix: Added Firestore pagination paths to self referencing candidates

[nidhi-nair]

Description

Firestore requires cursor based pagination which means that a query that needs to be paginated will most definitely also refer to the same widget that is consuming the query data. This introduced a cyclic dependency in the dependency graph for such apps. This fix uses the concept of self referencing paths to ignore the pagination related fields in Firestore for all dependency calculations.

Fixes #19256

Type of change

• Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

• Manual
• ?

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

• 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
• PR is being merged under a feature flag

QA activity:

• Test plan has been approved by relevant developers
• Test plan has been peer reviewed by QA
• Cypress test cases have been added and approved by either SDET or manual QA
• Organized project review call with relevant stakeholders after Round 1/2 of QA
• Added Test Plan Approved label after reveiwing all Cypress test

Summary by CodeRabbit

• New Features
  • Introduced a new method to enhance the Firestore plugin, allowing for the retrieval of specific self-referencing data paths related to form data.
  • Improved data handling capabilities for better integration with other components.

[vercel]

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

1 Ignored Deployment

Name	Status	Preview	Updated
appsmith	⬜️ Ignored (Inspect)		Jan 4, 2023 at 2:46PM (UTC)

[what-the-diff]

• Added a new method getSelfReferencingDataPaths() to the class FirestorePlugin.
• This method returns a set of strings which are used by Appsmith for self-referential data paths in widgets like Table and FormViewer.

[subrata71]

@nidhi-nair Can you please explain how did you come up with this solution?

@Override
public Set<String> getSelfReferencingDataPaths() {
    return Set.of("formData.prev.data", "formData.next.data");
}

To be more specific how did you identify that formData.prev.data and formData.next.data are the paths that needed to be added in the above function?

The other day I thought of adding some paths in the above-overridden method but wasn't sure what to add.

[nidhi-nair]

Sure. There's 3 clues to go on here.

1. The CRUD page template is a fully configured query and shows us all possible connections that a Firestore query can make to a Table widget. From here, we gather that the possible bindings are:

   Order By -> ["Table1.sortOrder.order", "Table1.sortOrder.column"]
   Start After -> ["Table1.tableData"]
   End Before -> ["Table1.tableData"]
   Limit Documents -> ["Table1.pageSize"]
   

2. The editor json configuration for Firestore tells us which paths are getting used by the plugin. From here we can map the above to the property paths we need.

   Order By -> "formData.orderBy.data"
   Start After -> "formData.next.data"
   End Before -> "formData.prev.data" 
   Limit Documents -> "formData.limitDocuments.data"
   

3. In the dependency graph created for on page load calculations, if you insert a debug point where the error gets generated, you'll see that state of the graph is something akin to the following diagram. This clearly shows that the loop is getting created because of the pagination properties.
   

The graph is limited by paths for clarity, but the point to note here is that the other properties with references to Table1 are noticably missing because they don't enter the Table1.data path in the graph and would hence not cause a conflict.

Hope this helps. :)

[nidhi-nair]

/ok-to-test sha=ade0bf9

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3822635653.
Workflow: Appsmith External Integration Test Workflow.
Commit: ade0bf9.
PR: 19412.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19412&runId=3822635653_1

[github-actions]

The following are new failures, please fix them before merging the PR

[nidhi-nair]

/ok-to-test sha=ade0bf9

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3822988793.
Workflow: Appsmith External Integration Test Workflow.
Commit: ade0bf9.
PR: 19412.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19412&runId=3822988793_1

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/Application/CommunityIssues_Spec.ts
cypress/integration/Smoke_TestSuite/Application/EchoApiCMS_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Bug9334_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitDiscardChange/DiscardChanges_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitImport/GitImport_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/DeleteBranch_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitSyncedApps_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Git_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/SwitchBranches_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Onboarding/GuidedTour_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Templates/Fork_Template_Existing_app_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/AppPageLayout_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/DatasourcePageLayout_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/WidgetsLayout_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Widgets/Form/FormWidget_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/Datasources/SMTPDatasource_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/Datatypes/MySQL_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/Datatypes/MySQL_false_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Mongo_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/MySQL1_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/MySQL2_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Postgres1_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Postgres2_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/Postgres_DataTypes/Character_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Mongo_Spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Mongo_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Postgres_Spec.js

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/Application/CommunityIssues_Spec.ts
cypress/integration/Smoke_TestSuite/Application/EchoApiCMS_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Bug9334_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitDiscardChange/DiscardChanges_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitImport/GitImport_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/DeleteBranch_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitSyncedApps_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/Git_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/SwitchBranches_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Onboarding/GuidedTour_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/AppPageLayout_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/DatasourcePageLayout_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/WidgetsLayout_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/Datasources/SMTPDatasource_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/Datatypes/MySQL_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/Datatypes/MySQL_false_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Mongo_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/MySQL1_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/MySQL2_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Postgres1_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/GenerateCRUD/Postgres2_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/Postgres_DataTypes/Character_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Mongo_Spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Mongo_Spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/Postgres_Spec.js

[subrata71]

The explanation makes sense.

[nidhi-nair]

/ok-to-test sha=ade0bf9

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3833674891.
Workflow: Appsmith External Integration Test Workflow.
Commit: ade0bf9.
PR: 19412.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19412&runId=3833674891_1

[subrata71]

/ok-to-test sha=ade0bf9

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/3834819320.
Workflow: Appsmith External Integration Test Workflow.
Commit: ade0bf9.
PR: 19412.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=19412&runId=3834819320_1

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Binding/JSObjectToListWidget_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/JsFunctionExecution/JSFunctionExecution_spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Binding/JSObjectToListWidget_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Binding/JSObjectToListWidget_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Binding/JSObjectToListWidget_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/JsFunctionExecution/JSFunctionExecution_spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js

[github-actions]

The following are new failures, please fix them before merging the PR cypress/integration/Smoke_TestSuite/ClientSideTests/Binding/JSObjectToListWidget_Spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/BugTests/Autocomplete_JS_spec.ts
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/Git/GitSync/GitBugs_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ClientSideTests/VisualTests/JSEditorIndent_spec.js
cypress/integration/Smoke_TestSuite/ServerSideTests/JsFunctionExecution/JSFunctionExecution_spec.ts
cypress/integration/Smoke_TestSuite/ServerSideTests/QueryPane/EmptyDataSource_spec.js

[btsgh]

Brought up the branch on local and tried with the application attached in the bug. The firestore page still brings up a cyclic dependency error. @nidhi-nair

[nidhi-nair]

Looks like older apps have the pre-UQI paths in the dynamicBindingPathList as well. This is tech debt we should get rid off. For now I have added these paths to the ignore list as well. Will create an issue for cleaning up data and attach it here.

[btsgh]

1. Tried with an imported json of the CRUD template app. The first time as soon as I open the app, I still see the cyclic dependency error and also I see that the "TypeError: Cannot read properties of undefined (reading 'length')". However, after I run the queries again, the error is no longer seen. [Confirmed this with @nidhi-nair and this is as per expectation]
2. Tried with a new application, with the steps in the bug attached to the PR. The cyclic dependency error is not seen. [The error is easily reproducible on Release on a new app also, but on this fix branch, it is not reproducible]
3. Exported and imported the new application and checked for the error - not reproducible.
4. Gave a new user permission on the new app and the imported app, and tried opening the page - works fine
5. Forked the imported app to another workspace. No cyclic dependency error. Works fine

[coderabbitai]

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 10 minutes and 39 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 f30359b and 6d4359d.

Walkthrough

The recent changes introduce a new method, getSelfReferencingDataPaths(), in the FirestorePlugin class. This method enhances the plugin's capability by providing a set of predefined data paths related to form data, improving how the application handles data retrieval and integration. This addition is aimed at resolving issues related to cyclic dependencies when performing cursor pagination in Firestore queries.

Changes

Files	Change Summary
app/server/appsmith-plugins/firestorePlugin/.../FirestorePlugin.java	Added new method getSelfReferencingDataPaths() to return specific self-referencing data paths.

Assessment against linked issues

Objective	Addressed	Explanation
Incorrectly detect cyclic dependency with cursor pagination ( #19256 )	✅

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.