PromucFlow_constructor/app/client/src/navigation/FocusEntity.test.ts
Hetu Nandu 721767d742
feat: URL Navigation for Widgets (#20202)
## Description

Widget selection is driven by URL changes. This would fix browser
navigation for users as they can use browser back/forward buttons to
travel across older contexts on Appsmith.

> Fixing browser URL navigation for widgets

Fixes #19571


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.

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


## How Has This Been Tested?

- Manual
- Jest
- Cypress

### Test Plan
> Add Testsmith [test
cases](https://github.com/appsmithorg/TestSmith/issues/2171) links that
relate to this PR

### Issues raised during DP testing
- [X] When a selected widget is below viewport and user refreshes the
page, then the widget property pane is open but the page does not
navigate to the selected widget
https://loom.com/share/09f1eda2f02d474981a0d48e4a6419ec

- [ ] Drop 2 widgets one at a time > Delete both the widgets > Now click
on back button of the browser > Observe the url it shows the widget id
in the URL but the canvas remains empty
https://loom.com/share/53cae28a5d224e67b783c8ccf53745f5
Dev Response: This issue is valid but not a major inconvenience. We will
try to track it and see if it needed to be addressed. Many other web
tools do not handle such cases


- [X] Canvas scrolls down when all widgets are selected.
https://loom.com/share/c8a68dadcdb040779abd3a73bde2b06c

- [X] Widget is not getting highlighted when added from the API editor
page. Please refer to the attached
video:-https://jiju8jbmwa.vmaker.com/record/IkwiAqFgafK9dVmu



## 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:
- [ ] Test plan has been approved by relevant developers
- [x] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test

---------

Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
2023-02-21 19:08:16 +05:30

92 lines
2.5 KiB
TypeScript

import { identifyEntityFromPath, FocusEntity } from "navigation/FocusEntity";
describe("identifyEntityFromPath", () => {
const oldUrlCases = [
{
path: "/applications/myAppId/pages/myPageId/edit",
expected: { entity: FocusEntity.CANVAS, id: "", pageId: "myPageId" },
},
{
path: "/applications/myAppId/pages/myPageId/edit/widgets/ryvc8i7oja",
expected: {
entity: FocusEntity.PROPERTY_PANE,
id: "ryvc8i7oja",
pageId: "myPageId",
},
},
{
path: "/applications/myAppId/pages/myPageId/edit/api/myApiId",
expected: { entity: FocusEntity.API, id: "myApiId", pageId: "myPageId" },
},
{
path: "/applications/myAppId/pages/myPageId/edit/queries/myQueryId",
expected: {
entity: FocusEntity.QUERY,
id: "myQueryId",
pageId: "myPageId",
},
},
];
const pageSlugCases = [
{
path: "/app/eval/page1-myPageId/edit",
expected: { entity: FocusEntity.CANVAS, id: "", pageId: "myPageId" },
},
{
path: "/app/myAppId/page1-myPageId/edit/widgets/ryvc8i7oja",
expected: {
entity: FocusEntity.PROPERTY_PANE,
id: "ryvc8i7oja",
pageId: "myPageId",
},
},
{
path: "/app/eval/page1-myPageId/edit/api/myApiId",
expected: { entity: FocusEntity.API, id: "myApiId", pageId: "myPageId" },
},
{
path: "/app/eval/page1-myPageId/edit/queries/myQueryId",
expected: {
entity: FocusEntity.QUERY,
id: "myQueryId",
pageId: "myPageId",
},
},
];
const customSlugCases = [
{
path: "/app/myCustomSlug-myPageId/edit",
expected: { entity: FocusEntity.CANVAS, id: "", pageId: "myPageId" },
},
{
path: "/app/myCustomSlug-myPageId/edit/widgets/ryvc8i7oja",
expected: {
entity: FocusEntity.PROPERTY_PANE,
id: "ryvc8i7oja",
pageId: "myPageId",
},
},
{
path: "/app/myCustomSlug-myPageId/edit/api/myApiId",
expected: { entity: FocusEntity.API, id: "myApiId", pageId: "myPageId" },
},
{
path: "/app/myCustomSlug-myPageId/edit/queries/myQueryId",
expected: {
entity: FocusEntity.QUERY,
id: "myQueryId",
pageId: "myPageId",
},
},
];
const cases = oldUrlCases.concat(pageSlugCases.concat(customSlugCases));
it("works", () => {
for (const testCase of cases) {
const actual = identifyEntityFromPath(testCase.path);
expect(actual).toStrictEqual(testCase.expected);
}
});
});