PromucFlow_constructor/app/client/cypress/support/Pages/DebuggerHelper.ts
akash-codemonk 22c272c210
feat: debugger error navigation (#25505)
## Description

Property pane navigation on click of a widget error or log from the
debugger. Navigation to a field works if the log has the required meta
data here it would be the property path. With the help of the property
pane config and the widget's properties we generate the payload to set
the required panel, tab, section states. Factory class to clearly
separate out the logic for the different entities.

#### PR fixes following issue(s)
Related to https://github.com/appsmithorg/appsmith/issues/16408
Fixes https://github.com/appsmithorg/appsmith/issues/25465
Fixes https://github.com/appsmithorg/appsmith/issues/25462
2023-08-01 09:32:41 +05:30

238 lines
6.6 KiB
TypeScript

import { ObjectsRegistry } from "../Objects/Registry";
export enum PageType {
Canvas,
API,
Query,
JsEditor,
DataSources,
}
export class DebuggerHelper {
private agHelper = ObjectsRegistry.AggregateHelper;
private commonLocators = ObjectsRegistry.CommonLocators;
// ActionExecutionResizerHeight -> in repo
private readonly bottomPaneHeight = 360;
// from design system
private readonly TAB_MIN_HEIGHT = 36;
public readonly locators = {
_debuggerIcon: ".t--debugger-count",
_debuggerToggle: "[data-testid=t--debugger-toggle]",
_debuggerDownStreamErrMsg: "[data-testid=t--debugger-downStreamErrorMsg]",
_tabsContainer: ".t--debugger-tabs-container",
_closeButton: ".t--close-debugger",
_logMessage: ".t--debugger-log-message",
_logEntityLink: ".t--debugger-log-entity-link",
_logState: ".t--debugger-log-state",
_errorCount: ".t--debugger-count",
_clearLogs: ".t--debugger-clear-logs",
_logMessageOccurence: ".t--debugger-log-message-occurence",
_debuggerMessage: "[data-testid=t--debugger-log-message]",
_contextMenuIcon: ".t--debugger-contextual-error-menu ",
_contextMenuItem: ".t--debugger-contextual-menuitem",
_debuggerLabel: "span.debugger-label",
_bottomPaneContainer: {
[PageType.API]: ".t--api-bottom-pane-container",
[PageType.Query]: ".t--query-bottom-pane-container",
[PageType.JsEditor]: ".t--js-editor-bottom-pane-container",
[PageType.DataSources]: ".t--datasource-bottom-pane-container",
},
_debuggerList: ".debugger-list",
_debuggerFilter: "input[data-testid=t--debugger-search]",
_debuggerSelectedTab: ".ads-v2-tabs__list-tab",
_helpButton: "[data-testid='t--help-button']",
_intercomOption: "#intercom-trigger",
_intercomConsentText: "[data-testid='t--intercom-consent-text']",
};
ClickDebuggerIcon(
index?: number,
force?: boolean,
waitTimeInterval?: number,
) {
this.agHelper.GetNClick(
this.locators._debuggerIcon,
index,
force,
waitTimeInterval,
);
}
ClickDebuggerToggle(expand = true, index = 0) {
cy.get(this.locators._debuggerToggle)
.eq(index)
.invoke("attr", "data-isopen")
.then((arrow) => {
if (expand && arrow == "false")
cy.get(this.locators._debuggerToggle)
.eq(index)
.trigger("click", { multiple: true })
.wait(1000);
else if (!expand && arrow == "true")
cy.get(this.locators._debuggerToggle)
.eq(index)
.trigger("click", { multiple: true })
.wait(1000);
else this.agHelper.Sleep(500);
});
}
ClickResponseTab() {
this.agHelper.GetNClick(this.commonLocators._responseTab);
}
CloseBottomBar() {
this.agHelper.GetNClick(this.locators._closeButton);
}
AssertOpen(pageType: PageType) {
switch (pageType) {
case PageType.Canvas:
this.agHelper.AssertElementExist(this.locators._tabsContainer);
break;
case PageType.API:
case PageType.JsEditor:
case PageType.Query:
case PageType.DataSources:
this.agHelper.AssertElementVisible(
this.locators._bottomPaneContainer[pageType],
);
// this.agHelper.AssertHeight(
// this.locators._bottomPaneContainer[pageType],
// this.bottomPaneHeight,
// );
break;
// case PageType.Query:
// case PageType.DataSources:
// this.agHelper.AssertElementVisible(
// this.locators._bottomPaneContainer[pageType],
// );
// // this.agHelper.AssertHeight(
// // this.locators._bottomPaneContainer[pageType],
// // this.bottomPaneHeight - 1, // -1 to offset error
// // );
// break;
}
}
AssertClosed() {
this.agHelper.AssertElementAbsence(this.locators._tabsContainer);
}
AssertSelectedTab(text: string) {
this.agHelper.GetNAssertContains(this.locators._debuggerSelectedTab, text);
this.agHelper.AssertSelectedTab(this.locators._debuggerSelectedTab, "true");
}
DoesConsoleLogExist(
text: string,
exists = true,
index?: number,
timeout?: number,
) {
this.agHelper.GetNAssertContains(
this.locators._logMessage,
text,
exists ? "exist" : "not.exist",
index,
timeout,
);
}
DebuggerLogsFilter(text: string) {
this.agHelper.RemoveCharsNType(this.locators._debuggerFilter, -1, text);
}
LogStateContains(text: string, index?: number) {
this.agHelper.GetNAssertContains(
this.locators._logState,
text,
"exist",
index,
);
}
AssertErrorCount(count: number) {
this.agHelper.GetNAssertContains(this.locators._errorCount, count);
}
ClearLogs() {
this.agHelper.GetNClick(this.locators._clearLogs);
}
AssertConsecutiveConsoleLogCount(count: number) {
count > 0
? this.agHelper.GetNAssertContains(
this.locators._logMessageOccurence,
count,
)
: this.agHelper.AssertElementAbsence(this.locators._logMessageOccurence);
}
AssertVisibleErrorMessagesCount(count: number) {
if (count > 0) {
this.agHelper.AssertElementVisible(this.locators._debuggerMessage);
this.agHelper.AssertElementLength(this.locators._debuggerMessage, count);
} else {
this.agHelper.AssertElementAbsence(this.locators._debuggerMessage);
}
}
ClickErrorMessage(index?: number) {
this.agHelper.GetNClick(this.locators._debuggerMessage, index);
}
ClicklogEntityLink(last = false, index?: number) {
if (last) {
this.agHelper.GetElement(this.locators._logEntityLink).last().click();
return;
}
this.agHelper.GetNClick(this.locators._logEntityLink, index);
}
AssertContextMenuItemVisible() {
this.agHelper.AssertElementVisible(this.locators._contextMenuItem);
}
AssertDebugError(
label: string,
message: string,
shouldOpenDebugger = true,
shouldToggleDebugger = true,
) {
if (shouldOpenDebugger) {
this.ClickDebuggerIcon();
}
this.agHelper.GetNClick(this.commonLocators._errorTab, 0, true, 0);
if (shouldToggleDebugger) {
this.ClickDebuggerToggle();
}
this.agHelper
.GetText(this.locators._debuggerLabel, "text", 0)
.then(($text) => {
expect($text).to.eq(label);
});
if (message) {
this.agHelper
.GetText(this.locators._debuggerDownStreamErrMsg, "text", 0)
.then(($text) => {
expect($text).to.contains(message);
});
}
}
DebuggerListDoesnotContain(text: string) {
this.agHelper.AssertContains(
text,
"not.exist",
this.locators._debuggerList,
);
}
}