0.0.24

update dependencies

README.md

@@ -4,14 +4,14 @@
 
 Misskeyの/proxyが単体で動作します（Misskeyのコードがほぼそのまま移植されています）。
 
-/proxyは画像ではないと403を返しますが、Media Proxyではそのまま内容を送信します。
-
 **Fastifyプラグインとして動作する気がします。**  
 `pnpm start`は[fastify-cli](https://github.com/fastify/fastify-cli)が動作します。
 
 一応AWS Lambdaで動かす実装を用意しましたが、全くおすすめしません。
 https://github.com/tamaina/media-proxy-lambda
 
+Sharp.jsを使っているため、メモリアロケータにjemallocを指定することをお勧めします。
+
 ## Fastifyプラグインとして動作させる
 ### npm install
 
@@ -38,6 +38,13 @@ git clone https://github.com/misskey-dev/media-proxy.git
 cd media-proxy
 ```
 
+### jemallocをインストール
+Debian/Ubuntuのaptの場合
+
+```
+sudo apt install libjemalloc2
+```
+
 ### pnpm install
 ```
 NODE_ENV=production pnpm install
@@ -78,14 +85,17 @@ export default {
 適当にサーバーを公開してください。  
 （ここではmediaproxy.example.comで公開するものとします。）
 
-メモ書き程度にsystemdでの開始方法を残しますが、もしかしたらAWS Lambdaとかで動かしたほうが楽かもしれません。  
+メモ書き程度にsystemdでの開始方法を残します。  
 （サーバーレスだとsharp.jsが動かない可能性が高いため、そこはなんとかしてください）
 
 systemdサービスのファイルを作成…
 
 /etc/systemd/system/misskey-proxy.service
 
-エディタで開き、以下のコードを貼り付けて保存（ユーザーやポートは適宜変更すること）:
+エディタで開き、以下のコードを貼り付けて保存
+
+ユーザーやポートは適宜変更すること。  
+また、arm64の場合`Environment="LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"`のx86_64をaarch64に変更する必要がある。jemallocのパスはディストリビューションによって変わる可能性がある。
 
 ```systemd
 [Unit]
@@ -96,6 +106,7 @@ Type=simple
 User=misskey
 ExecStart=/usr/bin/npm start
 WorkingDirectory=/home/misskey/media-proxy
+Environment="LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
 Environment="NODE_ENV=production"
 Environment="PORT=3000"
 TimeoutSec=60

SPECIFICATION.md

@@ -72,7 +72,7 @@ https://www.google.com/images/errors/robot.png をプロキシする場合:
 #### static
 存在すると、アニメーション画像では最初のフレームのみの静止画のwebpが応答される。
 
-emojiまたはavatarとstaticが同時に指定された場合は、それぞれに応じた高さが、指定されていない場合は幅498px・高さ280pxに収まるサイズ以下に縮小される。  
+emojiまたはavatarとstaticが同時に指定された場合は、それぞれに応じた高さが、指定されていない場合は幅498px・高さ422pxに収まるサイズ以下に縮小される。
 
 #### preview
 存在すると、幅200px・高さ200pxに収まるサイズ以下のwebpが応答される。

built/const.js

@@ -30,6 +30,10 @@ export const FILE_TYPE_BROWSERSAFE = [
     'video/webm',
     'audio/webm',
     'audio/aac',
+    // see https://github.com/misskey-dev/misskey/pull/10686
+    'audio/flac',
+    'audio/wav',
+    // backward compatibility
     'audio/x-flac',
     'audio/vnd.wave',
 ];

built/download.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import * as http from 'node:http';
 import * as https from 'node:https';
 export type DownloadConfig = {

built/download.js

@@ -1,9 +1,8 @@
 import * as fs from 'node:fs';
 import * as stream from 'node:stream';
 import * as util from 'node:util';
+import ipaddr from 'ipaddr.js';
 import got, * as Got from 'got';
-import IPCIDR from 'ip-cidr';
-import PrivateIp from 'private-ip';
 import { StatusError } from './status-error.js';
 import { getAgents } from './http.js';
 import { parse } from 'content-disposition';
@@ -30,7 +29,7 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
             lookup: timeout,
             connect: timeout,
             secureConnect: timeout,
-            socket: timeout,
+            socket: timeout, // read timeout
             response: timeout,
             send: timeout,
             request: operationTimeout, // whole operation timeout
@@ -61,9 +60,14 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
         }
         const contentDisposition = res.headers['content-disposition'];
         if (contentDisposition != null) {
-            const parsed = parse(contentDisposition);
-            if (parsed.parameters.filename) {
-                filename = parsed.parameters.filename;
+            try {
+                const parsed = parse(contentDisposition);
+                if (parsed.parameters.filename) {
+                    filename = parsed.parameters.filename;
+                }
+            }
+            catch (e) {
+                console.log(`Failed to parse content-disposition: ${contentDisposition}\n${e}`);
             }
         }
     }).on('downloadProgress', (progress) => {
@@ -90,11 +94,11 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
     };
 }
 function isPrivateIp(ip, allowedPrivateNetworks) {
+    const parsedIp = ipaddr.parse(ip);
     for (const net of allowedPrivateNetworks ?? []) {
-        const cidr = new IPCIDR(net);
-        if (cidr.contains(ip)) {
+        if (parsedIp.match(ipaddr.parseCIDR(net))) {
             return false;
         }
     }
-    return PrivateIp(ip) ?? false;
+    return parsedIp.range() !== 'unicast';
 }

built/file-info.js

@@ -30,7 +30,7 @@ export async function detectType(path) {
             return TYPE_OCTET_STREAM;
         }
         return {
-            mime: type.mime,
+            mime: fixMime(type.mime),
             ext: type.ext,
         };
     }
@@ -46,7 +46,7 @@ async function checkSvg(path) {
         const size = await getFileSize(path);
         if (size > 1 * 1024 * 1024)
             return false;
-        return isSvg(fs.readFileSync(path));
+        return isSvg(fs.readFileSync(path, { encoding: 'utf-8' }));
     }
     catch {
         return false;
@@ -55,7 +55,17 @@ async function checkSvg(path) {
 import { FILE_TYPE_BROWSERSAFE } from './const.js';
 const dictionary = {
     'safe-file': FILE_TYPE_BROWSERSAFE,
-    'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml'],
-    'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml'],
+    'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
+    'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
 };
 export const isMimeImage = (mime, type) => dictionary[type].includes(mime);
+function fixMime(mime) {
+    // see https://github.com/misskey-dev/misskey/pull/10686
+    if (mime === "audio/x-flac") {
+        return "audio/flac";
+    }
+    if (mime === "audio/vnd.wave") {
+        return "audio/wav";
+    }
+    return mime;
+}

built/http.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import * as http from 'node:http';
 import * as https from 'node:https';
 export declare function getAgents(proxy?: string): {

built/http.js

@@ -3,8 +3,8 @@ import * as https from 'node:https';
 import CacheableLookup from 'cacheable-lookup';
 import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent';
 const cache = new CacheableLookup({
-    maxTtl: 3600,
-    errorTtl: 30,
+    maxTtl: 3600, // 1hours
+    errorTtl: 30, // 30secs
     lookup: false, // nativeのdns.lookupにfallbackしない
 });
 const _http = new http.Agent({

built/image-processor.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import sharp from 'sharp';
 import { Readable } from 'node:stream';
 export type IImage = {

built/image-processor.js

@@ -1,11 +1,12 @@
 import sharp from 'sharp';
 export const webpDefault = {
-    quality: 85,
+    quality: 77,
     alphaQuality: 95,
     lossless: false,
     nearLossless: false,
     smartSubsample: true,
     mixed: true,
+    effort: 2,
 };
 export function convertToWebpStream(path, width, height, options = webpDefault) {
     return convertSharpToWebpStream(sharp(path), width, height, options);

built/index.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import * as http from 'node:http';
 import * as https from 'node:https';
 import type { FastifyInstance } from 'fastify';

built/index.js

@@ -4,9 +4,10 @@ import { dirname } from 'node:path';
 import fastifyStatic from '@fastify/static';
 import { createTemp } from './create-temp.js';
 import { FILE_TYPE_BROWSERSAFE } from './const.js';
-import { convertToWebpStream, webpDefault } from './image-processor.js';
+import { convertToWebpStream, webpDefault, convertSharpToWebpStream } from './image-processor.js';
 import { detectType, isMimeImage } from './file-info.js';
 import sharp from 'sharp';
+import { sharpBmp } from '@misskey-dev/sharp-read-bmp';
 import { StatusError } from './status-error.js';
 import { defaultDownloadConfig, downloadUrl } from './download.js';
 import { getAgents } from './http.js';
@@ -107,7 +108,7 @@ async function proxyHandler(request, reply) {
                 };
             }
             else {
-                const data = sharp(file.path, { animated: !('static' in request.query) })
+                const data = (await sharpBmp(file.path, file.mime, { animated: !('static' in request.query) }))
                     .resize({
                     height: 'emoji' in request.query ? 128 : 320,
                     withoutEnlargement: true,
@@ -121,15 +122,16 @@ async function proxyHandler(request, reply) {
             }
         }
         else if ('static' in request.query) {
-            image = convertToWebpStream(file.path, 498, 280);
+            image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 498, 422);
         }
         else if ('preview' in request.query) {
-            image = convertToWebpStream(file.path, 200, 200);
+            image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 200, 200);
         }
         else if ('badge' in request.query) {
-            const mask = sharp(file.path)
+            const mask = (await sharpBmp(file.path, file.mime))
                 .resize(96, 96, {
-                fit: 'inside',
+                fit: 'contain',
+                position: 'centre',
                 withoutEnlargement: false,
             })
                 .greyscale()
@@ -156,7 +158,7 @@ async function proxyHandler(request, reply) {
         else if (file.mime === 'image/svg+xml') {
             image = convertToWebpStream(file.path, 2048, 2048);
         }
-        else if (!file.mime.startsWith('image/') || !FILE_TYPE_BROWSERSAFE.includes(file.mime)) {
+        else if (!(file.mime.startsWith('image/') || FILE_TYPE_BROWSERSAFE.includes(file.mime))) {
             throw new StatusError('Rejected type', 403, 'Rejected type');
         }
         if (!image) {

package.json

@@ -1,9 +1,9 @@
 {
   "name": "misskey-media-proxy",
-  "version": "0.0.16",
+  "version": "0.0.24",
   "description": "The Media Proxy for Misskey",
   "main": "built/index.js",
-  "packageManager": "pnpm@7.26.0",
+  "packageManager": "pnpm@8.7.5",
   "type": "module",
   "files": [
     "built",
@@ -26,27 +26,28 @@
   },
   "homepage": "https://github.com/misskey-dev/media-proxy#readme",
   "devDependencies": {
-    "@swc/cli": "^0.1.61",
-    "@swc/core": "^1.3.32",
-    "@types/content-disposition": "^0.5.5",
-    "@types/node": "^18.11.19",
-    "@types/sharp": "^0.31.1",
-    "@types/tmp": "^0.2.3",
-    "typescript": "^4.9.5"
+    "@swc/cli": "^0.1.63",
+    "@swc/core": "^1.3.104",
+    "@types/content-disposition": "^0.5.8",
+    "@types/node": "^20.11.5",
+    "@types/tmp": "^0.2.6",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@fastify/static": "^6.8.0",
+    "@fastify/static": "^6.12.0",
+    "@misskey-dev/sharp-read-bmp": "^1.1.1",
     "cacheable-lookup": "^7.0.0",
     "content-disposition": "^0.5.4",
-    "fastify": "^4.12.0",
-    "fastify-cli": "^5.7.1",
-    "file-type": "^18.2.0",
-    "got": "^12.5.3",
+    "fastify": "^4.25.2",
+    "fastify-cli": "^6.0.1",
+    "file-type": "^19.0.0",
+    "got": "^13.0.0",
     "hpagent": "^1.2.0",
     "ip-cidr": "^3.1.0",
-    "is-svg": "^4.3.2",
-    "private-ip": "^3.0.0",
-    "sharp": "^0.31.3",
+    "ipaddr.js": "^2.1.0",
+    "is-svg": "^5.0.0",
+    "private-ip": "^3.0.1",
+    "sharp": "^0.32.6",
     "tmp": "^0.2.1"
   }
 }

src/const.ts

@@ -36,6 +36,11 @@ export const FILE_TYPE_BROWSERSAFE = [
 	'audio/webm',
 
 	'audio/aac',
+
+	// see https://github.com/misskey-dev/misskey/pull/10686
+	'audio/flac',
+	'audio/wav',
+	// backward compatibility
 	'audio/x-flac',
 	'audio/vnd.wave',
 ];

src/download.ts

@@ -3,9 +3,8 @@ import * as stream from 'node:stream';
 import * as util from 'node:util';
 import * as http from 'node:http';
 import * as https from 'node:https';
+import ipaddr from 'ipaddr.js';
 import got, * as Got from 'got';
-import IPCIDR from 'ip-cidr';
-import PrivateIp from 'private-ip';
 import { StatusError } from './status-error.js';
 import { getAgents } from './http.js';
 import { parse } from 'content-disposition';
@@ -82,9 +81,13 @@ export async function downloadUrl(url: string, path: string, settings:DownloadCo
 
         const contentDisposition = res.headers['content-disposition'];
         if (contentDisposition != null) {
-            const parsed = parse(contentDisposition);
-            if (parsed.parameters.filename) {
-                filename = parsed.parameters.filename;
+            try {
+                const parsed = parse(contentDisposition);
+                if (parsed.parameters.filename) {
+                    filename = parsed.parameters.filename;
+                }
+            } catch (e) {
+                console.log(`Failed to parse content-disposition: ${contentDisposition}\n${e}`);
             }
         }
     }).on('downloadProgress', (progress: Got.Progress) => {
@@ -112,12 +115,13 @@ export async function downloadUrl(url: string, path: string, settings:DownloadCo
 }
 
 function isPrivateIp(ip: string, allowedPrivateNetworks: string[]): boolean {
+    const parsedIp = ipaddr.parse(ip);
+
     for (const net of allowedPrivateNetworks ?? []) {
-        const cidr = new IPCIDR(net);
-        if (cidr.contains(ip)) {
+        if (parsedIp.match(ipaddr.parseCIDR(net))) {
             return false;
         }
     }
 
-    return PrivateIp(ip) ?? false;
+    return parsedIp.range() !== 'unicast';
 }

src/file-info.ts

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import { fileTypeFromFile } from 'file-type';
+import type { MimeType } from 'file-type';
 import isSvg from 'is-svg';
 import { promisify } from 'node:util';
 
@@ -39,7 +40,7 @@ export async function detectType(path: string): Promise<{
         }
 
         return {
-            mime: type.mime,
+            mime: fixMime(type.mime),
             ext: type.ext,
         };
     }
@@ -56,7 +57,7 @@ async function checkSvg(path: string) {
     try {
         const size = await getFileSize(path);
         if (size > 1 * 1024 * 1024) return false;
-        return isSvg(fs.readFileSync(path));
+        return isSvg(fs.readFileSync(path, { encoding: 'utf-8' }));
     } catch {
         return false;
     }
@@ -66,8 +67,20 @@ import { FILE_TYPE_BROWSERSAFE } from './const.js';
 
 const dictionary = {
     'safe-file': FILE_TYPE_BROWSERSAFE,
-    'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml'],
-    'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml'],
+    'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
+    'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
 };
 
 export const isMimeImage = (mime: string, type: keyof typeof dictionary): boolean => dictionary[type].includes(mime);
+
+function fixMime(mime: string | MimeType): string {
+    // see https://github.com/misskey-dev/misskey/pull/10686
+    if (mime === "audio/x-flac") {
+        return "audio/flac";
+    }
+    if (mime === "audio/vnd.wave") {
+        return "audio/wav";
+    }
+
+    return mime;
+}

src/http.ts

@@ -2,6 +2,7 @@ import * as http from 'node:http';
 import * as https from 'node:https';
 import CacheableLookup from 'cacheable-lookup';
 import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent';
+import { LookupFunction } from 'node:net';
 
 const cache = new CacheableLookup({
     maxTtl: 3600,	// 1hours
@@ -12,13 +13,13 @@ const cache = new CacheableLookup({
 const _http = new http.Agent({
     keepAlive: true,
     keepAliveMsecs: 30 * 1000,
-    lookup: cache.lookup,
+    lookup: cache.lookup as unknown as LookupFunction,
 } as http.AgentOptions);
 
 const _https = new https.Agent({
     keepAlive: true,
     keepAliveMsecs: 30 * 1000,
-    lookup: cache.lookup,
+    lookup: cache.lookup as unknown as LookupFunction,
 } as https.AgentOptions);
 
 export function getAgents(proxy?: string) {

src/image-processor.ts

@@ -16,12 +16,13 @@ export type IImageStream = {
 export type IImageStreamable = IImage | IImageStream;
 
 export const webpDefault: sharp.WebpOptions = {
-    quality: 85,
+    quality: 77,
     alphaQuality: 95,
     lossless: false,
     nearLossless: false,
     smartSubsample: true,
     mixed: true,
+    effort: 2,
 };
 
 export function convertToWebpStream(path: string, width: number, height: number, options: sharp.WebpOptions = webpDefault): IImageStream {

src/index.ts

@@ -6,10 +6,11 @@ import { dirname } from 'node:path';
 import fastifyStatic from '@fastify/static';
 import { createTemp } from './create-temp.js';
 import { FILE_TYPE_BROWSERSAFE } from './const.js';
-import { IImageStreamable, convertToWebpStream, webpDefault } from './image-processor.js';
+import { IImageStreamable, convertToWebpStream, webpDefault, convertSharpToWebpStream } from './image-processor.js';
 import type { FastifyInstance, FastifyRequest, FastifyReply, FastifyPluginOptions } from 'fastify';
 import { detectType, isMimeImage } from './file-info.js';
 import sharp from 'sharp';
+import { sharpBmp } from '@misskey-dev/sharp-read-bmp';
 import { StatusError } from './status-error.js';
 import { DownloadConfig, defaultDownloadConfig, downloadUrl } from './download.js';
 import { getAgents } from './http.js';
@@ -153,12 +154,12 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
                     type: file.mime,
                 };
             } else {
-                const data = sharp(file.path, { animated: !('static' in request.query) })
-                        .resize({
-                            height: 'emoji' in request.query ? 128 : 320,
-                            withoutEnlargement: true,
-                        })
-                        .webp(webpDefault);
+                const data = (await sharpBmp(file.path, file.mime, { animated: !('static' in request.query) }))
+                    .resize({
+                        height: 'emoji' in request.query ? 128 : 320,
+                        withoutEnlargement: true,
+                    })
+                    .webp(webpDefault);
 
                 image = {
                     data,
@@ -167,13 +168,14 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
                 };
             }
         } else if ('static' in request.query) {
-            image = convertToWebpStream(file.path, 498, 280);
+            image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 498, 422);
         } else if ('preview' in request.query) {
-            image = convertToWebpStream(file.path, 200, 200);
+            image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 200, 200);
         } else if ('badge' in request.query) {
-            const mask = sharp(file.path)
+            const mask = (await sharpBmp(file.path, file.mime))
                 .resize(96, 96, {
-                    fit: 'inside',
+                    fit: 'contain',
+                    position: 'centre',
                     withoutEnlargement: false,
                 })
                 .greyscale()
@@ -202,7 +204,7 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
             };
         } else if (file.mime === 'image/svg+xml') {
             image = convertToWebpStream(file.path, 2048, 2048);
-        } else if (!file.mime.startsWith('image/') || !FILE_TYPE_BROWSERSAFE.includes(file.mime)) {
+        } else if (!(file.mime.startsWith('image/') || FILE_TYPE_BROWSERSAFE.includes(file.mime))) {
             throw new StatusError('Rejected type', 403, 'Rejected type');
         }
 

tsconfig.json

@@ -10,8 +10,8 @@
 		"declaration": true,
 		"sourceMap": false,
 		"target": "es2021",
-		"module": "esnext",
-		"moduleResolution": "node",
+		"module": "nodenext",
+		"moduleResolution": "nodenext",
 		"allowSyntheticDefaultImports": true,
 		"removeComments": false,
 		"noLib": false,
@@ -36,6 +36,7 @@
 		],
 		"typeRoots": [
 			"./node_modules/@types",
+			"./node_modules",
 			"./src/@types"
 		],
 		"lib": [