PromucFlow_constructor/app/client/src/RouteParamsMiddleware.ts
ashit-rath 59d0f999ad
chore: route builder refactor (#27905)
## Description
This PR aims to achieve 2 things
1. Make route building independent of explicitly passing `pageId` as
param when the route is generated against the current page navigation.
2. Add extensible points to extend basePath generation in EE.

THIS PR DOES NOT CHANGE ROUTE GENERATION. 

Changes: 
In `app/client/src/ce/entities/URLRedirect/URLAssembly.ts`
1. Moves the logic of `generateBasePath` way to specific method called
`generateBasePathForApps` and the generateBasePath is available to
extend and switch between a different base path generation logic in EE.
2. Adds a new member variable called `currentPageId`. This
`currentPageId` would help generating basePath without explicitly
passing `pageId` to the build method. If a `pageId` is passed it would
be overridden in the `resolveEntityId` logic.
3. Added `resolveEntityId` method to resolve the entity (pageId) based
on the params passed and the `currentPageId`. This method also acts as
an extension point for extending the logic to any other resolution logic
similar to `generateBasePath`

In `app/client/src/pages/AppViewer/index.tsx` and
`app/client/src/pages/Editor/index.tsx`
The `currentPageId` is set using the `urlBuilder.setCurrentPageId` when
the component mounts or page changes and unset when the component
unmounts.


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

#### 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
- Chore (housekeeping or task changes that don't impact user perception)

## 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
- [x] Manual
- [ ] JUnit
- [x] 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
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] 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
2023-10-12 11:01:22 +05:30

129 lines
4.0 KiB
TypeScript

import type {
ApplicationPayload,
Page,
ReduxAction,
} from "@appsmith/constants/ReduxActionConstants";
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
import type { UpdatePageResponse } from "api/PageApi";
import type {
ApplicationURLParams,
PageURLParams,
} from "@appsmith/entities/URLRedirect/URLAssembly";
import urlBuilder from "@appsmith/entities/URLRedirect/URLAssembly";
import type { Middleware } from "redux";
const routeParamsMiddleware: Middleware =
() => (next: any) => (action: ReduxAction<any>) => {
let appParams: ApplicationURLParams = {};
let pageParams: PageURLParams[] = [];
switch (action.type) {
case ReduxActionTypes.IMPORT_APPLICATION_SUCCESS:
case ReduxActionTypes.IMPORT_TEMPLATE_TO_WORKSPACE_SUCCESS:
case ReduxActionTypes.FETCH_APPLICATION_SUCCESS: {
const application: ApplicationPayload = action.payload;
const { pages } = application;
appParams = {
applicationId: application.id,
applicationSlug: application.slug,
applicationVersion: application.applicationVersion,
};
pageParams = pages.map((page) => ({
pageSlug: page.slug,
pageId: page.id,
customSlug: page.customSlug,
}));
break;
}
case ReduxActionTypes.FORK_APPLICATION_SUCCESS:
case ReduxActionTypes.CREATE_APPLICATION_SUCCESS: {
const application: ApplicationPayload = action.payload.application;
const { pages } = application;
appParams = {
applicationId: application.id,
applicationSlug: application.slug,
applicationVersion: application.applicationVersion,
};
pageParams = pages.map((page) => ({
pageSlug: page.slug,
pageId: page.id,
customSlug: page.customSlug,
}));
break;
}
case ReduxActionTypes.CURRENT_APPLICATION_NAME_UPDATE: {
const application = action.payload;
appParams = {
applicationId: application.id,
applicationSlug: application.slug,
applicationVersion: application.applicationVersion,
};
break;
}
case ReduxActionTypes.FETCH_PAGE_LIST_SUCCESS: {
const pages: Page[] = action.payload.pages;
pageParams = pages.map((page) => ({
pageSlug: page.slug,
pageId: page.pageId,
customSlug: page.customSlug,
}));
break;
}
case ReduxActionTypes.UPDATE_PAGE_SUCCESS: {
const page: UpdatePageResponse = action.payload;
pageParams = [
{
pageSlug: page.slug,
pageId: page.id,
customSlug: page.customSlug,
},
];
break;
}
case ReduxActionTypes.CREATE_PAGE_SUCCESS: {
const page: Page = action.payload;
pageParams = [
{
pageSlug: page.slug,
pageId: page.pageId,
customSlug: page.customSlug,
},
];
break;
}
case ReduxActionTypes.GENERATE_TEMPLATE_PAGE_SUCCESS: {
const { page } = action.payload;
urlBuilder.updateURLParams(null, [
{
pageSlug: page.slug,
pageId: page.id,
customSlug: page.customSlug,
},
]);
break;
}
case ReduxActionTypes.UPDATE_APPLICATION_SUCCESS:
const application = action.payload;
appParams = {
applicationId: application.id,
applicationSlug: application.slug,
applicationVersion: application.applicationVersion,
};
break;
case ReduxActionTypes.CLONE_PAGE_SUCCESS:
const { pageId, pageSlug } = action.payload;
pageParams = [
{
pageId,
pageSlug,
},
];
break;
default:
break;
}
urlBuilder.updateURLParams(appParams, pageParams);
return next(action);
};
export default routeParamsMiddleware;