-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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: resolve empty table dropdown issue with dynamic select options in add new row functionality #37108
base: release
Are you sure you want to change the base?
Conversation
WalkthroughThe changes in this pull request enhance the testing and functionality of the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/AddNewRow1_spec.js (2 hunks)
- app/client/src/components/propertyControls/TableComputeValue.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/AddNewRow1_spec.js (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 (2)
app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/AddNewRow1_spec.js (1)
3-4
: LGTM: Import statements are properly structured.The addition of
entityExplorer
andlocators
imports aligns with the test requirements.app/client/src/components/propertyControls/TableComputeValue.tsx (1)
178-195
:getComputedValue
method implementation looks good.The logic correctly handles various cases and ensures proper binding formats.
it("1.8. should show the selectOptions data of a new row select cell when no data in the table", () => { | ||
entityExplorer.DragDropWidgetNVerify("tablewidgetv2", 350, 500); | ||
EditorNavigation.SelectEntityByName("Table2", EntityType.Widget); | ||
|
||
// add base data | ||
propPane.ToggleJSMode("Table data", "On"); | ||
propPane.UpdatePropertyFieldValue( | ||
"Table data", | ||
`{{[ | ||
{ | ||
role: "", | ||
} | ||
]}}`, | ||
); | ||
|
||
// remove all table data | ||
propPane.UpdatePropertyFieldValue("Table data", `[]`); | ||
|
||
// allow adding a row | ||
propPane.TogglePropertyState("Allow adding a row", "On"); | ||
|
||
// Edit role column to select type | ||
table.ChangeColumnType("role", "Select", "v2"); | ||
table.EditColumn("role", "v2"); | ||
propPane.TogglePropertyState("Editable", "On"); | ||
|
||
// Add data to select options | ||
agHelper.UpdateCodeInput( | ||
locators._controlOption, | ||
` | ||
{{ | ||
[ | ||
{"label": "Software Engineer", | ||
"value": 1,}, | ||
{"label": "Product Manager", | ||
"value": 2,}, | ||
{"label": "UX Designer", | ||
"value": 3,} | ||
] | ||
}} | ||
`, | ||
); | ||
|
||
table.AddNewRow(); | ||
agHelper.GetNClick(commonlocators.singleSelectWidgetButtonControl); | ||
agHelper | ||
.GetElement(commonlocators.singleSelectWidgetMenuItem) | ||
.contains("Software Engineer") | ||
.click(); | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test implementation needs refinement.
While the test case correctly validates the empty table dropdown functionality, there are several areas that need attention to align with the coding guidelines:
- Remove the cy.wait call and replace with proper assertions
- Extract string literals into constants
- Use data-* attributes for selectors
Apply these improvements:
- table.ChangeColumnType("role", "Select", "v2");
+ const COLUMN_TYPE = {
+ SELECT: "Select"
+ };
+ const ROLE_OPTIONS = {
+ SOFTWARE_ENGINEER: "Software Engineer"
+ };
+ table.ChangeColumnType("role", COLUMN_TYPE.SELECT, "v2");
- agHelper.GetElement(commonlocators.singleSelectWidgetMenuItem)
- .contains("Software Engineer")
- .click();
+ agHelper.GetElement(commonlocators.singleSelectWidgetMenuItem)
+ .contains(ROLE_OPTIONS.SOFTWARE_ENGINEER)
+ .should("exist")
+ .click();
Committable suggestion was skipped due to low confidence.
containsTableSpecificBindings = (stringToEvaluate: string) => { | ||
return ( | ||
stringToEvaluate.includes("currentIndex") || | ||
stringToEvaluate.includes("currentRow") | ||
); | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Improve string matching in containsTableSpecificBindings
.
Using string.includes(...)
may lead to false positives if currentIndex
or currentRow
appear within other identifiers (e.g., currentIndexValue
). Consider using word boundaries to ensure accurate matching.
Apply this diff to enhance the accuracy:
containsTableSpecificBindings = (stringToEvaluate: string) => {
- return (
- stringToEvaluate.includes("currentIndex") ||
- stringToEvaluate.includes("currentRow")
- );
+ const regex = /\b(currentIndex|currentRow)\b/;
+ return regex.test(stringToEvaluate);
};
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
containsTableSpecificBindings = (stringToEvaluate: string) => { | |
return ( | |
stringToEvaluate.includes("currentIndex") || | |
stringToEvaluate.includes("currentRow") | |
); | |
}; | |
containsTableSpecificBindings = (stringToEvaluate: string) => { | |
const regex = /\b(currentIndex|currentRow)\b/; | |
return regex.test(stringToEvaluate); | |
}; |
); | ||
}; | ||
|
||
containsTableSpecificBindings = (stringToEvaluate: string) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The functions that are extracted are just too shallow. I would do such abstractions only if they are used at atleast 3 places or doing something complex. But in this case, it is very straight forward, so extracting thesr won't help much, insteads, makes the code a little complex.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jsartisan I want to understand this better. Can you tell in detail, or share a link that explains this concept?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main idea is that modules should be deep. Methods like wrapInDoubleCurlyBraces and shouldReturnValueDirectly are too shallow - they don't hide enough complexity. These shallow methods actually increase cognitive load rather than reducing it.
I definitely recommend reading "Philosphy of software design".
if (stringToEvaluate === "") { | ||
return stringToEvaluate; | ||
} | ||
|
||
// Handle specific cases with "currentIndex" or "currentRow" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment is vey vague. Can you add a little more context why we need to handle this specific case?
/build-deploy-preview skip-tests=true |
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11550725809. |
Deploy-Preview-URL: https://ce-37108.dp.appsmith.com |
…o fix/new-row-select-options-dynamic-data
This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected. |
This PR has been closed because of inactivity. |
…o fix/new-row-select-options-dynamic-data
This PR has been closed because of inactivity. |
…o fix/new-row-select-options-dynamic-data
Description
Problem
When using a Table widget's Select column type with dynamic options, the computed value binding fails to handle empty table states correctly. If the table has no data (
processedTableData
is empty), the dynamic options evaluation still attempts to map over the non-existent table data, resulting in an empty array instead of the expected options.Root Cause
The issue stems from the
getComputedValue
function always using the table mapping binding prefix:This creates an unnecessary dependency on table data even when the dynamic options don't reference
currentRow
orcurrentIndex
, causing evaluation to fail when the table is empty.Problematic Evaluation
When the table is empty, expressions like:
Would evaluate to an empty array
[]
because it's wrapped in a.map()
over empty table data.Solution
Enhanced the
getComputedValue
function to use different binding strategies based on table state:getComputedValue
to choose the appropriate binding strategy:This ensures that:
The solution prevents unnecessary table data dependencies while preserving the ability to use table-specific values when required.
Fixes #23470
Automation
/ok-to-test tags="@tag.Table, @tag.Binding, @tag.Select, @tag.Sanity, @tag.Widget"
🔍 Cypress test results
Caution
🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13365913766
Commit: 080e71b
Cypress dashboard.
Tags: @tag.Table, @tag.Binding, @tag.Select, @tag.Sanity, @tag.Widget
Spec:
The following are new failures, please fix them before merging the PR:
Mon, 17 Feb 2025 09:54:23 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
TableV2
widget, ensuring proper UI behavior when no data exists.ComputeTablePropertyControlV2
, improving readability and functionality.