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: external merge request from Contributor #36558

Draft
wants to merge 7 commits into
base: release
Choose a base branch
from

Conversation

rahulbarwal
Copy link
Contributor

@rahulbarwal rahulbarwal commented Sep 26, 2024

Description

Original PR: #35381
EE PR: https://github.com/appsmithorg/appsmith-ee/pull/5230
Fixes #35381

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

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

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Added a new property, customJSControl, to enhance configuration options within the Table Widget.
  • Tests
    • Introduced a test case to verify the menu button's onClick functionality has access to the currentRow context.

Tip

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


Fri, 04 Oct 2024 12:51:36 UTC

Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces enhancements to the Table Widget by adding a new property, customJSControl, which facilitates dynamic handling of table data. Additionally, a new test case is included to ensure that the onClick property of menu items correctly accesses the currentRow context, thereby improving the robustness of the component's functionality.

Changes

File Change Summary
app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/columnTypes/ColumnTypeMenubutton_spec.js Added a test case to verify onClick property access to currentRow context.
app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts Introduced a new property customJSControl with value "TABLE_COMPUTE_VALUE" in configuration.

Assessment against linked issues

Objective Addressed Explanation
Allow currentRow for onClick in menuButton item in Table widget (#35381)
Introduce customJSControl for enhanced configuration in Table Widget (#35381)

Possibly related PRs

Suggested labels

ok-to-test, Enhancement, Widgets Product, Table Widget, Test

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🎉 In the realm of tables, we now enhance,
With customJSControl, we take a chance!
The currentRow shines bright in the click,
Our tests now ensure it works without a hitch!
So let’s celebrate this code, oh so neat,
For widgets and tables, it’s quite the treat! 🎊


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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Sep 26, 2024
@rahulbarwal rahulbarwal marked this pull request as draft September 26, 2024 06:14
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)
app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/columnTypes/ColumnTypeMenubutton_spec.js (1)

166-175: Well done on adding a new test case, but let's make it even better!

Class, I'm pleased to see you've added a new test case to check the onClick property's access to currentRow. Your test follows many of our best practices, which is commendable. However, there's always room for improvement, so let's review a few points:

  1. Good job using locator variables instead of plain strings. This makes our tests more maintainable.

  2. I appreciate that you've avoided using cy.wait, cy.pause, or agHelper.sleep(). This helps keep our tests efficient.

  3. To make our test even more robust, consider using data-* attributes for selectors. For example:

    cy.get("[data-cy=onClick-field]").type("{{currentR");
  4. Let's make our assertion more specific. Instead of just checking if the hint contains "currentRow", we could assert the exact text or structure of the hint:

    _.agHelper.GetNAssertElementText(
      _.locators._hints,
      "currentRow: { /* Properties of the current row */ }",
      "contain.text",
    );

Remember, class, specific assertions help us catch unexpected changes more easily.

Keep up the good work, and don't forget to raise your hand if you have any questions!

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5a4174a and 1bdafe2.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/columnTypes/ColumnTypeMenubutton_spec.js (1 hunks)
  • app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/columnTypes/ColumnTypeMenubutton_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 not posted (2)
app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts (2)

254-254: Class, let's examine this new line of code.

The addition of customJSControl: "TABLE_COMPUTE_VALUE" to the onClick property is a significant improvement. This change allows us to use table-specific computations in the onClick event of menu items.

Can anyone tell me how this relates to our lesson objective? That's right! It enables the use of currentRow context in the onClick event, just as we aimed for in our project plan (issue #35381).

Remember, students, this enhancement will make our Table widget more dynamic and user-friendly. It's a perfect example of how small changes can have a big impact on functionality.


Line range hint 1-454: Class, let's summarize our code review lesson.

We've examined the changes made to the Basic.ts file, and I'm pleased to report that the modification aligns perfectly with our lesson objective. The addition of the customJSControl property to the onClick event of menu items is a well-implemented solution that addresses the need for currentRow context in the Table widget's menu button items.

This change enhances the widget's functionality without disrupting the existing codebase. It's a textbook example of clean, focused code improvement. Well done to the contributor!

Are there any questions about how this change impacts our Table widget's capabilities?

@rahulbarwal rahulbarwal added Widgets & Accelerators Pod Issues related to widgets & Accelerators ok-to-test Required label for CI labels Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Widgets & Accelerators Pod Issues related to widgets & Accelerators
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants