Skip to content

fix: use type-specific action IDs to comply with W3C WebDriver spec (… #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DudaGod wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: use type-specific action IDs to comply with W3C WebDriver spec (… #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 36 additions & 6 deletions packages/webdriverio/src/utils/actions/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ interface Sequence {
value?: string
}

let actionIds = 0
/**
* Separate counters for each action type to ensure W3C WebDriver compliance.
* According to the spec, each input source ID must always map to the same action type
* throughout the session duration.
*/
let keyActionIds = 0
let pointerActionIds = 0
let wheelActionIds = 0

export default class BaseAction {
#id: string
Expand All @@ -27,18 +34,41 @@ export default class BaseAction {
#instance: WebdriverIO.Browser
protected sequence: Sequence[] = []

constructor (
constructor(
protected instance: WebdriverIO.Browser,
type: ActionType,
params?: BaseActionParams
) {
this.#instance = instance
this.#id = params?.id || `action${++actionIds}`

/**
* Generate type-specific IDs to prevent conflicts when mixing action types.
* This ensures compliance with W3C WebDriver spec which requires each input
* source ID to consistently map to the same action type.
*/
if (params?.id) {
this.#id = params.id
} else {
switch (type) {
case 'key':
this.#id = `key${++keyActionIds}`
break
case 'pointer':
this.#id = `pointer${++pointerActionIds}`
break
case 'wheel':
this.#id = `wheel${++wheelActionIds}`
break
default:
this.#id = `action${type}`
}
}

this.#type = type
this.#parameters = params?.parameters || {}
}

toJSON () {
toJSON() {
return {
id: this.#id,
type: this.#type,
Expand All @@ -51,7 +81,7 @@ export default class BaseAction {
* Inserts a pause action for the specified device, ensuring it idles for a tick.
* @param duration idle time of tick
*/
pause (duration: number) {
pause(duration: number) {
this.sequence.push({ type: 'pause', duration })
return this
}
Expand All @@ -60,7 +90,7 @@ export default class BaseAction {
* Perform action sequence
* @param skipRelease set to true if `releaseActions` command should not be invoked
*/
async perform (skipRelease = false) {
async perform(skipRelease = false) {
/**
* transform chainable / not resolved elements into WDIO elements
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/webdriverio/tests/commands/browser/__snapshots__/action.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ exports[`action command > resolves not resolved wdio elements in pointer action
"y": 0,
},
],
"id": "action2",
"id": "pointer1",
"parameters": {
"pointerType": "mouse",
},
Expand All @@ -43,7 +43,7 @@ exports[`action command > resolves not resolved wdio elements in wheel action 1`
"y": 0,
},
],
"id": "action3",
"id": "wheel1",
"parameters": {},
"type": "wheel",
},
Expand Down
2 changes: 1 addition & 1 deletion packages/webdriverio/tests/commands/browser/__snapshots__/scroll.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ exports[`scroll > desktop > should be able to scroll 1`] = `
"y": 0,
},
],
"id": "action1",
"id": "wheel1",
"parameters": {},
"type": "wheel",
},
Expand Down
16 changes: 8 additions & 8 deletions packages/webdriverio/tests/commands/element/__snapshots__/click.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ exports[`click test > should allow to left click on an element by passing a butt
"type": "pointerUp",
},
],
"id": "action1",
"id": "pointer1",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -60,7 +60,7 @@ exports[`click test > should allow to left click on an element by passing a butt
"type": "pointerUp",
},
],
"id": "action2",
"id": "pointer2",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -95,7 +95,7 @@ exports[`click test > should allow to left click on an element with an offset wi
"type": "pointerUp",
},
],
"id": "action7",
"id": "pointer7",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -130,7 +130,7 @@ exports[`click test > should allow to middle click on an element 1`] = `
"type": "pointerUp",
},
],
"id": "action5",
"id": "pointer5",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -164,7 +164,7 @@ exports[`click test > should allow to middle click on an element 2`] = `
"type": "pointerUp",
},
],
"id": "action6",
"id": "pointer6",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -198,7 +198,7 @@ exports[`click test > should allow to right click on an element 1`] = `
"type": "pointerUp",
},
],
"id": "action3",
"id": "pointer3",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -232,7 +232,7 @@ exports[`click test > should allow to right click on an element 2`] = `
"type": "pointerUp",
},
],
"id": "action4",
"id": "pointer4",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -273,7 +273,7 @@ exports[`click test > should to send a duration to execute a longPress on a mobi
"type": "pointerUp",
},
],
"id": "action9",
"id": "pointer9",
"parameters": {
"pointerType": "touch",
},
Expand Down
8 changes: 4 additions & 4 deletions packages/webdriverio/tests/commands/element/__snapshots__/dragAndDrop.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ exports[`dragAndDrop > should allow drag and drop to 0 coordinates 1`] = `
"type": "pointerUp",
},
],
"id": "action5",
"id": "pointer5",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -81,7 +81,7 @@ exports[`dragAndDrop > should do a dragAndDrop 1`] = `
"type": "pointerUp",
},
],
"id": "action1",
"id": "pointer1",
"parameters": {
"pointerType": "mouse",
},
Expand Down Expand Up @@ -127,7 +127,7 @@ exports[`dragAndDrop > should do a dragAndDrop for mobile 1`] = `
"type": "pointerUp",
},
],
"id": "action3",
"id": "pointer3",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -171,7 +171,7 @@ exports[`dragAndDrop > should do a dragAndDrop with coordinates 1`] = `
"type": "pointerUp",
},
],
"id": "action4",
"id": "pointer4",
"parameters": {
"pointerType": "mouse",
},
Expand Down
8 changes: 4 additions & 4 deletions packages/webdriverio/tests/commands/element/__snapshots__/scrollIntoView.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ exports[`scrollIntoView test > desktop > scrolls by default the element to the t
"y": -30,
},
],
"id": "action1",
"id": "wheel1",
"parameters": {},
"type": "wheel",
},
Expand All @@ -42,7 +42,7 @@ exports[`scrollIntoView test > desktop > scrolls element using scroll into view
"y": -385,
},
],
"id": "action4",
"id": "wheel4",
"parameters": {},
"type": "wheel",
},
Expand All @@ -67,7 +67,7 @@ exports[`scrollIntoView test > desktop > scrolls element when using boolean scro
"y": -30,
},
],
"id": "action2",
"id": "wheel2",
"parameters": {},
"type": "wheel",
},
Expand All @@ -92,7 +92,7 @@ exports[`scrollIntoView test > desktop > scrolls element when using boolean scro
"y": -770,
},
],
"id": "action3",
"id": "wheel3",
"parameters": {},
"type": "wheel",
},
Expand Down
12 changes: 6 additions & 6 deletions packages/webdriverio/tests/commands/mobile/__snapshots__/swipe.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ exports[`swipe test > should be able to swipe based on provided coordinates 1`]
"type": "pointerUp",
},
],
"id": "action4",
"id": "pointer4",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -80,7 +80,7 @@ exports[`swipe test > should call a swipe down command with 25% for a scrollable
"type": "pointerUp",
},
],
"id": "action8",
"id": "pointer8",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -120,7 +120,7 @@ exports[`swipe test > should call a swipe down command with duration 5000 for a
"type": "pointerUp",
},
],
"id": "action12",
"id": "pointer12",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -160,7 +160,7 @@ exports[`swipe test > should call a swipe left command with 50% for a scrollable
"type": "pointerUp",
},
],
"id": "action10",
"id": "pointer10",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -200,7 +200,7 @@ exports[`swipe test > should call a swipe right command with 75% for a scrollabl
"type": "pointerUp",
},
],
"id": "action11",
"id": "pointer11",
"parameters": {
"pointerType": "touch",
},
Expand Down Expand Up @@ -240,7 +240,7 @@ exports[`swipe test > should call a swipe up command with 45% for a scrollable e
"type": "pointerUp",
},
],
"id": "action9",
"id": "pointer9",
"parameters": {
"pointerType": "touch",
},
Expand Down
2 changes: 1 addition & 1 deletion packages/webdriverio/tests/commands/mobile/__snapshots__/tap.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ exports[`screen tap test > should call the action command for mobile web when a
"type": "pointerUp",
},
],
"id": "action1",
"id": "pointer1",
"parameters": {
"pointerType": "touch",
},
Expand Down
Loading