## Description
>
```
const isOnCanvas = matchBuilderPath(window.location.pathname);
if (isOnCanvas) {
dispatch(showDebuggerAction(!showDebugger));
}}
```
The condition check to verify if we are on canvas was removed as we are
opening debugger throughout all pages.
> Now debugger is accessible from all pages in Appsmith. (Earlier it was
not present in Datasources pages.)
Fixes #19567
#21935
#21934
#21907
#21223
Media
> [Video](https://www.loom.com/share/ff5eebb5e0a74e0bad6ead26050b5833)
## 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)
## How Has This Been Tested?
- Manual
- 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:
- [ ] Test plan has been approved by relevant developers
- [ ] 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
221 lines
5.9 KiB
TypeScript
221 lines
5.9 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 = 307;
|
|
// from design system
|
|
private readonly TAB_MIN_HEIGHT = 36;
|
|
|
|
public readonly locators = {
|
|
_debuggerIcon: ".t--debugger",
|
|
_debuggerToggle: "[data-cy=t--debugger-toggle]",
|
|
_debuggerDownStreamErrMsg: "[data-cy=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-cy=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: ".debugger-search",
|
|
_debuggerSelectedTab: ".react-tabs__tab--selected",
|
|
};
|
|
|
|
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:
|
|
this.agHelper.AssertHeight(
|
|
this.locators._bottomPaneContainer[pageType],
|
|
this.bottomPaneHeight,
|
|
);
|
|
break;
|
|
case PageType.Query:
|
|
case PageType.DataSources:
|
|
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);
|
|
}
|
|
|
|
DoesConsoleLogExist(
|
|
text: string,
|
|
exists = true,
|
|
index?: number,
|
|
timeout?: number,
|
|
) {
|
|
this.agHelper.GetNAssertContains(
|
|
this.locators._logMessage,
|
|
text,
|
|
exists ? "exist" : "not.exist",
|
|
index,
|
|
timeout,
|
|
);
|
|
}
|
|
|
|
filter(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);
|
|
}
|
|
|
|
Assert_Consecutive_Console_Log_Count(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(index?: number) {
|
|
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,
|
|
);
|
|
}
|
|
}
|