/
handler.py
782 lines (700 loc) · 31.7 KB
/
handler.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
import asyncio
import logging
from contextlib import suppress
from dataclasses import dataclass
from ipaddress import ip_address
from time import time
from typing import Awaitable, Callable, Dict, Optional, Tuple, Type, TypeVar, Union
from playwright.async_api import (
BrowserContext,
BrowserType,
Download,
Error as PlaywrightError,
Page,
Playwright as AsyncPlaywright,
PlaywrightContextManager,
Request as PlaywrightRequest,
Response as PlaywrightResponse,
Route,
)
from scrapy import Spider, signals
from scrapy.core.downloader.handlers.http import HTTPDownloadHandler
from scrapy.crawler import Crawler
from scrapy.http import Request, Response
from scrapy.http.headers import Headers
from scrapy.responsetypes import responsetypes
from scrapy.settings import Settings
from scrapy.utils.defer import deferred_from_coro
from scrapy.utils.misc import load_object
from scrapy.utils.reactor import verify_installed_reactor
from twisted.internet.defer import Deferred, inlineCallbacks
from scrapy_playwright.headers import use_scrapy_headers
from scrapy_playwright.page import PageMethod
from scrapy_playwright._utils import (
_encode_body,
_get_header_value,
_get_page_content,
_is_safe_close_error,
_maybe_await,
)
__all__ = ["ScrapyPlaywrightDownloadHandler"]
PlaywrightHandler = TypeVar("PlaywrightHandler", bound="ScrapyPlaywrightDownloadHandler")
logger = logging.getLogger("scrapy-playwright")
DEFAULT_BROWSER_TYPE = "chromium"
DEFAULT_CONTEXT_NAME = "default"
PERSISTENT_CONTEXT_PATH_KEY = "user_data_dir"
@dataclass
class BrowserContextWrapper:
context: BrowserContext
semaphore: asyncio.Semaphore
persistent: bool
@dataclass
class Config:
cdp_url: Optional[str]
cdp_kwargs: dict
browser_type_name: str
launch_options: dict
max_pages_per_context: int
max_contexts: Optional[int]
startup_context_kwargs: dict
navigation_timeout: Optional[float] = None
@classmethod
def from_settings(cls, settings: Settings) -> "Config":
cfg = cls(
cdp_url=settings.get("PLAYWRIGHT_CDP_URL"),
cdp_kwargs=settings.getdict("PLAYWRIGHT_CDP_KWARGS") or {},
browser_type_name=settings.get("PLAYWRIGHT_BROWSER_TYPE") or DEFAULT_BROWSER_TYPE,
launch_options=settings.getdict("PLAYWRIGHT_LAUNCH_OPTIONS") or {},
max_pages_per_context=settings.getint("PLAYWRIGHT_MAX_PAGES_PER_CONTEXT"),
max_contexts=settings.getint("PLAYWRIGHT_MAX_CONTEXTS") or None,
startup_context_kwargs=settings.getdict("PLAYWRIGHT_CONTEXTS"),
)
cfg.cdp_kwargs.pop("endpoint_url", None)
if not cfg.max_pages_per_context:
cfg.max_pages_per_context = settings.getint("CONCURRENT_REQUESTS")
if cfg.cdp_url and cfg.launch_options:
logger.warning("PLAYWRIGHT_CDP_URL is set, ignoring PLAYWRIGHT_LAUNCH_OPTIONS")
if "PLAYWRIGHT_DEFAULT_NAVIGATION_TIMEOUT" in settings:
with suppress(TypeError, ValueError):
cfg.navigation_timeout = float(settings["PLAYWRIGHT_DEFAULT_NAVIGATION_TIMEOUT"])
return cfg
class ScrapyPlaywrightDownloadHandler(HTTPDownloadHandler):
playwright_context_manager: Optional[PlaywrightContextManager] = None
playwright: Optional[AsyncPlaywright] = None
def __init__(self, crawler: Crawler) -> None:
super().__init__(settings=crawler.settings, crawler=crawler)
verify_installed_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
crawler.signals.connect(self._engine_started, signals.engine_started)
self.stats = crawler.stats
self.config = Config.from_settings(crawler.settings)
self.browser_launch_lock = asyncio.Lock()
self.context_launch_lock = asyncio.Lock()
self.context_wrappers: Dict[str, BrowserContextWrapper] = {}
if self.config.max_contexts:
self.context_semaphore = asyncio.Semaphore(value=self.config.max_contexts)
# headers
if "PLAYWRIGHT_PROCESS_REQUEST_HEADERS" in crawler.settings:
if crawler.settings["PLAYWRIGHT_PROCESS_REQUEST_HEADERS"] is None:
self.process_request_headers = None
else:
self.process_request_headers = load_object(
crawler.settings["PLAYWRIGHT_PROCESS_REQUEST_HEADERS"]
)
else:
self.process_request_headers = use_scrapy_headers
self.abort_request: Optional[Callable[[PlaywrightRequest], Union[Awaitable, bool]]] = None
if crawler.settings.get("PLAYWRIGHT_ABORT_REQUEST"):
self.abort_request = load_object(crawler.settings["PLAYWRIGHT_ABORT_REQUEST"])
@classmethod
def from_crawler(cls: Type[PlaywrightHandler], crawler: Crawler) -> PlaywrightHandler:
return cls(crawler)
def _engine_started(self) -> Deferred:
"""Launch the browser. Use the engine_started signal as it supports returning deferreds."""
return deferred_from_coro(self._launch())
async def _launch(self) -> None:
"""Launch Playwright manager and configured startup context(s)."""
logger.info("Starting download handler")
self.playwright_context_manager = PlaywrightContextManager()
self.playwright = await self.playwright_context_manager.start()
self.browser_type: BrowserType = getattr(self.playwright, self.config.browser_type_name)
if self.config.startup_context_kwargs:
logger.info("Launching %i startup context(s)", len(self.config.startup_context_kwargs))
await asyncio.gather(
*[
self._create_browser_context(name=name, context_kwargs=kwargs)
for name, kwargs in self.config.startup_context_kwargs.items()
]
)
self._set_max_concurrent_context_count()
logger.info("Startup context(s) launched")
self.stats.set_value("playwright/page_count", self._get_total_page_count())
async def _maybe_launch_browser(self) -> None:
async with self.browser_launch_lock:
if not hasattr(self, "browser"):
logger.info("Launching browser %s", self.browser_type.name)
self.browser = await self.browser_type.launch(**self.config.launch_options)
logger.info("Browser %s launched", self.browser_type.name)
async def _maybe_connect_devtools(self) -> None:
async with self.browser_launch_lock:
if not hasattr(self, "browser"):
logger.info("Connecting using CDP: %s", self.config.cdp_url)
self.browser = await self.browser_type.connect_over_cdp(
self.config.cdp_url, **self.config.cdp_kwargs
)
logger.info("Connected using CDP: %s", self.config.cdp_url)
async def _create_browser_context(
self,
name: str,
context_kwargs: Optional[dict],
spider: Optional[Spider] = None,
) -> BrowserContextWrapper:
"""Create a new context, also launching a local browser or connecting
to a remote one if necessary.
"""
if hasattr(self, "context_semaphore"):
await self.context_semaphore.acquire()
context_kwargs = context_kwargs or {}
if context_kwargs.get(PERSISTENT_CONTEXT_PATH_KEY):
context = await self.browser_type.launch_persistent_context(**context_kwargs)
persistent = True
remote = False
elif self.config.cdp_url:
await self._maybe_connect_devtools()
context = await self.browser.new_context(**context_kwargs)
persistent = False
remote = True
else:
await self._maybe_launch_browser()
context = await self.browser.new_context(**context_kwargs)
persistent = False
remote = False
context.on(
"close", self._make_close_browser_context_callback(name, persistent, remote, spider)
)
self.stats.inc_value("playwright/context_count")
self.stats.inc_value(f"playwright/context_count/persistent/{persistent}")
self.stats.inc_value(f"playwright/context_count/remote/{remote}")
logger.debug(
"Browser context started: '%s' (persistent=%s, remote=%s)",
name,
persistent,
remote,
extra={
"spider": spider,
"context_name": name,
"persistent": persistent,
"remote": remote,
},
)
if self.config.navigation_timeout is not None:
context.set_default_navigation_timeout(self.config.navigation_timeout)
self.context_wrappers[name] = BrowserContextWrapper(
context=context,
semaphore=asyncio.Semaphore(value=self.config.max_pages_per_context),
persistent=persistent,
)
self._set_max_concurrent_context_count()
return self.context_wrappers[name]
async def _create_page(self, request: Request, spider: Spider) -> Page:
"""Create a new page in a context, also creating a new context if necessary."""
context_name = request.meta.setdefault("playwright_context", DEFAULT_CONTEXT_NAME)
# this block needs to be locked because several attempts to launch a context
# with the same name could happen at the same time from different requests
async with self.context_launch_lock:
ctx_wrapper = self.context_wrappers.get(context_name)
if ctx_wrapper is None:
ctx_wrapper = await self._create_browser_context(
name=context_name,
context_kwargs=request.meta.get("playwright_context_kwargs"),
spider=spider,
)
await ctx_wrapper.semaphore.acquire()
page = await ctx_wrapper.context.new_page()
self.stats.inc_value("playwright/page_count")
total_page_count = self._get_total_page_count()
logger.debug(
"[Context=%s] New page created, page count is %i (%i for all contexts)",
context_name,
len(ctx_wrapper.context.pages),
total_page_count,
extra={
"spider": spider,
"context_name": context_name,
"context_page_count": len(ctx_wrapper.context.pages),
"total_page_count": total_page_count,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
},
)
self._set_max_concurrent_page_count()
if self.config.navigation_timeout is not None:
page.set_default_navigation_timeout(self.config.navigation_timeout)
page.on("close", self._make_close_page_callback(context_name))
page.on("crash", self._make_close_page_callback(context_name))
page.on("request", _make_request_logger(context_name, spider))
page.on("response", _make_response_logger(context_name, spider))
page.on("request", self._increment_request_stats)
page.on("response", self._increment_response_stats)
return page
def _get_total_page_count(self):
return sum(len(ctx.context.pages) for ctx in self.context_wrappers.values())
def _set_max_concurrent_page_count(self):
count = self._get_total_page_count()
current_max_count = self.stats.get_value("playwright/page_count/max_concurrent")
if current_max_count is None or count > current_max_count:
self.stats.set_value("playwright/page_count/max_concurrent", count)
def _set_max_concurrent_context_count(self):
current_max_count = self.stats.get_value("playwright/context_count/max_concurrent")
if current_max_count is None or len(self.context_wrappers) > current_max_count:
self.stats.set_value(
"playwright/context_count/max_concurrent", len(self.context_wrappers)
)
@inlineCallbacks
def close(self) -> Deferred:
logger.info("Closing download handler")
yield super().close()
yield deferred_from_coro(self._close())
async def _close(self) -> None:
await asyncio.gather(*[ctx.context.close() for ctx in self.context_wrappers.values()])
self.context_wrappers.clear()
if hasattr(self, "browser"):
logger.info("Closing browser")
await self.browser.close()
if self.playwright_context_manager:
await self.playwright_context_manager.__aexit__()
if self.playwright:
await self.playwright.stop()
def download_request(self, request: Request, spider: Spider) -> Deferred:
if request.meta.get("playwright"):
return deferred_from_coro(self._download_request(request, spider))
return super().download_request(request, spider)
async def _download_request(self, request: Request, spider: Spider) -> Response:
page = request.meta.get("playwright_page")
if not isinstance(page, Page):
page = await self._create_page(request=request, spider=spider)
context_name = request.meta.setdefault("playwright_context", DEFAULT_CONTEXT_NAME)
_attach_page_event_handlers(
page=page, request=request, spider=spider, context_name=context_name
)
await page.unroute("**")
await page.route(
"**",
self._make_request_handler(
context_name=context_name,
method=request.method,
url=request.url,
headers=request.headers,
body=request.body,
encoding=request.encoding,
spider=spider,
),
)
await _maybe_execute_page_init_callback(
page=page, request=request, context_name=context_name, spider=spider
)
try:
return await self._download_request_with_page(request, page, spider)
except Exception as ex:
if not request.meta.get("playwright_include_page") and not page.is_closed():
logger.warning(
"Closing page due to failed request: %s exc_type=%s exc_msg=%s",
request,
type(ex),
str(ex),
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
"exception": ex,
},
exc_info=True,
)
await page.close()
self.stats.inc_value("playwright/page_count/closed")
raise
async def _download_request_with_page(
self, request: Request, page: Page, spider: Spider
) -> Response:
# set this early to make it available in errbacks even if something fails
if request.meta.get("playwright_include_page"):
request.meta["playwright_page"] = page
start_time = time()
response, download = await self._get_response_and_download(request=request, page=page)
if isinstance(response, PlaywrightResponse):
await _set_redirect_meta(request=request, response=response)
headers = Headers(await response.all_headers())
headers.pop("Content-Encoding", None)
else:
logger.warning(
"Navigating to %s returned None, the response"
" will have empty headers and status 200",
request,
extra={
"spider": spider,
"context_name": request.meta.get("playwright_context"),
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
},
)
headers = Headers()
await self._apply_page_methods(page, request, spider)
body_str = await _get_page_content(
page=page,
spider=spider,
context_name=request.meta.get("playwright_context"),
scrapy_request_url=request.url,
scrapy_request_method=request.method,
)
request.meta["download_latency"] = time() - start_time
server_ip_address = None
if response is not None:
request.meta["playwright_security_details"] = await response.security_details()
with suppress(KeyError, TypeError, ValueError):
server_addr = await response.server_addr()
server_ip_address = ip_address(server_addr["ipAddress"])
if download.get("exception"):
raise download["exception"]
if not request.meta.get("playwright_include_page"):
await page.close()
self.stats.inc_value("playwright/page_count/closed")
if download:
request.meta["playwright_suggested_filename"] = download.get("suggested_filename")
respcls = responsetypes.from_args(url=download["url"], body=download["bytes"])
return respcls(
url=download["url"],
status=200,
body=download["bytes"],
request=request,
flags=["playwright"],
)
body, encoding = _encode_body(headers=headers, text=body_str)
respcls = responsetypes.from_args(headers=headers, url=page.url, body=body)
return respcls(
url=page.url,
status=response.status if response is not None else 200,
headers=headers,
body=body,
request=request,
flags=["playwright"],
encoding=encoding,
ip_address=server_ip_address,
)
async def _get_response_and_download(
self, request: Request, page: Page
) -> Tuple[Optional[PlaywrightResponse], dict]:
response: Optional[PlaywrightResponse] = None
download: dict = {} # updated in-place in _handle_download
download_ready = asyncio.Event()
async def _handle_download(dwnld: Download) -> None:
self.stats.inc_value("playwright/download_count")
try:
if failure := await dwnld.failure():
raise RuntimeError(f"Failed to download {dwnld.url}: {failure}")
download_path = await dwnld.path()
download["bytes"] = download_path.read_bytes()
download["url"] = dwnld.url
download["suggested_filename"] = dwnld.suggested_filename
except Exception as ex:
download["exception"] = ex
finally:
download_ready.set()
page_goto_kwargs = request.meta.get("playwright_page_goto_kwargs") or {}
page_goto_kwargs.pop("url", None)
page.on("download", _handle_download)
try:
response = await page.goto(url=request.url, **page_goto_kwargs)
except PlaywrightError as err:
if not (
self.config.browser_type_name in ("firefox", "webkit")
and "Download is starting" in err.message
or self.config.browser_type_name == "chromium"
and "net::ERR_ABORTED" in err.message
):
raise
await download_ready.wait()
finally:
page.remove_listener("download", _handle_download)
return response, download
async def _apply_page_methods(self, page: Page, request: Request, spider: Spider) -> None:
context_name = request.meta.get("playwright_context")
page_methods = request.meta.get("playwright_page_methods") or ()
if isinstance(page_methods, dict):
page_methods = page_methods.values()
for pm in page_methods:
if isinstance(pm, PageMethod):
try:
method = getattr(page, pm.method)
except AttributeError as ex:
logger.warning(
"Ignoring %r: could not find method",
pm,
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
"exception": ex,
},
exc_info=True,
)
else:
pm.result = await _maybe_await(method(*pm.args, **pm.kwargs))
await page.wait_for_load_state(timeout=self.config.navigation_timeout)
else:
logger.warning(
"Ignoring %r: expected PageMethod, got %r",
pm,
type(pm),
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
},
)
def _increment_request_stats(self, request: PlaywrightRequest) -> None:
stats_prefix = "playwright/request_count"
self.stats.inc_value(stats_prefix)
self.stats.inc_value(f"{stats_prefix}/resource_type/{request.resource_type}")
self.stats.inc_value(f"{stats_prefix}/method/{request.method}")
if request.is_navigation_request():
self.stats.inc_value(f"{stats_prefix}/navigation")
def _increment_response_stats(self, response: PlaywrightResponse) -> None:
stats_prefix = "playwright/response_count"
self.stats.inc_value(stats_prefix)
self.stats.inc_value(f"{stats_prefix}/resource_type/{response.request.resource_type}")
self.stats.inc_value(f"{stats_prefix}/method/{response.request.method}")
def _make_close_page_callback(self, context_name: str) -> Callable:
def close_page_callback() -> None:
if context_name in self.context_wrappers:
self.context_wrappers[context_name].semaphore.release()
return close_page_callback
def _make_close_browser_context_callback(
self, name: str, persistent: bool, remote: bool, spider: Optional[Spider] = None
) -> Callable:
def close_browser_context_callback() -> None:
self.context_wrappers.pop(name, None)
if hasattr(self, "context_semaphore"):
self.context_semaphore.release()
logger.debug(
"Browser context closed: '%s' (persistent=%s, remote=%s)",
name,
persistent,
remote,
extra={
"spider": spider,
"context_name": name,
"persistent": persistent,
"remote": remote,
},
)
return close_browser_context_callback
def _make_request_handler(
self,
context_name: str,
method: str,
url: str,
headers: Headers,
body: Optional[bytes],
encoding: str,
spider: Spider,
) -> Callable:
async def _request_handler(route: Route, playwright_request: PlaywrightRequest) -> None:
"""Override request headers, method and body."""
if self.abort_request:
should_abort = await _maybe_await(self.abort_request(playwright_request))
if should_abort:
await route.abort()
logger.debug(
"[Context=%s] Aborted Playwright request <%s %s>",
context_name,
playwright_request.method.upper(),
playwright_request.url,
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": url,
"scrapy_request_method": method,
"playwright_request_url": playwright_request.url,
"playwright_request_method": playwright_request.method,
},
)
self.stats.inc_value("playwright/request_count/aborted")
return None
overrides: dict = {}
if self.process_request_headers is None:
final_headers = await playwright_request.all_headers()
else:
overrides["headers"] = final_headers = await _maybe_await(
self.process_request_headers(
self.config.browser_type_name, playwright_request, headers
)
)
# if the current request corresponds to the original scrapy one
if (
playwright_request.url.rstrip("/") == url.rstrip("/")
and playwright_request.is_navigation_request()
):
if method.upper() != playwright_request.method.upper():
overrides["method"] = method
if body:
overrides["post_data"] = body.decode(encoding)
# the request that reaches the callback should contain the final headers
headers.clear()
headers.update(final_headers)
del final_headers
original_playwright_method: str = playwright_request.method
try:
await route.continue_(**overrides)
if overrides.get("method"):
logger.debug(
"[Context=%s] Overridden method for Playwright request"
" to %s: original=%s new=%s",
context_name,
playwright_request.url,
original_playwright_method,
overrides["method"],
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": url,
"scrapy_request_method": method,
"playwright_request_url": playwright_request.url,
"playwright_request_method_original": original_playwright_method,
"playwright_request_method_new": overrides["method"],
},
)
except PlaywrightError as ex:
if _is_safe_close_error(ex):
logger.warning(
"Failed processing Playwright request: <%s %s> exc_type=%s exc_msg=%s",
playwright_request.method,
playwright_request.url,
type(ex),
str(ex),
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": url,
"scrapy_request_method": method,
"playwright_request_url": playwright_request.url,
"playwright_request_method": playwright_request.method,
"exception": ex,
},
exc_info=True,
)
else:
raise
return _request_handler
def _attach_page_event_handlers(
page: Page, request: Request, spider: Spider, context_name: str
) -> None:
event_handlers = request.meta.get("playwright_page_event_handlers") or {}
for event, handler in event_handlers.items():
if callable(handler):
page.on(event, handler)
elif isinstance(handler, str):
try:
page.on(event, getattr(spider, handler))
except AttributeError as ex:
logger.warning(
"Spider '%s' does not have a '%s' attribute,"
" ignoring handler for event '%s'",
spider.name,
handler,
event,
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
"exception": ex,
},
exc_info=True,
)
async def _set_redirect_meta(request: Request, response: PlaywrightResponse) -> None:
"""Update a Scrapy request with metadata about redirects."""
redirect_times: int = 0
redirect_urls: list = []
redirect_reasons: list = []
redirected = response.request.redirected_from
while redirected is not None:
redirect_times += 1
redirect_urls.append(redirected.url)
redirected_response = await redirected.response()
reason = None if redirected_response is None else redirected_response.status
redirect_reasons.append(reason)
redirected = redirected.redirected_from
if redirect_times:
request.meta["redirect_times"] = redirect_times
request.meta["redirect_urls"] = list(reversed(redirect_urls))
request.meta["redirect_reasons"] = list(reversed(redirect_reasons))
async def _maybe_execute_page_init_callback(
page: Page,
request: Request,
context_name: str,
spider: Spider,
) -> None:
page_init_callback = request.meta.get("playwright_page_init_callback")
if page_init_callback:
try:
page_init_callback = load_object(page_init_callback)
await page_init_callback(page, request)
except Exception as ex:
logger.warning(
"[Context=%s] Page init callback exception for %s exc_type=%s exc_msg=%s",
context_name,
repr(request),
type(ex),
str(ex),
extra={
"spider": spider,
"context_name": context_name,
"scrapy_request_url": request.url,
"scrapy_request_method": request.method,
"exception": ex,
},
exc_info=True,
)
def _make_request_logger(context_name: str, spider: Spider) -> Callable:
async def _log_request(request: PlaywrightRequest) -> None:
log_args = [context_name, request.method.upper(), request.url, request.resource_type]
referrer = await _get_header_value(request, "referer")
if referrer:
log_args.append(referrer)
log_msg = "[Context=%s] Request: <%s %s> (resource type: %s, referrer: %s)"
else:
log_msg = "[Context=%s] Request: <%s %s> (resource type: %s)"
logger.debug(
log_msg,
*log_args,
extra={
"spider": spider,
"context_name": context_name,
"playwright_request_url": request.url,
"playwright_request_method": request.method,
"playwright_resource_type": request.resource_type,
},
)
return _log_request
def _make_response_logger(context_name: str, spider: Spider) -> Callable:
async def _log_response(response: PlaywrightResponse) -> None:
log_args = [context_name, response.status, response.url]
location = await _get_header_value(response, "location")
if location:
log_args.append(location)
log_msg = "[Context=%s] Response: <%i %s> (location: %s)"
else:
log_msg = "[Context=%s] Response: <%i %s>"
logger.debug(
log_msg,
*log_args,
extra={
"spider": spider,
"context_name": context_name,
"playwright_response_url": response.url,
"playwright_response_status": response.status,
},
)
return _log_response