refacotr(gh): refactor

.github/scripts/backend-diagnostics.render-md.mts

@@ -6,7 +6,7 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import * as util from './utility.mts';
 import * as heapSnapshotUtil from './heap-snapshot-util.mts';
-import type { MemoryReport } from './measure-backend-memory-comparison.mts';
+import type { MemoryReport } from './backend-diagnostics.inspect.mts';
 
 const [baseFile, headFile, outputFile] = process.argv.slice(2);
 

.github/scripts/backend-js-footprint-loader.mjs

@@ -1,46 +0,0 @@
-/*
- * SPDX-FileCopyrightText: syuilo and misskey-project
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import { appendFileSync, statSync } from 'node:fs';
-import { extname } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const traceFile = process.env.MK_BACKEND_JS_FOOTPRINT_TRACE;
-const jsExtensions = new Set(['.js', '.mjs', '.cjs']);
-
-function recordLoadedFile(kind, url, format) {
-	if (traceFile == null || !url.startsWith('file:')) return;
-
-	let filePath;
-	try {
-		filePath = fileURLToPath(url);
-	} catch {
-		return;
-	}
-
-	const extension = extname(filePath);
-	if (!jsExtensions.has(extension)) return;
-
-	let size = null;
-	try {
-		size = statSync(filePath).size;
-	} catch {
-		return;
-	}
-
-	appendFileSync(traceFile, `${JSON.stringify({
-		kind,
-		format,
-		path: filePath,
-		size,
-		timestamp: Date.now(),
-	})}\n`);
-}
-
-export async function load(url, context, nextLoad) {
-	const result = await nextLoad(url, context);
-	recordLoadedFile('esm', url, result.format ?? context.format ?? null);
-	return result;
-}

.github/scripts/backend-js-footprint-require.cjs

@@ -1,46 +0,0 @@
-/*
- * SPDX-FileCopyrightText: syuilo and misskey-project
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-'use strict';
-
-const { appendFileSync, statSync } = require('node:fs');
-const Module = require('node:module');
-const { extname } = require('node:path');
-
-const traceFile = process.env.MK_BACKEND_JS_FOOTPRINT_TRACE;
-const jsExtensions = new Set(['.js', '.mjs', '.cjs']);
-
-function recordLoadedFile(kind, filePath, request) {
-	if (traceFile == null || typeof filePath !== 'string') return;
-
-	const extension = extname(filePath);
-	if (!jsExtensions.has(extension) && extension !== '.node') return;
-
-	let size = null;
-	try {
-		size = statSync(filePath).size;
-	} catch {
-		return;
-	}
-
-	appendFileSync(traceFile, `${JSON.stringify({
-		kind,
-		format: extension === '.node' ? 'native' : 'commonjs',
-		path: filePath,
-		request,
-		size,
-		timestamp: Date.now(),
-	})}\n`);
-}
-
-const originalLoad = Module._load;
-const originalResolveFilename = Module._resolveFilename;
-
-Module._load = function load(request, parent, isMain) {
-	const resolved = originalResolveFilename.call(this, request, parent, isMain);
-	const result = originalLoad.apply(this, arguments);
-	recordLoadedFile('cjs', resolved, request);
-	return result;
-};

.github/scripts/backend-js-footprint.mjs

@@ -1,473 +0,0 @@
-/*
- * SPDX-FileCopyrightText: syuilo and misskey-project
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import { fork, spawn } from 'node:child_process';
-import { createRequire } from 'node:module';
-import { cpus, tmpdir } from 'node:os';
-import { dirname, extname, join, relative, resolve, sep } from 'node:path';
-import { setTimeout } from 'node:timers/promises';
-import { fileURLToPath, pathToFileURL } from 'node:url';
-import { gzipSync } from 'node:zlib';
-import * as fs from 'node:fs/promises';
-import * as fsSync from 'node:fs';
-import * as http from 'node:http';
-import * as util from './utility.mts';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const [repoDirArg, outputFileArg] = process.argv.slice(2);
-
-const STARTUP_TIMEOUT = util.readIntegerEnv('MK_JS_FOOTPRINT_STARTUP_TIMEOUT_MS', 120000, 1);
-const SETTLE_TIME = util.readIntegerEnv('MK_JS_FOOTPRINT_SETTLE_TIME_MS', 10000, 0);
-const REQUEST_COUNT = util.readIntegerEnv('MK_JS_FOOTPRINT_REQUEST_COUNT', 10, 0);
-
-const repoDir = resolve(repoDirArg);
-const outputFile = resolve(outputFileArg);
-const backendDir = join(repoDir, 'packages/backend');
-const backendBuiltDir = join(backendDir, 'built');
-const traceFile = join(tmpdir(), `misskey-backend-js-footprint-${process.pid}-${Date.now()}.jsonl`);
-const require = createRequire(join(repoDir, 'package.json'));
-const ts = require('typescript');
-const jsExtensions = new Set(['.js', '.mjs', '.cjs']);
-const fileMetricCache = new Map();
-const packageInfoCache = new Map();
-const nativePackageNames = new Set();
-
-function isInside(parent, child) {
-	const rel = relative(parent, child);
-	return rel === '' || (!rel.startsWith('..') && !rel.includes(`..${sep}`));
-}
-
-function bytesToKiB(value) {
-	return Math.round(value / 1024);
-}
-
-async function resetState() {
-	const backendRequire = createRequire(join(backendDir, 'package.json'));
-	const pg = backendRequire('pg');
-	const Redis = backendRequire('ioredis');
-
-	const postgres = new pg.Client({
-		host: '127.0.0.1',
-		port: 54312,
-		database: 'postgres',
-		user: 'postgres',
-	});
-
-	await postgres.connect();
-	try {
-		await postgres.query('DROP DATABASE IF EXISTS "test-misskey" WITH (FORCE)');
-		await postgres.query('CREATE DATABASE "test-misskey"');
-	} finally {
-		await postgres.end();
-	}
-
-	const redis = new Redis({ host: '127.0.0.1', port: 56312 });
-	try {
-		await redis.flushall();
-	} finally {
-		redis.disconnect();
-	}
-}
-
-function createRequest() {
-	return new Promise((resolvePromise, reject) => {
-		const req = http.request({
-			host: 'localhost',
-			port: 61812,
-			path: '/api/meta',
-			method: 'POST',
-		}, res => {
-			res.on('data', () => { });
-			res.on('end', () => resolvePromise());
-		});
-		req.on('error', reject);
-		req.end();
-	});
-}
-
-async function waitForServerReady(serverProcess) {
-	let serverReady = false;
-	serverProcess.on('message', message => {
-		if (message === 'ok') serverReady = true;
-	});
-
-	const startupStartTime = Date.now();
-	while (!serverReady) {
-		if (Date.now() - startupStartTime > STARTUP_TIMEOUT) {
-			serverProcess.kill('SIGTERM');
-			throw new Error('Server startup timeout');
-		}
-		await setTimeout(100);
-	}
-}
-
-async function stopServer(serverProcess) {
-	serverProcess.kill('SIGTERM');
-
-	let exited = false;
-	await new Promise(resolvePromise => {
-		serverProcess.on('exit', () => {
-			exited = true;
-			resolvePromise(undefined);
-		});
-
-		setTimeout(10000).then(() => {
-			if (!exited) serverProcess.kill('SIGKILL');
-			resolvePromise(undefined);
-		});
-	});
-}
-
-function getPackageNameFromPath(filePath) {
-	const normalized = util.normalizePath(filePath);
-	const marker = '/node_modules/';
-	const index = normalized.lastIndexOf(marker);
-	if (index === -1) return null;
-
-	const rest = normalized.slice(index + marker.length).split('/');
-	if (rest[0] === '.pnpm') {
-		const nestedNodeModulesIndex = rest.indexOf('node_modules');
-		if (nestedNodeModulesIndex === -1) return null;
-		const packageParts = rest.slice(nestedNodeModulesIndex + 1);
-		if (packageParts.length === 0) return null;
-		return packageParts[0].startsWith('@') ? packageParts.slice(0, 2).join('/') : packageParts[0];
-	}
-
-	return rest[0]?.startsWith('@') ? rest.slice(0, 2).join('/') : rest[0] ?? null;
-}
-
-function findPackageDir(filePath, packageName) {
-	const normalizedPackageName = packageName.split('/').join(sep);
-	let current = dirname(filePath);
-
-	while (current !== dirname(current)) {
-		if (current.endsWith(`${sep}${normalizedPackageName}`) && fsSync.existsSync(join(current, 'package.json'))) {
-			return current;
-		}
-
-		const parent = dirname(current);
-		if (parent === current) break;
-		current = parent;
-	}
-
-	return null;
-}
-
-function readPackageInfo(filePath) {
-	const externalPackageName = getPackageNameFromPath(filePath);
-	if (externalPackageName != null) {
-		const packageDir = findPackageDir(filePath, externalPackageName);
-		const cacheKey = packageDir ?? externalPackageName;
-		if (packageInfoCache.has(cacheKey)) return packageInfoCache.get(cacheKey);
-
-		let version = null;
-		if (packageDir != null) {
-			try {
-				const packageJson = JSON.parse(fsSync.readFileSync(join(packageDir, 'package.json'), 'utf8'));
-				version = typeof packageJson.version === 'string' ? packageJson.version : null;
-			} catch { }
-		}
-
-		const info = {
-			category: 'external',
-			name: externalPackageName,
-			version,
-			dir: packageDir,
-		};
-		packageInfoCache.set(cacheKey, info);
-		return info;
-	}
-
-	if (isInside(backendBuiltDir, filePath)) {
-		return {
-			category: 'internal',
-			name: 'backend',
-			version: null,
-			dir: backendDir,
-		};
-	}
-
-	return {
-		category: 'internal',
-		name: 'workspace',
-		version: null,
-		dir: repoDir,
-	};
-}
-
-function analyzeSource(filePath, source) {
-	const sourceFile = ts.createSourceFile(filePath, source, ts.ScriptTarget.Latest, true, ts.ScriptKind.JS);
-	const metrics = {
-		astNodeCount: 0,
-		functionCount: 0,
-		classCount: 0,
-		stringLiteralBytes: 0,
-	};
-
-	function visit(node) {
-		metrics.astNodeCount += 1;
-
-		if (
-			ts.isFunctionDeclaration(node) ||
-			ts.isFunctionExpression(node) ||
-			ts.isArrowFunction(node) ||
-			ts.isMethodDeclaration(node) ||
-			ts.isConstructorDeclaration(node) ||
-			ts.isGetAccessorDeclaration(node) ||
-			ts.isSetAccessorDeclaration(node)
-		) {
-			metrics.functionCount += 1;
-		} else if (ts.isClassDeclaration(node) || ts.isClassExpression(node)) {
-			metrics.classCount += 1;
-		} else if (ts.isStringLiteral(node) || ts.isNoSubstitutionTemplateLiteral(node)) {
-			metrics.stringLiteralBytes += Buffer.byteLength(node.text);
-		}
-
-		ts.forEachChild(node, visit);
-	}
-
-	visit(sourceFile);
-	return metrics;
-}
-
-function readFileMetrics(filePath) {
-	if (fileMetricCache.has(filePath)) return fileMetricCache.get(filePath);
-
-	const source = fsSync.readFileSync(filePath);
-	const sourceText = source.toString('utf8');
-	const astMetrics = analyzeSource(filePath, sourceText);
-	const packageInfo = readPackageInfo(filePath);
-	const metric = {
-		path: filePath,
-		displayPath: util.normalizePath(relative(repoDir, filePath)),
-		sourceBytes: source.byteLength,
-		gzipBytes: gzipSync(source).byteLength,
-		...astMetrics,
-		package: packageInfo,
-	};
-
-	fileMetricCache.set(filePath, metric);
-	return metric;
-}
-
-async function readTraceRecords() {
-	let content = '';
-	try {
-		content = await fs.readFile(traceFile, 'utf8');
-	} catch (err) {
-		if (err.code === 'ENOENT') return [];
-		throw err;
-	}
-
-	const records = [];
-	for (const line of content.split('\n')) {
-		if (line.trim() === '') continue;
-		try {
-			records.push(JSON.parse(line));
-		} catch { }
-	}
-	return records;
-}
-
-function emptyTotals() {
-	return {
-		loadedJsModules: 0,
-		loadedJsSourceBytes: 0,
-		loadedJsGzipBytes: 0,
-		astNodeCount: 0,
-		functionCount: 0,
-		classCount: 0,
-		stringLiteralBytes: 0,
-		externalPackageCount: 0,
-		nativeAddonPackageCount: 0,
-	};
-}
-
-function addFileMetrics(target, metric) {
-	target.loadedJsModules += 1;
-	target.loadedJsSourceBytes += metric.sourceBytes;
-	target.loadedJsGzipBytes += metric.gzipBytes;
-	target.astNodeCount += metric.astNodeCount;
-	target.functionCount += metric.functionCount;
-	target.classCount += metric.classCount;
-	target.stringLiteralBytes += metric.stringLiteralBytes;
-}
-
-function summarizeRecords(records, phase) {
-	const jsPaths = new Set();
-	const nativePaths = new Set();
-
-	for (const record of records) {
-		if (typeof record.path !== 'string') continue;
-
-		const extension = extname(record.path);
-		if (jsExtensions.has(extension)) {
-			jsPaths.add(resolve(record.path));
-		} else if (extension === '.node') {
-			nativePaths.add(resolve(record.path));
-		}
-	}
-
-	for (const nativePath of nativePaths) {
-		const packageInfo = readPackageInfo(nativePath);
-		if (packageInfo.category === 'external') nativePackageNames.add(packageInfo.name);
-	}
-
-	const totals = emptyTotals();
-	const packages = new Map();
-	const modules = [];
-
-	for (const filePath of [...jsPaths].toSorted()) {
-		let metric;
-		try {
-			metric = readFileMetrics(filePath);
-		} catch (err) {
-			process.stderr.write(`Failed to analyze ${filePath}: ${err.message}\n`);
-			continue;
-		}
-
-		addFileMetrics(totals, metric);
-
-		const packageKey = metric.package.name;
-		if (!packages.has(packageKey)) {
-			packages.set(packageKey, {
-				name: metric.package.name,
-				version: metric.package.version,
-				category: metric.package.category,
-				sourceBytes: 0,
-				gzipBytes: 0,
-				modules: 0,
-				astNodeCount: 0,
-				functionCount: 0,
-				classCount: 0,
-				stringLiteralBytes: 0,
-				nativeAddon: false,
-			});
-		}
-
-		const packageSummary = packages.get(packageKey);
-		packageSummary.sourceBytes += metric.sourceBytes;
-		packageSummary.gzipBytes += metric.gzipBytes;
-		packageSummary.modules += 1;
-		packageSummary.astNodeCount += metric.astNodeCount;
-		packageSummary.functionCount += metric.functionCount;
-		packageSummary.classCount += metric.classCount;
-		packageSummary.stringLiteralBytes += metric.stringLiteralBytes;
-
-		modules.push({
-			path: metric.displayPath,
-			package: metric.package.name,
-			category: metric.package.category,
-			sourceBytes: metric.sourceBytes,
-			gzipBytes: metric.gzipBytes,
-			astNodeCount: metric.astNodeCount,
-			functionCount: metric.functionCount,
-			classCount: metric.classCount,
-			stringLiteralBytes: metric.stringLiteralBytes,
-		});
-	}
-
-	for (const packageName of nativePackageNames) {
-		const packageSummary = packages.get(packageName);
-		if (packageSummary != null) packageSummary.nativeAddon = true;
-	}
-
-	const externalPackages = [...packages.values()].filter(packageSummary => packageSummary.category === 'external');
-	totals.externalPackageCount = externalPackages.length;
-	totals.nativeAddonPackageCount = externalPackages.filter(packageSummary => packageSummary.nativeAddon).length;
-
-	return {
-		totals: {
-			...totals,
-			loadedJsSourceKiB: bytesToKiB(totals.loadedJsSourceBytes),
-			loadedJsGzipKiB: bytesToKiB(totals.loadedJsGzipBytes),
-			stringLiteralKiB: bytesToKiB(totals.stringLiteralBytes),
-		},
-		packages: [...packages.values()].toSorted((a, b) => b.sourceBytes - a.sourceBytes),
-		modules: modules.toSorted((a, b) => b.sourceBytes - a.sourceBytes),
-	};
-}
-
-async function measureFootprint() {
-	await fs.writeFile(traceFile, '');
-
-	process.stderr.write('Resetting database and Redis\n');
-	await resetState();
-
-	process.stderr.write('Running migrations\n');
-	await util.run('pnpm', ['--filter', 'backend', 'migrate'], {
-		cwd: repoDir,
-		env: process.env,
-		logStdout: true,
-	});
-
-	const serverProcess = fork(join(backendBuiltDir, 'entry.js'), [], {
-		cwd: backendDir,
-		env: {
-			...process.env,
-			NODE_ENV: 'production',
-			MK_DISABLE_CLUSTERING: '1',
-			MK_ONLY_SERVER: '1',
-			MK_NO_DAEMONS: '1',
-			MK_BACKEND_JS_FOOTPRINT_TRACE: traceFile,
-		},
-		stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
-		execArgv: [
-			'--require',
-			join(__dirname, 'backend-js-footprint-require.cjs'),
-			'--experimental-loader',
-			pathToFileURL(join(__dirname, 'backend-js-footprint-loader.mjs')).href,
-		],
-	});
-
-	serverProcess.stdout?.on('data', data => {
-		process.stderr.write(`[server stdout] ${data}`);
-	});
-
-	serverProcess.stderr?.on('data', data => {
-		process.stderr.write(`[server stderr] ${data}`);
-	});
-
-	serverProcess.on('error', err => {
-		process.stderr.write(`[server error] ${err}\n`);
-	});
-
-	try {
-		await waitForServerReady(serverProcess);
-		await setTimeout(SETTLE_TIME);
-
-		//const startup = summarizeRecords(await readTraceRecords(), 'startup');
-
-		await Promise.all(
-			Array.from({ length: REQUEST_COUNT }).map(() => createRequest()),
-		);
-		await setTimeout(1000);
-
-		const afterRequest = summarizeRecords(await readTraceRecords(), 'afterRequest');
-
-		return {
-			timestamp: new Date().toISOString(),
-			measurement: {
-				strategy: 'runtime-loader-trace',
-				startupTimeoutMs: STARTUP_TIMEOUT,
-				settleTimeMs: SETTLE_TIME,
-				requestCount: REQUEST_COUNT,
-				cpus: cpus().length,
-			},
-			phases: {
-				//startup,
-				afterRequest,
-			},
-		};
-	} finally {
-		await stopServer(serverProcess);
-		await fs.rm(traceFile, { force: true });
-	}
-}
-
-const result = await measureFootprint();
-await fs.writeFile(outputFile, `${JSON.stringify(result, null, 2)}\n`);

.github/workflows/backend-diagnostics.inspect.yml

@@ -11,11 +11,8 @@ on:
       - packages/misskey-js/**
       - .github/scripts/utility.mts
       - .github/scripts/backend-diagnostics.render-md.mts
-      - .github/scripts/measure-backend-memory-comparison.mts
+      - .github/scripts/backend-diagnostics.inspect.mts
       - .github/scripts/memory-stability-util*.mts
-      - .github/scripts/backend-js-footprint.mjs
-      - .github/scripts/backend-js-footprint-loader.mjs
-      - .github/scripts/backend-js-footprint-require.cjs
       - .github/workflows/backend-diagnostics.inspect.yml
       - .github/workflows/backend-diagnostics.report.yml
 
@@ -96,7 +93,7 @@ jobs:
         MK_MEMORY_COMPARE_ROUNDS: 10
         MK_MEMORY_COMPARE_WARMUP_ROUNDS: 1
         MK_MEMORY_HEAP_SNAPSHOT: 1
-      run: node head/.github/scripts/measure-backend-memory-comparison.mts base head memory-base.json memory-head.json
+      run: node head/.github/scripts/backend-diagnostics.inspect.mts base head memory-base.json memory-head.json
     - name: Upload base heap snapshot
       uses: actions/upload-artifact@v7
       with:
@@ -111,10 +108,6 @@ jobs:
         archive: false
         if-no-files-found: error
         retention-days: 7
-    - name: Measure backend loaded JS footprint
-      run: |
-        node head/.github/scripts/backend-js-footprint.mjs base js-footprint-base.json
-        node head/.github/scripts/backend-js-footprint.mjs head js-footprint-head.json
     - name: Upload Artifact
       uses: actions/upload-artifact@v7
       with:
@@ -122,8 +115,6 @@ jobs:
         path: |
           memory-base.json
           memory-head.json
-          js-footprint-base.json
-          js-footprint-head.json
 
   save-pr-number:
     runs-on: ubuntu-latest

.github/workflows/backend-diagnostics.report.yml

@@ -60,7 +60,7 @@ jobs:
         env:
           MK_MEMORY_HEAP_SNAPSHOT_ARTIFACT_URL_BASE: ${{ steps.find-heap-snapshot-artifacts.outputs.base-url }}
           MK_MEMORY_HEAP_SNAPSHOT_ARTIFACT_URL_HEAD: ${{ steps.find-heap-snapshot-artifacts.outputs.head-url }}
-        run: node .github/scripts/backend-diagnostics.render-md.mts ./artifacts/memory-base.json ./artifacts/memory-head.json ./output.md ./artifacts/js-footprint-base.json ./artifacts/js-footprint-head.json
+        run: node .github/scripts/backend-diagnostics.render-md.mts ./artifacts/memory-base.json ./artifacts/memory-head.json ./output.md
       - uses: thollander/actions-comment-pull-request@v3
         with:
           pr-number: ${{ steps.load-pr-num.outputs.pr-number }}