selenium-webdriver 4.8.1 → 4.9.0

package/CHANGES.md

@@ -1,3 +1,32 @@
+## v4.9.0
+
+#### :nail_care: Polish
+
+* Adding CDP v112 and removing v109
+
+#### :bug: Bug Fix
+
+* Fix: return statement in submit() (#11883)
+* [grid] Refining the UI configuration to allow sub paths work properly.
+* Replace `execSync` with `spawnSync` in `seleniumManager.js` (#11649) (#11873)
+
+#### :rocket: New Feature
+
+* [BiDi] Add Script module commands and types (#11847)
+* Selenium Manager get Browser Version from Options classes
+* Selenium Manager use binary from Browser Options
+
+## v4.8.2
+
+#### :nail_care: Polish
+
+* Add CDP support for v111 and remove v108
+* Using json output with Selenium Manager
+
+#### :bug: Bug Fix
+
+* fix: Using status from response (#11742)
+
 ## v4.8.1
 
 #### :rocket: New Feature

package/bidi/argumentValue.js

@@ -0,0 +1,34 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const { LocalValue } = require('./protocolValue')
+class ArgumentValue {
+  constructor(value) {
+    this.value = value
+  }
+
+  asMap() {
+    if (this.value instanceof LocalValue) {
+      return this.value.toJson()
+    } else {
+      // ReferenceValue
+      return this.value.asMap()
+    }
+  }
+}
+
+module.exports = { ArgumentValue }

package/bidi/evaluateResult.js

@@ -0,0 +1,60 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const EvaluateResultType = {
+  SUCCESS: 'success',
+  EXCEPTION: 'exception',
+}
+
+class EvaluateResultSuccess {
+  constructor(realmId, value) {
+    this.resultType = EvaluateResultType.SUCCESS
+    this.realmId = realmId
+    this.result = value
+  }
+}
+
+class EvaluateResultException {
+  constructor(realmId, exceptionDetails) {
+    this.resultType = EvaluateResultType.EXCEPTION
+    this.realmId = realmId
+    this.exceptionDetails = exceptionDetails
+  }
+}
+
+class ExceptionDetails {
+  constructor(exceptionDetails) {
+    this.columnNumber =
+      'columnNumber' in exceptionDetails
+        ? exceptionDetails['columnNumber']
+        : null
+    this.exception =
+      'exception' in exceptionDetails ? exceptionDetails['exception'] : null
+    this.lineNumber =
+      'lineNumber' in exceptionDetails ? exceptionDetails['lineNumber'] : null
+    this.stackTrace =
+      'stackTrace' in exceptionDetails ? exceptionDetails['stackTrace'] : null
+    this.text = 'text' in exceptionDetails ? exceptionDetails['text'] : null
+  }
+}
+
+module.exports = {
+  EvaluateResultType,
+  EvaluateResultSuccess,
+  EvaluateResultException,
+  ExceptionDetails,
+}

package/bidi/logEntries.js

@@ -18,64 +18,64 @@
 'use strict'
 
 class BaseLogEntry {
-  constructor (level, text, timeStamp, stackTrace) {
+  constructor(level, text, timeStamp, stackTrace) {
     this._level = level
     this._text = text
     this._timeStamp = timeStamp
     this._stackTrace = stackTrace
   }
 
-  get level () {
+  get level() {
     return this._level
   }
 
-  get text () {
+  get text() {
     return this._text
   }
 
-  get timeStamp () {
+  get timeStamp() {
     return this._timeStamp
   }
 
-  get stackTrace () {
+  get stackTrace() {
     return this._stackTrace
   }
 }
 
 class GenericLogEntry extends BaseLogEntry {
-  constructor (level, text, timeStamp, type, stackTrace) {
+  constructor(level, text, timeStamp, type, stackTrace) {
     super(level, text, timeStamp, stackTrace)
     this._type = type
   }
 
-  get type () {
+  get type() {
     return this._type
   }
 }
 
 class ConsoleLogEntry extends GenericLogEntry {
-  constructor (level, text, timeStamp, type, method, realm, args, stackTrace) {
+  constructor(level, text, timeStamp, type, method, realm, args, stackTrace) {
     super(level, text, timeStamp, type, stackTrace)
     this._method = method
     this._realm = realm
     this._args = args
   }
 
-  get method () {
+  get method() {
     return this._method
   }
 
-  get realm () {
+  get realm() {
     return this._realm
   }
 
-  get args () {
+  get args() {
     return this._args
   }
 }
 
 class JavascriptLogEntry extends GenericLogEntry {
-  constructor (level, text, timeStamp, type, stackTrace) {
+  constructor(level, text, timeStamp, type, stackTrace) {
     super(level, text, timeStamp, type, stackTrace)
   }
 }
@@ -83,5 +83,8 @@ class JavascriptLogEntry extends GenericLogEntry {
 // PUBLIC API
 
 module.exports = {
-  BaseLogEntry, GenericLogEntry, ConsoleLogEntry, JavascriptLogEntry,
+  BaseLogEntry,
+  GenericLogEntry,
+  ConsoleLogEntry,
+  JavascriptLogEntry,
 }

package/bidi/protocolType.js

@@ -0,0 +1,97 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const PrimitiveType = {
+  UNDEFINED: 'undefined',
+  NULL: 'null',
+  STRING: 'string',
+  NUMBER: 'number',
+  SPECIAL_NUMBER: 'number',
+  BOOLEAN: 'boolean',
+  BIGINT: 'bigint',
+
+  findByName(name) {
+    return (
+      Object.values(this).find((type) => {
+        return (
+          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
+        )
+      }) || null
+    )
+  },
+}
+
+const NonPrimitiveType = {
+  ARRAY: 'array',
+  DATE: 'date',
+  MAP: 'map',
+  OBJECT: 'object',
+  REGULAR_EXPRESSION: 'regexp',
+  SET: 'set',
+
+  findByName(name) {
+    return (
+      Object.values(this).find((type) => {
+        return (
+          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
+        )
+      }) || null
+    )
+  },
+}
+
+const RemoteType = {
+  SYMBOL: 'symbol',
+  FUNCTION: 'function',
+  WEAK_MAP: 'weakmap',
+  WEAK_SET: 'weakset',
+  ITERATOR: 'iterator',
+  GENERATOR: 'generator',
+  ERROR: 'error',
+  PROXY: 'proxy',
+  PROMISE: 'promise',
+  TYPED_ARRAY: 'typedarray',
+  ARRAY_BUFFER: 'arraybuffer',
+  NODE_LIST: 'nodelist',
+  HTML_COLLECTION: 'htmlcollection',
+  NODE: 'node',
+  WINDOW: 'window',
+
+  findByName(name) {
+    return (
+      Object.values(this).find((type) => {
+        return (
+          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
+        )
+      }) || null
+    )
+  },
+}
+
+const SpecialNumberType = {
+  NAN: 'NaN',
+  MINUS_ZERO: '-0',
+  INFINITY: 'Infinity',
+  MINUS_INFINITY: '-Infinity',
+}
+
+module.exports = {
+  PrimitiveType,
+  NonPrimitiveType,
+  RemoteType,
+  SpecialNumberType,
+}

package/bidi/protocolValue.js

@@ -0,0 +1,204 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const {
+  PrimitiveType,
+  NonPrimitiveType,
+  RemoteType,
+} = require('./protocolType')
+
+const TYPE_CONSTANT = 'type'
+const VALUE_CONSTANT = 'value'
+const RemoteReferenceType = {
+  HANDLE: 'handle',
+  SHARED_ID: 'shareId',
+}
+
+class LocalValue {
+  constructor(type, value = null) {
+    if (type === PrimitiveType.UNDEFINED || type === PrimitiveType.NULL) {
+      this.type = type
+    } else {
+      this.type = type
+      this.value = value
+    }
+  }
+
+  static createStringValue(value) {
+    return new LocalValue(PrimitiveType.STRING, value)
+  }
+
+  static createNumberValue(value) {
+    return new LocalValue(PrimitiveType.NUMBER, value)
+  }
+
+  static createSpecialNumberValue(value) {
+    return new LocalValue(PrimitiveType.SPECIAL_NUMBER, value)
+  }
+
+  static createUndefinedValue() {
+    return new LocalValue(PrimitiveType.UNDEFINED)
+  }
+
+  static createNullValue() {
+    return new LocalValue(PrimitiveType.NULL)
+  }
+
+  static createBooleanValue(value) {
+    return new LocalValue(PrimitiveType.BOOLEAN, value)
+  }
+
+  static createBigIntValue(value) {
+    return new LocalValue(PrimitiveType.BIGINT, value)
+  }
+
+  static createArrayValue(value) {
+    return new LocalValue(NonPrimitiveType.ARRAY, value)
+  }
+
+  static createDateValue(value) {
+    return new LocalValue(NonPrimitiveType.DATE, value)
+  }
+
+  static createMapValue(map) {
+    let value = []
+    Object.entries(map).forEach((entry) => {
+      value.push(entry)
+    })
+    return new LocalValue(NonPrimitiveType.MAP, value)
+  }
+
+  static createObjectValue(map) {
+    let value = []
+    Object.entries(map).forEach((entry) => {
+      value.push(entry)
+    })
+    return new LocalValue(NonPrimitiveType.OBJECT, value)
+  }
+
+  static createRegularExpressionValue(value) {
+    return new LocalValue(NonPrimitiveType.REGULAR_EXPRESSION, value)
+  }
+
+  static createSetValue(value) {
+    return new LocalValue(NonPrimitiveType.SET, value)
+  }
+
+  toJson() {
+    let toReturn = {}
+    toReturn[TYPE_CONSTANT] = this.type
+
+    if (
+      !(
+        this.type === PrimitiveType.NULL ||
+        this.type === PrimitiveType.UNDEFINED
+      )
+    ) {
+      toReturn[VALUE_CONSTANT] = this.value
+    }
+    return toReturn
+  }
+}
+
+class RemoteValue {
+  constructor(remoteValue) {
+    this.type = null
+    this.handle = null
+    this.internalId = null
+    this.value = null
+    this.sharedId = null
+
+    if ('type' in remoteValue) {
+      var typeString = remoteValue['type']
+      if (PrimitiveType.findByName(typeString) != null) {
+        this.type = PrimitiveType.findByName(typeString)
+      } else if (NonPrimitiveType.findByName(typeString) != null) {
+        this.type = NonPrimitiveType.findByName(typeString)
+      } else {
+        this.type = RemoteType.findByName(typeString)
+      }
+    }
+
+    if ('handle' in remoteValue) {
+      this.handle = remoteValue['handle']
+    }
+
+    if ('internalId' in remoteValue) {
+      this.internalId = remoteValue['internalId']
+    }
+
+    if ('value' in remoteValue) {
+      this.value = remoteValue['value']
+    }
+
+    if ('sharedId' in remoteValue) {
+      this.sharedId = remoteValue['sharedId']
+    }
+
+    if (this.value != null) {
+      this.value = this.deserializeValue(this.value, this.type)
+    }
+  }
+
+  deserializeValue(value, type) {
+    if ([NonPrimitiveType.MAP, NonPrimitiveType.OBJECT].includes(type)) {
+      return Object.fromEntries(value)
+    } else if (type === NonPrimitiveType.REGULAR_EXPRESSION) {
+      return new RegExpValue(value.pattern, value.flags)
+    }
+    return value
+  }
+}
+
+class ReferenceValue {
+  constructor(handle, shareId) {
+    if (handle === RemoteReferenceType.HANDLE) {
+      this.handle = shareId
+    } else {
+      this.handle = handle
+      this.shareId = shareId
+    }
+  }
+
+  asMap() {
+    const toReturn = {}
+    if (this.handle != null) {
+      toReturn[RemoteReferenceType.HANDLE] = this.handle
+    }
+
+    if (this.shareId != null) {
+      toReturn[RemoteReferenceType.SHARED_ID] = this.shareId
+    }
+
+    return toReturn
+  }
+}
+
+class RegExpValue {
+  constructor(pattern, flags = null) {
+    this.pattern = pattern
+    this.flags = flags
+  }
+}
+
+module.exports = {
+  LocalValue,
+  RemoteValue,
+  ReferenceValue,
+  RemoteReferenceType,
+  RegExpValue,
+}

package/bidi/realmInfo.js

@@ -0,0 +1,99 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const RealmType = {
+  AUDIO_WORKLET: 'audio-worklet',
+  DEDICATED_WORKER: 'dedicated-worker',
+  PAINT_WORKLET: 'paint-worklet',
+  SERVICE_WORKED: 'service-worker',
+  SHARED_WORKED: 'shared-worker',
+  WINDOW: 'window',
+  WORKER: 'worker',
+  WORKLET: 'worklet',
+
+  findByName(name) {
+    return (
+      Object.values(this).find((type) => {
+        return (
+          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
+        )
+      }) || null
+    )
+  },
+}
+
+class RealmInfo {
+  constructor(realmId, origin, realmType) {
+    this.realmId = realmId
+    this.origin = origin
+    this.realmType = realmType
+  }
+
+  static fromJson(input) {
+    let realmId = null
+    let origin = null
+    let realmType = null
+    let browsingContext = null
+    let sandbox = null
+
+    if ('type' in input) {
+      let typeString = input['type']
+      realmType = RealmType.findByName(typeString)
+    }
+
+    if ('realm' in input) {
+      realmId = input['realm']
+    }
+
+    if ('origin' in input) {
+      origin = input['origin']
+    }
+
+    if ('context' in input) {
+      browsingContext = input['context']
+    }
+
+    if ('sandbox' in input) {
+      sandbox = input['sandbox']
+    }
+
+    if (realmType === RealmType.WINDOW) {
+      return new WindowRealmInfo(
+        realmId,
+        origin,
+        realmType,
+        browsingContext,
+        sandbox
+      )
+    }
+
+    return new RealmInfo(realmId, origin, realmType)
+  }
+}
+
+class WindowRealmInfo extends RealmInfo {
+  constructor(realmId, origin, realmType, browsingContext, sandbox = null) {
+    super(realmId, origin, realmType)
+    this.browsingContext = browsingContext
+    this.sandbox = sandbox
+  }
+}
+
+module.exports = {
+  RealmInfo,
+  RealmType,
+}

package/bidi/resultOwnership.js

@@ -0,0 +1,23 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const ResultOwnership = {
+  ROOT: 'root',
+  NONE: 'none',
+}
+
+module.exports = { ResultOwnership }