fix: compile_config.js should skip when YAML file not found instead of failing

Co-authored-by: syuilo <4439005+syuilo@users.noreply.github.com>

.github/workflows/get-backend-memory.yml

@@ -57,7 +57,7 @@ jobs:
     - name: Copy Configure
       run: cp .github/misskey/test.yml .config/default.yml
     - name: Compile Configure
-      run: pnpm convert:config
+      run: pnpm compile-config
     - name: Build
       run: pnpm build
     - name: Run migrations

package.json

@@ -22,15 +22,15 @@
 	],
 	"private": true,
 	"scripts": {
-		"convert:config": "cd packages/backend && pnpm convert:config",
+		"compile-config": "cd packages/backend && pnpm compile-config",
 		"build-pre": "node ./scripts/build-pre.js",
 		"build-assets": "node ./scripts/build-assets.mjs",
 		"build": "pnpm build-pre && pnpm -r build && pnpm build-assets",
 		"build-storybook": "pnpm --filter frontend build-storybook",
 		"build-misskey-js-with-types": "pnpm build-pre && pnpm --filter backend... --filter=!misskey-js build && pnpm --filter backend generate-api-json --no-build && ncp packages/backend/built/api.json packages/misskey-js/generator/api.json && pnpm --filter misskey-js update-autogen-code && pnpm --filter misskey-js build && pnpm --filter misskey-js api",
-		"start": "pnpm check:connect && cd packages/backend && pnpm convert:config && node ./built/boot/entry.js",
+		"start": "pnpm check:connect && cd packages/backend && pnpm compile-config && node ./built/boot/entry.js",
-		"start:inspect": "cd packages/backend && pnpm convert:config && node --inspect ./built/boot/entry.js",
+		"start:inspect": "cd packages/backend && pnpm compile-config && node --inspect ./built/boot/entry.js",
-		"start:test": "ncp ./.github/misskey/test.yml ./.config/test.yml && cd packages/backend && pnpm convert:config && cross-env NODE_ENV=test node ./built/boot/entry.js",
+		"start:test": "ncp ./.github/misskey/test.yml ./.config/test.yml && cd packages/backend && cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./built/boot/entry.js",
 		"cli": "cd packages/backend && pnpm cli",
 		"init": "pnpm migrate",
 		"migrate": "cd packages/backend && pnpm migrate",

packages/backend/migration/js/migration-config.js

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { path as configYamlPath } from '../../built/config.js';
+import { compiledConfigFilePath } from '../../built/config.js';
-import * as yaml from 'js-yaml';
 import fs from "node:fs";
 
 export function isConcurrentIndexMigrationEnabled() {
@@ -14,7 +13,7 @@ export function isConcurrentIndexMigrationEnabled() {
 let loadedConfigCache = undefined;
 
 function loadConfigInternal() {
-	const config = yaml.load(fs.readFileSync(configYamlPath, 'utf-8'));
+	const config = JSON.parse(fs.readFileSync(compiledConfigFilePath, 'utf-8'));
 
 	return {
 		disallowExternalApRedirect: Boolean(config.disallowExternalApRedirect ?? false),

packages/backend/package.json

@@ -7,37 +7,37 @@
 		"node": "^22.15.0 || ^24.10.0"
 	},
 	"scripts": {
-		"start": "pnpm convert:config && node ./built/boot/entry.js",
+		"start": "pnpm compile-config && node ./built/boot/entry.js",
-		"start:inspect": "pnpm convert:config && node --inspect ./built/boot/entry.js",
+		"start:inspect": "pnpm compile-config && node --inspect ./built/boot/entry.js",
-		"start:test": "pnpm convert:config && cross-env NODE_ENV=test node ./built/boot/entry.js",
+		"start:test": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./built/boot/entry.js",
-		"migrate": "pnpm convert:config && pnpm typeorm migration:run -d ormconfig.js",
+		"migrate": "pnpm compile-config && pnpm typeorm migration:run -d ormconfig.js",
-		"revert": "pnpm convert:config && pnpm typeorm migration:revert -d ormconfig.js",
+		"revert": "pnpm compile-config && pnpm typeorm migration:revert -d ormconfig.js",
-		"cli": "pnpm convert:config && node ./built/boot/cli.js",
+		"cli": "pnpm compile-config && node ./built/boot/cli.js",
-		"check:connect": "pnpm convert:config && node ./scripts/check_connect.js",
+		"check:connect": "pnpm compile-config && node ./scripts/check_connect.js",
-		"convert:config": "node ./scripts/convert_config.js",
+		"compile-config": "node ./scripts/compile_config.js",
 		"build": "swc src -d built -D --strip-leading-paths",
 		"build:test": "swc test-server -d built-test -D --config-file test-server/.swcrc --strip-leading-paths",
 		"watch:swc": "swc src -d built -D -w --strip-leading-paths",
 		"build:tsc": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
-		"watch": "pnpm convert:config && node ./scripts/watch.mjs",
+		"watch": "pnpm compile-config && node ./scripts/watch.mjs",
 		"restart": "pnpm build && pnpm start",
-		"dev": "pnpm convert:config && node ./scripts/dev.mjs",
+		"dev": "pnpm compile-config && node ./scripts/dev.mjs",
 		"typecheck": "tsc --noEmit && tsc -p test --noEmit && tsc -p test-federation --noEmit",
 		"eslint": "eslint --quiet \"{src,test-federation}/**/*.ts\"",
 		"lint": "pnpm typecheck && pnpm eslint",
-		"jest": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.unit.cjs",
+		"jest": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.unit.cjs",
-		"jest:e2e": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.e2e.cjs",
+		"jest:e2e": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.e2e.cjs",
-		"jest:fed": "pnpm convert:config && node ./jest.js --forceExit --config jest.config.fed.cjs",
+		"jest:fed": "pnpm compile-config && node ./jest.js --forceExit --config jest.config.fed.cjs",
-		"jest-and-coverage": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.unit.cjs",
+		"jest-and-coverage": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.unit.cjs",
-		"jest-and-coverage:e2e": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.e2e.cjs",
+		"jest-and-coverage:e2e": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.e2e.cjs",
-		"jest-clear": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --clearCache",
+		"jest-clear": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --clearCache",
 		"test": "pnpm jest",
 		"test:e2e": "pnpm build && pnpm build:test && pnpm jest:e2e",
 		"test:fed": "pnpm jest:fed",
 		"test-and-coverage": "pnpm jest-and-coverage",
 		"test-and-coverage:e2e": "pnpm build && pnpm build:test && pnpm jest-and-coverage:e2e",
 		"check-migrations": "node scripts/check_migrations_clean.js",
-		"generate-api-json": "pnpm convert:config && node ./scripts/generate_api_json.js"
+		"generate-api-json": "pnpm compile-config && node ./scripts/generate_api_json.js"
 	},
 	"optionalDependencies": {
 		"@swc/core-android-arm64": "1.3.11",

packages/backend/scripts/compile_config.js

@@ -17,13 +17,15 @@ const _filename = fileURLToPath(import.meta.url);
 const _dirname = dirname(_filename);
 
 const configDir = resolve(_dirname, '../../../.config');
+const OUTPUT_PATH = resolve(configDir, '.config.json');
+
+// TODO: yamlのパースに失敗したときのエラーハンドリング
 
 /**
  * YAMLファイルをJSONファイルに変換
  * @param {string} ymlPath - YAMLファイルのパス
- * @param {string} jsonPath - JSONファイルの出力パス
  */
-function convertYamlToJson(ymlPath, jsonPath) {
+function yamlToJson(ymlPath) {
 	if (!fs.existsSync(ymlPath)) {
 		console.log(`skipped: ${ymlPath} is not found`);
 		return;
@@ -31,29 +33,18 @@ function convertYamlToJson(ymlPath, jsonPath) {
 
 	const yamlContent = fs.readFileSync(ymlPath, 'utf-8');
 	const jsonContent = yaml.load(yamlContent);
-	fs.writeFileSync(jsonPath, JSON.stringify({
+	fs.writeFileSync(OUTPUT_PATH, JSON.stringify({
 		'_NOTE_': 'This file is auto-generated from YAML file. DO NOT EDIT.',
 		...jsonContent,
 	}), 'utf-8');
-	console.log(`✓ ${ymlPath} → ${jsonPath}`);
+	console.log(`✓ ${ymlPath} → ${OUTPUT_PATH}`);
 }
 
-// default.yml と test.yml を変換
-convertYamlToJson(
-	resolve(configDir, 'default.yml'),
-	resolve(configDir, 'default.json'),
-);
-
-convertYamlToJson(
-	resolve(configDir, 'test.yml'),
-	resolve(configDir, 'test.json'),
-);
-
-// MISSKEY_CONFIG_YML 環境変数が指定されている場合も変換
 if (process.env.MISSKEY_CONFIG_YML) {
 	const customYmlPath = resolve(configDir, process.env.MISSKEY_CONFIG_YML);
-	const customJsonPath = customYmlPath.replace(/\.ya?ml$/i, '.json');
+	yamlToJson(customYmlPath);
-	convertYamlToJson(customYmlPath, customJsonPath);
+} else {
+	yamlToJson(resolve(configDir, process.env.NODE_ENV === 'test' ? 'test.yml' : 'default.yml'));
 }
 
 console.log('Configuration compiled');

packages/backend/src/config.ts

@@ -217,21 +217,15 @@ export type FulltextSearchProvider = 'sqlLike' | 'sqlPgroonga' | 'meilisearch';
 const _filename = fileURLToPath(import.meta.url);
 const _dirname = dirname(_filename);
 
-/**
+const configDir = `${_dirname}/../../../.config`;
- * Path of configuration directory
- */
-const dir = `${_dirname}/../../../.config`;
 
-/**
+export const compiledConfigFilePath = resolve(configDir, '.config.json');
- * Path of configuration file
- */
-export const path = process.env.MISSKEY_CONFIG_YML
-	? resolve(dir, process.env.MISSKEY_CONFIG_YML).replace(/\.ya?ml$/i, '.json')
-	: process.env.NODE_ENV === 'test'
-		? resolve(dir, 'test.json')
-		: resolve(dir, 'default.json');
 
 export function loadConfig(): Config {
+	if (!fs.existsSync(compiledConfigFilePath)) {
+		throw new Error('Compiled configuration file not found. Try running \'pnpm compile-config\'.');
+	}
+
 	const meta = JSON.parse(fs.readFileSync(`${_dirname}/../../../built/meta.json`, 'utf-8'));
 
 	const frontendManifestExists = fs.existsSync(_dirname + '/../../../built/_frontend_vite_/manifest.json');
@@ -243,7 +237,7 @@ export function loadConfig(): Config {
 		JSON.parse(fs.readFileSync(`${_dirname}/../../../built/_frontend_embed_vite_/manifest.json`, 'utf-8'))
 		: { 'src/boot.ts': { file: null } };
 
-	const config = JSON.parse(fs.readFileSync(path, 'utf-8')) as Source;
+	const config = JSON.parse(fs.readFileSync(compiledConfigFilePath, 'utf-8')) as Source;
 
 	const url = tryCreateUrl(config.url ?? process.env.MISSKEY_URL ?? '');
 	const version = meta.version;

packages/backend/test-federation/compose.a.yml

@@ -41,8 +41,8 @@ services:
         target: /misskey/.config/default.yml
         read_only: true
       - type: bind
-        source: ../scripts/convert_config.js
+        source: ../scripts/compile_config.js
-        target: /misskey/packages/backend/scripts/convert_config.js
+        target: /misskey/packages/backend/scripts/compile_config.js
         read_only: true
 
   db.a.test:

packages/backend/test-federation/compose.b.yml

@@ -41,8 +41,8 @@ services:
         target: /misskey/.config/default.yml
         read_only: true
       - type: bind
-        source: ../scripts/convert_config.js
+        source: ../scripts/compile_config.js
-        target: /misskey/packages/backend/scripts/convert_config.js
+        target: /misskey/packages/backend/scripts/compile_config.js
         read_only: true
 
   db.b.test:

packages/backend/test-federation/compose.tpl.yml

@@ -43,8 +43,8 @@ services:
         target: /misskey/packages/backend/package.json
         read_only: true
       - type: bind
-        source: ../scripts/convert_config.js
+        source: ../scripts/compile_config.js
-        target: /misskey/packages/backend/scripts/convert_config.js
+        target: /misskey/packages/backend/scripts/compile_config.js
         read_only: true
       - type: bind
         source: ../../misskey-js/built

packages/backend/test-federation/compose.yml

@@ -55,8 +55,8 @@ services:
         target: /misskey/packages/backend/jest.js
         read_only: true
       - type: bind
-        source: ../scripts/convert_config.js
+        source: ../scripts/compile_config.js
-        target: /misskey/packages/backend/scripts/convert_config.js
+        target: /misskey/packages/backend/scripts/compile_config.js
         read_only: true
       - type: bind
         source: ../../misskey-js/built