test: partial import export areas covered #37661

NandanAnantharamu · 2024-11-23T06:45:42Z

Adding tests for partial import/export
To be done into a new app
To be done into a new page
GitConnected App and importApp testing
https://docs.google.com/spreadsheets/d/1Vq5vRUyAMv2npPv4j41omzZrYcRUb8LEOhNVu_O4OE8/edit?gid=428365096#gid=428365096

/ok-to-test tags="@tag.All"

Summary by CodeRabbit

Release Notes

New Features
- Introduced a comprehensive suite of end-to-end tests for validating partial import and export functionality.
- Added new JSON configurations for API actions and application components to enhance import/export capabilities, including structured representations for widgets and actions.
Improvements
- Updated test specification paths to reflect the new focus on partial import/export tests.
- Expanded the set of locators for Cypress tests to improve interaction with entity items and specific row data in tables.

These updates aim to improve the reliability and functionality of the import/export processes within the application.

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12035486686
Commit: 5c3d72b
Cypress dashboard.
Tags: @tag.All
Spec:

Wed, 27 Nov 2024 06:19:10 UTC

coderabbitai · 2024-11-23T06:45:50Z

Walkthrough

The changes introduce a new Cypress test suite for validating partial import and export functionality within an application. This includes the addition of a new test file, updates to test specifications, and the introduction of JSON configuration files that define application components and API actions. The modifications ensure comprehensive testing across various contexts, including workspace and Git branch scenarios, enhancing the overall test coverage for import/export features.

Changes

File Path	Change Summary
`app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportRegularApp.ts`	New file added with a suite of Cypress tests for validating partial import and export functionality.
`app/client/cypress/limited-tests.txt`	Updated test specification path to include the new test file for partial import/export functionality.
`app/client/cypress/fixtures/PartialImportExport/ImportExport.json`	New JSON file defining application components, including API actions and widget configurations.
`app/client/cypress/fixtures/PartialImportExport/PartialQueryExport.json`	New JSON file detailing an API action configuration for partial query export.
`app/client/cypress/fixtures/PartialImportExport/PartialWidgetExport.json`	New JSON file containing widget configurations for application exports.
`app/client/cypress/support/Objects/CommonLocators.ts`	Added new properties `_entityItem` and `_rowData` for enhanced locator functionality in tests.

Possibly related PRs

test:PartialExport_Widgets spec file updated and import app method updated with validations #33343: This PR addresses a failing test related to partial export functionality, which is directly connected to the new Cypress tests for partial import/export in the main PR.
test: PartialExport_Widgets_spec - updated test validation logic #33371: This PR updates the test validation logic for partial exports, which aligns with the changes made in the main PR regarding partial import/export functionality.
test: added test for incompatible file #37323: This PR adds a test for an incompatible file, which directly relates to the import/export functionalities discussed in the main PR.

Suggested labels

Task

Suggested reviewers

ApekshaBhosale
sagar-qa007

🎉 In the land of code where tests do play,
New imports and exports brighten the day!
With JSONs and fixtures, all neatly aligned,
Cypress tests flourish, their purpose defined.
So let’s celebrate this testing spree,
For partial imports bring joy, you see! 🎊

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

…rt/PartialImportExportWithinNewPageAndApp.ts

…port.json

…xport.json

coderabbitai

Actionable comments posted: 8

🧹 Outside diff range and nitpick comments (4)

app/client/cypress/fixtures/PartialImportExport/PartialQueryXport.json (1)
1-1: Enhance test data variation with parameterized values

The fixture contains static values for pagination and filtering which limits test coverage. Consider parameterizing these values to support multiple test scenarios.

Suggested improvements:

Use variables for pagination limits

Add more filter conditions

Include multiple sort configurations

Example:
{
  "pagination": {
    "data": {
      "limit": "<%= testData.paginationLimit %>",
      "offset": "<%= testData.paginationOffset %>"
    }
  }
}
app/client/cypress/fixtures/PartialImportExport/PartialWidgetXport.json (2)

