Skip to content

Commit 7951238

Browse files
pujaganipujagani
authored
[bidi][js] Deprecate argument value wrapper class (#14251)
1 parent 12769d6 commit 7951238

File tree

6 files changed

+35
-29
lines changed

6 files changed

+35
-29
lines changed

‎javascript/node/selenium-webdriver/bidi/argumentValue.js‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,19 @@
1717

1818
const { LocalValue } = require('./protocolValue')
1919

20+
/**
21+
* @deprecated
22+
* in favor of LocalValue methods for all argument values.
23+
* This extra wrapper is not required.
24+
*/
2025
class ArgumentValue {
2126
constructor(value) {
2227
this.value = value
2328
}
2429

2530
asMap() {
2631
if (this.value instanceof LocalValue) {
27-
return this.value.toJson()
32+
return this.value.asMap()
2833
} else {
2934
// ReferenceValue
3035
return this.value.asMap()

‎javascript/node/selenium-webdriver/bidi/protocolValue.js‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,11 @@ class LocalValue {
185185
return new LocalValue(NonPrimitiveType.CHANNEL, value)
186186
}
187187

188-
toJson() {
188+
static createReferenceValue(handle, sharedId) {
189+
return new ReferenceValue(handle, sharedId)
190+
}
191+
192+
asMap() {
189193
let toReturn = {}
190194
toReturn[TYPE_CONSTANT] = this.type
191195

‎javascript/node/selenium-webdriver/lib/script.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717

1818
const logInspector = require('../bidi/logInspector')
1919
const scriptManager = require('../bidi//scriptManager')
20-
const { ArgumentValue } = require('../bidi/argumentValue')
2120
const { LocalValue, ChannelValue } = require('../bidi/protocolValue')
2221
const fs = require('node:fs')
2322
const path = require('node:path')
@@ -77,7 +76,7 @@ class Script {
7776
await this.#initScript()
7877

7978
let argumentValues = []
80-
let value = new ArgumentValue(LocalValue.createChannelValue(new ChannelValue('channel_name')))
79+
let value = LocalValue.createChannelValue(new ChannelValue('channel_name'))
8180
argumentValues.push(value)
8281

8382
const filePath = path.join(__dirname, 'atoms', 'bidi-mutation-listener.js')

‎javascript/node/selenium-webdriver/test/bidi/local_value_test.js‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ const { suite } = require('../../lib/test')
2323

2424
const ScriptManager = require('selenium-webdriver/bidi/scriptManager')
2525
const { LocalValue, RegExpValue } = require('selenium-webdriver/bidi/protocolValue')
26-
const { ArgumentValue } = require('selenium-webdriver/bidi/argumentValue')
2726
const { EvaluateResultType } = require('selenium-webdriver/bidi/evaluateResult')
2827
const { SpecialNumberType } = require('selenium-webdriver/bidi/protocolType')
2928

@@ -44,7 +43,7 @@ suite(
4443
const id = await driver.getWindowHandle()
4544
const manager = await ScriptManager(id, driver)
4645
let argumentValues = []
47-
let value = new ArgumentValue(LocalValue.createUndefinedValue())
46+
let value = LocalValue.createUndefinedValue()
4847
argumentValues.push(value)
4948

5049
const result = await manager.callFunctionInBrowsingContext(
@@ -67,7 +66,7 @@ suite(
6766
const id = await driver.getWindowHandle()
6867
const manager = await ScriptManager(id, driver)
6968
let argumentValues = []
70-
let value = new ArgumentValue(LocalValue.createNullValue())
69+
let value = LocalValue.createNullValue()
7170
argumentValues.push(value)
7271

7372
const result = await manager.callFunctionInBrowsingContext(
@@ -90,7 +89,7 @@ suite(
9089
const id = await driver.getWindowHandle()
9190
const manager = await ScriptManager(id, driver)
9291
let argumentValues = []
93-
let value = new ArgumentValue(LocalValue.createSpecialNumberValue(SpecialNumberType.MINUS_ZERO))
92+
let value = LocalValue.createSpecialNumberValue(SpecialNumberType.MINUS_ZERO)
9493
argumentValues.push(value)
9594

9695
const result = await manager.callFunctionInBrowsingContext(
@@ -115,7 +114,7 @@ suite(
115114
const id = await driver.getWindowHandle()
116115
const manager = await ScriptManager(id, driver)
117116
let argumentValues = []
118-
let value = new ArgumentValue(LocalValue.createSpecialNumberValue(SpecialNumberType.INFINITY))
117+
let value = LocalValue.createSpecialNumberValue(SpecialNumberType.INFINITY)
119118
argumentValues.push(value)
120119

121120
const result = await manager.callFunctionInBrowsingContext(
@@ -140,7 +139,7 @@ suite(
140139
const id = await driver.getWindowHandle()
141140
const manager = await ScriptManager(id, driver)
142141
let argumentValues = []
143-
let value = new ArgumentValue(LocalValue.createSpecialNumberValue(SpecialNumberType.MINUS_INFINITY))
142+
let value = LocalValue.createSpecialNumberValue(SpecialNumberType.MINUS_INFINITY)
144143
argumentValues.push(value)
145144

146145
const result = await manager.callFunctionInBrowsingContext(
@@ -165,7 +164,7 @@ suite(
165164
const id = await driver.getWindowHandle()
166165
const manager = await ScriptManager(id, driver)
167166
let argumentValues = []
168-
let value = new ArgumentValue(LocalValue.createNumberValue(1.4))
167+
let value = LocalValue.createNumberValue(1.4)
169168
argumentValues.push(value)
170169

171170
const result = await manager.callFunctionInBrowsingContext(
@@ -190,7 +189,7 @@ suite(
190189
const id = await driver.getWindowHandle()
191190
const manager = await ScriptManager(id, driver)
192191
let argumentValues = []
193-
let value = new ArgumentValue(LocalValue.createBooleanValue(true))
192+
let value = LocalValue.createBooleanValue(true)
194193
argumentValues.push(value)
195194

196195
const result = await manager.callFunctionInBrowsingContext(
@@ -215,7 +214,7 @@ suite(
215214
const id = await driver.getWindowHandle()
216215
const manager = await ScriptManager(id, driver)
217216
let argumentValues = []
218-
let value = new ArgumentValue(LocalValue.createBigIntValue('42'))
217+
let value = LocalValue.createBigIntValue('42')
219218
argumentValues.push(value)
220219

221220
const result = await manager.callFunctionInBrowsingContext(
@@ -241,7 +240,7 @@ suite(
241240
const manager = await ScriptManager(id, driver)
242241
let argumentValues = []
243242
let arrayValue = [LocalValue.createStringValue('foobar')]
244-
let value = new ArgumentValue(LocalValue.createArrayValue(arrayValue))
243+
let value = LocalValue.createArrayValue(arrayValue)
245244
argumentValues.push(value)
246245

247246
const result = await manager.callFunctionInBrowsingContext(
@@ -272,7 +271,7 @@ suite(
272271
const manager = await ScriptManager(id, driver)
273272
let argumentValues = []
274273
let setValue = [LocalValue.createStringValue('foobar')]
275-
let value = new ArgumentValue(LocalValue.createSetValue(setValue))
274+
let value = LocalValue.createSetValue(setValue)
276275
argumentValues.push(value)
277276

278277
const result = await manager.callFunctionInBrowsingContext(
@@ -302,7 +301,7 @@ suite(
302301
const id = await driver.getWindowHandle()
303302
const manager = await ScriptManager(id, driver)
304303
let argumentValues = []
305-
let value = new ArgumentValue(LocalValue.createDateValue('2022-05-31T13:47:29.000Z'))
304+
let value = LocalValue.createDateValue('2022-05-31T13:47:29.000Z')
306305
argumentValues.push(value)
307306

308307
const result = await manager.callFunctionInBrowsingContext(
@@ -329,7 +328,7 @@ suite(
329328
const manager = await ScriptManager(id, driver)
330329
let argumentValues = []
331330
let mapValue = { foobar: LocalValue.createStringValue('foobar') }
332-
let value = new ArgumentValue(LocalValue.createMapValue(mapValue))
331+
let value = LocalValue.createMapValue(mapValue)
333332
argumentValues.push(value)
334333

335334
const result = await manager.callFunctionInBrowsingContext(
@@ -361,7 +360,7 @@ suite(
361360
const manager = await ScriptManager(id, driver)
362361
let argumentValues = []
363362
let mapValue = { foobar: LocalValue.createStringValue('foobar') }
364-
let value = new ArgumentValue(LocalValue.createObjectValue(mapValue))
363+
let value = LocalValue.createObjectValue(mapValue)
365364
argumentValues.push(value)
366365

367366
const result = await manager.callFunctionInBrowsingContext(
@@ -391,7 +390,7 @@ suite(
391390
const id = await driver.getWindowHandle()
392391
const manager = await ScriptManager(id, driver)
393392
let argumentValues = []
394-
let value = new ArgumentValue(LocalValue.createRegularExpressionValue(new RegExpValue('foo', 'g')))
393+
let value = LocalValue.createRegularExpressionValue(new RegExpValue('foo', 'g'))
395394
argumentValues.push(value)
396395

397396
const result = await manager.callFunctionInBrowsingContext(

‎javascript/node/selenium-webdriver/test/bidi/locate_nodes_test.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ const { Locator } = require('selenium-webdriver/bidi/browsingContext')
2525
const { ScriptManager } = require('selenium-webdriver/index')
2626
const { EvaluateResultType } = require('selenium-webdriver/bidi/evaluateResult')
2727
const { LocalValue, ReferenceValue } = require('selenium-webdriver/bidi/protocolValue')
28-
const { ArgumentValue } = require('selenium-webdriver/bidi/argumentValue')
2928

3029
suite(
3130
function (env) {
@@ -187,7 +186,7 @@ suite(
187186

188187
let argumentValues = []
189188
let mapValue = { sharedId: LocalValue.createStringValue(nodeId) }
190-
argumentValues.push(new ArgumentValue(LocalValue.createMapValue(mapValue)))
189+
argumentValues.push(LocalValue.createMapValue(mapValue))
191190

192191
const response = await script.callFunctionInBrowsingContext(
193192
id,

‎javascript/node/selenium-webdriver/test/bidi/script_test.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ suite(
100100
manager = await ScriptManager(id, driver)
101101

102102
let argumentValues = []
103-
let value1 = new ArgumentValue(LocalValue.createStringValue('ARGUMENT_STRING_VALUE'))
104-
let value2 = new ArgumentValue(LocalValue.createNumberValue(42))
103+
let value1 = LocalValue.createStringValue('ARGUMENT_STRING_VALUE')
104+
let value2 = LocalValue.createNumberValue(42)
105105
argumentValues.push(value1)
106106
argumentValues.push(value2)
107107

@@ -160,7 +160,7 @@ suite(
160160
manager = await ScriptManager(id, driver)
161161

162162
let mapValue = { some_property: LocalValue.createNumberValue(42) }
163-
let thisParameter = new ArgumentValue(LocalValue.createObjectValue(mapValue)).asMap()
163+
let thisParameter = LocalValue.createObjectValue(mapValue).asMap()
164164

165165
const result = await manager.callFunctionInBrowsingContext(
166166
id,
@@ -427,8 +427,8 @@ suite(
427427
let argumentValues = []
428428
let valueMap = evaluateResult.result.value
429429

430-
let value1 = new ArgumentValue(LocalValue.createObjectValue(valueMap))
431-
let value2 = new ArgumentValue(new ReferenceValue(RemoteReferenceType.HANDLE, evaluateResult.result.handle))
430+
let value1 = LocalValue.createObjectValue(valueMap)
431+
let value2 = new ReferenceValue(RemoteReferenceType.HANDLE, evaluateResult.result.handle)
432432
argumentValues.push(value1)
433433
argumentValues.push(value2)
434434

@@ -462,8 +462,8 @@ suite(
462462
let argumentValues = []
463463
let valueMap = evaluateResult.result.value
464464

465-
let value1 = new ArgumentValue(LocalValue.createObjectValue(valueMap))
466-
let value2 = new ArgumentValue(new ReferenceValue(RemoteReferenceType.HANDLE, evaluateResult.result.handle))
465+
let value1 = LocalValue.createObjectValue(valueMap)
466+
let value2 = new ReferenceValue(RemoteReferenceType.HANDLE, evaluateResult.result.handle)
467467
argumentValues.push(value1)
468468
argumentValues.push(value2)
469469

@@ -766,7 +766,7 @@ suite(
766766
})
767767

768768
let argumentValues = []
769-
let value = new ArgumentValue(LocalValue.createChannelValue(new ChannelValue('channel_name')))
769+
let value = LocalValue.createChannelValue(new ChannelValue('channel_name'))
770770
argumentValues.push(value)
771771

772772
const result = await manager.callFunctionInBrowsingContext(

0 commit comments

Comments
 (0)