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

feat: Pages section redesign - IDE navigation #30212

Merged
merged 11 commits into from
Jan 11, 2024
Merged

Conversation

albinAppsmith
Copy link
Collaborator

@albinAppsmith albinAppsmith commented Jan 10, 2024

Description

This PR includes the new redesigned pages section and the new intractions.

PR fixes following issue(s)

Fixes #30176

Media

Screen.Recording.2024-01-10.at.7.00.36.PM.mov

Type of change

  • New feature (non-breaking change which adds functionality)

Testing

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration.
Delete anything that is not relevant

  • Manual
  • JUnit
  • Jest
  • Cypress

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:

  • Speedbreak features have been covered
  • Test plan covers all impacted features and areas of interest
  • Test plan has been peer reviewed by project stakeholders and other QA members
  • Manually tested functionality on DP
  • We had an implementation alignment call with stakeholders post QA Round 2
  • Cypress test cases have been added and approved by SDET/manual QA
  • Added Test Plan Approved label after Cypress tests were reviewed
  • Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

  • New Features

    • Introduced a full-width display option for pages within the app.
    • Added a new 'Minimal Segment' component in the IDE editor pane to display counts of actions and widgets.
    • Implemented a 'Pages Section' component for enhanced page management and navigation.
  • Enhancements

    • Upgraded the IDE editor pane with new components to improve user interaction and workflow.
  • Refactor

    • Replaced the previous page management component with the new 'Pages Section' for better performance and usability.
  • Style

    • Updated styling to accommodate new full-width page layout option.

@github-actions github-actions bot added IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE labels Jan 10, 2024
@albinAppsmith
Copy link
Collaborator Author

/build-deploy-preview skip-tests=true

@github-actions github-actions bot added the Enhancement New feature or request label Jan 10, 2024
Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7475686024.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 30212.
recreate: .

@albinAppsmith albinAppsmith marked this pull request as ready for review January 10, 2024 13:38
Copy link
Contributor

coderabbitai bot commented Jan 10, 2024

Walkthrough

Walkthrough

The recent changes involve enhancing the IDE editor pane with new components and functionality. A new CSS rule has been added to ensure full width for pages, while the editor pane now features a MinimalSegment component displaying action and widget counts, with interactive capabilities. The PagesSection component has been introduced to manage and navigate pages. Selectors have been added for fetching counts of actions and widgets. The main index file integrates these updates, adjusting component rendering based on page activity.

Changes

File Path Change Summary
.../Explorer/Common/components.tsx Added CSS rule for .page.fullWidth to set width to 100%.
.../IDE/EditorPane/MinimalSegment.tsx Added new MinimalSegment component for displaying counts and interactive status changes.
.../IDE/EditorPane/PagesSection.tsx Introduced PagesSection component for page management and navigation.
.../IDE/EditorPane/index.tsx Integrated PagesSection and MinimalSegment, updated component rendering logic.
.../selectors/ideSelectors.tsx Added selectors for retrieving action and widget counts from state.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@albinAppsmith
Copy link
Collaborator Author

/build-deploy-preview skip-tests=true

@albinAppsmith
Copy link
Collaborator Author

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

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7475757272.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 30212.
recreate: .

Copy link

Whoa, @tag.All spotted in your test suite! 🚀
While @tag.All is cool, like a catch-all net, why not try specific tags? 🏷️
Narrow down your suite with specific tags for quicker and more accurate tests! 🚀 Less waiting, more zipping through tests like a ninja!
Explore the tags documentation here

Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7475762688.
Workflow: Appsmith External Integration Test Workflow.
Tags: ``.

Comment on lines +26 to +27
export const getActionsCount = (state: AppState) =>
state.entities.actions.length || 0;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The getActionsCount selector function correctly retrieves the length of the actions array from the state. However, the || 0 is unnecessary because the length property of an array will always return a number, and in the case of an empty array, it will return 0.

-  state.entities.actions.length || 0;
+  state.entities.actions.length;

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.

Suggested change
export const getActionsCount = (state: AppState) =>
state.entities.actions.length || 0;
export const getActionsCount = (state: AppState) =>
state.entities.actions.length;

Comment on lines +29 to +30
export const getJsActionsCount = (state: AppState) =>
state.entities.jsActions.length || 0;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The getJsActionsCount selector function correctly retrieves the length of the jsActions array from the state. Similar to the previous comment, the || 0 is unnecessary.

-  state.entities.jsActions.length || 0;
+  state.entities.jsActions.length;

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.

Suggested change
export const getJsActionsCount = (state: AppState) =>
state.entities.jsActions.length || 0;
export const getJsActionsCount = (state: AppState) =>
state.entities.jsActions.length;

Copy link

Deploy-Preview-URL: https://ce-30212.dp.appsmith.com

Copy link

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/7475762688.
Commit: ``.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ServerSide/QueryPane/S3_1_spec.js

To know the list of identified flaky tests - Refer here

Copy link

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

@hetunandu hetunandu merged commit 66c3a17 into release Jan 11, 2024
19 checks passed
@hetunandu hetunandu deleted the pages-redesign branch January 11, 2024 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Pages section re design
2 participants