## 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
89 lines
2.4 KiB
TypeScript
89 lines
2.4 KiB
TypeScript
import urlBuilder from "@appsmith/entities/URLRedirect/URLAssembly";
|
|
import { builderURL, viewerURL } from "@appsmith/RouteBuilder";
|
|
|
|
describe("builderURL", () => {
|
|
let location: typeof window.location;
|
|
beforeAll(() => {
|
|
location = window.location;
|
|
delete (window as any).location;
|
|
urlBuilder.updateURLParams(
|
|
{
|
|
applicationSlug: ":applicationSlug",
|
|
applicationId: ":applicationId",
|
|
applicationVersion: 2,
|
|
},
|
|
[
|
|
{
|
|
pageId: ":pageId",
|
|
pageSlug: ":pageSlug",
|
|
},
|
|
],
|
|
);
|
|
});
|
|
|
|
it("persists embed query param", () => {
|
|
(window as any).location = new URL("https://example.com?embed=true");
|
|
const pageURL = builderURL({
|
|
pageId: ":pageId",
|
|
});
|
|
const pageURLObject = new URL(`${window.origin}${pageURL}`);
|
|
expect(pageURLObject.searchParams.get("embed")).toBe("true");
|
|
});
|
|
|
|
it("does not append embed query param when it does not exist", () => {
|
|
(window as any).location = new URL("https://example.com");
|
|
const pageURL = builderURL({
|
|
pageId: ":pageId",
|
|
});
|
|
const pageURLObject = new URL(`${window.origin}${pageURL}`);
|
|
expect(pageURLObject.searchParams.get("embed")).toBe(null);
|
|
});
|
|
|
|
afterAll(() => {
|
|
window.location = location;
|
|
jest.clearAllMocks();
|
|
});
|
|
});
|
|
|
|
describe("viewerURL", () => {
|
|
let location: typeof window.location;
|
|
beforeAll(() => {
|
|
location = window.location;
|
|
urlBuilder.updateURLParams(
|
|
{
|
|
applicationSlug: ":applicationSlug",
|
|
applicationId: ":applicationId",
|
|
applicationVersion: 2,
|
|
},
|
|
[
|
|
{
|
|
pageId: ":pageId",
|
|
pageSlug: ":pageSlug",
|
|
},
|
|
],
|
|
);
|
|
});
|
|
|
|
it("persists embed query param", () => {
|
|
(window as any).location = new URL("https://example.com?embed=true");
|
|
const pageURL = viewerURL({
|
|
pageId: ":pageId",
|
|
});
|
|
const pageURLObject = new URL(`${window.origin}${pageURL}`);
|
|
expect(pageURLObject.searchParams.get("embed")).toBe("true");
|
|
});
|
|
|
|
it("does not append embed query param when it does not exist", () => {
|
|
(window as any).location = new URL("https://example.com");
|
|
const pageURL = viewerURL({
|
|
pageId: ":pageId",
|
|
});
|
|
const pageURLObject = new URL(`${window.origin}${pageURL}`);
|
|
expect(pageURLObject.searchParams.get("embed")).toBe(null);
|
|
});
|
|
|
|
afterAll(() => {
|
|
window.location = location;
|
|
});
|
|
});
|