opensource/RSSHub
1
0
Fork 0
mirror of https://github.com/DIYgod/RSSHub.git synced 2025-12-16 19:50:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: middleware errors

Browse Source
This commit is contained in:
DIYgod
2024-01-21 18:35:11 +08:00
parent e7e3f689bd
commit 4591116733
14 changed files with 126 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/errors/index.ts
View File

@@ -19,7 +19,7 @@ export const errorHandler: ErrorHandler = (error, ctx) => {
}
const debug = getDebugInfo();
if (ctx.res.headers.get('X-Koa-Redis-Cache') || ctx.res.headers.get('X-Koa-Memory-Cache')) {
if (ctx.res.headers.get('RSSHub-Cache-Status')) {
debug.hitCache++;
setDebugInfo(debug);
}

2
lib/index.ts
View File

@@ -25,8 +25,8 @@ const app = new Hono()
app.use('*', onerror);
app.use('*', accessControl);
app.use('*', debug);
app.use('*', header);
app.use('*', template);
app.use('*', header);
app.use('*', antiHotlink);
app.use('*', parameter);
app.use('*', cache);

147
lib/middleware/api-response-handler.js
View File

@@ -1,147 +0,0 @@
/**
* HTTP Status codes
*/
const statusCodes = {
CONTINUE: 100,
OK: 200,
CREATED: 201,
ACCEPTED: 202,
NO_CONTENT: 204,
BAD_REQUEST: 400,
UNAUTHORIZED: 401,
FORBIDDEN: 403,
NOT_FOUND: 404,
REQUEST_TIMEOUT: 408,
UNPROCESSABLE_ENTITY: 422,
INTERNAL_SERVER_ERROR: 500,
NOT_IMPLEMENTED: 501,
BAD_GATEWAY: 502,
SERVICE_UNAVAILABLE: 503,
GATEWAY_TIME_OUT: 504,
};
function responseHandler() {
return async (ctx, next) => {
ctx.res.statusCodes = statusCodes;
ctx.statusCodes = ctx.res.statusCodes;
ctx.res.success = ({ statusCode, data = null, message = null }) => {
const status = 0;
ctx.status = statusCode;
ctx.body = { status, data, message };
};
// ctx.res.fail = ({ statusCode, code, data = null, message = null }) => {
// const status = -1;
// if (!!statusCode && (statusCode >= 400 && statusCode < 500)) {
// ctx.status = statusCode;
// } else if (!(ctx.status >= 400 && ctx.status < 500)) {
// ctx.status = statusCodes.BAD_REQUEST;
// }
// ctx.body = { status, code, data, message };
// };
// ctx.res.error = ({ statusCode, code, data = null, message = null }) => {
// const status = -2;
// if (!!statusCode && (statusCode >= 500 && statusCode < 600)) {
// ctx.status = statusCode;
// } else if (!(ctx.status >= 500 && ctx.status < 600)) {
// ctx.status = statusCodes.INTERNAL_SERVER_ERROR;
// }
// ctx.body = { status, code, data, message };
// };
ctx.res.ok = (params = {}) => {
ctx.res.success({
...params,
statusCode: statusCodes.OK,
});
};
// ctx.res.noContent = (params = {}) => {
// ctx.res.success({
// ...params,
// statusCode: statusCodes.NO_CONTENT,
// });
// };
// ctx.res.badRequest = (params = {}) => {
// ctx.res.fail({
// ...params,
// statusCode: statusCodes.BAD_REQUEST,
// });
// };
// ctx.res.forbidden = (params = {}) => {
// ctx.res.fail({
// ...params,
// statusCode: statusCodes.FORBIDDEN,
// });
// };
// ctx.res.notFound = (params = {}) => {
// ctx.res.fail({
// ...params,
// statusCode: statusCodes.NOT_FOUND,
// });
// };
// ctx.res.requestTimeout = (params = {}) => {
// ctx.res.fail({
// ...params,
// statusCode: statusCodes.REQUEST_TIMEOUT,
// });
// };
// ctx.res.unprocessableEntity = (params = {}) => {
// ctx.res.fail({
// ...params,
// statusCode: statusCodes.UNPROCESSABLE_ENTITY,
// });
// };
// ctx.res.internalServerError = (params = {}) => {
// ctx.res.error({
// ...params,
// statusCode: statusCodes.INTERNAL_SERVER_ERROR,
// });
// };
// ctx.res.notImplemented = (params = {}) => {
// ctx.res.error({
// ...params,
// statusCode: statusCodes.NOT_IMPLEMENTED,
// });
// };
// ctx.res.badGateway = (params = {}) => {
// ctx.res.error({
// ...params,
// statusCode: statusCodes.BAD_GATEWAY,
// });
// };
// ctx.res.serviceUnavailable = (params = {}) => {
// ctx.res.error({
// ...params,
// statusCode: statusCodes.SERVICE_UNAVAILABLE,
// });
// };
// ctx.res.gatewayTimeOut = (params = {}) => {
// ctx.res.error({
// ...params,
// statusCode: statusCodes.GATEWAY_TIME_OUT,
// });
// };
await next();
};
}
module.exports = responseHandler;

9
lib/middleware/api-template.js
View File

@@ -1,9 +0,0 @@
module.exports = async (ctx, next) => {
await next();
if (ctx.request.path.startsWith('/api/')) {
return ctx.res.ok({
message: `request returned ${ctx.body.counter} ${ctx.body.counter > 1 ? 'routes' : 'route'}`,
data: ctx.body.result,
});
}
};

6
lib/middleware/cache.ts
View File

@@ -29,11 +29,7 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
if (value) {
ctx.status(200)
if (config.cache.type === 'redis') {
ctx.header('X-Koa-Redis-Cache', 'true')
} else if (config.cache.type === 'memory') {
ctx.header('X-Koa-Memory-Cache', 'true')
}
ctx.header('RSSHub-Cache-Status', 'HIT')
ctx.set('data', JSON.parse(value))
await next();
return;

2
lib/middleware/debug.ts
View File

@@ -12,7 +12,7 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
{
const debug = getDebugInfo();
if (ctx.res.headers.get('X-Koa-Redis-Cache') || ctx.res.headers.get('X-Koa-Memory-Cache')) {
if (ctx.res.headers.get('RSSHub-Cache-Status')) {
debug.hitCache++;
}

24
lib/middleware/header.ts
View File

@@ -29,30 +29,24 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
await next();
if (!ctx.res.body || ctx.res.headers.get('ETag')) {
const data = ctx.get('data');
if (!data || ctx.res.headers.get('ETag')) {
return;
}
const status = Math.trunc(ctx.res.status / 100);
if (2 !== status) {
return;
}
const lastBuildDate = data.lastBuildDate;
delete data.lastBuildDate;
const etag = etagCalculate(JSON.stringify(data));
const res = ctx.res as Response;
const body = await res.clone().text();
const etag = etagCalculate(body.replace(/<lastBuildDate>(.*)<\/lastBuildDate>/, '').replace(/<atom:link(.*)\/>/, ''));
ctx.set('ETag', etag);
ctx.header('ETag', etag);
const ifNoneMatch = ctx.req.header('If-None-Match') ?? null;
if (etagMatches(etag, ifNoneMatch)) {
console.log('in')
ctx.status(304);
ctx.body(null);
return ctx.body(null);
} else {
const match = body.match(/<lastBuildDate>(.*)<\/lastBuildDate>/);
if (match) {
ctx.header('Last-Modified', match[1]);
}
ctx.header('Last-Modified', lastBuildDate);
}
};

36
lib/middleware/load-on-demand.js
View File

@@ -1,36 +0,0 @@
const mount = require('koa-mount');
const Router = require('@koa/router');
const routes = require('../v2router');
const loadedRoutes = new Set();
module.exports = function (app) {
return async function (ctx, next) {
const p = ctx.request.path.split('/').filter(Boolean);
let modName = null;
let mounted = false;
if (p.length > 0) {
modName = p[0];
if (loadedRoutes.has(modName)) {
mounted = true;
} else {
const mod = routes[modName];
// Mount module
if (mod) {
mounted = true;
loadedRoutes.add(modName);
const router = new Router();
mod(router);
app.use(mount(`/${modName}`, router.routes())).use(router.allowedMethods());
}
}
}
await next();
// We should only add it when koa router matched
if (mounted && ctx._matchedRoute) {
ctx._matchedRoute = `/${modName}${ctx._matchedRoute}`;
}
};
};

46
lib/middleware/template.ts
View File

@@ -1,21 +1,15 @@
import render from '@/utils/render';
import * as path from 'node:path';
import { config } from '@/config';
const typeRegex = /\.(atom|rss|ums|debug\.json|json|\d+\.debug\.html)$/;
import utils from '@/utils/common-utils';
import type { MiddlewareHandler } from 'hono';
import { Data } from '@/types';
const middleware: MiddlewareHandler = async (ctx, next) => {
if (ctx.req.header('user-agent')?.includes('Reeder')) {
ctx.req.path = ctx.req.path.replace(/.com$/, '');
}
ctx.set('type', ctx.req.path.match(typeRegex) || ['', '']);
ctx.req.path = ctx.req.path.replace(typeRegex, '');
await next();
const outputType = ctx.get('type')[1] || 'rss';
const data: Data = ctx.get('data');
const outputType = ctx.req.query('format') || 'rss';
// only enable when debugInfo=true
if (config.debugInfo) {
@@ -24,26 +18,24 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
return ctx.body(ctx.get('json') ? JSON.stringify(ctx.get('json'), null, 4) : JSON.stringify({ message: 'plugin does not set debug json' }));
}
if (outputType.endsWith('.debug.html')) {
if (outputType === 'debug.html') {
ctx.header('Content-Type', 'text/html; charset=UTF-8');
const index = Number.parseInt(outputType.match(/(\d+)\.debug\.html$/)[1]);
return ctx.body(ctx.get('data')?.item?.[index]?.description || `ctx.get('data')?.item?.[${index}]?.description not found`);
const index = Number.parseInt(outputType.match(/(\d+)\.debug\.html$/)?.[1] || '0');
return ctx.body(data?.item?.[index]?.description || `data?.item?.[${index}]?.description not found`);
}
}
const templateName = outputType === 'atom' ? 'atom.art' : 'rss.art';
const template = path.resolve(__dirname, `../views/${templateName}`);
if (ctx.get('data')) {
for (const prop of ['title', 'subtitle', 'author']) {
if (ctx.get('data')[prop]) {
ctx.get('data')[prop] = utils.collapseWhitespace(ctx.get('data')[prop]);
}
}
if (data) {
data.title = utils.collapseWhitespace(data.title);
data.description && (data.description = utils.collapseWhitespace(data.description));
data.author && (data.author = utils.collapseWhitespace(data.author));
if (ctx.get('data').item) {
for (const item of ctx.get('data').item) {
if (data.item) {
for (const item of data.item) {
if (item.title) {
item.title = utils.collapseWhitespace(item.title);
// trim title length
@@ -63,9 +55,7 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
a.name = utils.collapseWhitespace(a.name);
}
if (outputType !== 'json') {
item.author = item.author.map((a: {
name: string;
}) => a.name).join(', ');
item.author = item.author.map((a: { name: string }) => a.name).join(', ');
}
}
@@ -76,24 +66,24 @@ const middleware: MiddlewareHandler = async (ctx, next) => {
}
if (outputType !== 'rss') {
item.pubDate = utils.convertDateToISO8601(item.pubDate);
item.updated = utils.convertDateToISO8601(item.updated);
item.pubDate && (item.pubDate = utils.convertDateToISO8601(item.pubDate));
item.updated && (item.updated = utils.convertDateToISO8601(item.updated));
}
}
}
}
const currentDate = new Date();
const data = {
const result = {
lastBuildDate: currentDate.toUTCString(),
updated: currentDate.toISOString(),
ttl: Math.trunc(config.cache.routeExpire / 60),
atomlink: ctx.req.url,
...ctx.get('data'),
...data,
};
if (config.isPackage) {
return ctx.body(data);
return ctx.json(result);
}
if (outputType === 'ums') {

6
lib/middleware/utf8.js
View File

@@ -1,6 +0,0 @@
// https://stackoverflow.com/questions/2507608/error-input-is-not-proper-utf-8-indicate-encoding-using-phps-simplexml-lo/40552083#40552083
// https://stackoverflow.com/questions/1497885/remove-control-characters-from-php-string/1497928#1497928
module.exports = async (ctx, next) => {
await next();
ctx.body = typeof ctx.body === 'object' ? ctx.body : ctx.body.replaceAll(/[\u0000-\u0009\u000B\u000C\u000E-\u001F\u007F]/g, '');
};

32
lib/types.ts
View File

@@ -1,11 +1,26 @@
export type DataItem = {
title: string;
description?: string;
pubDate: number | string;
pubDate?: number | string | Date;
link?: string;
category?: string[];
author?: string;
author?: string | { name: string }[];
doi?: string;
guid?: string;
id?: string;
content?: {
html: string;
text: string;
};
image?: string;
banner?: string;
updated?: number | string | Date;
language?: string;
enclosure_url?: string;
enclosure_type?: string;
enclosure_title?: string;
enclosure_length?: number;
itunes_duration?: number | string;
_extra?: Record<string, any> & {
links?: {
@@ -14,11 +29,16 @@ export type DataItem = {
content_html?: string;
}[];
};
}
};
export type Data = {
title: string;
description: string;
description?: string;
link?: string;
item: DataItem[];
item?: DataItem[];
allowEmpty?: boolean;
}
image?: string;
author?: string;
language?: string;
feedLink?: string;
};

2
lib/utils/common-utils.ts
View File

@@ -15,7 +15,7 @@ const collapseWhitespace = (str: string) => {
return str;
};
const convertDateToISO8601 = (date: string | Date) => {
const convertDateToISO8601 = (date: string | Date | number) => {
if (!date) {
return date;
}

2
lib/utils/parse-date.ts
View File

@@ -126,7 +126,7 @@ const toDurations = (matches: string[]) => {
};
export default {
parse: (date: string, ...options: any) => dayjs(date, ...options).toDate(),
parse: (date: string | number, ...options: any) => dayjs(date, ...options).toDate(),
parseRelativeDate: (date: string) => {
// 预处理日期字符串 date

6
lib/views/json.ts
View File

@@ -1,9 +1,11 @@
import { Data } from "@/types";
/**
* This function should be used by RSSHub middleware only.
* @param {object} data ctx.state.data
* @returns `JSON.stringify`-ed [JSON Feed](https://www.jsonfeed.org/)
*/
const json = (data) => {
const json = (data: Data) => {
const jsonFeed = {
version: 'https://jsonfeed.org/version/1.1',
title: data.title || 'RSSHub',
@@ -13,7 +15,7 @@ const json = (data) => {
icon: data.image,
authors: typeof data.author === 'string' ? [{ name: data.author }] : data.author,
language: data.language || 'zh-cn',
items: data.item.map((item) => ({
items: data.item?.map((item) => ({
id: item.guid || item.id || item.link,
url: item.link,
title: item.title,