Commit Graph

3 Commits

Author SHA1 Message Date
Hetu Nandu
3134224069
chore: IDE persistence (#31122)
## Description

Adds local persistence to IDE level features
- IDE Tabs
- IDE View mode (Split screen preference)


To achieve this, added a new option: `persist` in Focus Retention. This
will persist any Focus state and restore it when requested for the first
time.




#### PR fixes following issue(s)
Fixes #31135
Fixes #31025

#### Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
>
>
#### Type of change
> Please delete options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Chore (housekeeping or task changes that don't impact user perception)
- This change requires a documentation update
>
>
>
## 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](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced the ability to restore the IDE editor view mode to its last
state.
- Enhanced IDE tabs functionality with separate handling for query and
JS tabs.
- Added persistence of certain IDE states to local storage for improved
user experience.

- **Refactor**
- Updated focus management strategies to accommodate new IDE features
and state persistence.
- Streamlined IDE actions and sagas for better state management and
action handling.

- **Bug Fixes**
- Fixed an issue with the visibility of buttons in the IDE's segmented
header based on specific conditions.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-02-27 10:42:27 +05:30
Hetu Nandu
38d37ba874
chore: Split files for Module Instances in IDE (#30562)
As part of updating the IDE IA Redesign, we are splitting certain
functionalities so that they can be extended on the EE side.

Summary of changes:
- Create a `WithAddView` interface in RouteBuilder to indicate a
scenario where the url can be suffixed with a `/add` to have edit and
add views together
- Create a common GroupedList component
- Adds a dummy JS Add screen and routes. Wont navigate to it via the
system
- Move `EntityItem` interface to a more common location for
extensibility
- Update FocusElement config type to allow for a limited targeting in
FocusStrategy
- Extracted out ListItem render components for JS and Query
- Moved JS and Query segment hooks to a CE location for extensibility of
AddQuery and ListQuery
- Extracted EditorPaneRoutes for extensibility
- Added FocusEntity entries for QueryModuleInstance and
JSModuleInstance. This will be cleaned up at a later date.


Companion EE PR: https://github.com/appsmithorg/appsmith-ee/pull/3389

Fixes: #30544



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced an interface for adding views to enhance URL generation for
different editor functions.
- Added new user-facing messages for creating blank JavaScript objects
in the editor.
- Implemented new hooks and components to manage and render JavaScript
and Query entities within the IDE.
- Created a grouped list component for categorizing items within the
editor pane.

- **Enhancements**
- Extended existing enums and utilities to support new module instance
types and actions.
- Improved navigation and focus management within the IDE based on user
interaction and context.
- Streamlined the process of adding JavaScript operations and queries in
the editor.

- **Refactor**
- Updated import paths for better code organization and module
resolution.
- Removed redundant code and replaced components with more efficient
implementations.

- **Bug Fixes**
- Corrected the behavior of the `Files` component to handle undefined
types appropriately.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-01-24 14:22:40 +05:30
Hetu Nandu
8cb733937c
chore: Refactor Context Switching (#29966)
## Description

Refactors the Context Switching functionality to make it usable of
different IDE types. It now will set a `FocusStrategy` based on the IDE
type { App, Module, Workflow } and perform the same operations.
Implementation of `FocusStrategy` for other IDE types will be done on
the EE side. It removes all dependence of `pageId` from the core
functionality and relies on the Strategy implementation to define what
states to store and set, and the key used for them.

Also renamed the functionality to `FocusRetention` for more clarity.


#### PR fixes following issue(s)
Fixes #29961

#### Type of change
- Chore (housekeeping or task changes that don't impact user perception)

## Testing

#### How Has This Been Tested?

- [ ] 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](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added functionality for managing focus elements within the
application's integrated development environment (IDE).
- Introduced a focus strategy for handling focus elements in the
application.

- **Refactor**
- Restructured code for focus management configurations and strategies
to improve clarity and efficiency.
- Renamed `ConfigType` enum to `FocusElementConfigType` for better
reflection of its purpose.

- **Bug Fixes**
- Resolved issues with focus state restoration during navigation between
different URLs.

- **Tests**
- Updated test cases to align with the new focus management logic and
IDE type checks.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-01-08 11:09:47 +05:30