mwoffliner/lib/error.manager.js

MediaWiki ZIM scraper

import { downloadErrorPlaceholderTemplate } from './Templates.js';
import { getRelativeFilePath, interpolateTranslationString } from './util/misc.js';
import MediaWiki from './MediaWiki.js';
import { DELETED_ARTICLE_ERROR } from './util/const.js';
const matchingRules = [
    {
        name: '404 return code',
        errorCodes: null,
        urlContains: null,
        httpReturnCodes: [{ min: 404, max: 404 }],
        contentTypes: null,
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: null,
        detailsMessageKey: 'DELETED_ARTICLE',
        displayThirdLine: false,
        isHardFailure: false,
    },
    {
        name: 'deleted article error',
        errorCodes: null,
        urlContains: null,
        httpReturnCodes: null,
        contentTypes: null,
        responseIsEmpty: false,
        rawResponseDataContains: [DELETED_ARTICLE_ERROR],
        jsonResponseDataContains: null,
        detailsMessageKey: 'DELETED_ARTICLE',
        displayThirdLine: false,
        isHardFailure: false,
    },
    {
        name: 'missing title error',
        errorCodes: null,
        urlContains: null,
        httpReturnCodes: null,
        contentTypes: null,
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['missingtitle'] }],
        detailsMessageKey: 'DELETED_ARTICLE',
        displayThirdLine: false,
        isHardFailure: false,
    },
    {
        name: 'permission denied error',
        errorCodes: null,
        urlContains: null,
        httpReturnCodes: null,
        contentTypes: null,
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['permissiondenied'] }],
        detailsMessageKey: 'PERMISSION_DENIED',
        displayThirdLine: false,
        isHardFailure: false,
    },
    {
        name: 'Client-side timeout',
        errorCodes: ['ERR_CANCELED'],
        urlContains: null,
        httpReturnCodes: null,
        contentTypes: null,
        responseIsEmpty: false, // we don't mind if response is empty or not, even if it probably is
        rawResponseDataContains: null,
        jsonResponseDataContains: null,
        detailsMessageKey: 'CLIENT_SIDE_TIMEOUT',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'WikimediaDesktop API - HTML 500 error',
        errorCodes: null,
        urlContains: ['/api/rest_v1/page/html/'],
        httpReturnCodes: [{ min: 500, max: 500 }],
        contentTypes: ['text/html'],
        responseIsEmpty: false,
        rawResponseDataContains: ['Our servers are currently under maintenance or experiencing a technical issue'],
        jsonResponseDataContains: null,
        detailsMessageKey: 'WIKIMEDIA_DESKTOP_API_HTML_500_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'WikimediaDesktop API - JSON 504 Upstream Request Timeout',
        errorCodes: null,
        urlContains: ['/api/rest_v1/page/html/'],
        httpReturnCodes: [{ min: 504, max: 504 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'httpReason', valueContains: ['upstream request timeout'] }],
        detailsMessageKey: 'WIKIMEDIA_DESKTOP_API_HTML_504_UPSTREAM_TIMEOUT',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON Upstream Request Timeout',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [
            { min: 200, max: 200 },
            { min: 504, max: 504 },
        ],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_Wikimedia\\RequestTimeout\\RequestTimeoutException'] }],
        detailsMessageKey: 'ACTION_PARSE_UPSTREAM_TIMEOUT',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON 503 HTML error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 503, max: 503 }],
        contentTypes: ['text/html'],
        responseIsEmpty: false,
        rawResponseDataContains: ['Our servers are currently under maintenance or experiencing a technical problem'],
        jsonResponseDataContains: null,
        detailsMessageKey: 'ACTION_PARSE_HTML_503_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON BadRevisionException error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_MediaWiki\\Revision\\BadRevisionException'] }],
        detailsMessageKey: 'ACTION_PARSE_BAD_REVISION_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON UnreachableException error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_Wikimedia\\Assert\\UnreachableException'] }],
        detailsMessageKey: 'ACTION_PARSE_UNREACHABLE_EXCEPTION_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON InvariantException error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_Wikimedia\\Assert\\InvariantException'] }],
        detailsMessageKey: 'ACTION_PARSE_INVARIANT_EXCEPTION_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON Parsoid resource limit exceeded error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_Wikimedia\\Parsoid\\Core\\ResourceLimitExceededException'] }],
        detailsMessageKey: 'ACTION_PARSE_PARSOID_RESOURCE_LIMIT_EXCEEDED',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON Generic Internal API error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_Error'] }],
        detailsMessageKey: 'ACTION_PARSE_GENERIC_INTERNAL_API_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON InvalidArgumentException error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_InvalidArgumentException'] }],
        detailsMessageKey: 'ACTION_PARSE_INVALID_ARGUMENT_EXCEPTION_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - JSON Internal API type error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 200, max: 200 }],
        contentTypes: ['application/json'],
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'error.code', valueContains: ['internal_api_error_TypeError'] }],
        detailsMessageKey: 'ACTION_PARSE_INTERNAL_API_TYPE_ERROR',
        displayThirdLine: true,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - Truncated Response',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: null,
        contentTypes: null,
        responseIsEmpty: false,
        rawResponseDataContains: null,
        jsonResponseDataContains: [{ key: 'warnings.result.*', valueContains: ['This result was truncated'] }],
        detailsMessageKey: 'ACTION_PARSE_TRUNCATED_RESPONSE',
        displayThirdLine: false,
        isHardFailure: true,
    },
    {
        name: 'ActionParse API - Emtpy HTML 500 error',
        errorCodes: null,
        urlContains: ['api.php?action=parse&format=json'],
        httpReturnCodes: [{ min: 500, max: 500 }],
        contentTypes: ['text/html'],
        responseIsEmpty: true,
        rawResponseDataContains: null,
        jsonResponseDataContains: null,
        detailsMessageKey: 'ACTION_PARSE_EMPTY_500_RESPONSE',
        displayThirdLine: true,
        isHardFailure: true,
    },
];
function jsonMatch(jsonObject, keyPath, allowedValues) {
    const keys = keyPath.split('.');
    let current = jsonObject;
    for (const key of keys) {
        if (current[key] === undefined) {
            return false;
        }
        current = current[key];
    }
    return allowedValues.findIndex((allowedValue) => current.includes(allowedValue)) >= 0;
}
export function findFirstMatchingRule(err) {
    for (const matchingRule of matchingRules) {
        if ((!matchingRule.urlContains || matchingRule.urlContains.findIndex((urlContain) => err.urlCalled.includes(urlContain)) >= 0) &&
            (!matchingRule.errorCodes || matchingRule.errorCodes.findIndex((error) => err.errorCode && err.errorCode.includes(error)) >= 0) &&
            (!matchingRule.httpReturnCodes ||
                matchingRule.httpReturnCodes.findIndex((httpReturnCode) => err.httpReturnCode >= httpReturnCode.min && err.httpReturnCode <= httpReturnCode.max) >= 0) &&
            (!matchingRule.contentTypes ||
                matchingRule.contentTypes.findIndex((contentType) => (err.responseContentType || '').toLowerCase().includes(contentType.toLowerCase())) >= 0) &&
            (!matchingRule.responseIsEmpty || err.responseData == '') &&
            (!matchingRule.rawResponseDataContains ||
                matchingRule.rawResponseDataContains.findIndex((rawResponseDataContain) => typeof err.responseData == 'string' && err.responseData.includes(rawResponseDataContain)) >=
                    0) &&
            (!matchingRule.jsonResponseDataContains ||
                matchingRule.jsonResponseDataContains.findIndex((jsonResponseDataContain) => typeof err.responseData == 'object' && jsonMatch(err.responseData, jsonResponseDataContain.key, jsonResponseDataContain.valueContains)) >= 0)) {
            return matchingRule;
        }
    }
    return null;
}
export function renderDownloadError(matchingRule, dump, articleId, articleTitle) {
    return downloadErrorPlaceholderTemplate({
        heading: dump.strings.DOWNLOAD_ERRORS_HEADING,
        relative_file_path: getRelativeFilePath(articleId, ''),
        message: interpolateTranslationString(dump.strings.DOWNLOAD_ERRORS_MESSAGE, {
            articleTitle: articleTitle,
            server: MediaWiki.baseUrl.hostname,
        }),
        advice_line1: interpolateTranslationString(dump.strings[`DOWNLOAD_ERRORS_LINE1_${matchingRule.detailsMessageKey}`], {
            server: MediaWiki.baseUrl.hostname,
        }),
        advice_line2: dump.strings.DOWNLOAD_ERRORS_LINE2,
        advice_line3: interpolateTranslationString(dump.strings.DOWNLOAD_ERRORS_LINE3, {
            server: MediaWiki.baseUrl.hostname,
        }),
        display_third_line: matchingRule.displayThirdLine,
        strings: dump.strings,
    });
}
//# sourceMappingURL=error.manager.js.map