feat: implement pause and debug commands

Solant · Oct 11, 2024 · ef9f2b9 · ef9f2b9
1 parent fcdc73c
commit ef9f2b9
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 12 deletions.
diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md
@@ -80,7 +80,7 @@
 | [.clearCookies()](https://docs.cypress.io/api/commands/clearcookies)                      |      🕓      |    🕓     |       |
 | [.clearLocalStorage()](https://docs.cypress.io/api/commands/clearlocalstorage)            |      🕓      |    🕓     |       |
 | [.clock()](https://docs.cypress.io/api/commands/clock)                                    |      🕓      |    🕓     |       |
-| [.debug()](https://docs.cypress.io/api/commands/debug)                                    |      🕓      |    🕓     |       |
+| [.debug()](https://docs.cypress.io/api/commands/debug)                                    |      ✅       |     -     |       |
 | [.each()](https://docs.cypress.io/api/commands/each)                                      |      🕓      |    🕓     |       |
 | [.end()](https://docs.cypress.io/api/commands/end)                                        |      🕓      |    🕓     |       |
 | [.exec()](https://docs.cypress.io/api/commands/exec)                                      |      🕓      |    🕓     |       |
@@ -97,7 +97,7 @@
 | [.log()](https://docs.cypress.io/api/commands/log)                                        |      🕓      |    🕓     |       |
 | [.mount()](https://docs.cypress.io/api/commands/mount)                                    |      🕓      |    🕓     |       |
 | [.origin()](https://docs.cypress.io/api/commands/origin)                                  |      🕓      |    🕓     |       |
-| [.pause()](https://docs.cypress.io/api/commands/pause)                                    |      🕓      |    🕓     |       |
+| [.pause()](https://docs.cypress.io/api/commands/pause)                                    |      ✅       |     -     |       |
 | [.reload()](https://docs.cypress.io/api/commands/reload)                                  |      🕓      |    🕓     |       |
 | [.request()](https://docs.cypress.io/api/commands/request)                                |      🕓      |    🕓     |       |
 | [.screenshot()](https://docs.cypress.io/api/commands/screenshot)                          |      🕓      |    🕓     |       |

diff --git a/src/actions.ts b/src/actions.ts
@@ -50,6 +50,8 @@ export type Action = AssertActions | {
   key: string,
 } | {
   type: 'title'
+} | {
+  type: 'pause'
 };
 
 let queue: Array<Action> = [];
@@ -70,16 +72,6 @@ function resolveSelectorItem(parent: Locator | Page, selector: Selector[number])
   }
 }
 
-export function getLocator(page: Page, selector: Selector): Locator {
-  let locator = resolveSelectorItem(page, selector[0]);
-
-  for (let i = 1; i < selector.length; i += 1) {
-    locator = resolveSelectorItem(locator, selector[i]);
-  }
-
-  return locator;
-}
-
 export type Subject = { type: 'locator', value: Locator } | { type: 'value', value: unknown };
 
 export async function evaluateAction(
@@ -179,6 +171,9 @@ export async function evaluateAction(
       break;
     case 'title':
       return { type: 'value', value: await page.title() };
+    case 'pause':
+      await page.pause();
+      break;
     default:
       throw new Error(`Action type "${(action as Record<string, unknown>).type}" is not implemented`);
   }

diff --git a/src/cy.ts b/src/cy.ts
@@ -26,6 +26,16 @@ class Cy {
     return this.selfOrChild();
   }
 
+  debug() {
+    pushQueue({ type: 'pause' });
+    return this.selfOrChild();
+  }
+
+  pause() {
+    pushQueue({ type: 'pause' });
+    return this.selfOrChild();
+  }
+
   first() {
     pushQueue({ type: 'locator', selector: [{ modifier: 'first' }], root: this.root });
     return this.selfOrChild();

diff --git a/tests/api/other-commands/debug.cy.ts b/tests/api/other-commands/debug.cy.ts
@@ -0,0 +1,9 @@
+import { setup } from '../../../src';
+
+setup();
+
+describe('.debug()', () => {
+  it('basic usage', () => {
+    cy.visit('https://example.cypress.io/todo').get('button').debug();
+  })
+})
diff --git a/tests/api/other-commands/pause.cy.ts b/tests/api/other-commands/pause.cy.ts
@@ -0,0 +1,9 @@
+import { setup } from '../../../src';
+
+setup();
+
+describe('.pause()', () => {
+  it('basic usage', () => {
+    cy.visit('https://example.cypress.io/todo').get('button').pause();
+  })
+})