> Pull Request Template > > Use this template to quickly create a well written pull request. Delete all quotes before creating the pull request. > ## Description In this PR, we are fixing a few issues and also destructuring AnvilFlexComponent for edit and view. Issues Fixed - Widgets without any content like a text widget without text are not hoverable - Modal once opened does not close when other widgets on the canvas are selected via the enitty explorer. Anvil Flex Component was common component inspired from PositionedContainer of Fixed layout. It had all features of Edit and View together in one place. This mean viewer was unnecessarily interpreting more code. Now AnvilFlexComponent has been broken into AnvilFlexComponent and AnvilEditorFlexComponent. AnvilEditorFlexComponent is a wrapper around AnvilFlexComponent with abilities needed for Edit Mode. Another issue addressed in the PR is removal of DraggableComponennt, which was just making dragging possible and providing a few styles like fading the widget when it is being dragged. With this PR all the above mentioned functions will be taken care of by AnvilEditorFlexComponent. #### PR fixes following issue(s) Fixes #30734 > if no issue exists, please create an issue and ask the maintainers about this first > > #### 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 ## Summary by CodeRabbit - **New Features** - Enhanced feature flag management with additional flags for better control over application features. - Introduced a new editor component for Anvil layout system, improving layout and behavior management in edit mode. - Added a custom hook for managing hover states on Anvil widgets, enhancing user interaction. - **Refactor** - Updated AnvilFlexComponent to use `forwardRef` for better ref management and optimized widget configuration and rendering logic. - Modified selector logic to simplify the retrieval of layout system type, enhancing code maintainability. - Adjusted test methodologies to improve reliability and accuracy. - **Bug Fixes** - Corrected assertions in Cypress end-to-end tests to accurately locate and interact with widgets in the Anvil canvas, ensuring test reliability. - **Chores** - Updated common locators and assertion methods in Cypress support files for consistency and clarity in test scripts. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
123 lines
3.5 KiB
TypeScript
123 lines
3.5 KiB
TypeScript
import { drop } from "lodash";
|
|
import { getWidgetSelector } from "../../locators/WidgetLocators";
|
|
import { ObjectsRegistry } from "../Objects/Registry";
|
|
import {
|
|
AppSidebar,
|
|
AppSidebarButton,
|
|
PageLeftPane,
|
|
PagePaneSegment,
|
|
} from "./EditorNavigation";
|
|
|
|
interface DropTargetDetails {
|
|
id?: string;
|
|
name?: string;
|
|
}
|
|
|
|
interface DragDropWidgetOptions {
|
|
skipWidgetSearch?: boolean;
|
|
dropTargetDetails?: DropTargetDetails;
|
|
}
|
|
|
|
export class AnvilLayout {
|
|
private entityExplorer = ObjectsRegistry.EntityExplorer;
|
|
private locator = ObjectsRegistry.CommonLocators;
|
|
private agHelper = ObjectsRegistry.AggregateHelper;
|
|
|
|
private getAnvilDropTargetSelectorFromOptions = (
|
|
dropTarget?: DropTargetDetails,
|
|
) => {
|
|
if (dropTarget) {
|
|
if (dropTarget.id) {
|
|
return `#${dropTarget.id}`;
|
|
}
|
|
if (dropTarget.name) {
|
|
return `${getWidgetSelector(dropTarget.name.toLowerCase() as any)} ${
|
|
this.locator._canvasSlider
|
|
}`;
|
|
}
|
|
}
|
|
return this.locator._canvasSlider;
|
|
};
|
|
|
|
private performDnDInAnvil(
|
|
xPos: number,
|
|
yPos: number,
|
|
options = {} as DragDropWidgetOptions,
|
|
) {
|
|
const dropAreaSelector = this.getAnvilDropTargetSelectorFromOptions(
|
|
options.dropTargetDetails,
|
|
);
|
|
cy.get(dropAreaSelector)
|
|
.first()
|
|
.then((dropAreaDom) => {
|
|
const { left, top } = dropAreaDom[0].getBoundingClientRect();
|
|
cy.document()
|
|
// to activate ANVIL canvas
|
|
.trigger("mousemove", left + xPos, top + yPos, {
|
|
eventConstructor: "MouseEvent",
|
|
clientX: left + xPos,
|
|
clientY: top + yPos,
|
|
force: true,
|
|
});
|
|
this.agHelper.Sleep(200);
|
|
cy.get(dropAreaSelector).first().trigger("mousemove", xPos, yPos, {
|
|
eventConstructor: "MouseEvent",
|
|
force: true,
|
|
});
|
|
this.agHelper.Sleep(200);
|
|
cy.get(dropAreaSelector).first().trigger("mousemove", xPos, yPos, {
|
|
eventConstructor: "MouseEvent",
|
|
force: true,
|
|
});
|
|
cy.get(this.locator._canvasSlider)
|
|
.first()
|
|
.trigger("mouseup", xPos, yPos, {
|
|
eventConstructor: "MouseEvent",
|
|
force: true,
|
|
});
|
|
});
|
|
}
|
|
|
|
private startDraggingWidgetFromPane(widgetType: string) {
|
|
cy.get(this.locator._widgetPageIcon(widgetType))
|
|
.first()
|
|
.trigger("dragstart", { force: true });
|
|
}
|
|
|
|
private setupWidgetPane(skipWidgetSearch: boolean, widgetType: string) {
|
|
if (!skipWidgetSearch) {
|
|
this.entityExplorer.SearchWidgetPane(widgetType);
|
|
} else {
|
|
AppSidebar.navigate(AppSidebarButton.Editor);
|
|
PageLeftPane.switchSegment(PagePaneSegment.UI);
|
|
PageLeftPane.switchToAddNew();
|
|
}
|
|
}
|
|
|
|
private DragNDropAnvilWidget(
|
|
widgetType: string,
|
|
x = 300,
|
|
y = 100,
|
|
options = {} as DragDropWidgetOptions,
|
|
) {
|
|
const { skipWidgetSearch = false } = options;
|
|
this.setupWidgetPane(skipWidgetSearch, widgetType);
|
|
this.startDraggingWidgetFromPane(widgetType);
|
|
this.performDnDInAnvil(x, y, options);
|
|
}
|
|
|
|
public DragDropAnvilWidgetNVerify(
|
|
widgetType: string,
|
|
x = 300,
|
|
y = 100,
|
|
options = {} as DragDropWidgetOptions,
|
|
) {
|
|
this.DragNDropAnvilWidget(widgetType, x, y, options);
|
|
this.agHelper.AssertAutoSave(); //settling time for widget on canvas!
|
|
this.agHelper.AssertElementExist(
|
|
this.locator._anvilWidgetInCanvas(widgetType),
|
|
);
|
|
this.agHelper.Sleep(200); //waiting a bit for widget properties to open
|
|
}
|
|
}
|