Skip to content

Commit 24bd150

Browse files
authored
refactor(backend): 変換後.config.jsonに統一するように+修正など (misskey-dev#16929)
* wip * Update config.ts * wip * convertは元ファイルを変更するようなニュアンスを若干感じるのでcompileに改名 * wip * Update package.json * Revert "Update package.json" This reverts commit e5c2802. * wip * wip * 謎 * clean up * wip * wip * Revert "wip" This reverts commit 3aa25ac. * wip * wip * Update dummy.yml * wip * Update compile_config.js * Update compile_config.js * wip * Revert "wip" This reverts commit fd78e09. * Update dummy.yml * Update compile_config.js
1 parent a3c3052 commit 24bd150

17 files changed

Lines changed: 98 additions & 137 deletions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
- name: Copy Configure
5858
run: cp .github/misskey/test.yml .config/default.yml
5959
- name: Compile Configure
60-
run: pnpm convert:config
60+
run: pnpm compile-config
6161
- name: Build
6262
run: pnpm build
6363
- name: Run migrations

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
],
2323
"private": true,
2424
"scripts": {
25-
"convert:config": "cd packages/backend && pnpm convert:config",
25+
"compile-config": "cd packages/backend && pnpm compile-config",
2626
"build-pre": "node ./scripts/build-pre.js",
2727
"build-assets": "node ./scripts/build-assets.mjs",
2828
"build": "pnpm build-pre && pnpm -r build && pnpm build-assets",
2929
"build-storybook": "pnpm --filter frontend build-storybook",
3030
"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",
31-
"start": "pnpm check:connect && cd packages/backend && pnpm convert:config && node ./built/boot/entry.js",
32-
"start:inspect": "cd packages/backend && pnpm convert:config && node --inspect ./built/boot/entry.js",
33-
"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",
31+
"start": "pnpm check:connect && cd packages/backend && pnpm compile-config && node ./built/boot/entry.js",
32+
"start:inspect": "cd packages/backend && pnpm compile-config && node --inspect ./built/boot/entry.js",
33+
"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",
3434
"cli": "cd packages/backend && pnpm cli",
3535
"init": "pnpm migrate",
3636
"migrate": "cd packages/backend && pnpm migrate",

‎packages/backend/migration/1745378064470-composite-note-index.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
* SPDX-License-Identifier: AGPL-3.0-only
44
*/
55

6-
import { isConcurrentIndexMigrationEnabled } from "./js/migration-config.js";
6+
const isConcurrentIndexMigrationEnabled = process.env.MISSKEY_MIGRATION_CREATE_INDEX_CONCURRENTLY === '1';
77

88
export class CompositeNoteIndex1745378064470 {
99
name = 'CompositeNoteIndex1745378064470';
10-
transaction = isConcurrentIndexMigrationEnabled() ? false : undefined;
10+
transaction = isConcurrentIndexMigrationEnabled ? false : undefined;
1111

1212
async up(queryRunner) {
13-
const concurrently = isConcurrentIndexMigrationEnabled();
13+
const concurrently = isConcurrentIndexMigrationEnabled;
1414

1515
if (concurrently) {
1616
const hasValidIndex = await queryRunner.query(`SELECT indisvalid FROM pg_index INNER JOIN pg_class ON pg_index.indexrelid = pg_class.oid WHERE pg_class.relname = 'IDX_724b311e6f883751f261ebe378'`);
@@ -29,7 +29,7 @@ export class CompositeNoteIndex1745378064470 {
2929
}
3030

3131
async down(queryRunner) {
32-
const mayConcurrently = isConcurrentIndexMigrationEnabled() ? 'CONCURRENTLY' : '';
32+
const mayConcurrently = isConcurrentIndexMigrationEnabled ? 'CONCURRENTLY' : '';
3333
await queryRunner.query(`DROP INDEX IF EXISTS "IDX_724b311e6f883751f261ebe378"`);
3434
await queryRunner.query(`CREATE INDEX ${mayConcurrently} "IDX_5b87d9d19127bd5d92026017a7" ON "note" ("userId")`);
3535
}

‎packages/backend/migration/1746949539915-migrateSomeConfigFileSettingsToMeta.js‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@
33
* SPDX-License-Identifier: AGPL-3.0-only
44
*/
55

6-
import {loadConfig} from "./js/migration-config.js";
76

87
export class MigrateSomeConfigFileSettingsToMeta1746949539915 {
98
name = 'MigrateSomeConfigFileSettingsToMeta1746949539915'
109

1110
async up(queryRunner) {
12-
const config = loadConfig();
1311
// $1 cannot be used in ALTER TABLE queries
14-
await queryRunner.query(`ALTER TABLE "meta" ADD "proxyRemoteFiles" boolean NOT NULL DEFAULT ${config.proxyRemoteFiles}`);
15-
await queryRunner.query(`ALTER TABLE "meta" ADD "signToActivityPubGet" boolean NOT NULL DEFAULT ${config.signToActivityPubGet}`);
16-
await queryRunner.query(`ALTER TABLE "meta" ADD "allowExternalApRedirect" boolean NOT NULL DEFAULT ${!config.disallowExternalApRedirect}`);
12+
await queryRunner.query(`ALTER TABLE "meta" ADD "proxyRemoteFiles" boolean NOT NULL DEFAULT TRUE`);
13+
await queryRunner.query(`ALTER TABLE "meta" ADD "signToActivityPubGet" boolean NOT NULL DEFAULT TRUE`);
14+
await queryRunner.query(`ALTER TABLE "meta" ADD "allowExternalApRedirect" boolean NOT NULL DEFAULT TRUE`);
1715
}
1816

1917
async down(queryRunner) {

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

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎packages/backend/ormconfig.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import { DataSource } from 'typeorm';
22
import { loadConfig } from './built/config.js';
33
import { entities } from './built/postgres.js';
4-
import { isConcurrentIndexMigrationEnabled } from "./migration/js/migration-config.js";
4+
5+
const isConcurrentIndexMigrationEnabled = process.env.MISSKEY_MIGRATION_CREATE_INDEX_CONCURRENTLY === '1';
56

67
const config = loadConfig();
78

@@ -15,5 +16,5 @@ export default new DataSource({
1516
extra: config.db.extra,
1617
entities: entities,
1718
migrations: ['migration/*.js'],
18-
migrationsTransactionMode: isConcurrentIndexMigrationEnabled() ? 'each' : 'all',
19+
migrationsTransactionMode: isConcurrentIndexMigrationEnabled ? 'each' : 'all',
1920
});

‎packages/backend/package.json‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,37 @@
77
"node": "^22.15.0 || ^24.10.0"
88
},
99
"scripts": {
10-
"start": "pnpm convert:config && node ./built/boot/entry.js",
11-
"start:inspect": "pnpm convert:config && node --inspect ./built/boot/entry.js",
12-
"start:test": "pnpm convert:config && cross-env NODE_ENV=test node ./built/boot/entry.js",
13-
"migrate": "pnpm convert:config && pnpm typeorm migration:run -d ormconfig.js",
14-
"revert": "pnpm convert:config && pnpm typeorm migration:revert -d ormconfig.js",
15-
"cli": "pnpm convert:config && node ./built/boot/cli.js",
16-
"check:connect": "pnpm convert:config && node ./scripts/check_connect.js",
17-
"convert:config": "node ./scripts/convert_config.js",
10+
"start": "pnpm compile-config && node ./built/boot/entry.js",
11+
"start:inspect": "pnpm compile-config && node --inspect ./built/boot/entry.js",
12+
"start:test": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./built/boot/entry.js",
13+
"migrate": "pnpm compile-config && pnpm typeorm migration:run -d ormconfig.js",
14+
"revert": "pnpm compile-config && pnpm typeorm migration:revert -d ormconfig.js",
15+
"cli": "pnpm compile-config && node ./built/boot/cli.js",
16+
"check:connect": "pnpm compile-config && node ./scripts/check_connect.js",
17+
"compile-config": "node ./scripts/compile_config.js",
1818
"build": "swc src -d built -D --strip-leading-paths",
1919
"build:test": "swc test-server -d built-test -D --config-file test-server/.swcrc --strip-leading-paths",
2020
"watch:swc": "swc src -d built -D -w --strip-leading-paths",
2121
"build:tsc": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
22-
"watch": "pnpm convert:config && node ./scripts/watch.mjs",
22+
"watch": "pnpm compile-config && node ./scripts/watch.mjs",
2323
"restart": "pnpm build && pnpm start",
24-
"dev": "pnpm convert:config && node ./scripts/dev.mjs",
24+
"dev": "pnpm compile-config && node ./scripts/dev.mjs",
2525
"typecheck": "tsc --noEmit && tsc -p test --noEmit && tsc -p test-federation --noEmit",
2626
"eslint": "eslint --quiet \"{src,test-federation}/**/*.ts\"",
2727
"lint": "pnpm typecheck && pnpm eslint",
28-
"jest": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.unit.cjs",
29-
"jest:e2e": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.e2e.cjs",
30-
"jest:fed": "pnpm convert:config && node ./jest.js --forceExit --config jest.config.fed.cjs",
31-
"jest-and-coverage": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.unit.cjs",
32-
"jest-and-coverage:e2e": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --coverage --forceExit --config jest.config.e2e.cjs",
33-
"jest-clear": "pnpm convert:config && cross-env NODE_ENV=test node ./jest.js --clearCache",
28+
"jest": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.unit.cjs",
29+
"jest:e2e": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --forceExit --config jest.config.e2e.cjs",
30+
"jest:fed": "pnpm compile-config && node ./jest.js --forceExit --config jest.config.fed.cjs",
31+
"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",
32+
"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",
33+
"jest-clear": "cross-env NODE_ENV=test pnpm compile-config && cross-env NODE_ENV=test node ./jest.js --clearCache",
3434
"test": "pnpm jest",
3535
"test:e2e": "pnpm build && pnpm build:test && pnpm jest:e2e",
3636
"test:fed": "pnpm jest:fed",
3737
"test-and-coverage": "pnpm jest-and-coverage",
3838
"test-and-coverage:e2e": "pnpm build && pnpm build:test && pnpm jest-and-coverage:e2e",
3939
"check-migrations": "node scripts/check_migrations_clean.js",
40-
"generate-api-json": "pnpm convert:config && node ./scripts/generate_api_json.js"
40+
"generate-api-json": "pnpm compile-config && node ./scripts/generate_api_json.js"
4141
},
4242
"optionalDependencies": {
4343
"@swc/core-android-arm64": "1.3.11",

packages/backend/scripts/convert_config.js renamed to packages/backend/scripts/compile_config.js

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,43 +17,38 @@ const _filename = fileURLToPath(import.meta.url);
1717
const _dirname = dirname(_filename);
1818

1919
const configDir = resolve(_dirname, '../../../.config');
20+
const OUTPUT_PATH = resolve(_dirname, '../../../built/.config.json');
21+
22+
// TODO: yamlのパースに失敗したときのエラーハンドリング
2023

2124
/**
2225
* YAMLファイルをJSONファイルに変換
2326
* @param {string} ymlPath - YAMLファイルのパス
24-
* @param {string} jsonPath - JSONファイルの出力パス
2527
*/
26-
function convertYamlToJson(ymlPath, jsonPath) {
28+
function yamlToJson(ymlPath) {
2729
if (!fs.existsSync(ymlPath)) {
28-
console.log(`skipped: ${ymlPath} is not found`);
30+
console.warn(`YAML file not found: ${ymlPath}`);
2931
return;
3032
}
3133

34+
console.log(`${ymlPath} → ${OUTPUT_PATH}`);
35+
3236
const yamlContent = fs.readFileSync(ymlPath, 'utf-8');
3337
const jsonContent = yaml.load(yamlContent);
34-
fs.writeFileSync(jsonPath, JSON.stringify({
38+
if (!fs.existsSync(dirname(OUTPUT_PATH))) {
39+
fs.mkdirSync(dirname(OUTPUT_PATH), { recursive: true });
40+
}
41+
fs.writeFileSync(OUTPUT_PATH, JSON.stringify({
3542
'_NOTE_': 'This file is auto-generated from YAML file. DO NOT EDIT.',
3643
...jsonContent,
3744
}), 'utf-8');
38-
console.log(`✓ ${ymlPath} → ${jsonPath}`);
3945
}
4046

41-
// default.yml と test.yml を変換
42-
convertYamlToJson(
43-
resolve(configDir, 'default.yml'),
44-
resolve(configDir, 'default.json'),
45-
);
46-
47-
convertYamlToJson(
48-
resolve(configDir, 'test.yml'),
49-
resolve(configDir, 'test.json'),
50-
);
51-
52-
// MISSKEY_CONFIG_YML 環境変数が指定されている場合も変換
5347
if (process.env.MISSKEY_CONFIG_YML) {
5448
const customYmlPath = resolve(configDir, process.env.MISSKEY_CONFIG_YML);
55-
const customJsonPath = customYmlPath.replace(/\.ya?ml$/i, '.json');
56-
convertYamlToJson(customYmlPath, customJsonPath);
49+
yamlToJson(customYmlPath);
50+
} else {
51+
yamlToJson(resolve(configDir, process.env.NODE_ENV === 'test' ? 'test.yml' : 'default.yml'));
5752
}
5853

59-
console.log('Configuration compiled');
54+
console.log('Configuration compiled ✓');

‎packages/backend/src/config.ts‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -217,21 +217,15 @@ export type FulltextSearchProvider = 'sqlLike' | 'sqlPgroonga' | 'meilisearch';
217217
const _filename = fileURLToPath(import.meta.url);
218218
const _dirname = dirname(_filename);
219219

220-
/**
221-
* Path of configuration directory
222-
*/
223-
const dir = `${_dirname}/../../../.config`;
220+
const compiledConfigFilePathForTest = resolve(_dirname, '../../../built/._config_.json');
224221

225-
/**
226-
* Path of configuration file
227-
*/
228-
export const path = process.env.MISSKEY_CONFIG_YML
229-
? resolve(dir, process.env.MISSKEY_CONFIG_YML).replace(/\.ya?ml$/i, '.json')
230-
: process.env.NODE_ENV === 'test'
231-
? resolve(dir, 'test.json')
232-
: resolve(dir, 'default.json');
222+
export const compiledConfigFilePath = fs.existsSync(compiledConfigFilePathForTest) ? compiledConfigFilePathForTest : resolve(_dirname, '../../../built/.config.json');
233223

234224
export function loadConfig(): Config {
225+
if (!fs.existsSync(compiledConfigFilePath)) {
226+
throw new Error('Compiled configuration file not found. Try running \'pnpm compile-config\'.');
227+
}
228+
235229
const meta = JSON.parse(fs.readFileSync(`${_dirname}/../../../built/meta.json`, 'utf-8'));
236230

237231
const frontendManifestExists = fs.existsSync(_dirname + '/../../../built/_frontend_vite_/manifest.json');
@@ -243,7 +237,7 @@ export function loadConfig(): Config {
243237
JSON.parse(fs.readFileSync(`${_dirname}/../../../built/_frontend_embed_vite_/manifest.json`, 'utf-8'))
244238
: { 'src/boot.ts': { file: null } };
245239

246-
const config = JSON.parse(fs.readFileSync(path, 'utf-8')) as Source;
240+
const config = JSON.parse(fs.readFileSync(compiledConfigFilePath, 'utf-8')) as Source;
247241

248242
const url = tryCreateUrl(config.url ?? process.env.MISSKEY_URL ?? '');
249243
const version = meta.version;
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
url: https://example.com/
2+
port: 3000

0 commit comments

Comments
 (0)