@smpx/koa-request 0.2.8 → 0.4.1

package/Request.js

@@ -10,6 +10,8 @@ const enableBasicAuth = require('./basicAuth');
 const enableStaticPaths = require('./staticPaths');
 const enableBotBanning = require('./botBanning');
 
+const {setLogger, logError} = require('./logger');
+
 const uaParser = new UAParser();
 
 const ONE_HOUR = 3600 * 1000;
@@ -37,6 +39,7 @@ const COOKIEID_COOKIE = 'id';
 const COOKIE_PARAM_PREFIX = '_ck_';
 const USER_TOKEN_COOKIE = 'utok';
 const FLASH_COOKIE = 'flash';
+const VIEWPORT_WIDTH_COOKIE = 'vw';
 // these cookies are httpOnly, should not be readable from js
 const SENSITIVE_COOKIES = [USER_TOKEN_COOKIE, COOKIEID_COOKIE, SESSIONID_COOKIE];
 
@@ -122,19 +125,25 @@ function getIntegerKey(key) {
 }
 
 function addQuery(url, query = {}) {
-	const uri = new URL(url, 'http://localhost');
-	if (typeof query === 'string') {
-		query = new URLSearchParams(query);
-		for (const [key, val] of query) {
-			uri.searchParams.set(key, val);
+	try {
+		const uri = new URL(url, 'http://localhost');
+		if (typeof query === 'string') {
+			query = new URLSearchParams(query);
+			for (const [key, val] of query) {
+				uri.searchParams.set(key, val);
+			}
 		}
-	}
-	else {
-		for (const [key, val] of Object.entries(query)) {
-			uri.searchParams.set(key, val);
+		else {
+			for (const [key, val] of Object.entries(query)) {
+				uri.searchParams.set(key, val);
+			}
 		}
+		return `${uri.pathname}${uri.search}`;
+	}
+	catch (e) {
+		logError(e);
+		return url;
 	}
-	return `${uri.pathname}${uri.search}`;
 }
 
 const isProduction = (process.env.NODE_ENV === 'production');
@@ -756,9 +765,21 @@ class Request {
 			return false;
 		}
 
-		if (!this._isMobileWeb) {
-			const ua = this.parseUserAgent();
-			this._isMobileWeb = (ua && ua.device && ua.device.type === 'mobile') || false;
+		if (this._isMobileWeb == null) {
+			const secHeader = this.ctx.headers['sec-ch-ua-mobile'];
+			if (secHeader) {
+				this._isMobileWeb = secHeader === '?1';
+			}
+			else {
+				const vwCookie = this.cookie(VIEWPORT_WIDTH_COOKIE);
+				if (vwCookie) {
+					this._isMobileWeb = Number(vwCookie) <= 750;
+				}
+				else {
+					const ua = this.parseUserAgent();
+					this._isMobileWeb = (ua && ua.device && ua.device.type === 'mobile') || false;
+				}
+			}
 		}
 		return this._isMobileWeb;
 	}
@@ -767,6 +788,10 @@ class Request {
 		return this.isMobileApp() || this.isMobileWeb();
 	}
 
+	isAPI() {
+		return false;
+	}
+
 	platform() {
 		if (!this._platform) {
 			if (this.isMobileApp()) {
@@ -1218,7 +1243,20 @@ class Request {
 			};
 		}
 
-		const refererUri = new URL(referer);
+		let refererUri;
+		try {
+			refererUri = new URL(referer, 'http://localhost');
+		}
+		catch (e) {
+			logError(e);
+			return {
+				name: '',
+				source: 'direct',
+				medium: 'direct',
+				term: '',
+			};
+		}
+
 		let host = refererUri.hostname;
 		const baseDomain = this.baseDomain();
 
@@ -1271,16 +1309,22 @@ class Request {
 	 * sets UTM cookies from a predefined url
 	 */
 	setUTMCookieFromUrl(url) {
-		const uri = (url instanceof URL) ? url : new URL(url, 'http://localhost');
-		const params = uri.searchParams;
-		this.setUTMCookieFromQuery({
-			utm_source: params.get('utm_source'),
-			utm_medium: params.get('utm_medium'),
-			utm_campaign: params.get('utm_campaign'),
-			utm_term: params.get('utm_term'),
-			utm_content: params.get('utm_content'),
-			gclid: params.get('gclid'),
-		});
+		try {
+			const uri = (url instanceof URL) ? url : new URL(url, 'http://localhost');
+			const params = uri.searchParams;
+			this.setUTMCookieFromQuery({
+				utm_source: params.get('utm_source'),
+				utm_medium: params.get('utm_medium'),
+				utm_campaign: params.get('utm_campaign'),
+				utm_term: params.get('utm_term'),
+				utm_content: params.get('utm_content'),
+				gclid: params.get('gclid'),
+			});
+		}
+		catch (e) {
+			logError(e);
+			// ignore error
+		}
 	}
 
 	/**
@@ -1337,32 +1381,45 @@ class Request {
 	}
 
 	setAffidCookieFromUrl(url) {
-		const uri = (url instanceof URL) ? url : new URL(url, 'http://localhost');
-		const params = uri.searchParams;
-		const affid = params.get(AFFID_PARAM);
-		if (!affid) return;
-		const subaffid = params.get(SUBAFFID_PARAM);
-
-		this.cookie(
-			AFFID_COOKIE,
-			joinCookieParts([affid, subaffid]), {
-				maxAge: AFFID_COOKIE_DURATION,
-				domain: '*',
-			},
-		);
+		try {
+			const uri = (url instanceof URL) ? url : new URL(url, 'http://localhost');
+			const params = uri.searchParams;
+			const affid = params.get(AFFID_PARAM);
+			if (!affid) return;
+			const subaffid = params.get(SUBAFFID_PARAM);
+
+			this.cookie(
+				AFFID_COOKIE,
+				joinCookieParts([affid, subaffid]), {
+					maxAge: AFFID_COOKIE_DURATION,
+					domain: '*',
+				},
+			);
+		}
+		catch (e) {
+			logError(e);
+			// ignore error
+		}
 	}
 
 	handlePlatformModification() {
-		// don't change platform in mobile apps
-		if (this.isMobileApp()) return;
-
-		const platform = this.ctx.query[PLATFORM_PARAM] || this.cookie(PLATFORM_COOKIE);
-		const setPlatformCookie = this.setPlatform(platform);
-		if (setPlatformCookie) {
-			this.cookie(PLATFORM_COOKIE, platform, {
-				maxAge: PLATFORM_COOKIE_DURATION,
-				domain: '*',
-			});
+		let setPlatformCookie = false;
+		if (!this.isMobileApp()) {
+			// don't change platform in mobile apps from query or cookie
+			const platform = this.ctx.query[PLATFORM_PARAM] || this.cookie(PLATFORM_COOKIE);
+			setPlatformCookie = this.setPlatform(platform);
+			if (setPlatformCookie) {
+				this.cookie(PLATFORM_COOKIE, platform, {
+					maxAge: PLATFORM_COOKIE_DURATION,
+					domain: '*',
+				});
+			}
+		}
+		if (!setPlatformCookie) {
+			const smPlatform = this.header('x-sm-platform');
+			if (smPlatform) {
+				this._platform = smPlatform;
+			}
 		}
 	}
 
@@ -1479,7 +1536,7 @@ class Request {
 		}
 		catch (e) {
 			this._flash = '';
-			console.error('Error parsing flash message', e);
+			logError('Error parsing flash message', e);
 		}
 
 		this.cookie(FLASH_COOKIE, null);
@@ -1561,4 +1618,5 @@ class Request {
 	}
 }
 
+Request.setLogger = setLogger;
 module.exports = Request;

package/basicAuth.js

@@ -1,6 +1,6 @@
 const auth = require('koa-basic-auth');
 
-module.exports = function enableBasicAuth(app, options = {}) {
+module.exports = function enableBasicAuth(app, options) {
 	if (!options || options.enabled === false) return;
 
 	app.use(async (ctx, next) => {

package/botBanning.js

@@ -26,7 +26,7 @@ function banned(ctx, email) {
 	ctx.body = `<pre>Our system has detected unusual traffic from your ip ${ip}. Hence your ip has been banned temporarily.\n${emailStr}</pre>`;
 }
 
-module.exports = function enableBotBanning(app, options = {}) {
+module.exports = function enableBotBanning(app, options) {
 	if (!options || options.enabled === false) return;
 
 	let userAgents = [];

package/logger.js

@@ -0,0 +1,22 @@
+let globalLogger;
+
+/**
+ * set logger
+ */
+function setLogger(logger) {
+	globalLogger = logger;
+}
+
+function logError(...args) {
+	if (globalLogger !== undefined) {
+		if (globalLogger) globalLogger.error(...args);
+	}
+	else {
+		console.error(...args);
+	}
+}
+
+module.exports = {
+	setLogger,
+	logError,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smpx/koa-request",
-  "version": "0.2.8",
+  "version": "0.4.1",
   "description": "Handle basic tasks for koajs",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,12 +30,12 @@
   },
   "homepage": "https://github.com/smartprix/koa-request#readme",
   "dependencies": {
-    "ip": "^1.1.5",
+    "ip": "^1.1.8",
     "koa-basic-auth": "^4.0.0",
-    "koa-body": "^4.2.0",
+    "koa-body": "^5.0.0",
     "koa-send": "^5.0.1",
-    "koa2-ratelimit": "^0.9.1",
-    "maxmind": "^4.3.3",
+    "koa2-ratelimit": "^1.1.1",
+    "maxmind": "^4.3.6",
     "tar": "^6.1.11",
     "ua-parser-js": "^1.0.2"
   },

package/rateLimit.js

@@ -1,6 +1,6 @@
 const {RateLimit} = require('koa2-ratelimit');
 
-module.exports = function enableRateLimit(app, options = {}) {
+module.exports = function enableRateLimit(app, options) {
 	if (!options || options.enabled === false) return;
 
 	const skip = options.skip;

package/staticPaths.js

@@ -20,8 +20,8 @@ function getMiddleware(options) {
 
 		if (options.path === '/') {
 			// root requires special handling to check if extension denotes a static path
-			const matches = ctx.path.match(/^\/(.*)\.(jpg|jpeg|gif|png|webp|avif|jxl|ico|css|js|mjs|json|ttf|otf|eot|woff|woff2|svg|svgz|xml|html|txt|ogg|ogv|mp4|av1|webm|rss|atom|zip|tgz|gz|rar|bz2|doc|xls|exe|ppt|tar|mid|midi|wav|bmp|rtf)$/);
-			if (!matches) {
+			const isStatic = /^\/(.*)\.(jpg|jpeg|gif|png|webp|avif|jxl|ico|css|js|mjs|json|ttf|otf|eot|woff|woff2|svg|svgz|xml|html|txt|ogg|ogv|mp4|av1|webm|rss|atom|zip|tgz|gz|rar|bz2|doc|xls|exe|ppt|tar|mid|midi|wav|bmp|rtf)$/.test(ctx.path);
+			if (!isStatic) {
 				await next();
 				return;
 			}
@@ -48,7 +48,7 @@ function getMiddleware(options) {
 
 		if (options.immutable) {
 			// return a 304 not modified response, as immutables can't be modified
-			if (ctx.headers['if-modified-since']) {
+			if (ctx.headers['if-modified-since'] && !ctx.response.get('Cache-Control')) {
 				ctx.status = 304;
 				return;
 			}