# Copyright (c) Microsoft Corporation. # # Licensed 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. import base64 import json import mimetypes import pathlib import typing from pathlib import Path from typing import Any, Dict, List, Optional, Pattern, Sequence, Union, cast import playwright._impl._network as network from playwright._impl._api_structures import ( ClientCertificate, Cookie, FilePayload, HttpCredentials, ProxySettings, RemoteAddr, ResourceTiming, SecurityDetails, SetCookieParam, StorageState, ) from playwright._impl._connection import ChannelOwner, from_channel from playwright._impl._errors import is_target_closed_error from playwright._impl._form_data import FormData from playwright._impl._helper import ( Error, NameValue, TargetClosedError, TimeoutSettings, async_readfile, async_writefile, is_file_payload, locals_to_params, object_to_array, to_impl, ) from playwright._impl._internal_structures import FormField, Headers, ServerFilePayload from playwright._impl._network import ( serialize_headers, to_clear_cookies_params, to_client_certificates_protocol, to_http_credentials_protocol, ) from playwright._impl._tracing import Tracing if typing.TYPE_CHECKING: from playwright._impl._playwright import Playwright FormType = Union[Dict[str, Union[bool, float, str]], FormData] DataType = Union[Any, bytes, str] MultipartType = Union[Dict[str, Union[bytes, bool, float, str, FilePayload]], FormData] ParamsType = Union[Dict[str, Union[bool, float, str]], str] class APIRequest: def __init__(self, playwright: "Playwright") -> None: self.playwright = playwright self._loop = playwright._loop self._dispatcher_fiber = playwright._connection._dispatcher_fiber async def new_context( self, baseURL: str = None, extraHTTPHeaders: Dict[str, str] = None, httpCredentials: Union[HttpCredentials, Sequence[HttpCredentials]] = None, ignoreHTTPSErrors: bool = None, proxy: ProxySettings = None, userAgent: str = None, timeout: float = None, storageState: Union[StorageState, str, Path] = None, clientCertificates: List[ClientCertificate] = None, failOnStatusCode: bool = None, maxRedirects: int = None, ) -> "APIRequestContext": params = locals_to_params(locals()) if "storageState" in params: storage_state = params["storageState"] if not isinstance(storage_state, dict) and storage_state: params["storageState"] = json.loads( (await async_readfile(storage_state)).decode() ) if "extraHTTPHeaders" in params: params["extraHTTPHeaders"] = serialize_headers(params["extraHTTPHeaders"]) params["clientCertificates"] = await to_client_certificates_protocol( params.get("clientCertificates") ) if "httpCredentials" in params: params["httpCredentials"] = to_http_credentials_protocol( params["httpCredentials"] ) context = cast( APIRequestContext, from_channel( await self.playwright._channel.send("newRequest", None, params) ), ) context._timeout_settings.set_default_timeout(timeout) return context class APIRequestContext(ChannelOwner): def __init__( self, parent: ChannelOwner, type: str, guid: str, initializer: Dict ) -> None: super().__init__(parent, type, guid, initializer) self._tracing: Tracing = from_channel(initializer["tracing"]) self._close_reason: Optional[str] = None self._timeout_settings = TimeoutSettings(None) async def dispose(self, reason: str = None) -> None: self._close_reason = reason await self._tracing._export_all_hars() try: await self._channel.send("dispose", None, {"reason": reason}) except Error as e: if is_target_closed_error(e): return raise e self._tracing._reset_stack_counter() @property def tracing(self) -> Tracing: return self._tracing async def cookies(self, urls: Union[str, Sequence[str]] = None) -> List[Cookie]: if urls is None: urls = [] if isinstance(urls, str): urls = [urls] return await self._channel.send("cookies", None, dict(urls=urls)) async def add_cookies(self, cookies: Sequence[SetCookieParam]) -> None: await self._channel.send("addCookies", None, dict(cookies=cookies)) async def clear_cookies( self, name: Union[str, Pattern[str]] = None, domain: Union[str, Pattern[str]] = None, path: Union[str, Pattern[str]] = None, ) -> None: await self._channel.send( "clearCookies", None, to_clear_cookies_params(name, domain, path) ) async def delete( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="DELETE", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def head( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="HEAD", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def get( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="GET", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def patch( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="PATCH", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def put( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="PUT", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def post( self, url: str, params: ParamsType = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": return await self.fetch( url, method="POST", params=params, headers=headers, data=data, form=form, multipart=multipart, timeout=timeout, failOnStatusCode=failOnStatusCode, ignoreHTTPSErrors=ignoreHTTPSErrors, maxRedirects=maxRedirects, maxRetries=maxRetries, ) async def fetch( self, urlOrRequest: Union[str, network.Request], params: ParamsType = None, method: str = None, headers: Headers = None, data: DataType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": url = urlOrRequest if isinstance(urlOrRequest, str) else None request = ( cast(network.Request, to_impl(urlOrRequest)) if isinstance(to_impl(urlOrRequest), network.Request) else None ) if not request and not isinstance(urlOrRequest, str): raise Error("First argument must be either URL string or Request") return await self._inner_fetch( request, url, method, headers, data, params, form, multipart, timeout, failOnStatusCode, ignoreHTTPSErrors, maxRedirects, maxRetries, ) async def _inner_fetch( self, request: Optional[network.Request], url: Optional[str], method: str = None, headers: Headers = None, data: DataType = None, params: ParamsType = None, form: FormType = None, multipart: MultipartType = None, timeout: float = None, failOnStatusCode: bool = None, ignoreHTTPSErrors: bool = None, maxRedirects: int = None, maxRetries: int = None, ) -> "APIResponse": if self._close_reason: raise TargetClosedError(self._close_reason) if ( (1 if data is not None else 0) + (1 if form is not None else 0) + (1 if multipart is not None else 0) ) > 1: raise Error("Only one of 'data', 'form' or 'multipart' can be specified") if maxRedirects is not None and maxRedirects < 0: raise Error("'max_redirects' must be greater than or equal to '0'") if maxRetries is not None and maxRetries < 0: raise Error("'max_retries' must be greater than or equal to '0'") url = url or (request.url if request else url) method = method or (request.method if request else "GET") # Cannot call allHeaders() here as the request may be paused inside route handler. headers_obj = headers or (request.headers if request else None) serialized_headers = serialize_headers(headers_obj) if headers_obj else None json_data: Any = None form_data: Optional[List[NameValue]] = None multipart_data: Optional[List[FormField]] = None post_data_buffer: Optional[bytes] = None if data is not None: if isinstance(data, str): if is_json_content_type(serialized_headers): json_data = data if is_json_parsable(data) else json.dumps(data) else: post_data_buffer = data.encode() elif isinstance(data, bytes): post_data_buffer = data elif isinstance(data, (dict, list, int, float, bool)): try: # NaN and Infinity are not valid JSON. json_data = json.dumps(data, allow_nan=False) except ValueError as e: raise Error(str(e)) from None else: raise Error(f"Unsupported 'data' type: {type(data)}") elif form is not None: if isinstance(form, FormData): form_data = [] for fd_name, fd_value in form._fields: if isinstance(fd_value, (pathlib.Path, dict)): raise Error( f"Form field {fd_name!r} must be a string, number or boolean. Use 'multipart' for file uploads." ) form_data.append(NameValue(name=fd_name, value=str(fd_value))) else: form_data = object_to_array(form) or [] elif multipart is not None: multipart_data = [] if isinstance(multipart, FormData): for fd_name, fd_value in multipart._fields: multipart_data.append( await _form_data_field_to_form_field(fd_name, fd_value) ) else: for name, value in multipart.items(): multipart_data.append( await _form_data_field_to_form_field(name, value) ) if ( post_data_buffer is None and json_data is None and form_data is None and multipart_data is None ): post_data_buffer = request.post_data_buffer if request else None post_data = ( base64.b64encode(post_data_buffer).decode() if post_data_buffer else None ) response = await self._channel.send( "fetch", self._timeout_settings.timeout, { "url": url, "timeout": timeout, "params": object_to_array(params) if isinstance(params, dict) else None, "encodedParams": params if isinstance(params, str) else None, "method": method, "headers": serialized_headers, "postData": post_data, "jsonData": json_data, "formData": form_data, "multipartData": multipart_data, "failOnStatusCode": failOnStatusCode, "ignoreHTTPSErrors": ignoreHTTPSErrors, "maxRedirects": maxRedirects, "maxRetries": maxRetries, }, ) return APIResponse(self, response) async def storage_state( self, path: Union[pathlib.Path, str] = None, indexedDB: bool = None, opfs: bool = None, ) -> StorageState: result = await self._channel.send_return_as_dict( "storageState", None, {"indexedDB": indexedDB, "opfs": opfs} ) if path: await async_writefile(path, json.dumps(result)) return result def file_payload_to_json(payload: FilePayload) -> ServerFilePayload: return ServerFilePayload( name=payload["name"], mimeType=payload["mimeType"], buffer=base64.b64encode(payload["buffer"]).decode(), ) async def _form_data_field_to_form_field(name: str, value: Any) -> FormField: if isinstance(value, pathlib.Path): mime_type, _ = mimetypes.guess_type(str(value)) return FormField( name=name, file=ServerFilePayload( name=value.name, mimeType=mime_type or "application/octet-stream", buffer=base64.b64encode(await async_readfile(str(value))).decode(), ), ) if is_file_payload(value): payload = cast(FilePayload, value) if not isinstance(payload["buffer"], bytes): raise Error(f"Unexpected buffer type of form field {name!r}") return FormField(name=name, file=file_payload_to_json(payload)) if isinstance(value, (str, int, float, bool)): return FormField(name=name, value=str(value)) raise Error(f"Unsupported form field {name!r} value type: {type(value).__name__}") class APIResponse: def __init__(self, context: APIRequestContext, initializer: Dict) -> None: self._loop = context._loop self._dispatcher_fiber = context._connection._dispatcher_fiber self._request = context self._initializer = initializer self._headers = network.RawHeaders(initializer["headers"]) def __repr__(self) -> str: return f"" @property def ok(self) -> bool: return self.status >= 200 and self.status <= 299 @property def url(self) -> str: return self._initializer["url"] @property def status(self) -> int: return self._initializer["status"] @property def status_text(self) -> str: return self._initializer["statusText"] @property def headers(self) -> Headers: return self._headers.headers() @property def headers_array(self) -> network.HeadersArray: return self._headers.headers_array() @property def timing(self) -> ResourceTiming: return cast( ResourceTiming, { "startTime": -1, "domainLookupStart": -1, "domainLookupEnd": -1, "connectStart": -1, "secureConnectionStart": -1, "connectEnd": -1, "requestStart": -1, "responseStart": -1, **self._initializer.get("timing", {}), "responseEnd": self._initializer.get("responseEndTiming", -1), }, ) async def body(self) -> bytes: try: result = await self._request._connection.wrap_api_call( lambda: self._request._channel.send_return_as_dict( "fetchResponseBody", None, { "fetchUid": self._fetch_uid, }, ), True, ) if result is None: raise Error("Response has been disposed") return base64.b64decode(result["binary"]) except Error as exc: if is_target_closed_error(exc): raise Error("Response has been disposed") raise exc async def text(self) -> str: content = await self.body() return content.decode() async def json(self) -> Any: content = await self.text() return json.loads(content) async def security_details(self) -> Optional[SecurityDetails]: return self._initializer.get("securityDetails") or None async def server_addr(self) -> Optional[RemoteAddr]: return self._initializer.get("serverAddr") or None async def dispose(self) -> None: await self._request._channel.send( "disposeAPIResponse", None, { "fetchUid": self._fetch_uid, }, ) @property def _fetch_uid(self) -> str: return self._initializer["fetchUid"] async def _fetch_log(self) -> List[str]: return await self._request._channel.send( "fetchLog", None, { "fetchUid": self._fetch_uid, }, ) def is_json_content_type(headers: network.HeadersArray = None) -> bool: if not headers: return False for header in headers: if header["name"].lower() == "content-type": return header["value"].startswith("application/json") return False def is_json_parsable(value: Any) -> bool: if not isinstance(value, str): return False try: # NaN and Infinity are not valid JSON, unlike what json.loads() accepts by default. json.loads(value, parse_constant=_reject_json_constant) return True except ValueError: return False def _reject_json_constant(value: str) -> Any: raise ValueError(f"{value} is not valid JSON")