1-1: Format JSON for better readability

The JSON is minified, making it difficult to read and maintain. Consider formatting it with proper indentation for better readability in the test fixtures.

1-1: Consider extracting theme values

Multiple theme-related values are repeated throughout the configuration:

appsmith.theme.colors.primaryColor

appsmith.theme.borderRadius.appBorderRadius

appsmith.theme.boxShadow.appBoxShadow

Consider extracting these into a separate theme configuration file to maintain consistency across test fixtures.

app/client/cypress/fixtures/PartialImportExport/ImportExportUpdated.json (1)

1-1: Specify default sort column for Table1

The table is sortable but missing a default sort configuration, which may lead to inconsistent data presentation.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 86d17a6 and 2440266.

📒 Files selected for processing (4)

app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportRegularApp.ts (1 hunks)
app/client/cypress/fixtures/PartialImportExport/ImportExportUpdated.json (1 hunks)
app/client/cypress/fixtures/PartialImportExport/PartialQueryXport.json (1 hunks)
app/client/cypress/fixtures/PartialImportExport/PartialWidgetXport.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportRegularApp.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

Follow best practices for Cypress code and e2e automation.
Avoid using cy.wait in code.
Avoid using cy.pause in code.
Avoid using agHelper.sleep().
Use locator variables for locators and do not use plain strings.
Use data-* attributes for selectors.
Avoid Xpaths, Attributes and CSS path.
Avoid selectors like .btn.submit or button[type=submit].
Perform logins via API with LoginFromAPI.
Perform logout via API with LogOutviaAPI.
Perform signup via API with SignupFromAPI.
Avoid using it.only.
Avoid using after and aftereach in test cases.
Use multiple assertions for expect statements.
Avoid using strings for assertions.
Do not use duplicate filenames even with different paths.
Avoid using agHelper.Sleep, this.Sleep in any file in code.

