@arcblock/crawler 1.1.2 → 1.1.4

package/README.md

@@ -61,6 +61,8 @@ If not referenced by a Blocklet, some dependent Blocklet environment variables n
 
 - `BLOCKLET_DATA_DIR`: (Required) The directory to save webpage screenshots and HTML source files obtained by the crawler.
 
+- `BLOCKLET_LOG_DIR`: (Required) Directory path for storing @blocklet/logger logs
+
 ## SQLite
 
 When `initCrawler` is called, it attempts to create an SQLite database at `BLOCKLET_DATA_DIR`. This database is used to cache HTML content and screenshot. Please ensure that the deployment environment supports SQLite.

package/lib/cjs/crawler.d.ts

@@ -5,17 +5,8 @@ export declare function getDataDir(): Promise<{
     htmlDir: string;
     screenshotDir: string;
 }>;
-export declare const getPageContent: ({ url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage, }: {
-    url: string;
-    includeScreenshot?: boolean;
-    includeHtml?: boolean;
-    width?: number;
-    height?: number;
-    quality?: number;
-    timeout?: number;
-    fullPage?: boolean;
-}) => Promise<{
-    html: string;
+export declare const getPageContent: ({ url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage, headers, }: JobState) => Promise<{
+    html: string | null;
     screenshot: Uint8Array<ArrayBufferLike> | null;
     meta: {
         title?: string;
@@ -27,4 +18,4 @@ export declare const getPageContent: ({ url, includeScreenshot, includeHtml, wid
  * @param params
  * @param callback callback when job finished
  */
-export declare function crawlUrl(params: Omit<JobState, 'jobId'>, callback?: (snapshot: SnapshotModel | null) => void): Promise<string | undefined>;
+export declare function crawlUrl(params: Omit<JobState, 'jobId'>, callback?: (snapshot: SnapshotModel | null) => void): Promise<string>;

package/lib/cjs/crawler.js

@@ -137,18 +137,14 @@ function saveSnapshotToLocal(_a) {
         };
     });
 }
-function formatHtml(htmlString) {
-    if (htmlString.includes('<h2>Unexpected Application Error!</h2>')) {
-        return '';
-    }
-    return htmlString;
-}
-const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, includeScreenshot = true, includeHtml = true, width = 1440, height = 900, quality = 80, timeout = 90 * 1000, fullPage = false, }) {
-    config_1.logger.debug('getPageContent', { url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage });
+const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, includeScreenshot = true, includeHtml = true, width = 1440, height = 900, quality = 80, timeout = 90 * 1000, fullPage = false, headers, }) {
     const page = yield (0, puppeteer_1.initPage)();
     if (width && height) {
         yield page.setViewport({ width, height, deviceScaleFactor: 2 });
     }
+    if (headers) {
+        yield page.setExtraHTTPHeaders(headers);
+    }
     let html = null;
     let screenshot = null;
     const meta = {};
@@ -158,7 +154,6 @@ const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url,
             throw new Error(`Failed to load page: response is null for ${url}`);
         }
         const statusCode = response.status();
-        config_1.logger.debug('getPageContent.response', { response, statusCode });
         if (![200, 304].includes(statusCode)) {
             throw new Error(`Request failed with status ${statusCode}, in ${url}`);
         }
@@ -207,6 +202,11 @@ const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url,
                     description,
                 };
             });
