8cb733937c
## 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 -->
384 lines
9.6 KiB
TypeScript
384 lines
9.6 KiB
TypeScript
import type { FocusEntityInfo } from "navigation/FocusEntity";
|
|
import { FocusEntity, identifyEntityFromPath } from "navigation/FocusEntity";
|
|
import { EditorState } from "@appsmith/entities/IDE/constants";
|
|
|
|
interface TestCase {
|
|
path: string;
|
|
expected: FocusEntityInfo;
|
|
}
|
|
|
|
describe("identifyEntityFromPath", () => {
|
|
const oldUrlCases: TestCase[] = [
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit",
|
|
expected: {
|
|
entity: FocusEntity.CANVAS,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/widgets/ryvc8i7oja",
|
|
expected: {
|
|
entity: FocusEntity.PROPERTY_PANE,
|
|
id: "ryvc8i7oja",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
pageId: "myPageId",
|
|
widgetIds: "ryvc8i7oja",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/queries",
|
|
expected: {
|
|
entity: FocusEntity.QUERY_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
entity: "queries",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/api/myApiId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myApiId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
apiId: "myApiId",
|
|
applicationId: "myAppId",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/queries/myQueryId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myQueryId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
queryId: "myQueryId",
|
|
applicationId: "myAppId",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/jsObjects",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
entity: "jsObjects",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/jsObjects/myJSId",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT,
|
|
id: "myJSId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
collectionId: "myJSId",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/datasource",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE_LIST,
|
|
id: "",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
entity: "datasource",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/applications/myAppId/pages/myPageId/edit/datasource/myDatasourceId",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE,
|
|
id: "myDatasourceId",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
applicationId: "myAppId",
|
|
datasourceId: "myDatasourceId",
|
|
pageId: "myPageId",
|
|
},
|
|
},
|
|
},
|
|
];
|
|
const pageSlugCases: TestCase[] = [
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit",
|
|
expected: {
|
|
entity: FocusEntity.CANVAS,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myAppId/page1-myPageId/edit/widgets/ryvc8i7oja",
|
|
expected: {
|
|
entity: FocusEntity.PROPERTY_PANE,
|
|
id: "ryvc8i7oja",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "myAppId",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
widgetIds: "ryvc8i7oja",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/queries",
|
|
expected: {
|
|
entity: FocusEntity.QUERY_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
entity: "queries",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/api/myApiId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myApiId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
apiId: "myApiId",
|
|
applicationSlug: "eval",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/queries/myQueryId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myQueryId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
queryId: "myQueryId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/jsObjects",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
entity: "jsObjects",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/jsObjects/myJSId",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT,
|
|
id: "myJSId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
collectionId: "myJSId",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/datasource",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE_LIST,
|
|
id: "",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
entity: "datasource",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/eval/page1-myPageId/edit/datasource/myDatasourceId",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE,
|
|
id: "myDatasourceId",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
applicationSlug: "eval",
|
|
datasourceId: "myDatasourceId",
|
|
pageId: "myPageId",
|
|
pageSlug: "page1-",
|
|
},
|
|
},
|
|
},
|
|
];
|
|
const customSlugCases: TestCase[] = [
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit",
|
|
expected: {
|
|
entity: FocusEntity.CANVAS,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/widgets/ryvc8i7oja",
|
|
expected: {
|
|
entity: FocusEntity.PROPERTY_PANE,
|
|
id: "ryvc8i7oja",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
widgetIds: "ryvc8i7oja",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/queries",
|
|
expected: {
|
|
entity: FocusEntity.QUERY_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
entity: "queries",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/api/myApiId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myApiId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
apiId: "myApiId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/queries/myQueryId",
|
|
expected: {
|
|
entity: FocusEntity.QUERY,
|
|
id: "myQueryId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
queryId: "myQueryId",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/jsObjects",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT_LIST,
|
|
id: "",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
pageId: "myPageId",
|
|
entity: "jsObjects",
|
|
customSlug: "myCustomSlug-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/jsObjects/myJSId",
|
|
expected: {
|
|
entity: FocusEntity.JS_OBJECT,
|
|
id: "myJSId",
|
|
appState: EditorState.EDITOR,
|
|
params: {
|
|
collectionId: "myJSId",
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/datasource",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE_LIST,
|
|
id: "",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
entity: "datasource",
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
path: "/app/myCustomSlug-myPageId/edit/datasource/myDatasourceId",
|
|
expected: {
|
|
entity: FocusEntity.DATASOURCE,
|
|
id: "myDatasourceId",
|
|
appState: EditorState.DATA,
|
|
params: {
|
|
pageId: "myPageId",
|
|
customSlug: "myCustomSlug-",
|
|
datasourceId: "myDatasourceId",
|
|
},
|
|
},
|
|
},
|
|
];
|
|
|
|
const cases = oldUrlCases.concat(pageSlugCases.concat(customSlugCases));
|
|
|
|
it("works", () => {
|
|
for (const testCase of cases) {
|
|
const actual = identifyEntityFromPath(testCase.path);
|
|
expect(actual).toStrictEqual(testCase.expected);
|
|
}
|
|
});
|
|
});
|