@crawlee/http 4.0.0-beta.19 → 4.0.0-beta.190
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -14
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/internals/dom-crawler.d.ts +131 -0
- package/internals/dom-crawler.js +96 -0
- package/internals/file-download.d.ts +12 -11
- package/internals/file-download.js +42 -41
- package/internals/http-crawler.d.ts +208 -201
- package/internals/http-crawler.js +257 -230
- package/internals/utils.d.ts +11 -1
- package/internals/utils.js +50 -6
- package/package.json +13 -12
- package/index.d.ts.map +0 -1
- package/index.js.map +0 -1
- package/internals/file-download.d.ts.map +0 -1
- package/internals/file-download.js.map +0 -1
- package/internals/http-crawler.d.ts.map +0 -1
- package/internals/http-crawler.js.map +0 -1
- package/internals/utils.d.ts.map +0 -1
- package/internals/utils.js.map +0 -1
|
@@ -1,27 +1,37 @@
|
|
|
1
1
|
import { Readable } from 'node:stream';
|
|
2
2
|
import util from 'node:util';
|
|
3
|
-
import { BasicCrawler,
|
|
4
|
-
import {
|
|
5
|
-
import
|
|
3
|
+
import { BasicCrawler, ContextPipeline, getCookiesFromResponse, NavigationSkippedError, remainingNavigationWindowMillis, RequestState, RequestThrottledError, Router, SessionError, } from '@crawlee/basic';
|
|
4
|
+
import { ResponseWithUrl } from '@crawlee/http-client';
|
|
5
|
+
import { parseArgument, RETRY_CSS_SELECTORS, schemas } from '@crawlee/utils/internal';
|
|
6
6
|
import contentTypeParser from 'content-type';
|
|
7
7
|
import iconv from 'iconv-lite';
|
|
8
|
-
import
|
|
9
|
-
import { addTimeoutToPromise, tryCancel } from '@apify/timeout';
|
|
10
|
-
import { parseContentTypeFromResponse } from './utils.js';
|
|
11
|
-
let TimeoutError;
|
|
8
|
+
import { z } from 'zod';
|
|
9
|
+
import { addTimeoutToPromise, storage, TimeoutError, tryCancel } from '@apify/timeout';
|
|
10
|
+
import { extractCharsetFromHtmlBytes, parseContentTypeFromResponse, processHttpRequestOptions } from './utils.js';
|
|
12
11
|
/**
|
|
13
12
|
* Default mime types, which HttpScraper supports.
|
|
14
13
|
*/
|
|
15
14
|
const HTML_AND_XML_MIME_TYPES = ['text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'];
|
|
16
15
|
const APPLICATION_JSON_MIME_TYPE = 'application/json';
|
|
17
|
-
|
|
16
|
+
/**
|
|
17
|
+
* A higher starting concurrency and a relaxed event loop signal, since HTTP-only crawling barely touches the event
|
|
18
|
+
* loop. {@link HttpCrawler} folds these into the {@link ConcurrencySystem} it builds by default.
|
|
19
|
+
*
|
|
20
|
+
* A {@link BasicCrawlerOptions.concurrencySystem|`concurrencySystem`} you supply yourself replaces that default
|
|
21
|
+
* wholesale, tuning included, so spread these options in if you want to keep it:
|
|
22
|
+
*
|
|
23
|
+
* ```typescript
|
|
24
|
+
* new ConcurrencySystem({ ...HTTP_OPTIMIZED_CONCURRENCY_SYSTEM_OPTIONS, maxConcurrency: 50 });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export const HTTP_OPTIMIZED_CONCURRENCY_SYSTEM_OPTIONS = {
|
|
18
28
|
desiredConcurrency: 10,
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
29
|
+
loadSignals: {
|
|
30
|
+
eventLoop: {
|
|
31
|
+
snapshotIntervalSecs: 2,
|
|
32
|
+
maxBlockedMillis: 100,
|
|
33
|
+
overloadedRatio: 0.7,
|
|
34
|
+
},
|
|
25
35
|
},
|
|
26
36
|
};
|
|
27
37
|
/**
|
|
@@ -35,13 +45,15 @@ const HTTP_OPTIMIZED_AUTOSCALED_POOL_OPTIONS = {
|
|
|
35
45
|
*
|
|
36
46
|
* This crawler downloads each URL using a plain HTTP request and doesn't do any HTML parsing.
|
|
37
47
|
*
|
|
38
|
-
* The source URLs are represented using {@link Request} objects that are fed from
|
|
39
|
-
* {@link
|
|
40
|
-
*
|
|
48
|
+
* The source URLs are represented using {@link Request} objects that are fed from the
|
|
49
|
+
* {@link IRequestManager|request manager} provided via the {@link HttpCrawlerOptions.requestManager|`requestManager`}
|
|
50
|
+
* constructor option (a {@link RequestQueue} is itself a request manager). To read from a read-only source such
|
|
51
|
+
* as a {@link RequestList} while still being able to enqueue new requests, combine it with a queue into a
|
|
52
|
+
* {@link RequestManagerTandem} via {@link IRequestLoader.toTandem|`requestLoader.toTandem()`} and pass the
|
|
53
|
+
* result as `requestManager`.
|
|
41
54
|
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* to {@link RequestQueue} before it starts their processing. This ensures that a single URL is not crawled multiple times.
|
|
55
|
+
* > The {@link HttpCrawlerOptions.requestList|`requestList`} and {@link HttpCrawlerOptions.requestQueue|`requestQueue`}
|
|
56
|
+
* > options are deprecated; they are still accepted and folded into a single `requestManager` for back-compat.
|
|
45
57
|
*
|
|
46
58
|
* The crawler finishes when there are no more {@link Request} objects to crawl.
|
|
47
59
|
*
|
|
@@ -55,18 +67,18 @@ const HTTP_OPTIMIZED_AUTOSCALED_POOL_OPTIONS = {
|
|
|
55
67
|
* ]
|
|
56
68
|
* ```
|
|
57
69
|
*
|
|
58
|
-
* By default, this crawler only processes web pages with the `text/html`
|
|
59
|
-
* and `application/
|
|
70
|
+
* By default, this crawler only processes web pages with the `text/html`, `application/xhtml+xml`, `text/xml`, `application/xml`,
|
|
71
|
+
* and `application/json` MIME content types (as reported by the `Content-Type` HTTP header),
|
|
60
72
|
* and skips pages with other content types. If you want the crawler to process other content types,
|
|
61
73
|
* use the {@link HttpCrawlerOptions.additionalMimeTypes} constructor option.
|
|
62
74
|
* Beware that the parsing behavior differs for HTML, XML, JSON and other types of content.
|
|
63
75
|
* For details, see {@link HttpCrawlerOptions.requestHandler}.
|
|
64
76
|
*
|
|
65
|
-
* New requests are only dispatched when there is enough free CPU and memory available,
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* {@link
|
|
77
|
+
* New requests are only dispatched when there is enough free CPU and memory available, as judged by the crawler's
|
|
78
|
+
* {@link ConcurrencySystem}.
|
|
79
|
+
* Concurrency is tuned via the `minConcurrency`, `maxConcurrency` and `maxRequestsPerMinute` options of the
|
|
80
|
+
* constructor, or, for finer control, by injecting a pre-configured
|
|
81
|
+
* {@link ConcurrencySystem|`concurrencySystem`}.
|
|
70
82
|
*
|
|
71
83
|
* **Example usage:**
|
|
72
84
|
*
|
|
@@ -92,108 +104,137 @@ const HTTP_OPTIMIZED_AUTOSCALED_POOL_OPTIONS = {
|
|
|
92
104
|
* @category Crawlers
|
|
93
105
|
*/
|
|
94
106
|
export class HttpCrawler extends BasicCrawler {
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
107
|
+
// Internal storage uses the base (non-extended) context types. The public option types are
|
|
108
|
+
// extension-aware for consumer DX, but internally the pipeline composes hooks against the
|
|
109
|
+
// concrete crawling context, which does not statically carry `ContextExtension`. The members
|
|
110
|
+
// added by `extendContext` are present at runtime regardless.
|
|
111
|
+
#preNavigationHooks;
|
|
112
|
+
#postNavigationHooks;
|
|
113
|
+
#saveResponseCookies;
|
|
114
|
+
#navigationTimeoutMillis;
|
|
115
|
+
#ignoreTlsErrors;
|
|
116
|
+
#suggestResponseEncoding;
|
|
117
|
+
#forceResponseEncoding;
|
|
118
|
+
#supportedMimeTypes;
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
106
122
|
static optionsShape = {
|
|
107
123
|
...BasicCrawler.optionsShape,
|
|
108
|
-
navigationTimeoutSecs:
|
|
109
|
-
|
|
110
|
-
additionalMimeTypes:
|
|
111
|
-
suggestResponseEncoding:
|
|
112
|
-
forceResponseEncoding:
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
preNavigationHooks: ow.optional.array,
|
|
117
|
-
postNavigationHooks: ow.optional.array,
|
|
124
|
+
navigationTimeoutSecs: schemas.anyNumber.default(30),
|
|
125
|
+
ignoreTlsErrors: z.boolean().default(true),
|
|
126
|
+
additionalMimeTypes: schemas.arrayOf(z.string(), 'strings').default(() => []),
|
|
127
|
+
suggestResponseEncoding: z.string().optional(),
|
|
128
|
+
forceResponseEncoding: z.string().optional(),
|
|
129
|
+
saveResponseCookies: z.boolean().default(true),
|
|
130
|
+
preNavigationHooks: schemas.anyArray.default(() => []),
|
|
131
|
+
postNavigationHooks: schemas.anyArray.default(() => []),
|
|
118
132
|
};
|
|
133
|
+
/** @internal */
|
|
134
|
+
static optionsSchema = z.strictObject(HttpCrawler.optionsShape);
|
|
119
135
|
/**
|
|
120
136
|
* All `HttpCrawlerOptions` parameters are passed via an options object.
|
|
121
137
|
*/
|
|
122
|
-
constructor(options = {}
|
|
123
|
-
|
|
124
|
-
const { navigationTimeoutSecs = 30, ignoreSslErrors = true, additionalMimeTypes = [], suggestResponseEncoding, forceResponseEncoding, persistCookiesPerSession, preNavigationHooks = [], postNavigationHooks = [], additionalHttpErrorStatusCodes = [], ignoreHttpErrorStatusCodes = [],
|
|
138
|
+
constructor(options = {}) {
|
|
139
|
+
const { navigationTimeoutSecs, ignoreTlsErrors, additionalMimeTypes, suggestResponseEncoding, forceResponseEncoding, saveResponseCookies, preNavigationHooks, postNavigationHooks,
|
|
125
140
|
// BasicCrawler
|
|
126
|
-
|
|
141
|
+
contextPipelineBuilder, ...basicCrawlerOptions } = parseArgument(options, HttpCrawler.optionsSchema, 'HttpCrawlerOptions');
|
|
127
142
|
super({
|
|
128
143
|
...basicCrawlerOptions,
|
|
129
|
-
autoscaledPoolOptions,
|
|
130
144
|
contextPipelineBuilder: contextPipelineBuilder ??
|
|
131
145
|
(() => this.buildContextPipeline()),
|
|
132
|
-
}
|
|
133
|
-
this
|
|
134
|
-
// Cookies should be persisted per session only if session pool is used
|
|
135
|
-
if (!this.useSessionPool && persistCookiesPerSession) {
|
|
136
|
-
throw new Error('You cannot use "persistCookiesPerSession" without "useSessionPool" set to true.');
|
|
137
|
-
}
|
|
138
|
-
this.supportedMimeTypes = new Set([...HTML_AND_XML_MIME_TYPES, APPLICATION_JSON_MIME_TYPE]);
|
|
146
|
+
});
|
|
147
|
+
this.#supportedMimeTypes = new Set([...HTML_AND_XML_MIME_TYPES, APPLICATION_JSON_MIME_TYPE]);
|
|
139
148
|
if (additionalMimeTypes.length)
|
|
140
|
-
this.
|
|
149
|
+
this.extendSupportedMimeTypes(additionalMimeTypes);
|
|
141
150
|
if (suggestResponseEncoding && forceResponseEncoding) {
|
|
142
151
|
this.log.warning('Both forceResponseEncoding and suggestResponseEncoding options are set. Using forceResponseEncoding.');
|
|
143
152
|
}
|
|
144
|
-
this
|
|
145
|
-
this
|
|
146
|
-
this
|
|
147
|
-
this
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
this
|
|
152
|
-
|
|
153
|
+
this.#navigationTimeoutMillis = navigationTimeoutSecs * 1000;
|
|
154
|
+
this.#ignoreTlsErrors = ignoreTlsErrors;
|
|
155
|
+
this.#suggestResponseEncoding = suggestResponseEncoding;
|
|
156
|
+
this.#forceResponseEncoding = forceResponseEncoding;
|
|
157
|
+
// Cast away the extension-aware option types to the base internal storage types (see the field
|
|
158
|
+
// declarations above). This is sound - the hooks only ever receive the base context plus the
|
|
159
|
+
// members `extendContext` added at runtime.
|
|
160
|
+
this.#preNavigationHooks = preNavigationHooks;
|
|
161
|
+
this.#postNavigationHooks = [
|
|
162
|
+
({ request, response }) => this.abortDownloadOfBody(request, response),
|
|
153
163
|
...postNavigationHooks,
|
|
154
164
|
];
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
165
|
+
this.#saveResponseCookies = saveResponseCookies;
|
|
166
|
+
}
|
|
167
|
+
getNavigationTimeoutMillis() {
|
|
168
|
+
return this.#navigationTimeoutMillis;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Folds {@link HTTP_OPTIMIZED_CONCURRENCY_SYSTEM_OPTIONS} into the default system, keeping the user's
|
|
172
|
+
* concurrency shortcuts on top. Not called for a supplied
|
|
173
|
+
* {@link BasicCrawlerOptions.concurrencySystem|`concurrencySystem`} — spread the constant into it yourself to
|
|
174
|
+
* keep the tuning.
|
|
175
|
+
*/
|
|
176
|
+
createDefaultConcurrencySystem(options) {
|
|
177
|
+
return super.createDefaultConcurrencySystem({
|
|
178
|
+
...HTTP_OPTIMIZED_CONCURRENCY_SYSTEM_OPTIONS,
|
|
179
|
+
...options,
|
|
180
|
+
});
|
|
161
181
|
}
|
|
162
182
|
buildContextPipeline() {
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
183
|
+
// When navigation is skipped, `prepareHttpRequest` has already installed throwing getters for
|
|
184
|
+
// the response-derived members, so the guarded action is bypassed and the context left untouched.
|
|
185
|
+
const skipGuard = (action) => async (ctx) => (ctx.request.skipNavigation ? {} : ((await action(ctx)) ?? {}));
|
|
186
|
+
// A single navigation window covers the pre-navigation hooks, the navigation, and the post-navigation
|
|
187
|
+
// hooks: the whole phase shares one `navigationTimeoutSecs` budget, so a slow hook eats into the same
|
|
188
|
+
// window the navigation uses instead of each step being timed on its own.
|
|
189
|
+
const navigationTimedOut = `Navigation timed out after ${this.#navigationTimeoutMillis / 1000} seconds.`;
|
|
190
|
+
const windowGuard = (step) => skipGuard(async (ctx) => {
|
|
191
|
+
const remaining = remainingNavigationWindowMillis(ctx, this.#navigationTimeoutMillis);
|
|
192
|
+
if (remaining <= 0) {
|
|
193
|
+
throw new TimeoutError(navigationTimedOut);
|
|
194
|
+
}
|
|
195
|
+
return addTimeoutToPromise(async () => step(ctx), remaining, navigationTimedOut);
|
|
196
|
+
});
|
|
197
|
+
let pipeline = ContextPipeline.create().compose(this.prepareHttpRequest.bind(this));
|
|
198
|
+
for (const hook of this.#preNavigationHooks) {
|
|
199
|
+
pipeline = pipeline.compose(windowGuard(hook));
|
|
200
|
+
}
|
|
201
|
+
let pipelineWithNavigation = pipeline.compose(skipGuard(this.makeHttpRequest.bind(this)));
|
|
202
|
+
for (const hook of this.#postNavigationHooks) {
|
|
203
|
+
pipelineWithNavigation = pipelineWithNavigation.compose(windowGuard(hook));
|
|
204
|
+
}
|
|
205
|
+
return pipelineWithNavigation
|
|
206
|
+
.compose(this.processHttpResponse.bind(this))
|
|
207
|
+
.compose(this.handleBlockedRequestByContent.bind(this));
|
|
169
208
|
}
|
|
170
|
-
async
|
|
171
|
-
const { request
|
|
209
|
+
async prepareHttpRequest(crawlingContext) {
|
|
210
|
+
const { request } = crawlingContext;
|
|
172
211
|
if (request.skipNavigation) {
|
|
173
212
|
return {
|
|
174
213
|
request: new Proxy(request, {
|
|
175
214
|
get(target, propertyName, receiver) {
|
|
176
215
|
if (propertyName === 'loadedUrl') {
|
|
177
|
-
throw new
|
|
216
|
+
throw new NavigationSkippedError('The `request.loadedUrl` property is not available - `skipNavigation` was used');
|
|
178
217
|
}
|
|
179
218
|
return Reflect.get(target, propertyName, receiver);
|
|
180
219
|
},
|
|
181
220
|
}),
|
|
182
221
|
get response() {
|
|
183
|
-
throw new
|
|
222
|
+
throw new NavigationSkippedError('The `response` property is not available - `skipNavigation` was used');
|
|
184
223
|
},
|
|
185
224
|
};
|
|
186
225
|
}
|
|
187
|
-
const preNavigationHooksCookies = this._getCookieHeaderFromRequest(request);
|
|
188
226
|
request.state = RequestState.BEFORE_NAV;
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
227
|
+
return {};
|
|
228
|
+
}
|
|
229
|
+
// oxlint-disable-next-line crawlee/prefer-private-fields -- patched by @crawlee/otel
|
|
230
|
+
async makeHttpRequest(crawlingContext) {
|
|
192
231
|
tryCancel();
|
|
193
|
-
const
|
|
194
|
-
const cookieString = this._applyCookies(crawlingContext, preNavigationHooksCookies, postNavigationHooksCookies);
|
|
232
|
+
const { request, session } = crawlingContext;
|
|
195
233
|
const proxyUrl = crawlingContext.proxyInfo?.url;
|
|
196
|
-
|
|
234
|
+
// Bound the request by whatever is left of the shared navigation window (the pre-navigation hooks may
|
|
235
|
+
// have already spent part of it), so it produces a clean navigation-timeout error rather than the raw
|
|
236
|
+
// client abort.
|
|
237
|
+
const httpResponse = await addTimeoutToPromise(async () => this.requestFunction({ request, session, proxyUrl }), Math.max(1, remainingNavigationWindowMillis(crawlingContext, this.#navigationTimeoutMillis)), `Navigation timed out after ${this.#navigationTimeoutMillis / 1000} seconds.`);
|
|
197
238
|
tryCancel();
|
|
198
239
|
request.loadedUrl = httpResponse?.url;
|
|
199
240
|
request.state = RequestState.AFTER_NAV;
|
|
@@ -203,46 +244,81 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
203
244
|
if (crawlingContext.request.skipNavigation) {
|
|
204
245
|
return {
|
|
205
246
|
get contentType() {
|
|
206
|
-
throw new
|
|
247
|
+
throw new NavigationSkippedError('The `contentType` property is not available - `skipNavigation` was used');
|
|
207
248
|
},
|
|
208
249
|
get body() {
|
|
209
|
-
throw new
|
|
250
|
+
throw new NavigationSkippedError('The `body` property is not available - `skipNavigation` was used');
|
|
210
251
|
},
|
|
211
252
|
get json() {
|
|
212
|
-
throw new
|
|
253
|
+
throw new NavigationSkippedError('The `json` property is not available - `skipNavigation` was used');
|
|
213
254
|
},
|
|
214
255
|
get waitForSelector() {
|
|
215
|
-
throw new
|
|
256
|
+
throw new NavigationSkippedError('The `waitForSelector` method is not available - `skipNavigation` was used');
|
|
216
257
|
},
|
|
217
258
|
get parseWithCheerio() {
|
|
218
|
-
throw new
|
|
259
|
+
throw new NavigationSkippedError('The `parseWithCheerio` method is not available - `skipNavigation` was used');
|
|
219
260
|
},
|
|
220
261
|
};
|
|
221
262
|
}
|
|
222
|
-
await this._executeHooks(this.postNavigationHooks, crawlingContext);
|
|
223
263
|
tryCancel();
|
|
224
|
-
|
|
264
|
+
// Before `parseResponse`, which throws for error status codes - a 429 the user opted into treating as an
|
|
265
|
+
// error is still a rate limit the domain should back off from.
|
|
266
|
+
if (crawlingContext.response.status === 429) {
|
|
267
|
+
const retryAfter = crawlingContext.response.headers.get('retry-after');
|
|
268
|
+
if (this.recordDomainRateLimit(crawlingContext.request.url, retryAfter)) {
|
|
269
|
+
// This is the one path that never reads the body, so cancel it to release the connection
|
|
270
|
+
// rather than leaving it to the garbage collector.
|
|
271
|
+
await crawlingContext.response.body?.cancel().catch(() => { });
|
|
272
|
+
throw new RequestThrottledError(`${crawlingContext.request.url} responded with 429.`);
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
// Reading the body is still part of the navigation, so it draws from the same shared window: on a server
|
|
276
|
+
// that streams the body slowly the request completes (headers arrive) but the body read would otherwise
|
|
277
|
+
// run unbounded. `extendTimeout` from a post-navigation hook has already pushed this deadline out if asked.
|
|
278
|
+
const remaining = remainingNavigationWindowMillis(crawlingContext, this.#navigationTimeoutMillis);
|
|
279
|
+
if (remaining <= 0) {
|
|
280
|
+
throw new TimeoutError(`Navigation timed out after ${this.#navigationTimeoutMillis / 1000} seconds.`);
|
|
281
|
+
}
|
|
282
|
+
const parsed = await addTimeoutToPromise(async () => this.parseResponse(crawlingContext.request, crawlingContext.response), remaining, `Navigation timed out after ${this.#navigationTimeoutMillis / 1000} seconds.`);
|
|
225
283
|
tryCancel();
|
|
226
284
|
const response = parsed.response;
|
|
227
285
|
const contentType = parsed.contentType;
|
|
286
|
+
const loadBody = async () => {
|
|
287
|
+
const { load } = await import('cheerio/slim');
|
|
288
|
+
return load(parsed.body.toString(), { xmlMode: contentType.type.includes('xml') });
|
|
289
|
+
};
|
|
228
290
|
const waitForSelector = async (selector, _timeoutMs) => {
|
|
229
|
-
const $ =
|
|
291
|
+
const $ = await loadBody();
|
|
230
292
|
if ($(selector).get().length === 0) {
|
|
231
293
|
throw new Error(`Selector '${selector}' not found.`);
|
|
232
294
|
}
|
|
233
295
|
};
|
|
234
296
|
const parseWithCheerio = async (selector, timeoutMs) => {
|
|
235
|
-
const $ =
|
|
297
|
+
const $ = await loadBody();
|
|
236
298
|
if (selector) {
|
|
237
299
|
await crawlingContext.waitForSelector(selector, timeoutMs);
|
|
238
300
|
}
|
|
239
301
|
return $;
|
|
240
302
|
};
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
303
|
+
this.throwOnBlockedRequest(response.status);
|
|
304
|
+
if (this.#saveResponseCookies) {
|
|
305
|
+
try {
|
|
306
|
+
for (const cookie of getCookiesFromResponse(response)) {
|
|
307
|
+
if (!cookie)
|
|
308
|
+
continue;
|
|
309
|
+
try {
|
|
310
|
+
await crawlingContext.session.cookieJar.setCookie(cookie, response.url, {
|
|
311
|
+
ignoreError: false,
|
|
312
|
+
});
|
|
313
|
+
}
|
|
314
|
+
catch (e) {
|
|
315
|
+
this.log.debug(`Could not set cookie: ${e.message}`);
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
catch (e) {
|
|
320
|
+
this.log.exception(e, 'Could not get cookies from response');
|
|
321
|
+
}
|
|
246
322
|
}
|
|
247
323
|
return {
|
|
248
324
|
get json() {
|
|
@@ -273,47 +349,28 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
273
349
|
return `Found selectors: ${foundSelectors.join(', ')}`;
|
|
274
350
|
}
|
|
275
351
|
}
|
|
276
|
-
|
|
277
|
-
// eslint-disable-next-line dot-notation
|
|
278
|
-
(this.sessionPool?.['blockedStatusCodes'].length ?? 0) > 0
|
|
279
|
-
? // eslint-disable-next-line dot-notation
|
|
280
|
-
this.sessionPool['blockedStatusCodes']
|
|
281
|
-
: BLOCKED_STATUS_CODES;
|
|
282
|
-
if (blockedStatusCodes.includes(crawlingContext.response.status)) {
|
|
352
|
+
if (this.blockedStatusCodes.has(crawlingContext.response.status)) {
|
|
283
353
|
return `Blocked by status code ${crawlingContext.response.status}`;
|
|
284
354
|
}
|
|
285
355
|
return false;
|
|
286
356
|
}
|
|
287
|
-
/**
|
|
288
|
-
* Returns the `Cookie` header value based on the current context and
|
|
289
|
-
* any changes that occurred in the navigation hooks.
|
|
290
|
-
*/
|
|
291
|
-
_applyCookies({ session, request }, preHookCookies, postHookCookies) {
|
|
292
|
-
const sessionCookie = session?.getCookieString(request.url) ?? '';
|
|
293
|
-
const sourceCookies = [sessionCookie, preHookCookies, postHookCookies];
|
|
294
|
-
return mergeCookies(request.url, sourceCookies);
|
|
295
|
-
}
|
|
296
357
|
/**
|
|
297
358
|
* Function to make the HTTP request. It performs optimizations
|
|
298
359
|
* on the request such as only downloading the request body if the
|
|
299
360
|
* received content type matches text/html, application/xml, application/xhtml+xml.
|
|
300
361
|
*/
|
|
301
|
-
async
|
|
302
|
-
|
|
303
|
-
// @ts-ignore
|
|
304
|
-
({ TimeoutError } = await import('got-scraping'));
|
|
305
|
-
}
|
|
306
|
-
const opts = this._getRequestOptions(request, session, proxyUrl);
|
|
362
|
+
async requestFunction({ request, session, proxyUrl }) {
|
|
363
|
+
const opts = this.getRequestOptions(request, session, proxyUrl);
|
|
307
364
|
try {
|
|
308
|
-
return await this.
|
|
365
|
+
return await this.requestAsBrowser(opts, session);
|
|
309
366
|
}
|
|
310
367
|
catch (e) {
|
|
311
|
-
if (e instanceof TimeoutError) {
|
|
312
|
-
this.
|
|
313
|
-
return new Response(); // this will never happen, as
|
|
368
|
+
if (e instanceof Error && e.constructor.name === 'TimeoutError') {
|
|
369
|
+
this.handleRequestTimeout(session);
|
|
370
|
+
return new Response(); // this will never happen, as handleRequestTimeout always throws
|
|
314
371
|
}
|
|
315
372
|
if (this.isProxyError(e)) {
|
|
316
|
-
throw new SessionError(this.
|
|
373
|
+
throw new SessionError(this.getMessageFromError(e));
|
|
317
374
|
}
|
|
318
375
|
else {
|
|
319
376
|
throw e;
|
|
@@ -323,18 +380,15 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
323
380
|
/**
|
|
324
381
|
* Encodes and parses response according to the provided content type
|
|
325
382
|
*/
|
|
326
|
-
async
|
|
383
|
+
async parseResponse(request, response) {
|
|
327
384
|
const { status } = response;
|
|
328
385
|
const { type, charset } = parseContentTypeFromResponse(response);
|
|
329
|
-
const { response: reencodedResponse, encoding } = this._encodeResponse(request, response, charset);
|
|
330
|
-
const contentType = { type, encoding };
|
|
331
386
|
if (status >= 400 && status <= 599) {
|
|
332
|
-
this.
|
|
387
|
+
this.statistics.registerStatusCode(status);
|
|
333
388
|
}
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
const body = await reencodedResponse.text(); // TODO - this always uses UTF-8 (see https://developer.mozilla.org/en-US/docs/Web/API/Request/text)
|
|
389
|
+
if (this.isErrorStatusCode(status)) {
|
|
390
|
+
const { response: decoded } = this.encodeResponse(request, response, charset);
|
|
391
|
+
const body = await decoded.text(); // TODO - this always uses UTF-8 (see https://developer.mozilla.org/en-US/docs/Web/API/Request/text)
|
|
338
392
|
// Errors are often sent as JSON, so attempt to parse them,
|
|
339
393
|
// despite Accept header being set to text/html.
|
|
340
394
|
if (type === APPLICATION_JSON_MIME_TYPE) {
|
|
@@ -344,60 +398,61 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
344
398
|
message = util.inspect(errorResponse, { depth: 1, maxArrayLength: 10 });
|
|
345
399
|
throw new Error(`${status} - ${message}`);
|
|
346
400
|
}
|
|
347
|
-
if (
|
|
401
|
+
if (this.additionalHttpErrorStatusCodes.has(status)) {
|
|
348
402
|
throw new Error(`${status} - Error status code was set by user.`);
|
|
349
403
|
}
|
|
350
404
|
// It's not a JSON, so it's probably some text. Get the first 100 chars of it.
|
|
351
405
|
throw new Error(`${status} - Internal Server Error: ${body.slice(0, 100)}`);
|
|
352
406
|
}
|
|
353
|
-
|
|
354
|
-
|
|
407
|
+
if (HTML_AND_XML_MIME_TYPES.includes(type) && !charset && !this.#forceResponseEncoding) {
|
|
408
|
+
// The charset comes from the document itself, so the raw bytes are what we need -
|
|
409
|
+
// decoding them through `encodeResponse` first would consume the body for nothing.
|
|
410
|
+
const rawBytes = Buffer.from(await response.arrayBuffer());
|
|
411
|
+
const metaCharset = extractCharsetFromHtmlBytes(rawBytes);
|
|
412
|
+
const charsetToUse = metaCharset ?? this.#suggestResponseEncoding ?? 'utf-8';
|
|
413
|
+
const body = iconv.encodingExists(charsetToUse)
|
|
414
|
+
? iconv.decode(rawBytes, charsetToUse)
|
|
415
|
+
: rawBytes.toString('utf8');
|
|
416
|
+
return { response, contentType: { type, encoding: 'utf-8' }, body };
|
|
355
417
|
}
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
response,
|
|
361
|
-
contentType,
|
|
362
|
-
};
|
|
418
|
+
const { response: reencodedResponse, encoding } = this.encodeResponse(request, response, charset);
|
|
419
|
+
const contentType = { type, encoding };
|
|
420
|
+
if (HTML_AND_XML_MIME_TYPES.includes(type)) {
|
|
421
|
+
return { response, contentType, body: await reencodedResponse.text() };
|
|
363
422
|
}
|
|
423
|
+
return {
|
|
424
|
+
body: Buffer.from(await reencodedResponse.bytes()),
|
|
425
|
+
response,
|
|
426
|
+
contentType,
|
|
427
|
+
};
|
|
364
428
|
}
|
|
365
429
|
/**
|
|
366
430
|
* Combines the provided `requestOptions` with mandatory (non-overridable) values.
|
|
367
431
|
*/
|
|
368
|
-
|
|
432
|
+
getRequestOptions(request, session, proxyUrl) {
|
|
369
433
|
const requestOptions = {
|
|
370
434
|
url: request.url,
|
|
371
435
|
method: request.method,
|
|
372
436
|
proxyUrl,
|
|
373
|
-
timeout:
|
|
374
|
-
cookieJar: this.persistCookiesPerSession ? session?.cookieJar : undefined,
|
|
437
|
+
timeout: this.#navigationTimeoutMillis,
|
|
375
438
|
sessionToken: session,
|
|
376
439
|
headers: request.headers,
|
|
377
|
-
https: {
|
|
378
|
-
rejectUnauthorized: !this.ignoreSslErrors,
|
|
379
|
-
},
|
|
380
440
|
body: undefined,
|
|
381
441
|
};
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
if (session?.proxyInfo?.ignoreTlsErrors) {
|
|
386
|
-
requestOptions.https = {
|
|
387
|
-
...requestOptions.https,
|
|
388
|
-
rejectUnauthorized: false,
|
|
389
|
-
};
|
|
442
|
+
if (requestOptions.headers?.cookie || requestOptions.headers?.Cookie) {
|
|
443
|
+
requestOptions.headers.Cookie = this.getCookieHeaderFromRequest(request);
|
|
444
|
+
delete requestOptions.headers.cookie;
|
|
390
445
|
}
|
|
391
446
|
if (/PATCH|POST|PUT/.test(request.method))
|
|
392
447
|
requestOptions.body = request.payload ?? '';
|
|
393
448
|
return requestOptions;
|
|
394
449
|
}
|
|
395
|
-
|
|
396
|
-
if (this
|
|
397
|
-
encoding = this
|
|
450
|
+
encodeResponse(request, response, encoding) {
|
|
451
|
+
if (this.#forceResponseEncoding) {
|
|
452
|
+
encoding = this.#forceResponseEncoding;
|
|
398
453
|
}
|
|
399
|
-
else if (!encoding && this
|
|
400
|
-
encoding = this
|
|
454
|
+
else if (!encoding && this.#suggestResponseEncoding) {
|
|
455
|
+
encoding = this.#suggestResponseEncoding;
|
|
401
456
|
}
|
|
402
457
|
// Fall back to utf-8 if we still don't have encoding.
|
|
403
458
|
const utf8 = 'utf8';
|
|
@@ -410,7 +465,9 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
410
465
|
// Try to re-encode a variety of unsupported encodings to utf-8
|
|
411
466
|
if (iconv.encodingExists(encoding)) {
|
|
412
467
|
const encodeStream = iconv.encodeStream(utf8);
|
|
413
|
-
const decodeStream = iconv
|
|
468
|
+
const decodeStream = iconv
|
|
469
|
+
.decodeStream(encoding)
|
|
470
|
+
.on('error', (err) => encodeStream.emit('error', err));
|
|
414
471
|
const reencodedBody = response.body
|
|
415
472
|
? Readable.toWeb(Readable.from(Readable.fromWeb(response.body)
|
|
416
473
|
.pipe(decodeStream)
|
|
@@ -426,15 +483,15 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
426
483
|
/**
|
|
427
484
|
* Checks and extends supported mime types
|
|
428
485
|
*/
|
|
429
|
-
|
|
486
|
+
extendSupportedMimeTypes(additionalMimeTypes) {
|
|
430
487
|
for (const mimeType of additionalMimeTypes) {
|
|
431
488
|
if (mimeType === '*/*') {
|
|
432
|
-
this
|
|
489
|
+
this.#supportedMimeTypes.add(mimeType);
|
|
433
490
|
continue;
|
|
434
491
|
}
|
|
435
492
|
try {
|
|
436
493
|
const parsedType = contentTypeParser.parse(mimeType);
|
|
437
|
-
this
|
|
494
|
+
this.#supportedMimeTypes.add(parsedType.type);
|
|
438
495
|
}
|
|
439
496
|
catch (err) {
|
|
440
497
|
throw new Error(`Can not parse mime type ${mimeType} from "options.additionalMimeTypes".`);
|
|
@@ -444,38 +501,39 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
444
501
|
/**
|
|
445
502
|
* Handles timeout request
|
|
446
503
|
*/
|
|
447
|
-
|
|
448
|
-
session
|
|
449
|
-
throw new Error(`
|
|
504
|
+
handleRequestTimeout(session) {
|
|
505
|
+
session.markBad();
|
|
506
|
+
throw new Error(`Request timed out after ${this.#navigationTimeoutMillis / 1000} seconds.`);
|
|
450
507
|
}
|
|
451
|
-
|
|
508
|
+
abortDownloadOfBody(request, response) {
|
|
452
509
|
const { status } = response;
|
|
453
510
|
const { type } = parseContentTypeFromResponse(response);
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
// if we retry the request, can the Content-Type change?
|
|
457
|
-
const isTransientContentType = status >= 500 || blockedStatusCodes.includes(status);
|
|
458
|
-
if (!this.supportedMimeTypes.has(type) && !this.supportedMimeTypes.has('*/*') && !isTransientContentType) {
|
|
511
|
+
const isTransientContentType = status >= 500 || this.blockedStatusCodes.has(status);
|
|
512
|
+
if (!this.#supportedMimeTypes.has(type) && !this.#supportedMimeTypes.has('*/*') && !isTransientContentType) {
|
|
459
513
|
request.noRetry = true;
|
|
460
514
|
throw new Error(`Resource ${request.url} served Content-Type ${type}, ` +
|
|
461
|
-
`but only ${Array.from(this
|
|
515
|
+
`but only ${Array.from(this.#supportedMimeTypes).join(', ')} are allowed. Skipping resource.`);
|
|
462
516
|
}
|
|
463
517
|
}
|
|
464
518
|
/**
|
|
465
519
|
* @internal wraps public utility for mocking purposes
|
|
466
520
|
*/
|
|
467
|
-
|
|
521
|
+
requestAsBrowser = async (options, session) => {
|
|
468
522
|
const opts = processHttpRequestOptions({
|
|
469
523
|
...options,
|
|
470
|
-
cookieJar: options.cookieJar,
|
|
471
524
|
responseType: 'text',
|
|
472
525
|
});
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
526
|
+
// When saveResponseCookies is false, the response cookies must not mutate the
|
|
527
|
+
// session jar. Reads still go through the session (so session.setCookie() in pre-nav
|
|
528
|
+
// hooks keeps working) but a per-request clone is passed in so writes are discarded.
|
|
529
|
+
const cookieJar = this.#saveResponseCookies ? session.cookieJar : await session.cookieJar.clone();
|
|
530
|
+
// Bind the request to the shared navigation window instead of a fixed per-request timeout, so
|
|
531
|
+
// `extendTimeout()` can push the deadline and a fixed `AbortSignal.timeout` won't fire on its own and
|
|
532
|
+
// kill a lazily-read body mid-extension. This aborts the socket only during the header phase; the body
|
|
533
|
+
// read is bounded separately at the promise level (see `processHttpResponse`), so a slow-streaming body
|
|
534
|
+
// still fails cleanly with a navigation timeout, though the socket is left to close on its own.
|
|
535
|
+
const cancelSignal = storage.getStore()?.cancelTask.signal;
|
|
536
|
+
const response = await this.httpClient.sendRequest(new Request(opts.url, {
|
|
479
537
|
body: opts.body ? Readable.toWeb(opts.body) : undefined,
|
|
480
538
|
headers: new Headers(opts.headers),
|
|
481
539
|
method: opts.method,
|
|
@@ -483,45 +541,14 @@ export class HttpCrawler extends BasicCrawler {
|
|
|
483
541
|
duplex: 'half',
|
|
484
542
|
}), {
|
|
485
543
|
session,
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
const cookieStringRedirected = session.getCookieString(updatedRequest.url.toString());
|
|
491
|
-
if (cookieStringRedirected !== '') {
|
|
492
|
-
updatedRequest.headers.set('Cookie', cookieStringRedirected);
|
|
493
|
-
}
|
|
494
|
-
}
|
|
495
|
-
},
|
|
544
|
+
cookieJar,
|
|
545
|
+
signal: cancelSignal,
|
|
546
|
+
timeoutMillis: cancelSignal ? undefined : opts.timeout,
|
|
547
|
+
ignoreTlsErrors: this.#ignoreTlsErrors,
|
|
496
548
|
});
|
|
497
549
|
return response;
|
|
498
550
|
};
|
|
499
551
|
}
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
* This instance can then serve as a `requestHandler` of your {@link HttpCrawler}.
|
|
503
|
-
* Defaults to the {@link HttpCrawlingContext}.
|
|
504
|
-
*
|
|
505
|
-
* > Serves as a shortcut for using `Router.create<HttpCrawlingContext>()`.
|
|
506
|
-
*
|
|
507
|
-
* ```ts
|
|
508
|
-
* import { HttpCrawler, createHttpRouter } from 'crawlee';
|
|
509
|
-
*
|
|
510
|
-
* const router = createHttpRouter();
|
|
511
|
-
* router.addHandler('label-a', async (ctx) => {
|
|
512
|
-
* ctx.log.info('...');
|
|
513
|
-
* });
|
|
514
|
-
* router.addDefaultHandler(async (ctx) => {
|
|
515
|
-
* ctx.log.info('...');
|
|
516
|
-
* });
|
|
517
|
-
*
|
|
518
|
-
* const crawler = new HttpCrawler({
|
|
519
|
-
* requestHandler: router,
|
|
520
|
-
* });
|
|
521
|
-
* await crawler.run();
|
|
522
|
-
* ```
|
|
523
|
-
*/
|
|
524
|
-
export function createHttpRouter(routes) {
|
|
525
|
-
return Router.create(routes);
|
|
552
|
+
export function createHttpRouter(routesOrSchemas) {
|
|
553
|
+
return Router.create(routesOrSchemas);
|
|
526
554
|
}
|
|
527
|
-
//# sourceMappingURL=http-crawler.js.map
|