+            // check if the page is an error page
+            const isErrorPage = ['<h2>Unexpected Application Error!</h2>', 'Current route occurred an error'].some((errorHtml) => data.html.includes(errorHtml));
+            if (isErrorPage) {
+                throw new Error('Page is an error page');
+            }
             meta.title = data.title;
             meta.description = data.description;
             if (includeHtml) {
@@ -225,7 +225,6 @@ const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url,
     finally {
         yield page.close();
     }
-    html = formatHtml(html || '');
     return {
         html,
         screenshot,
@@ -238,24 +237,17 @@ exports.getPageContent = getPageContent;
  * @param params
  * @param callback callback when job finished
  */
+// eslint-disable-next-line require-await
 function crawlUrl(params, callback) {
     return __awaiter(this, void 0, void 0, function* () {
         params = Object.assign(Object.assign({}, params), { url: (0, utils_1.formatUrl)(params.url) });
         // skip duplicate job
-        const { job: duplicateJob } = (yield job_1.Job.findJob({
-            url: params.url,
-            includeScreenshot: params.includeScreenshot,
-            includeHtml: params.includeHtml,
-            quality: params.quality,
-            width: params.width,
-            height: params.height,
-            fullPage: params.fullPage,
-        })) || {};
-        if (duplicateJob) {
+        const existsJob = yield job_1.Job.isExists(params);
+        if (existsJob) {
             config_1.logger.info(`Crawl job already exists for ${params.url}, skip`);
-            return duplicateJob.id;
+            return existsJob.id;
         }
-        config_1.logger.info('create crawl job', params);
+        config_1.logger.info('enqueue crawl job', params);
         const jobId = (0, crypto_1.randomUUID)();
         const job = crawlQueue.push(Object.assign(Object.assign({}, params), { id: jobId }));
         job.on('finished', (_a) => __awaiter(this, [_a], void 0, function* ({ result }) {

package/lib/cjs/site.d.ts

@@ -1,2 +1,2 @@
 import { Site } from './config';
-export declare const crawlSite: ({ url, pathname, interval }: Site) => Promise<(string | null | undefined)[]>;
+export declare const crawlSite: ({ url, pathname, interval }: Site) => Promise<(string | null)[]>;

package/lib/cjs/site.js

@@ -42,6 +42,7 @@ const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, path
     });
     config_1.logger.info(`Found ${sitemapItems.length} sitemap items which match ${pathname} from ${url}`);
     let processCount = 0;
+    let crawlCount = 0;
     crawlBlockletRunningMap.set(key, true);
     try {
         const jobIds = yield (0, p_map_1.default)(sitemapItems, (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, sitemapItem }) {
@@ -58,7 +59,13 @@ const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, path
                     return null;
                 }
             }
-            config_1.logger.debug(`Sitemap process ${processCount} / ${sitemapItems.length}`);
+            config_1.logger.debug(`Sitemap process ${processCount} / ${sitemapItems.length}`, {
+                snapshotExists: !!snapshot,
+                lastModified: snapshot === null || snapshot === void 0 ? void 0 : snapshot.lastModified,
+                sitemapLastmod: sitemapItem.lastmod,
+                url,
+            });
+            crawlCount++;
             return (0, crawler_1.crawlUrl)({
                 url,
                 lastModified: sitemapItem.lastmod,
@@ -66,6 +73,12 @@ const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, path
                 includeHtml: true,
             });
         }), { concurrency: config_1.config.siteCron.sitemapConcurrency });
+        config_1.logger.info('Enqueued jobs from sitemap finished', {
+            url,
+            pathname,
+            processCount,
+            crawlCount,
+        });
         return jobIds;
     }
     catch (error) {

package/lib/cjs/store/job.d.ts

@@ -11,6 +11,7 @@ export interface JobState {
     timeout?: number;
     fullPage?: boolean;
     lastModified?: string;
+    headers?: Record<string, string>;
 }
 export interface JobModel {
     id: string;
@@ -31,4 +32,7 @@ export declare class Job extends Model<JobModel> implements JobModel {
     cancelled: JobModel['cancelled'];
     static initModel(sequelize: Sequelize): typeof Job;
     static findJob(condition: Partial<JobState>): Promise<JobModel | null>;
+    static isExists(condition: Partial<JobState> & {
+        url: string;
+    }): Promise<JobModel | null | undefined>;
 }

package/lib/cjs/store/job.js

@@ -41,9 +41,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Job = void 0;
 const core_1 = __importStar(require("@sequelize/core"));
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
 class Job extends core_1.Model {
     static initModel(sequelize) {
         return Job.init({
@@ -106,5 +110,22 @@ class Job extends core_1.Model {
             return (job === null || job === void 0 ? void 0 : job.toJSON()) || null;
         });
     }
+    static isExists(condition) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const jobs = yield Job.findAll({
+                where: core_1.default.where(core_1.default.fn('json_extract', core_1.default.col('job'), '$.url'), condition.url),
+            });
+            if (!(jobs === null || jobs === void 0 ? void 0 : jobs.length)) {
+                return null;
+            }
+            const existsJob = jobs.find((job) => {
+                const jobModel = job.get('job');
+                return Object.keys(condition).every((key) => {
+                    return (0, isEqual_1.default)(condition[key], jobModel[key]);
+                });
+            });
+            return existsJob === null || existsJob === void 0 ? void 0 : existsJob.get();
+        });
+    }
 }
 exports.Job = Job;

package/lib/cjs/store/snapshot.d.ts

@@ -18,6 +18,7 @@ export interface SnapshotModel {
         includeHtml?: boolean;
         quality?: number;
         fullPage?: boolean;
+        headers?: Record<string, string>;
     };
 }
 export declare class Snapshot extends Model<SnapshotModel> implements SnapshotModel {

package/lib/cjs/utils.js

@@ -153,7 +153,7 @@ exports.isSelfCrawler = isSelfCrawler;
  * Check if the request is a static file
  */
 function isStaticFile(req) {
-    const excludeUrlPattern = new RegExp(`\\.(${staticFileExtensions.join('|')})$`, 'i');
+    const excludeUrlPattern = new RegExp(`\\.(${staticFileExtensions.join('|')})([\\?#]|$)`, 'i');
     return excludeUrlPattern.test(req.path);
 }
 /**

package/lib/esm/crawler.d.ts

@@ -5,17 +5,8 @@ export declare function getDataDir(): Promise<{
     htmlDir: string;
     screenshotDir: string;
 }>;
-export declare const getPageContent: ({ url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage, }: {
-    url: string;
-    includeScreenshot?: boolean;
-    includeHtml?: boolean;
-    width?: number;
-    height?: number;
-    quality?: number;
-    timeout?: number;
-    fullPage?: boolean;
-}) => Promise<{
-    html: string;
+export declare const getPageContent: ({ url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage, headers, }: JobState) => Promise<{
+    html: string | null;
     screenshot: Uint8Array<ArrayBufferLike> | null;
     meta: {
         title?: string;
@@ -27,4 +18,4 @@ export declare const getPageContent: ({ url, includeScreenshot, includeHtml, wid
  * @param params
  * @param callback callback when job finished
  */
-export declare function crawlUrl(params: Omit<JobState, 'jobId'>, callback?: (snapshot: SnapshotModel | null) => void): Promise<string | undefined>;
+export declare function crawlUrl(params: Omit<JobState, 'jobId'>, callback?: (snapshot: SnapshotModel | null) => void): Promise<string>;

package/lib/esm/crawler.js

@@ -128,18 +128,14 @@ function saveSnapshotToLocal(_a) {
         };
     });
 }
