Skip to content

When fetching robots.txt, use the same User-Agent as defined by the user #491

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

Merged
freekmurze merged 4 commits into from
Oct 28, 2025
Merged

When fetching robots.txt, use the same User-Agent as defined by the user #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25d764b
Bugfix: prevent infinite loops when a CrawlProfile prevents crawling …
mattiasgeniar Feb 26, 2021
bba1dab
Merge branch 'spatie:main' into master
mattiasgeniar Sep 29, 2025
5be7274
Merge branch 'spatie:main' into master
mattiasgeniar Oct 23, 2025
3527cf9
When fetching robots.txt, use the same User-Agent as defined by the user
mattiasgeniar Oct 23, 2025
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
10 changes: 9 additions & 1 deletion src/Crawler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,15 @@ protected function startCrawlingQueue(): void

protected function createRobotsTxt(UriInterface $uri): RobotsTxt
{
return RobotsTxt::create($uri->withPath('/robots.txt'));
try {
$robotsUrl = (string) $uri->withPath('/robots.txt');
$response = $this->client->get($robotsUrl);
$content = (string) $response->getBody();

return new RobotsTxt($content);
} catch (\Exception $exception) {
return new RobotsTxt('');
}
}

protected function getCrawlRequests(): Generator
Expand Down
40 changes: 40 additions & 0 deletions tests/CrawlerRobotsUserAgentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Response;
use Spatie\Crawler\Crawler;

beforeEach(function () {
$this->mockHandler = new \GuzzleHttp\Handler\MockHandler([
new Response(200, [], "User-agent: *\nDisallow: /admin"),
new Response(200, [], '<html><body>Home</body></html>'),
]);

$this->crawledUrls = [];
$this->history = Middleware::history($this->crawledUrls);

$this->handlerStack = HandlerStack::create($this->mockHandler);
$this->handlerStack->push($this->history);
});

it('should send the correct user agent header when fetching robots.txt', function () {
$client = new Client(['handler' => $this->handlerStack]);
$crawler = new Crawler($client);
$crawler->respectRobots()->startCrawling('http://example.com');

expect($this->crawledUrls)->toHaveCount(2);
expect((string) $this->crawledUrls[0]['request']->getUri())->toBe('http://example.com/robots.txt');
expect($this->crawledUrls[0]['request']->getHeader('User-Agent'))->toBe(['GuzzleHttp/7']);
});

it('should send the custom user agent header when fetching robots.txt', function () {
$client = new Client(['handler' => $this->handlerStack]);
$crawler = new Crawler($client);
$crawler->respectRobots()->setUserAgent('CustomBot/2.0')->startCrawling('http://example.com');

expect($this->crawledUrls)->toHaveCount(2);
expect((string) $this->crawledUrls[0]['request']->getUri())->toBe('http://example.com/robots.txt');
expect($this->crawledUrls[0]['request']->getHeader('User-Agent'))->toBe(['CustomBot/2.0']);
});