app/client/cypress/fixtures/PartialImportExport/ImportExportUpdated.json (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

Follow best practices for Cypress code and e2e automation.
Avoid using cy.wait in code.
Avoid using cy.pause in code.
Avoid using agHelper.sleep().
Use locator variables for locators and do not use plain strings.
Use data-* attributes for selectors.
Avoid Xpaths, Attributes and CSS path.
Avoid selectors like .btn.submit or button[type=submit].
Perform logins via API with LoginFromAPI.
Perform logout via API with LogOutviaAPI.
Perform signup via API with SignupFromAPI.
Avoid using it.only.
Avoid using after and aftereach in test cases.
Use multiple assertions for expect statements.
Avoid using strings for assertions.
Do not use duplicate filenames even with different paths.
Avoid using agHelper.Sleep, this.Sleep in any file in code.

app/client/cypress/fixtures/PartialImportExport/PartialQueryXport.json (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

Follow best practices for Cypress code and e2e automation.
Avoid using cy.wait in code.
Avoid using cy.pause in code.
Avoid using agHelper.sleep().
Use locator variables for locators and do not use plain strings.
Use data-* attributes for selectors.
Avoid Xpaths, Attributes and CSS path.
Avoid selectors like .btn.submit or button[type=submit].
Perform logins via API with LoginFromAPI.
Perform logout via API with LogOutviaAPI.
Perform signup via API with SignupFromAPI.
Avoid using it.only.
Avoid using after and aftereach in test cases.
Use multiple assertions for expect statements.
Avoid using strings for assertions.
Do not use duplicate filenames even with different paths.
Avoid using agHelper.Sleep, this.Sleep in any file in code.

app/client/cypress/fixtures/PartialImportExport/PartialWidgetXport.json (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

Follow best practices for Cypress code and e2e automation.
Avoid using cy.wait in code.
Avoid using cy.pause in code.
Avoid using agHelper.sleep().
Use locator variables for locators and do not use plain strings.
Use data-* attributes for selectors.
Avoid Xpaths, Attributes and CSS path.
Avoid selectors like .btn.submit or button[type=submit].
Perform logins via API with LoginFromAPI.
Perform logout via API with LogOutviaAPI.
Perform signup via API with SignupFromAPI.
Avoid using it.only.
Avoid using after and aftereach in test cases.
Use multiple assertions for expect statements.
Avoid using strings for assertions.
Do not use duplicate filenames even with different paths.
Avoid using agHelper.Sleep, this.Sleep in any file in code.

🔇 Additional comments (6)

app/client/cypress/fixtures/PartialImportExport/PartialWidgetXport.json (2)

1-1: Review table widget's client-side features

The table widget configuration enables client-side features that might impact performance:

Client-side search is enabled (enableClientSideSearch: true)
Inline editing is configured (inlineEditingSaveOption: "ROW_LEVEL")
Client-side sorting is enabled (isSortable: true)

Ensure these features are actually required for the test scenarios.

✅ Verification successful

Features are required for test scenarios

The client-side features in the table widget configuration are actively tested in the test suite:

Client-side search is verified in Table_ClientSide_Search_spec.js
Inline editing is tested in Inline_editing_1_spec.js
Sorting functionality is validated in TableV2_spec.js

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for test files that validate these client-side features
rg -l "enableClientSideSearch|inlineEditingSaveOption|isSortable" app/client/cypress/integration/

Length of output: 171

Script:

#!/bin/bash
# First, let's find the correct test directory path
fd -t d "cypress" --full-path

# Then search for test files containing these features
rg -l "enableClientSideSearch|inlineEditingSaveOption|isSortable" app/client/cypress/

Length of output: 16253

Script:

#!/bin/bash
# Let's check the test files that specifically test these features
rg -l "enableClientSideSearch.*test|inlineEditingSaveOption.*test|isSortable.*test" app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/

# Also check the content of Table_ClientSide_Search_spec.js which seems relevant
rg -A 5 "enableClientSideSearch|inlineEditingSaveOption|isSortable" app/client/cypress/e2e/Regression/ClientSide/Binding/Table_ClientSide_Search_spec.js

Length of output: 584

Script:

#!/bin/bash
# Let's check the test file content for inline editing and sorting features
rg -A 5 "inlineEditingSaveOption|isSortable" app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_1_spec.js

# Also check if these features are being tested in TableV2_spec.js
rg -A 5 "inlineEditingSaveOption|isSortable" app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/TableV2_spec.js

Length of output: 1038

1-1: Verify button's onClick handler implementation

The button is configured to call JSObject1.genPDF() on click. Ensure this function exists and is properly tested.

app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportRegularApp.ts (2)

1-13: LGTM!

The imports are well-organized and the fixture setup is clean.

78-100: LGTM!

Good use of assertions and proper locator variables.

app/client/cypress/fixtures/PartialImportExport/ImportExportUpdated.json (2)

1-1: Update dependencies to latest stable versions

Consider updating:

jsonwebtoken from 8.5.1 to latest version
jspdf from 2.5.1 to latest version

1-1: Verify schema version compatibility

The large gap between client (v1) and server (v11) schema versions might cause compatibility issues.

✅ Verification successful

Schema version mismatch is expected and handled

The server has built-in migration support for schema version differences through JsonSchemaMigration.java. The version gap between client (v1) and server (v11) is part of the normal versioning pattern.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for schema version compatibility issues in other configuration files
fd -e json -x jq -r 'select(.clientSchemaVersion != null and .serverSchemaVersion != null) | "\(.clientSchemaVersion) \(.serverSchemaVersion)"'

Length of output: 1342

Script:

#!/bin/bash
# Let's check the schema version compatibility in the application configuration files
fd -e json -x grep -l "schemaVersion" {} \; | while read -r file; do
  echo "=== $file ==="
  jq -r 'select(.clientSchemaVersion != null and .serverSchemaVersion != null) | "Client: \(.clientSchemaVersion), Server: \(.serverSchemaVersion)"' "$file" 2>/dev/null
done

# Also check if there are any documented schema version requirements
fd -t f -e md -e txt -x grep -l "schema.*version" {} \;

Length of output: 122

Script:

#!/bin/bash
# Let's check the schema version patterns in the codebase
rg -g '*.{ts,js}' -l 'schemaVersion' 

# Check for schema version handling in code
ast-grep --pattern 'schemaVersion' 

# Look for schema version documentation
rg -g '*.md' -l 'schema.*version'

Length of output: 434

coderabbitai · 2024-11-23T06:53:40Z

app/client/cypress/fixtures/PartialImportExport/PartialQueryXport.json

@@ -0,0 +1 @@
+{"artifactJsonType":"APPLICATION","clientSchemaVersion":1,"serverSchemaVersion":11,"actionList":[{"id":"Home_Api1","pluginType":"SAAS","pluginId":"google-sheets-plugin","unpublishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"name":"Untitled datasource 2","pluginId":"google-sheets-plugin","messages":[],"isValid":true},"pageId":"Home","actionConfiguration":{"timeoutInMillisecond":10000,"paginationType":"NONE","encodeParamsToggle":true,"formData":{"command":{"data":"FETCH_MANY"},"entityType":{"data":"ROWS"},"tableHeaderIndex":{"data":"1"},"projection":{"data":["Currency"]},"queryFormat":{"data":"ROWS"},"range":{"data":""},"where":{"data":{"condition":"AND","children":[{"condition":"LT"}]}},"pagination":{"data":{"limit":"20","offset":"0"}},"smartSubstitution":{"data":true},"sheetUrl":{"data":"https://docs.google.com/spreadsheets/d/1DLNNumIhXhbajHGAEhWfzlgixcAu259gzAOVvLtWVpA/edit"},"sheetName":{"data":"Sheet1"},"sortBy":{"data":[{"column":"","order":"Ascending"}]}}},"executeOnLoad":true,"dynamicBindingPathList":[],"isValid":true,"invalids":[],"messages":[],"jsonPathKeys":[],"confirmBeforeExecute":false,"userPermissions":[]},"publishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"name":"Untitled datasource 2","pluginId":"google-sheets-plugin","messages":[],"isValid":true},"pageId":"Home","actionConfiguration":{"timeoutInMillisecond":10000,"paginationType":"NONE","encodeParamsToggle":true,"formData":{"command":{"data":"FETCH_MANY"},"entityType":{"data":"ROWS"},"tableHeaderIndex":{"data":"1"},"projection":{"data":["Currency"]},"queryFormat":{"data":"ROWS"},"range":{"data":""},"where":{"data":{"condition":"AND","children":[{"condition":"LT"}]}},"pagination":{"data":{"limit":"20","offset":"0"}},"smartSubstitution":{"data":true},"sheetUrl":{"data":"https://docs.google.com/spreadsheets/d/1DLNNumIhXhbajHGAEhWfzlgixcAu259gzAOVvLtWVpA/edit"},"sheetName":{"data":"Sheet1"},"sortBy":{"data":[{"column":"","order":"Ascending"}]}}},"executeOnLoad":true,"dynamicBindingPathList":[],"isValid":true,"invalids":[],"messages":[],"jsonPathKeys":[],"confirmBeforeExecute":false,"userPermissions":[]}}],"widgets":""}


⚠️ Potential issue

Consider using environment variables or test constants for sensitive URLs

The Google Sheets URL should not be hardcoded in test fixtures. Consider moving it to a centralized test constants file or environment variables.

Suggested approaches:

Use Cypress environment variables

Create a separate test constants file

Use a mock URL for tests

Example implementation:

-"sheetUrl":{"data":"https://docs.google.com/spreadsheets/d/1DLNNumIhXhbajHGAEhWfzlgixcAu259gzAOVvLtWVpA/edit"} +"sheetUrl":{"data":"<%= Cypress.env('TEST_SHEET_URL') %>"}

Committable suggestion skipped: line range outside the PR's diff.

coderabbitai · 2024-11-23T06:53:41Z