-function formatHtml(htmlString) {
-    if (htmlString.includes('<h2>Unexpected Application Error!</h2>')) {
-        return '';
-    }
-    return htmlString;
-}
-export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, includeScreenshot = true, includeHtml = true, width = 1440, height = 900, quality = 80, timeout = 90 * 1000, fullPage = false, }) {
-    logger.debug('getPageContent', { url, includeScreenshot, includeHtml, width, height, quality, timeout, fullPage });
+export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, includeScreenshot = true, includeHtml = true, width = 1440, height = 900, quality = 80, timeout = 90 * 1000, fullPage = false, headers, }) {
     const page = yield initPage();
     if (width && height) {
         yield page.setViewport({ width, height, deviceScaleFactor: 2 });
     }
+    if (headers) {
+        yield page.setExtraHTTPHeaders(headers);
+    }
     let html = null;
     let screenshot = null;
     const meta = {};
@@ -149,7 +145,6 @@ export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function*
             throw new Error(`Failed to load page: response is null for ${url}`);
         }
         const statusCode = response.status();
-        logger.debug('getPageContent.response', { response, statusCode });
         if (![200, 304].includes(statusCode)) {
             throw new Error(`Request failed with status ${statusCode}, in ${url}`);
         }
@@ -198,6 +193,11 @@ export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function*
                     description,
                 };
             });
+            // check if the page is an error page
+            const isErrorPage = ['<h2>Unexpected Application Error!</h2>', 'Current route occurred an error'].some((errorHtml) => data.html.includes(errorHtml));
+            if (isErrorPage) {
+                throw new Error('Page is an error page');
+            }
             meta.title = data.title;
             meta.description = data.description;
             if (includeHtml) {
@@ -216,7 +216,6 @@ export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function*
     finally {
         yield page.close();
     }
-    html = formatHtml(html || '');
     return {
         html,
         screenshot,
@@ -228,24 +227,17 @@ export const getPageContent = (_a) => __awaiter(void 0, [_a], void 0, function*
  * @param params
  * @param callback callback when job finished
  */
+// eslint-disable-next-line require-await
 export function crawlUrl(params, callback) {
     return __awaiter(this, void 0, void 0, function* () {
         params = Object.assign(Object.assign({}, params), { url: formatUrl(params.url) });
         // skip duplicate job
-        const { job: duplicateJob } = (yield Job.findJob({
-            url: params.url,
-            includeScreenshot: params.includeScreenshot,
-            includeHtml: params.includeHtml,
-            quality: params.quality,
-            width: params.width,
-            height: params.height,
-            fullPage: params.fullPage,
-        })) || {};
-        if (duplicateJob) {
+        const existsJob = yield Job.isExists(params);
+        if (existsJob) {
             logger.info(`Crawl job already exists for ${params.url}, skip`);
-            return duplicateJob.id;
+            return existsJob.id;
         }
-        logger.info('create crawl job', params);
+        logger.info('enqueue crawl job', params);
         const jobId = randomUUID();
         const job = crawlQueue.push(Object.assign(Object.assign({}, params), { id: jobId }));
         job.on('finished', (_a) => __awaiter(this, [_a], void 0, function* ({ result }) {

package/lib/esm/site.d.ts

@@ -1,2 +1,2 @@
 import { Site } from './config';
-export declare const crawlSite: ({ url, pathname, interval }: Site) => Promise<(string | null | undefined)[]>;
+export declare const crawlSite: ({ url, pathname, interval }: Site) => Promise<(string | null)[]>;

package/lib/esm/site.js

@@ -36,6 +36,7 @@ export const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ ur
     });
     logger.info(`Found ${sitemapItems.length} sitemap items which match ${pathname} from ${url}`);
     let processCount = 0;
+    let crawlCount = 0;
     crawlBlockletRunningMap.set(key, true);
     try {
         const jobIds = yield pMap(sitemapItems, (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, sitemapItem }) {
@@ -52,7 +53,13 @@ export const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ ur
                     return null;
                 }
             }
-            logger.debug(`Sitemap process ${processCount} / ${sitemapItems.length}`);
+            logger.debug(`Sitemap process ${processCount} / ${sitemapItems.length}`, {
+                snapshotExists: !!snapshot,
+                lastModified: snapshot === null || snapshot === void 0 ? void 0 : snapshot.lastModified,
+                sitemapLastmod: sitemapItem.lastmod,
+                url,
+            });
+            crawlCount++;
             return crawlUrl({
                 url,
                 lastModified: sitemapItem.lastmod,
@@ -60,6 +67,12 @@ export const crawlSite = (_a) => __awaiter(void 0, [_a], void 0, function* ({ ur
                 includeHtml: true,
             });
         }), { concurrency: config.siteCron.sitemapConcurrency });
+        logger.info('Enqueued jobs from sitemap finished', {
+            url,
+            pathname,
+            processCount,
+            crawlCount,
+        });
         return jobIds;
     }
     catch (error) {

package/lib/esm/store/job.d.ts

@@ -11,6 +11,7 @@ export interface JobState {
     timeout?: number;
     fullPage?: boolean;
     lastModified?: string;
+    headers?: Record<string, string>;
 }
 export interface JobModel {
     id: string;
@@ -31,4 +32,7 @@ export declare class Job extends Model<JobModel> implements JobModel {
     cancelled: JobModel['cancelled'];
     static initModel(sequelize: Sequelize): typeof Job;
     static findJob(condition: Partial<JobState>): Promise<JobModel | null>;
+    static isExists(condition: Partial<JobState> & {
+        url: string;
+    }): Promise<JobModel | null | undefined>;
 }

package/lib/esm/store/job.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import sequelize, { DataTypes, Model } from '@sequelize/core';
+import isEqual from 'lodash/isEqual';
 export class Job extends Model {
     static initModel(sequelize) {
         return Job.init({
@@ -70,4 +71,21 @@ export class Job extends Model {
             return (job === null || job === void 0 ? void 0 : job.toJSON()) || null;
         });
     }
+    static isExists(condition) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const jobs = yield Job.findAll({
+                where: sequelize.where(sequelize.fn('json_extract', sequelize.col('job'), '$.url'), condition.url),
+            });
+            if (!(jobs === null || jobs === void 0 ? void 0 : jobs.length)) {
+                return null;
+            }
+            const existsJob = jobs.find((job) => {
+                const jobModel = job.get('job');
+                return Object.keys(condition).every((key) => {
+                    return isEqual(condition[key], jobModel[key]);
+                });
+            });
+            return existsJob === null || existsJob === void 0 ? void 0 : existsJob.get();
+        });
+    }
 }

package/lib/esm/store/snapshot.d.ts

@@ -18,6 +18,7 @@ export interface SnapshotModel {
         includeHtml?: boolean;
         quality?: number;
         fullPage?: boolean;
+        headers?: Record<string, string>;
     };
 }
 export declare class Snapshot extends Model<SnapshotModel> implements SnapshotModel {

package/lib/esm/utils.js

@@ -140,7 +140,7 @@ export const isSelfCrawler = (req) => {
  * Check if the request is a static file
  */
 export function isStaticFile(req) {
-    const excludeUrlPattern = new RegExp(`\\.(${staticFileExtensions.join('|')})$`, 'i');
+    const excludeUrlPattern = new RegExp(`\\.(${staticFileExtensions.join('|')})([\\?#]|$)`, 'i');
     return excludeUrlPattern.test(req.path);
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/crawler",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",
   "types": "lib/cjs/index.d.ts",
@@ -55,12 +55,9 @@
     "@sequelize/sqlite3": "7.0.0-alpha.46",
     "axios": "^1.7.9",
     "fs-extra": "^11.2.0",
-    "generic-pool": "^3.9.0",
     "lodash": "^4.17.21",
     "lru-cache": "^10.4.3",
-    "redis": "^4.7.0",
     "robots-parser": "^3.0.1",
-    "sequelize": "^6.37.7",
     "sitemap": "^7.1.2",
     "sqlite3": "^5.1.7",
     "ufo": "^1.5.4",