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

fix: code split for run history resize issue in workflows editor #34049

Merged
merged 2 commits into from
Jun 6, 2024

Conversation

ayushpahwa
Copy link
Contributor

@ayushpahwa ayushpahwa commented Jun 6, 2024

Description

Run history for workflows is a system wide pane but due to the nature of the panes in appsmith, a pane has to be individually imported to each editor (jsobject, query,data and api). This PR is the code split PR which imports the pane into the respective component. The logic for the pane is in EE and can only be opened by a trigger that is only in workflow editor. EE PR for reference.

Fixes #33024

Automation

/test ide

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9403599136
Commit: 3d5d2c1
Cypress dashboard url: Click here!

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced RunHistory component to track and display run history in various editors.
  • Enhancements

    • Added RunHistory component to API Editor, JS Editor, and Query Editor for improved user experience.

These updates aim to provide better visibility and tracking of run histories across different sections of the application.

Copy link
Contributor

coderabbitai bot commented Jun 6, 2024

Walkthrough

The recent changes introduce a new RunHistory component across various parts of the application. This component is initially defined to return null, and it is incorporated into multiple editor forms, including the CommonEditorForm, JSEditorForm, and EditorJSONtoForm. Additionally, the changes ensure that the RunHistory component from the Community Edition (CE) is used within the Enterprise Edition (EE) by updating import and export statements accordingly.

Changes

File Path Change Summary
app/client/src/ce/components/RunHistory/index.tsx Introduced a new RunHistory component that returns null.
app/client/src/ee/components/RunHistory/index.tsx Updated to export all entities from CE's RunHistory and use it as default.
app/client/src/pages/Editor/APIEditor/CommonEditorForm.tsx Added import for RunHistory and included <RunHistory /> component.
app/client/src/pages/Editor/JSEditor/Form.tsx Added import for RunHistory and included <RunHistory /> component.
app/client/src/pages/Editor/QueryEditor/EditorJSONtoForm.tsx Added import for RunHistory and included <RunHistory /> component.

Poem

In the code, a change so bright,
A RunHistory takes its flight.
Across the forms, it makes its way,
Though it returns null today.
Editors now with history's trace,
A silent witness in its place. 🌟

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

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

@github-actions github-actions bot added Bug Something isn't working Frontend This label marks the issue or pull request to reference client code Low An issue that is neither critical nor breaks a user flow Workflows Workflows Pod For all issues related to the Workflows feature labels Jun 6, 2024
@ayushpahwa ayushpahwa requested a review from hetunandu June 6, 2024 15:23
@ayushpahwa ayushpahwa added the ok-to-test Required label for CI label Jun 6, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 001acca and 3d5d2c1.

Files selected for processing (5)
  • app/client/src/ce/components/RunHistory/index.tsx (1 hunks)
  • app/client/src/ee/components/RunHistory/index.tsx (1 hunks)
  • app/client/src/pages/Editor/APIEditor/CommonEditorForm.tsx (2 hunks)
  • app/client/src/pages/Editor/JSEditor/Form.tsx (2 hunks)
  • app/client/src/pages/Editor/QueryEditor/EditorJSONtoForm.tsx (2 hunks)
Files skipped from review due to trivial changes (2)
  • app/client/src/ce/components/RunHistory/index.tsx
  • app/client/src/ee/components/RunHistory/index.tsx
Additional comments not posted (6)
app/client/src/pages/Editor/QueryEditor/EditorJSONtoForm.tsx (2)

43-43: Import of RunHistory looks good.


390-390: Integration of <RunHistory /> component appears correctly placed within the UI structure.

#!/bin/bash
# Description: Verify that the RunHistory component is properly integrated and functional.

# Test: Search for the component usage in related test files. Expect: Relevant test cases covering the new component.
rg --type typescript $'describe\(.*RunHistory.*\)'
app/client/src/pages/Editor/JSEditor/Form.tsx (2)

74-74: Import of RunHistory looks good.


444-444: Integration of <RunHistory /> component appears correctly placed within the UI structure.

#!/bin/bash
# Description: Verify that the RunHistory component is properly integrated and functional.

# Test: Search for the component usage in related test files. Expect: Relevant test cases covering the new component.
rg --type typescript $'describe\(.*RunHistory.*\)'
app/client/src/pages/Editor/APIEditor/CommonEditorForm.tsx (2)

64-64: Import of RunHistory looks good.


750-750: Integration of <RunHistory /> component appears correctly placed within the UI structure.

#!/bin/bash
# Description: Verify that the RunHistory component is properly integrated and functional.

# Test: Search for the component usage in related test files. Expect: Relevant test cases covering the new component.
rg --type typescript $'describe\(.*RunHistory.*\)'

@ayushpahwa ayushpahwa merged commit 3177a4d into release Jun 6, 2024
50 of 51 checks passed
@ayushpahwa ayushpahwa deleted the fix/run-history-resize-issue branch June 6, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Frontend This label marks the issue or pull request to reference client code Low An issue that is neither critical nor breaks a user flow ok-to-test Required label for CI Workflows Pod For all issues related to the Workflows feature Workflows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: JS Object not scrolling when run history is open .
2 participants